One or more domain names (subject alternative names) \n included in the certificate. This\n list contains the domain names that are bound to the public key that is contained in the\n certificate. The subject alternative names include the canonical domain name (CN) of the\n certificate and additional domain names that can be used to connect to the website.
" } }, + "ManagedBy": { + "target": "com.amazonaws.acm#CertificateManagedBy", + "traits": { + "smithy.api#documentation": "Identifies the Amazon Web Services service that manages the certificate issued by ACM.
" + } + }, "DomainValidationOptions": { "target": "com.amazonaws.acm#DomainValidationList", "traits": { @@ -318,6 +296,17 @@ "smithy.api#documentation": "Contains metadata about an ACM certificate. This structure is returned in the response\n to a DescribeCertificate request.
" } }, + "com.amazonaws.acm#CertificateManagedBy": { + "type": "enum", + "members": { + "CLOUDFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDFRONT" + } + } + } + }, "com.amazonaws.acm#CertificateManager": { "type": "service", "version": "2015-12-08", @@ -371,10 +360,10 @@ "traits": { "aws.api#service": { "sdkId": "ACM", + "endpointPrefix": "acm", "arnNamespace": "acm", - "cloudFormationName": "CertificateManager", "cloudTrailEventSource": "acm.amazonaws.com", - "endpointPrefix": "acm" + "cloudFormationName": "CertificateManager" }, "aws.auth#sigv4": { "name": "acm" @@ -1473,13 +1462,13 @@ "SubjectAlternativeNameSummaries": { "target": "com.amazonaws.acm#DomainList", "traits": { - "smithy.api#documentation": "One or more domain names (subject alternative names) \n included in the certificate. This\n list contains the domain names that are bound to the public key that is contained in the\n certificate. The subject alternative names include the canonical domain name (CN) of the\n certificate and additional domain names that can be used to connect to the website.
\nWhen called by ListCertificates, this parameter will only return the first 100 subject alternative\n names included in the certificate. To display the full list of subject alternative names, use\n DescribeCertificate.
" + "smithy.api#documentation": "One or more domain names (subject alternative names) \n included in the certificate. This\n list contains the domain names that are bound to the public key that is contained in the\n certificate. The subject alternative names include the canonical domain name (CN) of the\n certificate and additional domain names that can be used to connect to the website.
\nWhen called by ListCertificates, this parameter will only return the first 100 subject alternative\n names included in the certificate. To display the full list of subject alternative names, use\n DescribeCertificate.
" } }, "HasAdditionalSubjectAlternativeNames": { "target": "com.amazonaws.acm#NullableBoolean", "traits": { - "smithy.api#documentation": "When called by ListCertificates, indicates whether the full list of subject alternative names has\n been included in the response. If false, the response includes all of the subject alternative\n names included in the certificate. If true, the response only includes the first 100 subject\n alternative names included in the certificate. To display the full list of subject alternative\n names, use DescribeCertificate.
" + "smithy.api#documentation": "When called by ListCertificates, indicates whether the full list of subject alternative names has\n been included in the response. If false, the response includes all of the subject alternative\n names included in the certificate. If true, the response only includes the first 100 subject\n alternative names included in the certificate. To display the full list of subject alternative\n names, use DescribeCertificate.
" } }, "Status": { @@ -1565,6 +1554,12 @@ "traits": { "smithy.api#documentation": "The time at which the certificate was revoked. This value exists only when the certificate\n status is REVOKED.
Identifies the Amazon Web Services service that manages the certificate issued by ACM.
" + } } }, "traits": { @@ -1838,13 +1833,19 @@ "ValidationStatus": { "target": "com.amazonaws.acm#DomainStatus", "traits": { - "smithy.api#documentation": "The validation status of the domain name. This can be one of the following values:
\n\n PENDING_VALIDATION\n
\n SUCCESS\n
\n FAILED\n
The validation status of the domain name. This can be one of the following values:
\n\n PENDING_VALIDATION\n
\n SUCCESS
\n FAILED
Contains the CNAME record that you add to your DNS database for domain validation. For\n more information, see Use DNS to Validate Domain Ownership.
\nNote: The CNAME information that you need does not include the name of your domain. If you\n include\u2028 your domain name in the DNS database CNAME record, validation fails.\u2028 For example, if\n the name is \"_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com\", only\n \"_a79865eb4cd1a6ab990a45779b4e0b96\" must be used.
" + "smithy.api#documentation": "Contains the CNAME record that you add to your DNS database for domain validation. For\n more information, see Use DNS to Validate Domain Ownership.
\nNote: The CNAME information that you need does not include the name of your domain. If you\n include your domain name in the DNS database CNAME record, validation fails. For example, if\n the name is \"_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com\", only\n \"_a79865eb4cd1a6ab990a45779b4e0b96\" must be used.
" + } + }, + "HttpRedirect": { + "target": "com.amazonaws.acm#HttpRedirect", + "traits": { + "smithy.api#documentation": "Contains information for HTTP-based domain validation of certificates requested through CloudFront and issued by ACM.\n This field exists only when the certificate type is AMAZON_ISSUED and the validation method is HTTP.
Specify one or more algorithms that can be used to generate key pairs.
\nDefault filtering returns only RSA_1024 and RSA_2048\n certificates that have at least one domain. To return other certificate types, provide the\n desired type signatures in a comma-separated list. For example, \"keyTypes\":\n [\"RSA_2048\",\"RSA_4096\"] returns both RSA_2048 and RSA_4096\n certificates.
Identifies the Amazon Web Services service that manages the certificate issued by ACM.
" + } } }, "traits": { @@ -2344,6 +2351,26 @@ "smithy.api#output": {} } }, + "com.amazonaws.acm#HttpRedirect": { + "type": "structure", + "members": { + "RedirectFrom": { + "target": "com.amazonaws.acm#String", + "traits": { + "smithy.api#documentation": "The URL including the domain to be validated. The certificate authority sends GET requests here during validation.
The URL hosting the validation token. RedirectFrom must return this content or redirect here.
Contains information for HTTP-based domain validation of certificates requested through CloudFront and issued by ACM.\n This field exists only when the certificate type is AMAZON_ISSUED and the validation method is HTTP.
Retrieves a list of certificate ARNs and domain names. By default, the API returns RSA_2048 certificates. To return all certificates in the account, include the keyType filter with the values [RSA_1024, RSA_2048, RSA_3072, RSA_4096, EC_prime256v1, EC_secp384r1, EC_secp521r1].
In addition to keyType, you can also filter by the CertificateStatuses, keyUsage, and extendedKeyUsage attributes on the certificate. For more information, see Filters.
Retrieves a list of certificate ARNs and domain names. You can request that only\n certificates that match a specific status be listed. You can also filter by specific\n attributes of the certificate. Default filtering returns only RSA_2048\n certificates. For more information, see Filters.
Specifies the algorithm of the public and private key pair that your certificate uses to\n encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital\n Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but\n with greater computing efficiency. However, ECDSA is not supported by all network clients.\n Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size,\n while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not\n broken. Check the requirements for the Amazon Web Services service where you plan to deploy your\n certificate. For more information about selecting an algorithm, see Key\n algorithms.
\nAlgorithms supported for an ACM certificate request include:
\n\n RSA_2048\n
\n EC_prime256v1\n
\n EC_secp384r1\n
Other listed algorithms are for imported certificates only.
\nWhen you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the\n specified signing algorithm family (RSA or ECDSA) must match the algorithm family of\n the CA's secret key.
\nDefault: RSA_2048
" } + }, + "ManagedBy": { + "target": "com.amazonaws.acm#CertificateManagedBy", + "traits": { + "smithy.api#documentation": "Identifies the Amazon Web Services service that manages the certificate issued by ACM.
" + } } }, "traits": { @@ -3405,6 +3441,12 @@ "smithy.api#enumValue": "SUPERCEDED" } }, + "SUPERSEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPERSEDED" + } + }, "CESSATION_OF_OPERATION": { "target": "smithy.api#Unit", "traits": { @@ -3656,6 +3698,12 @@ "traits": { "smithy.api#enumValue": "DNS" } + }, + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } } } } diff --git a/amp/service/2020-08-01/amp-2020-08-01.json b/models/amp/service/2020-08-01/amp-2020-08-01.json similarity index 100% rename from amp/service/2020-08-01/amp-2020-08-01.json rename to models/amp/service/2020-08-01/amp-2020-08-01.json diff --git a/amplify/service/2017-07-25/amplify-2017-07-25.json b/models/amplify/service/2017-07-25/amplify-2017-07-25.json similarity index 100% rename from amplify/service/2017-07-25/amplify-2017-07-25.json rename to models/amplify/service/2017-07-25/amplify-2017-07-25.json diff --git a/amplifybackend/service/2020-08-11/amplifybackend-2020-08-11.json b/models/amplifybackend/service/2020-08-11/amplifybackend-2020-08-11.json similarity index 100% rename from amplifybackend/service/2020-08-11/amplifybackend-2020-08-11.json rename to models/amplifybackend/service/2020-08-11/amplifybackend-2020-08-11.json diff --git a/amplifyuibuilder/service/2021-08-11/amplifyuibuilder-2021-08-11.json b/models/amplifyuibuilder/service/2021-08-11/amplifyuibuilder-2021-08-11.json similarity index 100% rename from amplifyuibuilder/service/2021-08-11/amplifyuibuilder-2021-08-11.json rename to models/amplifyuibuilder/service/2021-08-11/amplifyuibuilder-2021-08-11.json diff --git a/api-gateway/service/2015-07-09/api-gateway-2015-07-09.json b/models/api-gateway/service/2015-07-09/api-gateway-2015-07-09.json similarity index 100% rename from api-gateway/service/2015-07-09/api-gateway-2015-07-09.json rename to models/api-gateway/service/2015-07-09/api-gateway-2015-07-09.json diff --git a/apigatewaymanagementapi/service/2018-11-29/apigatewaymanagementapi-2018-11-29.json b/models/apigatewaymanagementapi/service/2018-11-29/apigatewaymanagementapi-2018-11-29.json similarity index 100% rename from apigatewaymanagementapi/service/2018-11-29/apigatewaymanagementapi-2018-11-29.json rename to models/apigatewaymanagementapi/service/2018-11-29/apigatewaymanagementapi-2018-11-29.json diff --git a/apigatewayv2/service/2018-11-29/apigatewayv2-2018-11-29.json b/models/apigatewayv2/service/2018-11-29/apigatewayv2-2018-11-29.json similarity index 100% rename from apigatewayv2/service/2018-11-29/apigatewayv2-2018-11-29.json rename to models/apigatewayv2/service/2018-11-29/apigatewayv2-2018-11-29.json diff --git a/app-mesh/service/2019-01-25/app-mesh-2019-01-25.json b/models/app-mesh/service/2019-01-25/app-mesh-2019-01-25.json similarity index 100% rename from app-mesh/service/2019-01-25/app-mesh-2019-01-25.json rename to models/app-mesh/service/2019-01-25/app-mesh-2019-01-25.json diff --git a/appconfig/service/2019-10-09/appconfig-2019-10-09.json b/models/appconfig/service/2019-10-09/appconfig-2019-10-09.json similarity index 93% rename from appconfig/service/2019-10-09/appconfig-2019-10-09.json rename to models/appconfig/service/2019-10-09/appconfig-2019-10-09.json index 491b05b3..d86e5d82 100644 --- a/appconfig/service/2019-10-09/appconfig-2019-10-09.json +++ b/models/appconfig/service/2019-10-09/appconfig-2019-10-09.json @@ -35,7 +35,7 @@ "DeletionProtection": { "target": "com.amazonaws.appconfig#DeletionProtectionSettings", "traits": { - "smithy.api#documentation": "A parameter to configure deletion protection. If enabled, deletion protection prevents a\n user from deleting a configuration profile or an environment if AppConfig has\n called either GetLatestConfiguration or for the\n configuration profile or from the environment during the specified interval. Deletion\n protection is disabled by default. The default interval for\n ProtectionPeriodInMinutes is 60.
A parameter to configure deletion protection. Deletion protection prevents a user from\n deleting a configuration profile or an environment if AppConfig has called either\n GetLatestConfiguration or for the\n configuration profile or from the environment during the specified interval. The default\n interval for ProtectionPeriodInMinutes is 60.
AppConfig feature flags and dynamic configurations help software builders\n quickly and securely adjust application behavior in production environments without full\n code deployments. AppConfig speeds up software release frequency, improves\n application resiliency, and helps you address emergent issues more quickly. With feature\n flags, you can gradually release new capabilities to users and measure the impact of those\n changes before fully deploying the new capabilities to all users. With operational flags\n and dynamic configurations, you can update block lists, allow lists, throttling limits,\n logging verbosity, and perform other operational tuning to quickly respond to issues in\n production environments.
\nAppConfig is a capability of Amazon Web Services Systems Manager.
\nDespite the fact that application configuration content can vary greatly from\n application to application, AppConfig supports the following use cases, which\n cover a broad spectrum of customer needs:
\n\n Feature flags and toggles - Safely release new\n capabilities to your customers in a controlled environment. Instantly roll back\n changes if you experience a problem.
\n\n Application tuning - Carefully introduce\n application changes while testing the impact of those changes with users in\n production environments.
\n\n Allow list or block list - Control access to\n premium features or instantly block specific users without deploying new code.\n
\n\n Centralized configuration storage - Keep your\n configuration data organized and consistent across all of your workloads. You can use\n AppConfig to deploy configuration data stored in the AppConfig\n hosted configuration store, Secrets Manager, Systems Manager, Parameter\n Store, or Amazon S3.
\n\n How AppConfig works\n
\nThis section provides a high-level description of how AppConfig works and how\n you get started.
\nBefore you start creating AppConfig artifacts, we recommend you\n identify configuration data in your code that you want to dynamically manage using\n AppConfig. Good examples include feature flags or toggles, allow and\n block lists, logging verbosity, service limits, and throttling rules, to name a\n few.
\nIf your configuration data already exists in the cloud, you can take advantage\n of AppConfig validation, deployment, and extension features to further\n streamline configuration data management.
\nTo create a namespace, you create an AppConfig artifact called an\n application. An application is simply an organizational construct like a\n folder.
\nFor each AppConfig application, you define one or more environments.\n An environment is a logical grouping of targets, such as applications in a\n Beta or Production environment, Lambda functions,\n or containers. You can also define environments for application subcomponents,\n such as the Web, Mobile, and\n Back-end.
You can configure Amazon CloudWatch alarms for each environment. The system monitors\n alarms during a configuration deployment. If an alarm is triggered, the system\n rolls back the configuration.
\nA configuration profile includes, among other things, a URI that enables\n AppConfig to locate your configuration data in its stored location\n and a profile type. AppConfig supports two configuration profile types:\n feature flags and freeform configurations. Feature flag configuration profiles\n store their data in the AppConfig hosted configuration store and the URI\n is simply hosted. For freeform configuration profiles, you can store\n your data in the AppConfig hosted configuration store or any Amazon Web Services\n service that integrates with AppConfig, as described in Creating\n a free form configuration profile in the the AppConfig User Guide.
A configuration profile can also include optional validators to ensure your\n configuration data is syntactically and semantically correct. AppConfig\n performs a check using the validators when you start a deployment. If any errors\n are detected, the deployment rolls back to the previous configuration data.
\nWhen you create a new deployment, you specify the following:
\nAn application ID
\nA configuration profile ID
\nA configuration version
\nAn environment ID where you want to deploy the configuration data
\nA deployment strategy ID that defines how fast you want the changes to\n take effect
\nWhen you call the StartDeployment API action, AppConfig performs the following\n tasks:
\nRetrieves the configuration data from the underlying data store by using\n the location URI in the configuration profile.
\nVerifies the configuration data is syntactically and semantically correct\n by using the validators you specified when you created your configuration\n profile.
\nCaches a copy of the data so it is ready to be retrieved by your\n application. This cached copy is called the deployed\n data.
\nYou can configure AppConfig Agent as a local host and have the agent\n poll AppConfig for configuration updates. The agent calls the StartConfigurationSession and GetLatestConfiguration API actions and caches your configuration data\n locally. To retrieve the data, your application makes an HTTP call to the\n localhost server. AppConfig Agent supports several use cases, as\n described in Simplified\n retrieval methods in the the AppConfig User\n Guide.
\nIf AppConfig Agent isn't supported for your use case, you can\n configure your application to poll AppConfig for configuration updates\n by directly calling the StartConfigurationSession and GetLatestConfiguration API actions.
\nThis reference is intended to be used with the AppConfig User\n Guide.
", + "smithy.api#documentation": "AppConfig feature flags and dynamic configurations help software builders\n quickly and securely adjust application behavior in production environments without full\n code deployments. AppConfig speeds up software release frequency, improves\n application resiliency, and helps you address emergent issues more quickly. With feature\n flags, you can gradually release new capabilities to users and measure the impact of those\n changes before fully deploying the new capabilities to all users. With operational flags\n and dynamic configurations, you can update block lists, allow lists, throttling limits,\n logging verbosity, and perform other operational tuning to quickly respond to issues in\n production environments.
\nAppConfig is a tool in Amazon Web Services Systems Manager.
\nDespite the fact that application configuration content can vary greatly from\n application to application, AppConfig supports the following use cases, which\n cover a broad spectrum of customer needs:
\n\n Feature flags and toggles - Safely release new\n capabilities to your customers in a controlled environment. Instantly roll back\n changes if you experience a problem.
\n\n Application tuning - Carefully introduce\n application changes while testing the impact of those changes with users in\n production environments.
\n\n Allow list or block list - Control access to\n premium features or instantly block specific users without deploying new code.\n
\n\n Centralized configuration storage - Keep your\n configuration data organized and consistent across all of your workloads. You can use\n AppConfig to deploy configuration data stored in the AppConfig\n hosted configuration store, Secrets Manager, Systems Manager, Parameter\n Store, or Amazon S3.
\n\n How AppConfig works\n
\nThis section provides a high-level description of how AppConfig works and how\n you get started.
\nBefore you start creating AppConfig artifacts, we recommend you\n identify configuration data in your code that you want to dynamically manage using\n AppConfig. Good examples include feature flags or toggles, allow and\n block lists, logging verbosity, service limits, and throttling rules, to name a\n few.
\nIf your configuration data already exists in the cloud, you can take advantage\n of AppConfig validation, deployment, and extension features to further\n streamline configuration data management.
\nTo create a namespace, you create an AppConfig artifact called an\n application. An application is simply an organizational construct like a\n folder.
\nFor each AppConfig application, you define one or more environments.\n An environment is a logical grouping of targets, such as applications in a\n Beta or Production environment, Lambda functions,\n or containers. You can also define environments for application subcomponents,\n such as the Web, Mobile, and\n Back-end.
You can configure Amazon CloudWatch alarms for each environment. The system monitors\n alarms during a configuration deployment. If an alarm is triggered, the system\n rolls back the configuration.
\nA configuration profile includes, among other things, a URI that enables\n AppConfig to locate your configuration data in its stored location\n and a profile type. AppConfig supports two configuration profile types:\n feature flags and freeform configurations. Feature flag configuration profiles\n store their data in the AppConfig hosted configuration store and the URI\n is simply hosted. For freeform configuration profiles, you can store\n your data in the AppConfig hosted configuration store or any Amazon Web Services\n service that integrates with AppConfig, as described in Creating\n a free form configuration profile in the the AppConfig User Guide.
A configuration profile can also include optional validators to ensure your\n configuration data is syntactically and semantically correct. AppConfig\n performs a check using the validators when you start a deployment. If any errors\n are detected, the deployment rolls back to the previous configuration data.
\nWhen you create a new deployment, you specify the following:
\nAn application ID
\nA configuration profile ID
\nA configuration version
\nAn environment ID where you want to deploy the configuration data
\nA deployment strategy ID that defines how fast you want the changes to\n take effect
\nWhen you call the StartDeployment API action, AppConfig performs the following\n tasks:
\nRetrieves the configuration data from the underlying data store by using\n the location URI in the configuration profile.
\nVerifies the configuration data is syntactically and semantically correct\n by using the validators you specified when you created your configuration\n profile.
\nCaches a copy of the data so it is ready to be retrieved by your\n application. This cached copy is called the deployed\n data.
\nYou can configure AppConfig Agent as a local host and have the agent\n poll AppConfig for configuration updates. The agent calls the StartConfigurationSession and GetLatestConfiguration API actions and caches your configuration data\n locally. To retrieve the data, your application makes an HTTP call to the\n localhost server. AppConfig Agent supports several use cases, as\n described in Simplified\n retrieval methods in the the AppConfig User\n Guide.
\nIf AppConfig Agent isn't supported for your use case, you can\n configure your application to poll AppConfig for configuration updates\n by directly calling the StartConfigurationSession and GetLatestConfiguration API actions.
\nThis reference is intended to be used with the AppConfig User\n Guide.
", "smithy.api#title": "Amazon AppConfig", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1447,7 +1447,7 @@ "min": 20, "max": 2048 }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:[a-z]+:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:[a-zA-Z0-9-_/:.]+$" + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\\d{1})?:(\\d{12})?:[a-zA-Z0-9-_/:.]+$" } }, "com.amazonaws.appconfig#BadRequestDetails": { @@ -1848,7 +1848,7 @@ "RetrievalRoleArn": { "target": "com.amazonaws.appconfig#RoleArn", "traits": { - "smithy.api#documentation": "The ARN of an IAM role with permission to access the configuration at the specified\n LocationUri.
A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that\n store your configuration.
\nThe ARN of an IAM role with permission to access the configuration at the specified\n LocationUri.
A retrieval role ARN is not required for configurations stored in CodePipeline or the AppConfig hosted configuration store. It is required for all other sources that\n store your configuration.
\nA parameter to configure deletion protection. If enabled, deletion protection prevents a\n user from deleting a configuration profile if your application has called either GetLatestConfiguration or for the\n configuration profile during the specified interval.
\nThis parameter supports the following values:
\n\n BYPASS: Instructs AppConfig to bypass the deletion\n protection check and delete a configuration profile even if deletion protection would\n have otherwise prevented it.
\n APPLY: Instructs the deletion protection check to run, even if\n deletion protection is disabled at the account level. APPLY also forces\n the deletion protection check to run against resources created in the past hour,\n which are normally excluded from deletion protection checks.
\n ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the\n UpdateAccountSettings API.
A parameter to configure deletion protection. Deletion protection prevents a user from\n deleting a configuration profile if your application has called either GetLatestConfiguration or for the\n configuration profile during the specified interval.
\nThis parameter supports the following values:
\n\n BYPASS: Instructs AppConfig to bypass the deletion\n protection check and delete a configuration profile even if deletion protection would\n have otherwise prevented it.
\n APPLY: Instructs the deletion protection check to run, even if\n deletion protection is disabled at the account level. APPLY also forces\n the deletion protection check to run against resources created in the past hour,\n which are normally excluded from deletion protection checks.
\n ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the\n UpdateAccountSettings API.
A parameter to configure deletion protection. If enabled, deletion protection prevents a\n user from deleting an environment if your application called either GetLatestConfiguration or in the\n environment during the specified interval.
\nThis parameter supports the following values:
\n\n BYPASS: Instructs AppConfig to bypass the deletion\n protection check and delete a configuration profile even if deletion protection would\n have otherwise prevented it.
\n APPLY: Instructs the deletion protection check to run, even if\n deletion protection is disabled at the account level. APPLY also forces\n the deletion protection check to run against resources created in the past hour,\n which are normally excluded from deletion protection checks.
\n ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the\n UpdateAccountSettings API.
A parameter to configure deletion protection. Deletion protection prevents a user from\n deleting an environment if your application called either GetLatestConfiguration or in the\n environment during the specified interval.
\nThis parameter supports the following values:
\n\n BYPASS: Instructs AppConfig to bypass the deletion\n protection check and delete a configuration profile even if deletion protection would\n have otherwise prevented it.
\n APPLY: Instructs the deletion protection check to run, even if\n deletion protection is disabled at the account level. APPLY also forces\n the deletion protection check to run against resources created in the past hour,\n which are normally excluded from deletion protection checks.
\n ACCOUNT_DEFAULT: The default setting, which instructs AppConfig to implement the deletion protection value specified in the\n UpdateAccountSettings API.
A parameter to configure deletion protection. If enabled, deletion protection prevents a\n user from deleting a configuration profile or an environment if AppConfig has\n called either GetLatestConfiguration or for the\n configuration profile or from the environment during the specified interval.
\nThis setting uses the following default values:
\nDeletion protection is disabled by default.
\nThe default interval specified by ProtectionPeriodInMinutes is\n 60.
\n DeletionProtectionCheck skips configuration profiles and environments\n that were created in the past hour.
A parameter to configure deletion protection. Deletion protection prevents a user from\n deleting a configuration profile or an environment if AppConfig has called either\n GetLatestConfiguration or for the\n configuration profile or from the environment during the specified interval.
\nThe default interval specified by ProtectionPeriodInMinutes is 60.\n DeletionProtectionCheck skips configuration profiles and environments that\n were created in the past hour.
A parameter to configure deletion protection. If enabled, deletion protection prevents a\n user from deleting a configuration profile or an environment if AppConfig has\n called either GetLatestConfiguration or for the\n configuration profile or from the environment during the specified interval. Deletion\n protection is disabled by default. The default interval for\n ProtectionPeriodInMinutes is 60.
A parameter to configure deletion protection. Deletion protection prevents a user from\n deleting a configuration profile or an environment if AppConfig has called either\n GetLatestConfiguration or for the\n configuration profile or from the environment during the specified interval. The default\n interval for ProtectionPeriodInMinutes is 60.
The ARN of an IAM role with permission to access the configuration at the specified\n LocationUri.
The ARN of an IAM role with permission to access the configuration at the specified\n LocationUri.
A retrieval role ARN is not required for configurations stored in CodePipeline or the AppConfig hosted configuration store. It is required for all other sources that\n store your configuration.
\n\n Contains details about the S3 object containing the OpenAPI schema for the action group.\n
" + "smithy.api#documentation": "Contains details about the S3 object containing the OpenAPI schema for the action group.
" } }, "payload": { "target": "com.amazonaws.bedrockagentruntime#Payload", "traits": { - "smithy.api#documentation": "\n The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.\n
" + "smithy.api#documentation": "The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
" } } }, "traits": { - "smithy.api#documentation": "\n Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.\n You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.\n
" + "smithy.api#documentation": "Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
" } }, "com.amazonaws.bedrockagentruntime#AWSResourceARN": { @@ -49,18 +49,18 @@ "lambda": { "target": "com.amazonaws.bedrockagentruntime#LambdaResourceArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" } }, "customControl": { "target": "com.amazonaws.bedrockagentruntime#CustomControlMethod", "traits": { - "smithy.api#documentation": "\n To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL. \n
To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL.
\n Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the \n custom control method for handling the information elicited from the user.\n
" + "smithy.api#documentation": "Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" } }, "com.amazonaws.bedrockagentruntime#ActionGroupInvocationInput": { @@ -249,49 +249,49 @@ "actionGroupName": { "target": "com.amazonaws.bedrockagentruntime#ResourceName", "traits": { - "smithy.api#documentation": "\n The name of the action group.\n
", + "smithy.api#documentation": "The name of the action group.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagentruntime#ResourceDescription", "traits": { - "smithy.api#documentation": "\n A description of the action group.\n
" + "smithy.api#documentation": "A description of the action group.
" } }, "parentActionGroupSignature": { "target": "com.amazonaws.bedrockagentruntime#ActionGroupSignature", "traits": { - "smithy.api#documentation": "Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. \n When operating computer use functionality, we recommend taking additional security precautions,\n such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. \n For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\n\n ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and\n take screenshots.
\n ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.
\n ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.
Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and take screenshots.
ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.
ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.
\n The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking \n the action or the custom control method for handling the information elicited from the user.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
" } }, "apiSchema": { "target": "com.amazonaws.bedrockagentruntime#APISchema", "traits": { - "smithy.api#documentation": "\n Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted \n payload defining the schema. For more information, see Action group OpenAPI schemas.\n
" + "smithy.api#documentation": "Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
" } }, "functionSchema": { "target": "com.amazonaws.bedrockagentruntime#FunctionSchema", "traits": { - "smithy.api#documentation": "\n Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.\n
" + "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" } }, "parentActionGroupSignatureParams": { "target": "com.amazonaws.bedrockagentruntime#ActionGroupSignatureParams", "traits": { - "smithy.api#documentation": "\n The configuration settings for a computer use action. \n
\nComputer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
\nThe configuration settings for a computer use action.
Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
\n Contains details of the inline agent's action group.\n
" + "smithy.api#documentation": "Contains details of the inline agent's action group.
" } }, "com.amazonaws.bedrockagentruntime#AgentActionGroups": { @@ -1268,7 +1268,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information about the API operation that the agent predicts should be called.
\nThis data type is used in the following API operations:
\nIn the returnControl field of the InvokeAgent response\n
Contains information about the API operation that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
Information about a parameter to provide to the API request.
\nThis data type is used in the following API operations:
\n\n InvokeAgent response\n
\nInformation about a parameter to provide to the API request.
This data type is used in the following API operations:
" } }, "com.amazonaws.bedrockagentruntime#ApiParameters": { @@ -1320,7 +1320,7 @@ } }, "traits": { - "smithy.api#documentation": "The request body to provide for the API request, as the agent elicited from the user.
\nThis data type is used in the following API operations:
\n\n InvokeAgent response\n
\nThe request body to provide for the API request, as the agent elicited from the user.
This data type is used in the following API operations:
" } }, "com.amazonaws.bedrockagentruntime#ApiResult": { @@ -1377,7 +1377,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information about the API operation that was called from the action group and the response body that was returned.
\nThis data type is used in the following API operations:
\nIn the returnControlInvocationResults of the InvokeAgent request\n
Contains information about the API operation that was called from the action group and the response body that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the InvokeAgent request
A block of content that you pass to, or receive from, a Amazon Bedrock session in an invocation step. You pass the content to a\n session in the payLoad of the PutInvocationStep API operation.\n You retrieve the content with the GetInvocationStep API operation.
For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", + "smithy.api#documentation": "A block of content that you pass to, or receive from, a Amazon Bedrock session in an invocation step. You pass the content to a session in the payLoad of the PutInvocationStep API operation. You retrieve the content with the GetInvocationStep API operation.
For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", "smithy.api#sensitive": {} } }, @@ -1665,7 +1665,7 @@ } }, "traits": { - "smithy.api#documentation": "An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.
\nThis data type is used in the following API operations:
\n\n InvokeAgent response \u2013 in the citations field
\n RetrieveAndGenerate response \u2013 in the citations field
An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.
This data type is used in the following API operations:
InvokeAgent response \u2013 in the citations field
RetrieveAndGenerate response \u2013 in the citations field
\n The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator. \n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.
" } }, "foundationModel": { "target": "com.amazonaws.bedrockagentruntime#ModelIdentifier", "traits": { - "smithy.api#documentation": "\n The foundation model used by the inline collaborator agent.\n
", + "smithy.api#documentation": "The foundation model used by the inline collaborator agent.
", "smithy.api#required": {} } }, "instruction": { "target": "com.amazonaws.bedrockagentruntime#Instruction", "traits": { - "smithy.api#documentation": "\n Instruction that tell the inline collaborator agent what it should do and how it should interact with users.\n
", + "smithy.api#documentation": "Instruction that tell the inline collaborator agent what it should do and how it should interact with users.
", "smithy.api#required": {} } }, "idleSessionTTLInSeconds": { "target": "com.amazonaws.bedrockagentruntime#SessionTTL", "traits": { - "smithy.api#documentation": "\n The number of seconds for which the Amazon Bedrock keeps information about the user's conversation with the inline collaborator agent.
\nA user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.\n
" + "smithy.api#documentation": "The number of seconds for which the Amazon Bedrock keeps information about the user's conversation with the inline collaborator agent.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
" } }, "actionGroups": { "target": "com.amazonaws.bedrockagentruntime#AgentActionGroups", "traits": { - "smithy.api#documentation": "\n List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.\n
" + "smithy.api#documentation": "List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.
" } }, "knowledgeBases": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBases", "traits": { - "smithy.api#documentation": "\n Knowledge base associated with the inline collaborator agent.\n
" + "smithy.api#documentation": "Knowledge base associated with the inline collaborator agent.
" } }, "guardrailConfiguration": { "target": "com.amazonaws.bedrockagentruntime#GuardrailConfigurationWithArn", "traits": { - "smithy.api#documentation": "\n Details of the guardwrail associated with the inline collaborator.\n
" + "smithy.api#documentation": "Details of the guardwrail associated with the inline collaborator.
" } }, "promptOverrideConfiguration": { "target": "com.amazonaws.bedrockagentruntime#PromptOverrideConfiguration", "traits": { - "smithy.api#documentation": "\n Contains configurations to override prompt templates in different parts of an inline collaborator sequence. For more information, see Advanced prompts.\n
" + "smithy.api#documentation": "Contains configurations to override prompt templates in different parts of an inline collaborator sequence. For more information, see Advanced prompts.
" } }, "agentCollaboration": { "target": "com.amazonaws.bedrockagentruntime#AgentCollaboration", "traits": { - "smithy.api#documentation": "\n Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.\n
" + "smithy.api#documentation": "Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
" } }, "collaboratorConfigurations": { "target": "com.amazonaws.bedrockagentruntime#CollaboratorConfigurations", "traits": { - "smithy.api#documentation": "\n Settings of the collaborator agent.\n
" + "smithy.api#documentation": "Settings of the collaborator agent.
" } }, "agentName": { "target": "com.amazonaws.bedrockagentruntime#Name", "traits": { - "smithy.api#documentation": "\n Name of the inline collaborator agent which must be the same name as specified for collaboratorName.\n
Name of the inline collaborator agent which must be the same name as specified for collaboratorName.
\n List of inline collaborators. \n
" + "smithy.api#documentation": "List of inline collaborators.
" } }, "com.amazonaws.bedrockagentruntime#CollaboratorConfiguration": { @@ -1848,32 +1848,32 @@ "collaboratorName": { "target": "com.amazonaws.bedrockagentruntime#Name", "traits": { - "smithy.api#documentation": "\n Name of the inline collaborator agent which must be the same name as specified for agentName.\n
Name of the inline collaborator agent which must be the same name as specified for agentName.
\n Instructions that tell the inline collaborator agent what it should do and how it should interact with users.\n
", + "smithy.api#documentation": "Instructions that tell the inline collaborator agent what it should do and how it should interact with users.
", "smithy.api#required": {} } }, "agentAliasArn": { "target": "com.amazonaws.bedrockagentruntime#AgentAliasArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the inline collaborator agent.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inline collaborator agent.
" } }, "relayConversationHistory": { "target": "com.amazonaws.bedrockagentruntime#RelayConversationHistory", "traits": { - "smithy.api#documentation": "\n A relay conversation history for the inline collaborator agent.\n
" + "smithy.api#documentation": "A relay conversation history for the inline collaborator agent.
" } } }, "traits": { - "smithy.api#documentation": "\n Settings of an inline collaborator agent.\n
" + "smithy.api#documentation": "Settings of an inline collaborator agent.
" } }, "com.amazonaws.bedrockagentruntime#CollaboratorConfigurations": { @@ -1951,12 +1951,12 @@ "images": { "target": "com.amazonaws.bedrockagentruntime#ImageInputs", "traits": { - "smithy.api#documentation": "Lists details, including format and source, for the image in the response from the function call. You can specify only one image and the function in the returnControlInvocationResults \n must be a computer use action.\n For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
Lists details, including format and source, for the image in the response from the function call. You can specify only one image and the function in the returnControlInvocationResults must be a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Contains the body of the API response.
\nThis data type is used in the following API operations:
\nIn the returnControlInvocationResults field of the InvokeAgent request\n
Contains the body of the API response.
This data type is used in the following API operations:
In the returnControlInvocationResults field of the InvokeAgent request
Creates a new invocation within a session. An invocation groups the related invocation steps that store the content from\n a conversation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
\nRelated APIs
\n\n ListInvocations\n
\n\n ListSessions\n
\n\n GetSession\n
\nCreates a new invocation within a session. An invocation groups the related invocation steps that store the content from a conversation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Related APIs
", "smithy.api#http": { "code": 201, "method": "PUT", @@ -2064,7 +2064,7 @@ "sessionIdentifier": { "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier", "traits": { - "smithy.api#documentation": "The unique identifier for the associated session for the invocation. You can specify either the session's sessionId or its Amazon Resource Name (ARN).\n
The unique identifier for the associated session for the invocation. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source\n frameworks such as LangGraph and LlamaIndex. Sessions enable you to save the state of\n conversations at checkpoints, with the added security and infrastructure of Amazon Web Services. For more information, see\n Store and retrieve conversation history and context with Amazon Bedrock sessions.
\nBy default, Amazon Bedrock uses Amazon Web Services-managed keys for session encryption, including session metadata,\n or you can use your own KMS key. For more information, see Amazon Bedrock session encryption.
\n\n You use a session to store state and conversation history for generative AI applications built with open-source frameworks. \n For Amazon Bedrock Agents, the service automatically manages conversation context and associates them with the agent-specific sessionId you specify in the \n InvokeAgent API operation.\n
\nRelated APIs:
\n\n ListSessions\n
\n\n GetSession\n
\n\n EndSession\n
\n\n DeleteSession\n
\nCreates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and LlamaIndex. Sessions enable you to save the state of conversations at checkpoints, with the added security and infrastructure of Amazon Web Services. For more information, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
By default, Amazon Bedrock uses Amazon Web Services-managed keys for session encryption, including session metadata, or you can use your own KMS key. For more information, see Amazon Bedrock session encryption.
You use a session to store state and conversation history for generative AI applications built with open-source frameworks. For Amazon Bedrock Agents, the service automatically manages conversation context and associates them with the agent-specific sessionId you specify in the InvokeAgent API operation.
Related APIs:
", "smithy.api#http": { "code": 201, "method": "PUT", @@ -2147,13 +2147,13 @@ "sessionMetadata": { "target": "com.amazonaws.bedrockagentruntime#SessionMetadataMap", "traits": { - "smithy.api#documentation": "A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference, \n and the type of device they are using.
" + "smithy.api#documentation": "A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference, and the type of device they are using.
" } }, "encryptionKeyArn": { "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key.\n For more information, see Amazon Bedrock session encryption.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see Amazon Bedrock session encryption.
" } }, "tags": { @@ -2231,24 +2231,38 @@ } } }, + "com.amazonaws.bedrockagentruntime#CustomOrchestration": { + "type": "structure", + "members": { + "executor": { + "target": "com.amazonaws.bedrockagentruntime#OrchestrationExecutor", + "traits": { + "smithy.api#documentation": "The structure of the executor invoking the actions in custom orchestration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of the custom orchestration configured for the agent.
" + } + }, "com.amazonaws.bedrockagentruntime#CustomOrchestrationTrace": { "type": "structure", "members": { "traceId": { "target": "com.amazonaws.bedrockagentruntime#TraceId", "traits": { - "smithy.api#documentation": "\n The unique identifier of the trace. \n
" + "smithy.api#documentation": "The unique identifier of the trace.
" } }, "event": { "target": "com.amazonaws.bedrockagentruntime#CustomOrchestrationTraceEvent", "traits": { - "smithy.api#documentation": "\n The event details used with the custom orchestration.\n
" + "smithy.api#documentation": "The event details used with the custom orchestration.
" } } }, "traits": { - "smithy.api#documentation": "\n The trace behavior for the custom orchestration. \n
", + "smithy.api#documentation": "The trace behavior for the custom orchestration.
", "smithy.api#sensitive": {} } }, @@ -2258,12 +2272,12 @@ "text": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "\n The text that prompted the event at this step.\n
" + "smithy.api#documentation": "The text that prompted the event at this step.
" } } }, "traits": { - "smithy.api#documentation": "\n The event in the custom orchestration sequence. Events are the responses which the custom orchestration Lambda function sends as response to the agent. \n
", + "smithy.api#documentation": "The event in the custom orchestration sequence. Events are the responses which the custom orchestration Lambda function sends as response to the agent.
", "smithy.api#sensitive": {} } }, @@ -2395,7 +2409,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a session that you ended. You can't delete a session with an ACTIVE status. To delete an active session, you must first end it with the \n EndSession API operation.\n For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Deletes a session that you ended. You can't delete a session with an ACTIVE status. To delete an active session, you must first end it with the EndSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Ends the session. \n After you end a session, you can still access its content but you can\u2019t add to it. To delete the session and it's content, you use the DeleteSession API operation.\n For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", + "smithy.api#documentation": "Ends the session. After you end a session, you can still access its content but you can\u2019t add to it. To delete the session and it's content, you use the DeleteSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", "smithy.api#http": { "code": 200, "method": "PATCH", @@ -2836,7 +2850,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see Query configurations.
\nThis data type is used in the following API operations:
\nSpecifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see Query configurations.
This data type is used in the following API operations:
" } }, "com.amazonaws.bedrockagentruntime#FilterKey": { @@ -3200,7 +3214,7 @@ "nodeActionTrace": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeActionEvent", "traits": { - "smithy.api#documentation": "Contains information about an action (operation) called by a node.\n For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
" + "smithy.api#documentation": "Contains information about an action (operation) called by a node. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
" } } }, @@ -3322,7 +3336,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information about an action (operation) called by a node in an Amazon Bedrock flow. The service generates action events for calls made by prompt nodes,\n agent nodes, and Amazon Web Services Lambda nodes.
", + "smithy.api#documentation": "Contains information about an action (operation) called by a node in an Amazon Bedrock flow. The service generates action events for calls made by prompt nodes, agent nodes, and Amazon Web Services Lambda nodes.
", "smithy.api#sensitive": {} } }, @@ -3497,31 +3511,31 @@ "name": { "target": "com.amazonaws.bedrockagentruntime#ResourceName", "traits": { - "smithy.api#documentation": "\n A name for the function.\n
", + "smithy.api#documentation": "A name for the function.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagentruntime#FunctionDescription", "traits": { - "smithy.api#documentation": "\n A description of the function and its purpose.\n
" + "smithy.api#documentation": "A description of the function and its purpose.
" } }, "parameters": { "target": "com.amazonaws.bedrockagentruntime#ParameterMap", "traits": { - "smithy.api#documentation": "\n The parameters that the agent elicits from the user to fulfill the function.\n
" + "smithy.api#documentation": "The parameters that the agent elicits from the user to fulfill the function.
" } }, "requireConfirmation": { "target": "com.amazonaws.bedrockagentruntime#RequireConfirmation", "traits": { - "smithy.api#documentation": "\n Contains information if user confirmation is required to invoke the function.\n
" + "smithy.api#documentation": "Contains information if user confirmation is required to invoke the function.
" } } }, "traits": { - "smithy.api#documentation": "\n Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.\n
" + "smithy.api#documentation": "Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
" } }, "com.amazonaws.bedrockagentruntime#FunctionDescription": { @@ -3575,7 +3589,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information about the function that the agent predicts should be called.
\nThis data type is used in the following API operations:
\nIn the returnControl field of the InvokeAgent response\n
Contains information about the function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
Contains information about a parameter of the function.
\nThis data type is used in the following API operations:
\nIn the returnControl field of the InvokeAgent response\n
Contains information about a parameter of the function.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
The response from the function call using the parameters. The response might be returned directly or from the Lambda function. \n Specify TEXT or IMAGES. The key of the object is the content type. You can only specify one type. If you\n specify IMAGES, you can specify only one image. You can specify images only when the function in the returnControlInvocationResults \n is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
The response from the function call using the parameters. The response might be returned directly or from the Lambda function. Specify TEXT or IMAGES. The key of the object is the content type. You can only specify one type. If you specify IMAGES, you can specify only one image. You can specify images only when the function in the returnControlInvocationResults is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
Contains information about the function that was called from the action group and the response that was returned.
\nThis data type is used in the following API operations:
\nIn the returnControlInvocationResults of the InvokeAgent request\n
Contains information about the function that was called from the action group and the response that was returned.
This data type is used in the following API operations:
In the returnControlInvocationResults of the InvokeAgent request
\n A list of functions that each define an action in the action group.\n
" + "smithy.api#documentation": "A list of functions that each define an action in the action group.
" } } }, "traits": { - "smithy.api#documentation": "\n Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.\n
" + "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" } }, "com.amazonaws.bedrockagentruntime#Functions": { @@ -3820,7 +3834,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains metadata about a part of the generated response that is accompanied by a citation.
\nThis data type is used in the following API operations:
\n\n InvokeAgent response \u2013 in the generatedResponsePart field
\n RetrieveAndGenerate response \u2013 in the generatedResponsePart field
Contains metadata about a part of the generated response that is accompanied by a citation.
This data type is used in the following API operations:
InvokeAgent response \u2013 in the generatedResponsePart field
RetrieveAndGenerate response \u2013 in the generatedResponsePart field
Contains configurations for response generation based on the knowledge base query results.
\nThis data type is used in the following API operations:
\nContains configurations for response generation based on the knowledge base query results.
This data type is used in the following API operations:
" } }, "com.amazonaws.bedrockagentruntime#GetAgentMemory": { @@ -3920,14 +3934,14 @@ "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { - "smithy.api#documentation": "If the total number of results is greater than the maxItems value provided in the request, enter the token returned \n in the nextToken field in the response in this field to return the next batch of results.
If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The maximum number of items to return in the response. If the total number of results is greater \n than this value, use the token returned in the response in the nextToken field when making another \n request to return the next batch of results.
The maximum number of items to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxItems value provided in the request, use this token \n when making another request in the nextToken field to return the next batch of results.
If the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data.\n For more information, see Amazon Bedrock session encryption.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data. For more information, see Amazon Bedrock session encryption.
" } } }, @@ -4285,20 +4299,20 @@ "guardrailIdentifier": { "target": "com.amazonaws.bedrockagentruntime#GuardrailIdentifierWithArn", "traits": { - "smithy.api#documentation": "\n The unique identifier for the guardrail.\n
", + "smithy.api#documentation": "The unique identifier for the guardrail.
", "smithy.api#required": {} } }, "guardrailVersion": { "target": "com.amazonaws.bedrockagentruntime#GuardrailVersion", "traits": { - "smithy.api#documentation": "\n The version of the guardrail.\n
", + "smithy.api#documentation": "The version of the guardrail.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "\n The configuration details for the guardrail.\n
" + "smithy.api#documentation": "The configuration details for the guardrail.
" } }, "com.amazonaws.bedrockagentruntime#GuardrailContentFilter": { @@ -5068,7 +5082,7 @@ } }, "traits": { - "smithy.api#documentation": "Details about an image in the result from a function in the action group invocation. You can specify images only when the function\n is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
" + "smithy.api#documentation": "Details about an image in the result from a function in the action group invocation. You can specify images only when the function is a computer use action. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.
" } }, "com.amazonaws.bedrockagentruntime#ImageInputFormat": { @@ -5283,13 +5297,13 @@ "trace": { "target": "com.amazonaws.bedrockagentruntime#InlineAgentTracePart", "traits": { - "smithy.api#documentation": "Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying \n knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. \n For more information, see Trace events. \n
" + "smithy.api#documentation": "Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace events.
" } }, "returnControl": { "target": "com.amazonaws.bedrockagentruntime#InlineAgentReturnControlPayload", "traits": { - "smithy.api#documentation": "Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system \n and can be used in your own setup for fulfilling the action.
" + "smithy.api#documentation": "Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
" } }, "internalServerException": { @@ -5364,7 +5378,7 @@ "invocationInputs": { "target": "com.amazonaws.bedrockagentruntime#InvocationInputs", "traits": { - "smithy.api#documentation": "A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent \n determines from its session with the user.
" + "smithy.api#documentation": "A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
" } }, "invocationId": { @@ -5375,7 +5389,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information to return from the action group that the agent has predicted to invoke.
\nThis data type is used in the InvokeAgent response API operation.
", + "smithy.api#documentation": "Contains information to return from the action group that the agent has predicted to invoke.
This data type is used in the InvokeAgent response API operation.
", "smithy.api#sensitive": {} } }, @@ -5391,12 +5405,31 @@ "trace": { "target": "com.amazonaws.bedrockagentruntime#Trace", "traits": { - "smithy.api#documentation": "Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the \n agent arrived at the response it provided the customer. For more information, see Trace enablement.\n
" + "smithy.api#documentation": "Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
" + } + }, + "callerChain": { + "target": "com.amazonaws.bedrockagentruntime#CallerChain", + "traits": { + "smithy.api#documentation": "The caller chain for the trace part.
" + } + }, + "eventTime": { + "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", + "traits": { + "smithy.api#documentation": "The time that trace occurred.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "collaboratorName": { + "target": "com.amazonaws.bedrockagentruntime#Name", + "traits": { + "smithy.api#documentation": "The collaborator name for the trace part.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases \n and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. \n For more information, see Trace enablement.
", + "smithy.api#documentation": "Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
", "smithy.api#sensitive": {} } }, @@ -5420,42 +5453,42 @@ "sessionAttributes": { "target": "com.amazonaws.bedrockagentruntime#SessionAttributesMap", "traits": { - "smithy.api#documentation": "\n Contains attributes that persist across a session and the values of those attributes.\n
" + "smithy.api#documentation": "Contains attributes that persist across a session and the values of those attributes.
" } }, "promptSessionAttributes": { "target": "com.amazonaws.bedrockagentruntime#PromptSessionAttributesMap", "traits": { - "smithy.api#documentation": "\n Contains attributes that persist across a session and the values of those attributes.\n
" + "smithy.api#documentation": "Contains attributes that persist across a session and the values of those attributes.
" } }, "returnControlInvocationResults": { "target": "com.amazonaws.bedrockagentruntime#ReturnControlInvocationResults", "traits": { - "smithy.api#documentation": "\n Contains information about the results from the action group invocation. For more information, see Return control to the agent developer.\n
\nIf you include this field in the sessionState field, the inputText field will be ignored.
Contains information about the results from the action group invocation. For more information, see Return control to the agent developer.
If you include this field in the sessionState field, the inputText field will be ignored.
\n The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeInlineAgent response for the action \n whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer.\n
The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeInlineAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer.
\n Contains information about the files used by code interpreter.\n
" + "smithy.api#documentation": "Contains information about the files used by code interpreter.
" } }, "conversationHistory": { "target": "com.amazonaws.bedrockagentruntime#ConversationHistory", "traits": { - "smithy.api#documentation": "\n Contains the conversation history that persist across sessions.\n
" + "smithy.api#documentation": "Contains the conversation history that persist across sessions.
" } } }, "traits": { - "smithy.api#documentation": "\n Contains parameters that specify various attributes that persist across a session or prompt. You can define session state \n attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeInlineAgent request. \n Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior. \n For more information, see Control session context\n
Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeInlineAgent request. Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior. For more information, see Control session context
Contains details about the API operation or function that the agent predicts should be called.
\nThis data type is used in the following API operations:
\nIn the returnControl field of the InvokeAgent response\n
Contains details about the API operation or function that the agent predicts should be called.
This data type is used in the following API operations:
In the returnControl field of the InvokeAgent response
A result from the invocation of an action. For more information, see Return control to the agent developer and Control session context.
\nThis data type is used in the following API operations:
\n\n InvokeAgent request\n
\nA result from the invocation of an action. For more information, see Return control to the agent developer and Control session context.
This data type is used in the following API operations:
" } }, "com.amazonaws.bedrockagentruntime#InvocationStep": { @@ -5917,7 +5950,7 @@ } ], "traits": { - "smithy.api#documentation": "Sends a prompt for the agent to process and respond to. Note the following fields for the request:
\nTo continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.
The response contains both chunk and trace attributes.
\nThe final response is returned in the bytes field of the chunk object. The InvokeAgent returns one chunk for the entire interaction.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.
Errors are also surfaced in the response.
\nSends a prompt for the agent to process and respond to. Note the following fields for the request:
To continue the same conversation with an agent, use the same sessionId value in the request.
To activate trace enablement, turn enableTrace to true. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.
End a conversation by setting endSession to true.
In the sessionState object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.
The response contains both chunk and trace attributes.
The final response is returned in the bytes field of the chunk object. The InvokeAgent returns one chunk for the entire interaction.
The attribution object contains citations for parts of the response.
If you set enableTrace to true in the request, you can trace the agent's steps and reasoning process that led it to the response.
If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the returnControl field.
Errors are also surfaced in the response.
Contains parameters that specify various attributes of the session. For more information, see Control session context.
\nIf you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
Contains parameters that specify various attributes of the session. For more information, see Control session context.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
The prompt text to send the agent.
\nIf you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
The prompt text to send the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
\n Specifies the configurations for streaming.\n
\nTo use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
\nThe CLI doesn't support streaming operations in Amazon Bedrock, including InvokeFlow.
Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeFlow.
The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.
" + "smithy.api#documentation": "The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.
" } } }, @@ -6201,7 +6234,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Invokes an inline Amazon Bedrock agent using the configurations you provide with the request.\n
\nSpecify the following fields for security purposes.
\n(Optional) customerEncryptionKeyArn \u2013 The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds \u2013 Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. \n For more information, see Advanced prompts.
The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
\nInvokes an inline Amazon Bedrock agent using the configurations you provide with the request.
Specify the following fields for security purposes.
(Optional) customerEncryptionKeyArn \u2013 The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds \u2013 Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.
The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
\n The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent. \n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.
" } }, "foundationModel": { "target": "com.amazonaws.bedrockagentruntime#ModelIdentifier", "traits": { - "smithy.api#documentation": "\n The model identifier (ID) of the model to use for orchestration by the inline agent. For example, meta.llama3-1-70b-instruct-v1:0.\n
The model identifier (ID) of the model to use for orchestration by the inline agent. For example, meta.llama3-1-70b-instruct-v1:0.
\n The instructions that tell the inline agent what it should do and how it should interact with users.\n
", + "smithy.api#documentation": "The instructions that tell the inline agent what it should do and how it should interact with users.
", "smithy.api#required": {} } }, "idleSessionTTLInSeconds": { "target": "com.amazonaws.bedrockagentruntime#SessionTTL", "traits": { - "smithy.api#documentation": "\n The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.\n
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.
" + "smithy.api#documentation": " The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent InvokeInlineAgent request begins a new session.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.
" } }, "actionGroups": { "target": "com.amazonaws.bedrockagentruntime#AgentActionGroups", "traits": { - "smithy.api#documentation": "\n A list of action groups with each action group defining the action the inline agent needs to carry out.\n
" + "smithy.api#documentation": "A list of action groups with each action group defining the action the inline agent needs to carry out.
" } }, "knowledgeBases": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBases", "traits": { - "smithy.api#documentation": "\n Contains information of the knowledge bases to associate with. \n
" + "smithy.api#documentation": "Contains information of the knowledge bases to associate with.
" } }, "guardrailConfiguration": { "target": "com.amazonaws.bedrockagentruntime#GuardrailConfigurationWithArn", "traits": { - "smithy.api#documentation": "\n The guardrails to assign to the inline agent.\n
" + "smithy.api#documentation": "The guardrails to assign to the inline agent.
" } }, "promptOverrideConfiguration": { "target": "com.amazonaws.bedrockagentruntime#PromptOverrideConfiguration", "traits": { - "smithy.api#documentation": "\n Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.\n
" + "smithy.api#documentation": "Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.
" } }, "agentCollaboration": { "target": "com.amazonaws.bedrockagentruntime#AgentCollaboration", "traits": { - "smithy.api#documentation": "\n Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.\n
" + "smithy.api#documentation": "Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.
" } }, "collaboratorConfigurations": { "target": "com.amazonaws.bedrockagentruntime#CollaboratorConfigurations", "traits": { - "smithy.api#documentation": "\n Settings for an inline agent collaborator called with InvokeInlineAgent.\n
" + "smithy.api#documentation": "Settings for an inline agent collaborator called with InvokeInlineAgent.
" + } + }, + "agentName": { + "target": "com.amazonaws.bedrockagentruntime#Name", + "traits": { + "smithy.api#documentation": "The name for the agent.
" } }, "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { - "smithy.api#documentation": "\n The unique identifier of the session. Use the same value across requests to continue the same conversation.\n
", + "smithy.api#documentation": "The unique identifier of the session. Use the same value across requests to continue the same conversation.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6285,37 +6324,37 @@ "endSession": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "\n Specifies whether to end the session with the inline agent or not.\n
" + "smithy.api#documentation": "Specifies whether to end the session with the inline agent or not.
" } }, "enableTrace": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "\n Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.\n \n
" + "smithy.api#documentation": "Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.
" } }, "inputText": { "target": "com.amazonaws.bedrockagentruntime#InputText", "traits": { - "smithy.api#documentation": "\n The prompt text to send to the agent.\n
\nIf you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
The prompt text to send to the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
\n Specifies the configurations for streaming.\n
\nTo use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
\n Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an \n action group to return control, results from invocation of the action group. For more information, see Control session context.\n
\nIf you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see Control session context.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
\n List of collaborator inline agents.\n
" + "smithy.api#documentation": "List of collaborator inline agents.
" } }, "bedrockModelConfigurations": { @@ -6323,6 +6362,18 @@ "traits": { "smithy.api#documentation": "Model settings for the request.
" } + }, + "orchestrationType": { + "target": "com.amazonaws.bedrockagentruntime#OrchestrationType", + "traits": { + "smithy.api#documentation": "Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
" + } + }, + "customOrchestration": { + "target": "com.amazonaws.bedrockagentruntime#CustomOrchestration", + "traits": { + "smithy.api#documentation": "Contains details of the custom orchestration configured for the agent.
" + } } }, "traits": { @@ -6335,7 +6386,7 @@ "completion": { "target": "com.amazonaws.bedrockagentruntime#InlineAgentResponseStream", "traits": { - "smithy.api#documentation": "\n \n
", + "smithy.api#documentation": "The inline agent's response to the user prompt.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -6343,7 +6394,7 @@ "contentType": { "target": "com.amazonaws.bedrockagentruntime#MimeType", "traits": { - "smithy.api#documentation": "\n The MIME type of the input data in the request. The default value is application/json.\n
", + "smithy.api#documentation": "The MIME type of the input data in the request. The default value is application/json.
", "smithy.api#httpHeader": "x-amzn-bedrock-agent-content-type", "smithy.api#required": {} } @@ -6351,7 +6402,7 @@ "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { - "smithy.api#documentation": "\n The unique identifier of the session with the agent.\n
", + "smithy.api#documentation": "The unique identifier of the session with the agent.
", "smithy.api#httpHeader": "x-amz-bedrock-agent-session-id", "smithy.api#required": {} } @@ -6377,26 +6428,26 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseId", "traits": { - "smithy.api#documentation": "\n The unique identifier for a knowledge base associated with the inline agent.\n
", + "smithy.api#documentation": "The unique identifier for a knowledge base associated with the inline agent.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagentruntime#ResourceDescription", "traits": { - "smithy.api#documentation": "\n The description of the knowledge base associated with the inline agent.\n
", + "smithy.api#documentation": "The description of the knowledge base associated with the inline agent.
", "smithy.api#required": {} } }, "retrievalConfiguration": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", "traits": { - "smithy.api#documentation": "\n The configurations to apply to the knowledge base during query. For more information, see Query configurations.\n
" + "smithy.api#documentation": "The configurations to apply to the knowledge base during query. For more information, see Query configurations.
" } } }, "traits": { - "smithy.api#documentation": "\n Details of the knowledge base associated withe inline agent.\n
" + "smithy.api#documentation": "Details of the knowledge base associated withe inline agent.
" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseArn": { @@ -6505,7 +6556,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the query made to the knowledge base.
\nThis data type is used in the following API operations:
\n\n Retrieve request \u2013 in the retrievalQuery field
Contains the query made to the knowledge base.
This data type is used in the following API operations:
Retrieve request \u2013 in the retrievalQuery field
Contains configurations for knowledge base query. For more information, see Query configurations.
\nThis data type is used in the following API operations:
\n\n Retrieve request \u2013 in the retrievalConfiguration field
\n RetrieveAndGenerate request \u2013 in the retrievalConfiguration field
Contains configurations for knowledge base query. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request \u2013 in the retrievalConfiguration field
RetrieveAndGenerate request \u2013 in the retrievalConfiguration field
Details about a result from querying the knowledge base.
\nThis data type is used in the following API operations:
\n\n Retrieve response \u2013 in the retrievalResults field
Details about a result from querying the knowledge base.
This data type is used in the following API operations:
Retrieve response \u2013 in the retrievalResults field
Contains details about the resource being queried.
\nThis data type is used in the following API operations:
\n\n Retrieve request \u2013 in the knowledgeBaseConfiguration field
\n RetrieveAndGenerate request \u2013 in the knowledgeBaseConfiguration field
Contains details about the resource being queried.
This data type is used in the following API operations:
Retrieve request \u2013 in the knowledgeBaseConfiguration field
RetrieveAndGenerate request \u2013 in the knowledgeBaseConfiguration field
Configurations for how to perform the search query and return results. For more information, see Query configurations.
\nThis data type is used in the following API operations:
\n\n Retrieve request \u2013 in the vectorSearchConfiguration field
\n RetrieveAndGenerate request \u2013 in the vectorSearchConfiguration field
Configurations for how to perform the search query and return results. For more information, see Query configurations.
This data type is used in the following API operations:
Retrieve request \u2013 in the vectorSearchConfiguration field
RetrieveAndGenerate request \u2013 in the vectorSearchConfiguration field
If the total number of results is greater than the maxResults value provided in the request, enter the\n token returned in the nextToken field in the response in this field to return the next batch of results.\n
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value,\n use the token returned in the response in the nextToken field when making another request to return the next\n batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the\n token returned in the nextToken field in the response in this field to return the next batch of results.\n
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value,\n use the token returned in the response in the nextToken field when making another request to return the next\n batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value,\n use the token returned in the response in the nextToken field when making another request to return the next\n batch of results.
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
If the total number of results is greater than the maxResults value provided in the request, enter the\n token returned in the nextToken field in the response in this field to return the next batch of results.\n
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
The input for the pre-processing step.
\nThe type matches the agent step.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The input for the pre-processing step.
The type matches the agent step.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
\n The model specified in the request is not ready to serve inference requests. The AWS SDK\n will automatically retry the operation up to 5 times. For information about configuring\n automatic retries, see Retry behavior in the AWS SDKs and Tools\n reference guide.\n
", + "smithy.api#documentation": "The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.
", "smithy.api#error": "client", "smithy.api#httpError": 424 } @@ -7438,7 +7489,7 @@ "type": { "target": "com.amazonaws.bedrockagentruntime#Type", "traits": { - "smithy.api#documentation": "Specifies what kind of information the agent returns in the observation. The following values are possible.
\n\n ACTION_GROUP \u2013 The agent returns the result of an action group.
\n KNOWLEDGE_BASE \u2013 The agent returns information from a knowledge base.
\n FINISH \u2013 The agent returns a final response to the user with no follow-up.
\n ASK_USER \u2013 The agent asks the user a question.
\n REPROMPT \u2013 The agent prompts the user again for the same information.
Specifies what kind of information the agent returns in the observation. The following values are possible.
ACTION_GROUP \u2013 The agent returns the result of an action group.
KNOWLEDGE_BASE \u2013 The agent returns information from a knowledge base.
FINISH \u2013 The agent returns a final response to the user with no follow-up.
ASK_USER \u2013 The agent asks the user a question.
REPROMPT \u2013 The agent prompts the user again for the same information.
To split up the prompt and retrieve multiple sources, set the transformation type to\n QUERY_DECOMPOSITION.
To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
Settings for how the model processes the prompt prior to retrieval and generation.
" } }, + "com.amazonaws.bedrockagentruntime#OrchestrationExecutor": { + "type": "union", + "members": { + "lambda": { + "target": "com.amazonaws.bedrockagentruntime#LambdaArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structure of the executor invoking the actions in custom orchestration.
" + } + }, "com.amazonaws.bedrockagentruntime#OrchestrationModelInvocationOutput": { "type": "structure", "members": { @@ -7752,7 +7817,7 @@ "modelInvocationInput": { "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", "traits": { - "smithy.api#documentation": "The input for the orchestration step.
\nThe type is ORCHESTRATION.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The input for the orchestration step.
The type is ORCHESTRATION.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
\n A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.\n
" + "smithy.api#documentation": "A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
" } }, "type": { "target": "com.amazonaws.bedrockagentruntime#ParameterType", "traits": { - "smithy.api#documentation": "\n The data type of the parameter.\n
", + "smithy.api#documentation": "The data type of the parameter.
", "smithy.api#required": {} } }, "required": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "\n Whether the parameter is required for the agent to complete the function for action group invocation.\n
" + "smithy.api#documentation": "Whether the parameter is required for the agent to complete the function for action group invocation.
" } } }, "traits": { - "smithy.api#documentation": "\n Contains details about a parameter in a function for an action group.\n
" + "smithy.api#documentation": "Contains details about a parameter in a function for an action group.
" } }, "com.amazonaws.bedrockagentruntime#ParameterList": { @@ -8039,13 +8121,13 @@ "rawResponse": { "target": "com.amazonaws.bedrockagentruntime#RawResponse", "traits": { - "smithy.api#documentation": "\n Details of the raw response from the foundation model output.\n
" + "smithy.api#documentation": "Details of the raw response from the foundation model output.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#Metadata", "traits": { - "smithy.api#documentation": "\n Contains information about the foundation model output from the post-processing step.\n
" + "smithy.api#documentation": "Contains information about the foundation model output from the post-processing step.
" } }, "reasoningContent": { @@ -8081,7 +8163,7 @@ "modelInvocationInput": { "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", "traits": { - "smithy.api#documentation": "The input for the post-processing step.
\nThe type is POST_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The input for the post-processing step.
The type is POST_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
\n Details of the raw response from the foundation model output.\n
" + "smithy.api#documentation": "Details of the raw response from the foundation model output.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#Metadata", "traits": { - "smithy.api#documentation": "\n Contains information about the foundation model output from the pre-processing step.\n
" + "smithy.api#documentation": "Contains information about the foundation model output from the pre-processing step.
" } }, "reasoningContent": { @@ -8162,7 +8244,7 @@ "modelInvocationInput": { "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", "traits": { - "smithy.api#documentation": "The input for the pre-processing step.
\nThe type is PRE_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
The input for the pre-processing step.
The type is PRE_PROCESSING.
The text contains the prompt.
The inferenceConfiguration, parserMode, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
\n The step in the agent sequence that this prompt configuration applies to.\n
" + "smithy.api#documentation": "The step in the agent sequence that this prompt configuration applies to.
" } }, "promptCreationMode": { @@ -8195,7 +8277,7 @@ "promptState": { "target": "com.amazonaws.bedrockagentruntime#PromptState", "traits": { - "smithy.api#documentation": "Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
\n PRE_PROCESSING \u2013 ENABLED\n
\n ORCHESTRATION \u2013 ENABLED\n
\n KNOWLEDGE_BASE_RESPONSE_GENERATION \u2013 ENABLED\n
\n POST_PROCESSING \u2013 DISABLED\n
Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
PRE_PROCESSING \u2013 ENABLED
ORCHESTRATION \u2013 ENABLED
KNOWLEDGE_BASE_RESPONSE_GENERATION \u2013 ENABLED
POST_PROCESSING \u2013 DISABLED
\n The foundation model to use.\n
" + "smithy.api#documentation": "The foundation model to use.
" } }, "additionalModelRequestFields": { "target": "smithy.api#Document", "traits": { - "smithy.api#documentation": "If the Converse or ConverseStream operations support the model,\n additionalModelRequestFields contains additional inference parameters,\n beyond the base set of inference parameters in the inferenceConfiguration\n field.
For more information, see Inference request parameters and\n response fields for foundation models in the Amazon Bedrock user\n guide.
" + "smithy.api#documentation": "If the Converse or ConverseStream operations support the model, additionalModelRequestFields contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration field.
For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.
" } } }, "traits": { - "smithy.api#documentation": "\n Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.\n
" + "smithy.api#documentation": "Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" } }, "com.amazonaws.bedrockagentruntime#PromptConfigurations": { @@ -8257,7 +8339,7 @@ "overrideLambda": { "target": "com.amazonaws.bedrockagentruntime#LambdaResourceArn", "traits": { - "smithy.api#documentation": "The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. \n If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is \n set to OVERRIDDEN. For more information, see Parser Lambda function in Amazon Bedrock Agents.\n
The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN. For more information, see Parser Lambda function in Amazon Bedrock Agents.
The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.
\nFor more information, see the following resources:
\nThe template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.
For more information, see the following resources:
" } } }, "traits": { - "smithy.api#documentation": "Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates.
\nThis data type is used in the following API operations:
\n\n RetrieveAndGenerate request \u2013 in the filter field
Contains the template for the prompt that's sent to the model for response generation. For more information, see Knowledge base prompt templates.
This data type is used in the following API operations:
RetrieveAndGenerate request \u2013 in the filter field
Add an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each interaction. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
\nRelated APIs:
\n\n GetInvocationStep\n
\n\n ListInvocationSteps\n
\n\n ListInvocations\n
\n\n ListSessions\n
\nAdd an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each interaction. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Related APIs:
", "smithy.api#http": { "code": 201, "method": "PUT", @@ -8499,7 +8581,7 @@ } }, "traits": { - "smithy.api#documentation": "To split up the prompt and retrieve multiple sources, set the transformation type to\n QUERY_DECOMPOSITION.
To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
Contains information about the reasoning that the model used to return the content in\n the content block.
" + "smithy.api#documentation": "Contains information about the reasoning that the model used to return the content in the content block.
" } }, "redactedContent": { @@ -8601,7 +8683,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains content regarding the reasoning that the foundation model made with respect\n to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that\n the model generates to enhance the accuracy of its final response.
", + "smithy.api#documentation": "Contains content regarding the reasoning that the foundation model made with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.
", "smithy.api#sensitive": {} } }, @@ -8618,7 +8700,7 @@ "signature": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "A hash of all the messages in the conversation to ensure that the content in the\n reasoning text block isn't tampered with. You must submit the signature in subsequent\n Converse requests, in addition to the previous messages. If the\n previous messages are tampered with, the response throws an error.
A hash of all the messages in the conversation to ensure that the content in the reasoning text block isn't tampered with. You must submit the signature in subsequent Converse requests, in addition to the previous messages. If the previous messages are tampered with, the response throws an error.
\n The model specified in the request is not ready to serve Inference requests. The AWS SDK\n will automatically retry the operation up to 5 times. For information about configuring\n automatic retries, see Retry behavior in the AWS SDKs and Tools\n reference guide.\n
" + "smithy.api#documentation": "The model specified in the request is not ready to serve Inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see Retry behavior in the AWS SDKs and Tools reference guide.
" } }, "files": { @@ -9233,67 +9315,67 @@ "equals": { "target": "com.amazonaws.bedrockagentruntime#FilterAttribute", "traits": { - "smithy.api#documentation": "Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.
The following example would return data sources with an animal attribute whose value is cat:
\n \"equals\": { \"key\": \"animal\", \"value\": \"cat\" }\n
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.
The following example would return data sources with an animal attribute whose value is cat:
\"equals\": { \"key\": \"animal\", \"value\": \"cat\" }
Knowledge base data sources are returned when:
\nIt contains a metadata attribute whose name matches the key and whose value doesn't match the value\n in this object.
The key is not present in the document.
\nThe following example would return data sources that don't contain an animal attribute whose value is cat.
\n \"notEquals\": { \"key\": \"animal\", \"value\": \"cat\" }\n
Knowledge base data sources are returned when:
It contains a metadata attribute whose name matches the key and whose value doesn't match the value in this object.
The key is not present in the document.
The following example would return data sources that don't contain an animal attribute whose value is cat.
\"notEquals\": { \"key\": \"animal\", \"value\": \"cat\" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.
The following example would return data sources with an year attribute whose value is greater than 1989:
\n \"greaterThan\": { \"key\": \"year\", \"value\": 1989 }\n
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.
The following example would return data sources with an year attribute whose value is greater than 1989:
\"greaterThan\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is greater than or equal to 1989:
\n \"greaterThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }\n
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is greater than or equal to 1989:
\"greaterThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.
The following example would return data sources with an year attribute whose value is less than to 1989.
\n \"lessThan\": { \"key\": \"year\", \"value\": 1989 }\n
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.
The following example would return data sources with an year attribute whose value is less than to 1989.
\"lessThan\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is less than or equal to 1989.
\n \"lessThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }\n
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is less than or equal to 1989.
\"lessThanOrEquals\": { \"key\": \"year\", \"value\": 1989 }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.
The following example would return data sources with an animal attribute that is either cat or dog:
\n \"in\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }\n
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.
The following example would return data sources with an animal attribute that is either cat or dog:
\"in\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object.
The following example would return data sources whose animal attribute is neither cat nor dog.
\n \"notIn\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }\n
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object.
The following example would return data sources whose animal attribute is neither cat nor dog.
\"notIn\": { \"key\": \"animal\", \"value\": [\"cat\", \"dog\"] }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
The following example would return data sources with an animal attribute starts with ca (for example, cat or camel).
\n \"startsWith\": { \"key\": \"animal\", \"value\": \"ca\" }\n
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
The following example would return data sources with an animal attribute starts with ca (for example, cat or camel).
\"startsWith\": { \"key\": \"animal\", \"value\": \"ca\" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.
The following example would return data sources with an animals attribute that is a list containing a cat member (for example [\"dog\", \"cat\"]).
\n \"listContains\": { \"key\": \"animals\", \"value\": \"cat\" }\n
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.
The following example would return data sources with an animals attribute that is a list containing a cat member (for example [\"dog\", \"cat\"]).
\"listContains\": { \"key\": \"animals\", \"value\": \"cat\" }
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:
A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example cat).
\n \"stringContains\": { \"key\": \"animal\", \"value\": \"at\" }\n
A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example [\"dog\", \"cat\"]).
\n \"stringContains\": { \"key\": \"animals\", \"value\": \"at\" }\n
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:
A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example cat).
\"stringContains\": { \"key\": \"animal\", \"value\": \"at\" }
A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example [\"dog\", \"cat\"]).
\"stringContains\": { \"key\": \"animals\", \"value\": \"at\" }
Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations. See the examples below to see how to use these filters.
\nThis data type is used in the following API operations:
\n\n Retrieve request \u2013 in the filter field
\n RetrieveAndGenerate request \u2013 in the filter field
Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations. See the examples below to see how to use these filters.
This data type is used in the following API operations:
Retrieve request \u2013 in the filter field
RetrieveAndGenerate request \u2013 in the filter field
Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.
\nThis data type is used in the following API operations:
\n\n Retrieve response \u2013 in the content field
\n RetrieveAndGenerate response \u2013 in the content field
\n InvokeAgent response \u2013 in the content field
Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.
This data type is used in the following API operations:
Retrieve response \u2013 in the content field
RetrieveAndGenerate response \u2013 in the content field
InvokeAgent response \u2013 in the content field
Contains information about the data source location.
\nThis data type is used in the following API operations:
\n\n Retrieve response \u2013 in the location field
\n RetrieveAndGenerate response \u2013 in the location field
\n InvokeAgent response \u2013 in the location field
Contains information about the data source location.
This data type is used in the following API operations:
Retrieve response \u2013 in the location field
RetrieveAndGenerate response \u2013 in the location field
InvokeAgent response \u2013 in the location field
The S3 data source location.
\nThis data type is used in the following API operations:
\n\n Retrieve response \u2013 in the s3Location field
\n RetrieveAndGenerate response \u2013 in the s3Location field
\n InvokeAgent response \u2013 in the s3Location field
The S3 data source location.
This data type is used in the following API operations:
Retrieve response \u2013 in the s3Location field
RetrieveAndGenerate response \u2013 in the s3Location field
InvokeAgent response \u2013 in the s3Location field
The type of resource that contains your data for retrieving information and generating responses.
\nIf you choose to use EXTERNAL_SOURCES, then currently only Anthropic Claude 3 Sonnet models for knowledge bases are supported.
The type of resource that contains your data for retrieving information and generating responses.
If you choose to use EXTERNAL_SOURCES, then currently only Anthropic Claude 3 Sonnet models for knowledge bases are supported.
Contains details about the resource being queried.
\nThis data type is used in the following API operations:
\n\n RetrieveAndGenerate request \u2013 in the retrieveAndGenerateConfiguration field
Contains details about the resource being queried.
This data type is used in the following API operations:
RetrieveAndGenerate request \u2013 in the retrieveAndGenerateConfiguration field
Contains the query made to the knowledge base.
\nThis data type is used in the following API operations:
\n\n RetrieveAndGenerate request \u2013 in the input field
Contains the query made to the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate request \u2013 in the input field
Contains the response generated from querying the knowledge base.
\nThis data type is used in the following API operations:
\n\n RetrieveAndGenerate response \u2013 in the output field
Contains the response generated from querying the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate response \u2013 in the output field
Contains configuration about the session with the knowledge base.
\nThis data type is used in the following API operations:
\n\n RetrieveAndGenerate request \u2013 in the sessionConfiguration field
Contains configuration about the session with the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate request \u2013 in the sessionConfiguration field
Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.
\nThe CLI doesn't support streaming operations in Amazon Bedrock, including InvokeModelWithResponseStream.
This operation requires permission for the bedrock:RetrieveAndGenerate action.
Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.
The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeModelWithResponseStream.
This operation requires permission for the bedrock:RetrieveAndGenerate action.
The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, \n see ValidationError in the Amazon Bedrock User Guide.
" + "smithy.api#documentation": "The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide.
" } }, "resourceNotFoundException": { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", "traits": { - "smithy.api#documentation": "The specified resource ARN was not found. For troubleshooting this error, \n see ResourceNotFound in the Amazon Bedrock User Guide.
" + "smithy.api#documentation": "The specified resource ARN was not found. For troubleshooting this error, see ResourceNotFound in the Amazon Bedrock User Guide.
" } }, "serviceQuotaExceededException": { @@ -10141,13 +10223,13 @@ "throttlingException": { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", "traits": { - "smithy.api#documentation": "Your request was denied due to exceeding the account quotas for Amazon Bedrock. For\n troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide.
" + "smithy.api#documentation": "Your request was denied due to exceeding the account quotas for Amazon Bedrock. For troubleshooting this error, see ThrottlingException in the Amazon Bedrock User Guide.
" } }, "accessDeniedException": { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", "traits": { - "smithy.api#documentation": "The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, \n see AccessDeniedException in the Amazon Bedrock User Guide.
" + "smithy.api#documentation": "The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see AccessDeniedException in the Amazon Bedrock User Guide.
" } }, "conflictException": { @@ -10290,7 +10372,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains metadata about a source cited for the generated response.
\nThis data type is used in the following API operations:
\n\n RetrieveAndGenerate response \u2013 in the retrievedReferences field
\n InvokeAgent response \u2013 in the retrievedReferences field
Contains metadata about a source cited for the generated response.
This data type is used in the following API operations:
RetrieveAndGenerate response \u2013 in the retrievedReferences field
InvokeAgent response \u2013 in the retrievedReferences field
Contains information to return from the action group that the agent has predicted to invoke.
\nThis data type is used in the following API operations:
\n\n InvokeAgent response\n
\nContains information to return from the action group that the agent has predicted to invoke.
This data type is used in the following API operations:
", "smithy.api#sensitive": {} } }, @@ -10428,18 +10510,18 @@ "s3BucketName": { "target": "com.amazonaws.bedrockagentruntime#S3BucketName", "traits": { - "smithy.api#documentation": "\n The name of the S3 bucket.\n
" + "smithy.api#documentation": "The name of the S3 bucket.
" } }, "s3ObjectKey": { "target": "com.amazonaws.bedrockagentruntime#S3ObjectKey", "traits": { - "smithy.api#documentation": "\n The S3 object key for the S3 resource.\n
" + "smithy.api#documentation": "The S3 object key for the S3 resource.
" } } }, "traits": { - "smithy.api#documentation": "\n The identifier information for an Amazon S3 bucket.\n
" + "smithy.api#documentation": "The identifier information for an Amazon S3 bucket.
" } }, "com.amazonaws.bedrockagentruntime#S3Location": { @@ -10649,13 +10731,13 @@ "promptSessionAttributes": { "target": "com.amazonaws.bedrockagentruntime#PromptSessionAttributesMap", "traits": { - "smithy.api#documentation": "Contains attributes that persist across a prompt and the values of those attributes.
\nIn orchestration prompt template, these attributes replace the $prompt_session_attributes$ placeholder variable. For more information, see Prompt template placeholder variables.
\nIn multi-agent collaboration, the promptSessionAttributes will only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.
Contains attributes that persist across a prompt and the values of those attributes.
In orchestration prompt template, these attributes replace the $prompt_session_attributes$ placeholder variable. For more information, see Prompt template placeholder variables.
In multi-agent collaboration, the promptSessionAttributes will only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.
Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.
\nIf you include this field, the inputText field will be ignored.
Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.
If you include this field, the inputText field will be ignored.
Contains information about where the text with a citation begins and ends in the generated output.
\nThis data type is used in the following API operations:
\n\n RetrieveAndGenerate response \u2013 in the span field
\n InvokeAgent response \u2013 in the span field
Contains information about where the text with a citation begins and ends in the generated output.
This data type is used in the following API operations:
RetrieveAndGenerate response \u2013 in the span field
InvokeAgent response \u2013 in the span field
\n Specifies whether to enable streaming for the final response. This is set to false by default.\n
Specifies whether to enable streaming for the final response. This is set to false by default.
The guardrail interval to apply as response is generated. By default, the guardrail\n interval is set to 50 characters. If a larger interval is specified, the response will\n be generated in larger chunks with fewer ApplyGuardrail calls. The\n following examples show the response generated for Hello, I am an\n agent input string.
\n Example response in chunks: Interval set to 3 characters\n
\n\n 'Hel', 'lo, ','I am', ' an', ' Age', 'nt'\n
Each chunk has at least 3 characters except for the last chunk
\n\n Example response in chunks: Interval set to 20 or more characters\n
\n\n Hello, I am an Agent\n
The guardrail interval to apply as response is generated. By default, the guardrail interval is set to 50 characters. If a larger interval is specified, the response will be generated in larger chunks with fewer ApplyGuardrail calls. The following examples show the response generated for Hello, I am an agent input string.
Example response in chunks: Interval set to 3 characters
'Hel', 'lo, ','I am', ' an', ' Age', 'nt'
Each chunk has at least 3 characters except for the last chunk
Example response in chunks: Interval set to 20 or more characters
Hello, I am an Agent
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", + "smithy.api#documentation": "Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -11023,7 +11105,7 @@ "temperature": { "target": "com.amazonaws.bedrockagentruntime#Temperature", "traits": { - "smithy.api#documentation": "Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.
" + "smithy.api#documentation": "Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.
" } }, "topP": { @@ -11035,18 +11117,18 @@ "maxTokens": { "target": "com.amazonaws.bedrockagentruntime#MaxTokens", "traits": { - "smithy.api#documentation": "The maximum number of tokens to generate in the output text. Do not use the minimum of 0\n or the maximum of 65536. The limit values described here are arbitary values, for actual\n values consult the limits defined by your specific model.
" + "smithy.api#documentation": "The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
" } }, "stopSequences": { "target": "com.amazonaws.bedrockagentruntime#RAGStopSequences", "traits": { - "smithy.api#documentation": "A list of sequences of characters that, if generated, will cause the model to stop\n generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The\n limit values described here are arbitary values, for actual values consult the limits defined\n by your specific model.
" + "smithy.api#documentation": "A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
" } } }, "traits": { - "smithy.api#documentation": "Configuration settings for text generation using a language model via the\n RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token\n count, and stop sequences.
\nThe valid range of maxTokens depends on the accepted values for your chosen\n model's inference parameters. To see the inference parameters for your model, see Inference\n parameters for foundation models.\n
Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.
The valid range of maxTokens depends on the accepted values for your chosen model's inference parameters. To see the inference parameters for your model, see Inference parameters for foundation models.
Contains the part of the generated text that contains a citation, alongside where it begins and ends.
\nThis data type is used in the following API operations:
\n\n RetrieveAndGenerate response \u2013 in the textResponsePart field
\n InvokeAgent response \u2013 in the textResponsePart field
Contains the part of the generated text that contains a citation, alongside where it begins and ends.
This data type is used in the following API operations:
RetrieveAndGenerate response \u2013 in the textResponsePart field
InvokeAgent response \u2013 in the textResponsePart field
\n Details about the custom orchestration step in which the agent determines the order in which actions are executed. \n
" + "smithy.api#documentation": "Details about the custom orchestration step in which the agent determines the order in which actions are executed.
" } } }, @@ -11259,24 +11341,6 @@ "smithy.api#documentation": "Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see Trace enablement.
" } }, - "agentId": { - "target": "com.amazonaws.bedrockagentruntime#AgentId", - "traits": { - "smithy.api#documentation": "The unique identifier of the agent.
" - } - }, - "agentAliasId": { - "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", - "traits": { - "smithy.api#documentation": "The unique identifier of the alias of the agent.
" - } - }, - "agentVersion": { - "target": "com.amazonaws.bedrockagentruntime#AgentVersion", - "traits": { - "smithy.api#documentation": "The version of the agent.
" - } - }, "callerChain": { "target": "com.amazonaws.bedrockagentruntime#CallerChain", "traits": { @@ -11286,7 +11350,7 @@ "eventTime": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { - "smithy.api#documentation": "\n The time of the trace.\n
", + "smithy.api#documentation": "The time of the trace.
", "smithy.api#timestampFormat": "date-time" } }, @@ -11295,6 +11359,24 @@ "traits": { "smithy.api#documentation": "The part's collaborator name.
" } + }, + "agentId": { + "target": "com.amazonaws.bedrockagentruntime#AgentId", + "traits": { + "smithy.api#documentation": "The unique identifier of the agent.
" + } + }, + "agentAliasId": { + "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", + "traits": { + "smithy.api#documentation": "The unique identifier of the alias of the agent.
" + } + }, + "agentVersion": { + "target": "com.amazonaws.bedrockagentruntime#AgentVersion", + "traits": { + "smithy.api#documentation": "The version of the agent.
" + } } }, "traits": { @@ -11474,7 +11556,7 @@ "sessionMetadata": { "target": "com.amazonaws.bedrockagentruntime#SessionMetadataMap", "traits": { - "smithy.api#documentation": "A map of key-value pairs containing attributes to be persisted across the session. For example the user's ID, their language preference, \n and the type of device they are using.
" + "smithy.api#documentation": "A map of key-value pairs containing attributes to be persisted across the session. For example the user's ID, their language preference, and the type of device they are using.
" } }, "sessionIdentifier": { diff --git a/bedrock-agent/service/2023-06-05/bedrock-agent-2023-06-05.json b/models/bedrock-agent/service/2023-06-05/bedrock-agent-2023-06-05.json similarity index 99% rename from bedrock-agent/service/2023-06-05/bedrock-agent-2023-06-05.json rename to models/bedrock-agent/service/2023-06-05/bedrock-agent-2023-06-05.json index 0f351b5b..598dd92d 100644 --- a/bedrock-agent/service/2023-06-05/bedrock-agent-2023-06-05.json +++ b/models/bedrock-agent/service/2023-06-05/bedrock-agent-2023-06-05.json @@ -419,7 +419,7 @@ "parentActionGroupSignatureParams": { "target": "com.amazonaws.bedrockagent#ActionGroupSignatureParams", "traits": { - "smithy.api#documentation": "The configuration settings for a computer use action.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\nThe configuration settings for a computer use action.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\nSpecify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. \n When operating computer use functionality, we recommend taking additional security precautions,\n such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. \n For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\n\n ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and\n take screenshots.
\n ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.
\n ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.
Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. \n When operating computer use functionality, we recommend taking additional security precautions,\n such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. \n For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\n\n ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and\n take screenshots.
\n ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.
\n ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.
The configuration settings for a computer use action.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\nThe configuration settings for a computer use action.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\nContains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow.
" + "smithy.api#documentation": "Contains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow.
" } }, "lex": { @@ -7006,7 +7006,7 @@ "storage": { "target": "com.amazonaws.bedrockagent#StorageFlowNodeConfiguration", "traits": { - "smithy.api#documentation": "Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location.
" + "smithy.api#documentation": "Contains configurations for a storage node in your flow. Stores an input in an Amazon S3 location.
" } }, "agent": { @@ -7018,7 +7018,7 @@ "retrieval": { "target": "com.amazonaws.bedrockagent#RetrievalFlowNodeConfiguration", "traits": { - "smithy.api#documentation": "Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.
" + "smithy.api#documentation": "Contains configurations for a retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.
" } }, "iterator": { @@ -7032,6 +7032,12 @@ "traits": { "smithy.api#documentation": "Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.
" } + }, + "inlineCode": { + "target": "com.amazonaws.bedrockagent#InlineCodeFlowNodeConfiguration", + "traits": { + "smithy.api#documentation": "Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.
" + } } }, "traits": { @@ -7248,6 +7254,12 @@ "traits": { "smithy.api#enumValue": "Collector" } + }, + "INLINE_CODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InlineCode" + } } } }, @@ -9443,7 +9455,7 @@ "topP": { "target": "com.amazonaws.bedrockagent#TopP", "traits": { - "smithy.api#documentation": "While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.
Contains details about a data ingestion job.
" } }, + "com.amazonaws.bedrockagent#InlineCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.bedrockagent#InlineCodeFlowNodeConfiguration": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.bedrockagent#InlineCode", + "traits": { + "smithy.api#documentation": "The code that's executed in your inline code node. The code can access input data from previous nodes in the flow, perform operations on that data, and produce output that can be used by other nodes in your flow.
\nThe code must be valid in the programming language that you specify.
The programming language used by your inline code node.
\nThe code must be valid in the programming language that you specify. Currently, only Python 3 (Python_3) is supported.
Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.
" + } + }, "com.amazonaws.bedrockagent#InlineContent": { "type": "structure", "members": { @@ -13414,7 +13458,7 @@ "promptState": { "target": "com.amazonaws.bedrockagent#PromptState", "traits": { - "smithy.api#documentation": "Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
\n PRE_PROCESSING \u2013 ENABLED\n
\n ORCHESTRATION \u2013 ENABLED\n
\n KNOWLEDGE_BASE_RESPONSE_GENERATION \u2013 ENABLED\n
\n POST_PROCESSING \u2013 DISABLED\n
Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.
\n PRE_PROCESSING \u2013 DISABLED\n
\n ORCHESTRATION \u2013 ENABLED\n
\n KNOWLEDGE_BASE_RESPONSE_GENERATION \u2013 ENABLED\n
\n POST_PROCESSING \u2013 DISABLED\n
Update the built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. \n When operating computer use functionality, we recommend taking additional security precautions,\n such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. \n For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\n\n ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and\n take screenshots.
\n ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.
\n ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" + "smithy.api#documentation": "Update the built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.
To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.
To allow your agent to use an Anthropic computer use tool, specify one of the following values.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. \n When operating computer use functionality, we recommend taking additional security precautions,\n such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. \n For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\n\n ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and\n take screenshots.
\n ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.
\n ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.
During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
" } }, "parentActionGroupSignatureParams": { "target": "com.amazonaws.bedrockagent#ActionGroupSignatureParams", "traits": { - "smithy.api#documentation": "The configuration settings for a computer use action.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\nThe configuration settings for a computer use action.
\n\n Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.\n
\nDescribes the API operations for running inference using Amazon Bedrock models.
", "smithy.api#title": "Amazon Bedrock Runtime", "smithy.rules#endpointRuleSet": { diff --git a/bedrock/service/2023-04-20/bedrock-2023-04-20.json b/models/bedrock/service/2023-04-20/bedrock-2023-04-20.json similarity index 98% rename from bedrock/service/2023-04-20/bedrock-2023-04-20.json rename to models/bedrock/service/2023-04-20/bedrock-2023-04-20.json index 77c3cfbf..a03aac68 100644 --- a/bedrock/service/2023-04-20/bedrock-2023-04-20.json +++ b/models/bedrock/service/2023-04-20/bedrock-2023-04-20.json @@ -2749,7 +2749,7 @@ "distillationConfig": { "target": "com.amazonaws.bedrock#DistillationConfig", "traits": { - "smithy.api#documentation": "The distillation configuration for the custom model.
" + "smithy.api#documentation": "The Distillation configuration for the custom model.
" } } }, @@ -2780,6 +2780,32 @@ } } }, + "com.amazonaws.bedrock#DataProcessingDetails": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrock#JobStatusDetails", + "traits": { + "smithy.api#documentation": "The status of the data processing sub-task of the job.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the data processing sub-task of the job.
" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The latest update to the data processing sub-task of the job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "For a Distillation job, the status details for the data processing sub-task of the job.
" + } + }, "com.amazonaws.bedrock#DeleteCustomModel": { "type": "operation", "input": { @@ -5653,6 +5679,12 @@ "smithy.api#documentation": "Information about why the job failed.
" } }, + "statusDetails": { + "target": "com.amazonaws.bedrock#StatusDetails", + "traits": { + "smithy.api#documentation": "For a Distillation job, the details about the statuses of the sub-tasks of the customization job.
" + } + }, "creationTime": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { @@ -8709,6 +8741,47 @@ "smithy.api#pattern": "^[a-zA-Z0-9](-*[a-zA-Z0-9\\+\\-\\.])*$" } }, + "com.amazonaws.bedrock#JobStatusDetails": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopping" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Stopped" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotStarted" + } + } + } + }, "com.amazonaws.bedrock#KbInferenceConfig": { "type": "structure", "members": { @@ -10888,6 +10961,12 @@ "smithy.api#documentation": "Time that the customization job was last modified.
" } }, + "statusDetails": { + "target": "com.amazonaws.bedrock#StatusDetails", + "traits": { + "smithy.api#documentation": "Details about the status of the data processing sub-task of the job.
" + } + }, "creationTime": { "target": "com.amazonaws.bedrock#Timestamp", "traits": { @@ -12269,7 +12348,7 @@ } }, "traits": { - "smithy.api#documentation": "Rules for filtering invocation logs. A filter can be a mapping of a metadata\n key to a value that it should or should not equal (a base filter), or a list of base filters\n that are all applied with AND or OR logical operators
Rules for filtering invocation logs. A filter can be a mapping of a metadata\n key to a value that it should or should not equal (a base filter), or a list of base filters\n that are all applied with AND or OR logical operators
The status details for the validation sub-task of the job.
" + } + }, + "dataProcessingDetails": { + "target": "com.amazonaws.bedrock#DataProcessingDetails", + "traits": { + "smithy.api#documentation": "The status details for the data processing sub-task of the job.
" + } + }, + "trainingDetails": { + "target": "com.amazonaws.bedrock#TrainingDetails", + "traits": { + "smithy.api#documentation": "The status details for the training sub-task of the job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "For a Distillation job, the status details for sub-tasks of the job. Possible statuses for each sub-task include the following:
\nNotStarted
\nInProgress
\nCompleted
\nStopping
\nStopped
\nFailed
\nS3 Location of the training data.
" } }, + "com.amazonaws.bedrock#TrainingDetails": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrock#JobStatusDetails", + "traits": { + "smithy.api#documentation": "The status of the training sub-task of the job.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the training sub-task of the job.
" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The latest update to the training sub-task of the job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "For a Distillation job, the status details for the training sub-task of the job.
" + } + }, "com.amazonaws.bedrock#TrainingMetrics": { "type": "structure", "members": { @@ -13705,6 +13836,32 @@ "smithy.api#documentation": "Array of up to 10 validators.
" } }, + "com.amazonaws.bedrock#ValidationDetails": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.bedrock#JobStatusDetails", + "traits": { + "smithy.api#documentation": "The status of the validation sub-task of the job.
" + } + }, + "creationTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the validation sub-task of the job.
" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.bedrock#Timestamp", + "traits": { + "smithy.api#documentation": "The latest update to the validation sub-task of the job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "For a Distillation job, the status details for the validation sub-task of the job.
" + } + }, "com.amazonaws.bedrock#ValidationException": { "type": "structure", "members": { diff --git a/billing/service/2023-09-07/billing-2023-09-07.json b/models/billing/service/2023-09-07/billing-2023-09-07.json similarity index 100% rename from billing/service/2023-09-07/billing-2023-09-07.json rename to models/billing/service/2023-09-07/billing-2023-09-07.json diff --git a/billingconductor/service/2021-07-30/billingconductor-2021-07-30.json b/models/billingconductor/service/2021-07-30/billingconductor-2021-07-30.json similarity index 100% rename from billingconductor/service/2021-07-30/billingconductor-2021-07-30.json rename to models/billingconductor/service/2021-07-30/billingconductor-2021-07-30.json diff --git a/braket/service/2019-09-01/braket-2019-09-01.json b/models/braket/service/2019-09-01/braket-2019-09-01.json similarity index 100% rename from braket/service/2019-09-01/braket-2019-09-01.json rename to models/braket/service/2019-09-01/braket-2019-09-01.json diff --git a/budgets/service/2016-10-20/budgets-2016-10-20.json b/models/budgets/service/2016-10-20/budgets-2016-10-20.json similarity index 100% rename from budgets/service/2016-10-20/budgets-2016-10-20.json rename to models/budgets/service/2016-10-20/budgets-2016-10-20.json diff --git a/chatbot/service/2017-10-11/chatbot-2017-10-11.json b/models/chatbot/service/2017-10-11/chatbot-2017-10-11.json similarity index 100% rename from chatbot/service/2017-10-11/chatbot-2017-10-11.json rename to models/chatbot/service/2017-10-11/chatbot-2017-10-11.json diff --git a/chime-sdk-identity/service/2021-04-20/chime-sdk-identity-2021-04-20.json b/models/chime-sdk-identity/service/2021-04-20/chime-sdk-identity-2021-04-20.json similarity index 100% rename from chime-sdk-identity/service/2021-04-20/chime-sdk-identity-2021-04-20.json rename to models/chime-sdk-identity/service/2021-04-20/chime-sdk-identity-2021-04-20.json diff --git a/chime-sdk-media-pipelines/service/2021-07-15/chime-sdk-media-pipelines-2021-07-15.json b/models/chime-sdk-media-pipelines/service/2021-07-15/chime-sdk-media-pipelines-2021-07-15.json similarity index 100% rename from chime-sdk-media-pipelines/service/2021-07-15/chime-sdk-media-pipelines-2021-07-15.json rename to models/chime-sdk-media-pipelines/service/2021-07-15/chime-sdk-media-pipelines-2021-07-15.json diff --git a/chime-sdk-meetings/service/2021-07-15/chime-sdk-meetings-2021-07-15.json b/models/chime-sdk-meetings/service/2021-07-15/chime-sdk-meetings-2021-07-15.json similarity index 100% rename from chime-sdk-meetings/service/2021-07-15/chime-sdk-meetings-2021-07-15.json rename to models/chime-sdk-meetings/service/2021-07-15/chime-sdk-meetings-2021-07-15.json diff --git a/chime-sdk-messaging/service/2021-05-15/chime-sdk-messaging-2021-05-15.json b/models/chime-sdk-messaging/service/2021-05-15/chime-sdk-messaging-2021-05-15.json similarity index 100% rename from chime-sdk-messaging/service/2021-05-15/chime-sdk-messaging-2021-05-15.json rename to models/chime-sdk-messaging/service/2021-05-15/chime-sdk-messaging-2021-05-15.json diff --git a/chime-sdk-voice/service/2022-08-03/chime-sdk-voice-2022-08-03.json b/models/chime-sdk-voice/service/2022-08-03/chime-sdk-voice-2022-08-03.json similarity index 100% rename from chime-sdk-voice/service/2022-08-03/chime-sdk-voice-2022-08-03.json rename to models/chime-sdk-voice/service/2022-08-03/chime-sdk-voice-2022-08-03.json diff --git a/chime/service/2018-05-01/chime-2018-05-01.json b/models/chime/service/2018-05-01/chime-2018-05-01.json similarity index 100% rename from chime/service/2018-05-01/chime-2018-05-01.json rename to models/chime/service/2018-05-01/chime-2018-05-01.json diff --git a/cleanrooms/service/2022-02-17/cleanrooms-2022-02-17.json b/models/cleanrooms/service/2022-02-17/cleanrooms-2022-02-17.json similarity index 94% rename from cleanrooms/service/2022-02-17/cleanrooms-2022-02-17.json rename to models/cleanrooms/service/2022-02-17/cleanrooms-2022-02-17.json index 61add062..35524ca9 100644 --- a/cleanrooms/service/2022-02-17/cleanrooms-2022-02-17.json +++ b/models/cleanrooms/service/2022-02-17/cleanrooms-2022-02-17.json @@ -76,7 +76,7 @@ ], "maxAge": 86400 }, - "smithy.api#documentation": "Welcome to the Clean Rooms API Reference.
\nClean Rooms is an Amazon Web Services service that helps multiple parties to join\n their data together in a secure collaboration workspace. In the collaboration, members who\n can run queries and jobs and receive results can get insights into the collective datasets without either\n party getting access to the other party's raw data.
\nTo learn more about Clean Rooms concepts, procedures, and best practices, see the\n Clean Rooms User Guide.
\nTo learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the\n Clean Rooms SQL Reference.
", + "smithy.api#documentation": "Welcome to the Clean Rooms API Reference.
Clean Rooms is an Amazon Web Services service that helps multiple parties to join their data together in a secure collaboration workspace. In the collaboration, members who can run queries and jobs and receive results can get insights into the collective datasets without either party getting access to the other party's raw data.
To learn more about Clean Rooms concepts, procedures, and best practices, see the Clean Rooms User Guide.
To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the Clean Rooms SQL Reference.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -885,14 +885,14 @@ "columnName": { "target": "com.amazonaws.cleanrooms#AnalysisRuleColumnName", "traits": { - "smithy.api#documentation": "Column in aggregation constraint for which there must be a minimum number of distinct\n values in an output row for it to be in the query output.
", + "smithy.api#documentation": "Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.
", "smithy.api#required": {} } }, "minimum": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The minimum number of distinct values that an output row must be an aggregation of.\n Minimum threshold of distinct values for a specified column that must exist in an output\n row for it to be in the query output.
", + "smithy.api#documentation": "The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.
", "smithy.api#range": { "min": 2, "max": 100000 @@ -903,13 +903,13 @@ "type": { "target": "com.amazonaws.cleanrooms#AggregationType", "traits": { - "smithy.api#documentation": "The type of aggregation the constraint allows. The only valid value is currently\n `COUNT_DISTINCT`.
", + "smithy.api#documentation": "The type of aggregation the constraint allows. The only valid value is currently `COUNT_DISTINCT`.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Constraint on query output removing output rows that do not meet a minimum number of\n distinct values of a specified column.
" + "smithy.api#documentation": "Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.
" } }, "com.amazonaws.cleanrooms#AggregationConstraints": { @@ -965,8 +965,7 @@ }, "traits": { "smithy.api#length": { - "min": 1, - "max": 225 + "min": 1 } } }, @@ -1022,7 +1021,7 @@ "name": { "target": "com.amazonaws.cleanrooms#ParameterName", "traits": { - "smithy.api#documentation": "The name of the parameter. The name must use only alphanumeric, underscore (_), or\n hyphen (-) characters but cannot start or end with a hyphen.
", + "smithy.api#documentation": "The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.
", "smithy.api#required": {} } }, @@ -1036,12 +1035,12 @@ "defaultValue": { "target": "com.amazonaws.cleanrooms#ParameterValue", "traits": { - "smithy.api#documentation": "Optional. The default value that is applied in the analysis template. The member who can\n query can override this value in the query editor.
" + "smithy.api#documentation": "Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.
" } } }, "traits": { - "smithy.api#documentation": "Optional. The member who can query can provide this placeholder for a literal data value\n in an analysis template.
", + "smithy.api#documentation": "Optional. The member who can query can provide this placeholder for a literal data value in an analysis template.
", "smithy.api#sensitive": {} } }, @@ -1132,20 +1131,20 @@ "joinColumns": { "target": "com.amazonaws.cleanrooms#AnalysisRuleColumnList", "traits": { - "smithy.api#documentation": "Columns in configured table that can be used in join statements and/or as aggregate\n columns. They can never be outputted directly.
", + "smithy.api#documentation": "Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.
", "smithy.api#required": {} } }, "joinRequired": { "target": "com.amazonaws.cleanrooms#JoinRequiredOption", "traits": { - "smithy.api#documentation": "Control that requires member who runs query to do a join with their configured table\n and/or other configured table in query.
" + "smithy.api#documentation": "Control that requires member who runs query to do a join with their configured table and/or other configured table in query.
" } }, "allowedJoinOperators": { "target": "com.amazonaws.cleanrooms#JoinOperatorsList", "traits": { - "smithy.api#documentation": "Which logical operators (if any) are to be used in an INNER JOIN match condition.\n Default is AND.
Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND.
Set of scalar functions that are allowed to be used on dimension columns and the output\n of aggregation of metrics.
", + "smithy.api#documentation": "Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.
", "smithy.api#required": {} } }, "outputConstraints": { "target": "com.amazonaws.cleanrooms#AggregationConstraints", "traits": { - "smithy.api#documentation": "Columns that must meet a specific threshold value (after an aggregation function is\n applied to it) for each output row to be returned.
", + "smithy.api#documentation": "Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.
", "smithy.api#required": {} } }, "additionalAnalyses": { "target": "com.amazonaws.cleanrooms#AdditionalAnalyses", "traits": { - "smithy.api#documentation": "An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
\nThe additionalAnalyses parameter is currently supported for the list\n analysis rule (AnalysisRuleList) and the custom analysis rule\n (AnalysisRuleCustom).
An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
The additionalAnalyses parameter is currently supported for the list analysis rule (AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom).
A type of analysis rule that enables query structure and specified queries that produce\n aggregate statistics.
" + "smithy.api#documentation": "A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.
" } }, "com.amazonaws.cleanrooms#AnalysisRuleColumnList": { @@ -1218,7 +1217,7 @@ "allowedAnalysisProviders": { "target": "com.amazonaws.cleanrooms#AllowedAnalysisProviderList", "traits": { - "smithy.api#documentation": "The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when\n allowedAnalyses is ANY_QUERY.
The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when allowedAnalyses is ANY_QUERY.
A type of analysis rule that enables the table owner to approve custom SQL queries on\n their configured tables. It supports differential privacy.
" + "smithy.api#documentation": "A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.
" } }, "com.amazonaws.cleanrooms#AnalysisRuleIdMappingTable": { @@ -1285,7 +1284,7 @@ "joinColumns": { "target": "com.amazonaws.cleanrooms#AnalysisRuleColumnList", "traits": { - "smithy.api#documentation": "Columns that can be used to join a configured table with the table of the member who can\n query and other members' configured tables.
", + "smithy.api#documentation": "Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.
", "smithy.api#length": { "min": 1 }, @@ -1295,7 +1294,7 @@ "allowedJoinOperators": { "target": "com.amazonaws.cleanrooms#JoinOperatorsList", "traits": { - "smithy.api#documentation": "The logical operators (if any) that are to be used in an INNER JOIN match condition.\n Default is AND.
The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is AND.
A unique identifier for the collaboration that the analysis template summary belongs to.\n Currently accepts collaboration ID.
", + "smithy.api#documentation": "A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.
", "smithy.api#required": {} } }, @@ -1855,7 +1854,7 @@ } }, "traits": { - "smithy.api#documentation": "The status details of the analysis template validation. Clean Rooms Differential Privacy uses a general-purpose query structure to support complex SQL queries and validates whether an analysis template fits that general-purpose query structure. Validation is performed when analysis templates are created and fetched. Because analysis templates are immutable by design, we recommend that you create analysis templates after you associate the configured tables with their analysis rule to your collaboration.
\nFor more information, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy.
" + "smithy.api#documentation": "The status details of the analysis template validation. Clean Rooms Differential Privacy uses a general-purpose query structure to support complex SQL queries and validates whether an analysis template fits that general-purpose query structure. Validation is performed when analysis templates are created and fetched. Because analysis templates are immutable by design, we recommend that you create analysis templates after you associate the configured tables with their analysis rule to your collaboration.
For more information, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy.
" } }, "com.amazonaws.cleanrooms#AnalysisTemplateValidationStatusDetailList": { @@ -2030,7 +2029,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to view details of multiple analysis tempaltes within a collaboration", - "smithy.api#documentation": "Retrieves multiple analysis templates within a collaboration by their Amazon Resource\n Names (ARNs).
", + "smithy.api#documentation": "Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
", "smithy.api#http": { "code": 200, "method": "POST", @@ -2065,7 +2064,7 @@ } }, "traits": { - "smithy.api#documentation": "Details of errors thrown by the call to retrieve multiple analysis templates within a\n collaboration by their identifiers.
" + "smithy.api#documentation": "Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.
" } }, "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateErrorList": { @@ -2085,7 +2084,7 @@ "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.
", + "smithy.api#documentation": "A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" @@ -2094,7 +2093,7 @@ "analysisTemplateArns": { "target": "com.amazonaws.cleanrooms#AnalysisTemplateArnList", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the analysis template within a\n collaboration.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
", "smithy.api#required": {} } } @@ -2113,7 +2112,7 @@ "errors": { "target": "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateErrorList", "traits": { - "smithy.api#documentation": "Error reasons for collaboration analysis templates that could not be retrieved. One\n error is returned for every collaboration analysis template that could not be\n retrieved.
", + "smithy.api#documentation": "Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.
", "smithy.api#required": {} } } @@ -2330,7 +2329,7 @@ "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the collaboration that the schemas belong to. Currently accepts\n collaboration ID.
", + "smithy.api#documentation": "A unique identifier for the collaboration that the schemas belong to. Currently accepts collaboration ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" @@ -2358,7 +2357,7 @@ "errors": { "target": "com.amazonaws.cleanrooms#BatchGetSchemaErrorList", "traits": { - "smithy.api#documentation": "Error reasons for schemas that could not be retrieved. One error is returned for every\n schema that could not be retrieved.
", + "smithy.api#documentation": "Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.
", "smithy.api#required": {} } } @@ -2376,7 +2375,7 @@ } }, "traits": { - "smithy.api#documentation": "Information related to the utilization of resources that have been billed \n or charged for in a given context, such as a protected job.
" + "smithy.api#documentation": "Information related to the utilization of resources that have been billed or charged for in a given context, such as a protected job.
" } }, "com.amazonaws.cleanrooms#BilledResourceUtilization": { @@ -2424,7 +2423,7 @@ "name": { "target": "com.amazonaws.cleanrooms#CollaborationName", "traits": { - "smithy.api#documentation": "A human-readable identifier provided by the collaboration owner. Display names are not\n unique.
", + "smithy.api#documentation": "A human-readable identifier provided by the collaboration owner. Display names are not unique.
", "smithy.api#required": {} } }, @@ -2437,7 +2436,7 @@ "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.
", + "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", "smithy.api#required": {} } }, @@ -2490,14 +2489,14 @@ "queryLogStatus": { "target": "com.amazonaws.cleanrooms#CollaborationQueryLogStatus", "traits": { - "smithy.api#documentation": "An indicator as to whether query logging has been enabled or disabled for the\n collaboration.
\nWhen ENABLED, Clean Rooms logs details about queries run within this\n collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is\n DISABLED.
An indicator as to whether query logging has been enabled or disabled for the collaboration.
When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
An indicator as to whether job logging has been enabled or disabled \n for the collaboration.
\nWhen ENABLED, Clean Rooms logs details about jobs run within this\n collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is\n DISABLED.
An indicator as to whether job logging has been enabled or disabled for the collaboration.
When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
The multi-party data share environment. The collaboration contains metadata about its\n purpose and participants.
" + "smithy.api#documentation": "The multi-party data share environment. The collaboration contains metadata about its purpose and participants.
" } }, "com.amazonaws.cleanrooms#CollaborationAnalysisTemplate": { @@ -2532,7 +2531,7 @@ "collaborationId": { "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.
", + "smithy.api#documentation": "A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
", "smithy.api#required": {} } }, @@ -2552,7 +2551,7 @@ "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.
", + "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", "smithy.api#required": {} } }, @@ -2644,7 +2643,7 @@ "createTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time that the summary of the analysis template in a collaboration was\n created.
", + "smithy.api#documentation": "The time that the summary of the analysis template in a collaboration was created.
", "smithy.api#required": {} } }, @@ -2665,7 +2664,7 @@ "updateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The time that the summary of the analysis template in the collaboration was last\n updated.
", + "smithy.api#documentation": "The time that the summary of the analysis template in the collaboration was last updated.
", "smithy.api#required": {} } }, @@ -2679,14 +2678,14 @@ "collaborationId": { "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.
", + "smithy.api#documentation": "A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
", "smithy.api#required": {} } }, "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.
", + "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", "smithy.api#required": {} } }, @@ -3241,7 +3240,7 @@ "autoRefresh": { "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateAutoRefresh", "traits": { - "smithy.api#documentation": "How often the privacy budget refreshes.
\nIf you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
How often the privacy budget refreshes.
If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
A human-readable identifier provided by the collaboration owner. Display names are not\n unique.
", + "smithy.api#documentation": "A human-readable identifier provided by the collaboration owner. Display names are not unique.
", "smithy.api#required": {} } }, "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.
", + "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", "smithy.api#required": {} } }, @@ -3538,7 +3537,7 @@ } }, "traits": { - "smithy.api#documentation": "A column within a schema relation, derived from the underlying\n table.
" + "smithy.api#documentation": "A column within a schema relation, derived from the underlying table.
" } }, "com.amazonaws.cleanrooms#ColumnList": { @@ -3887,7 +3886,7 @@ "tableReference": { "target": "com.amazonaws.cleanrooms#TableReference", "traits": { - "smithy.api#documentation": "The\n table\n that this configured table represents.
", + "smithy.api#documentation": "The table that this configured table represents.
", "smithy.api#required": {} } }, @@ -3908,21 +3907,21 @@ "analysisRuleTypes": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleTypeList", "traits": { - "smithy.api#documentation": "The types of analysis rules associated with this configured table. Currently, only one\n analysis rule may be associated with a configured table.
", + "smithy.api#documentation": "The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.
", "smithy.api#required": {} } }, "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "The analysis method for the configured table.
\n\n DIRECT_QUERY allows SQL queries to be run directly on this table.
\n DIRECT_JOB allows PySpark jobs to be run directly on this table.
\n MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
The analysis method for the configured table.
DIRECT_QUERY allows SQL queries to be run directly on this table.
DIRECT_JOB allows PySpark jobs to be run directly on this table.
MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
The columns within the underlying Glue table that can be utilized within\n collaborations.
", + "smithy.api#documentation": "The columns within the underlying Glue table that can be utilized within collaborations.
", "smithy.api#required": {} } }, @@ -3985,7 +3984,7 @@ } }, "traits": { - "smithy.api#documentation": "A configured table analysis rule, which limits how data for this table can be\n used.
" + "smithy.api#documentation": "A configured table analysis rule, which limits how data for this table can be used.
" } }, "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRulePolicy": { @@ -4120,7 +4119,7 @@ "name": { "target": "com.amazonaws.cleanrooms#TableAlias", "traits": { - "smithy.api#documentation": "The name of the configured table association, in lowercase. The table is identified by\n this name when running protected queries against the underlying data.
", + "smithy.api#documentation": "The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.
", "smithy.api#required": {} } }, @@ -4211,7 +4210,7 @@ } }, "traits": { - "smithy.api#documentation": "An analysis rule for a configured table association. This analysis rule specifies how\n data from the table can be used within its associated collaboration. In the console, the\n ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.
An analysis rule for a configured table association. This analysis rule specifies how data from the table can be used within its associated collaboration. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.
The list of collaboration members who are allowed to receive results of queries run\n with this configured table.
" + "smithy.api#documentation": "The list of collaboration members who are allowed to receive results of queries run with this configured table.
" } }, "allowedAdditionalAnalyses": { "target": "com.amazonaws.cleanrooms#AllowedAdditionalAnalyses", "traits": { - "smithy.api#documentation": "The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
\nThe allowedAdditionalAnalyses parameter is currently supported for the list\n analysis rule (AnalysisRuleList) and the custom analysis rule\n (AnalysisRuleCustom).
The list of resources or wildcards (ARNs) that are allowed to perform additional analysis on query output.
The allowedAdditionalAnalyses parameter is currently supported for the list analysis rule (AnalysisRuleList) and the custom analysis rule (AnalysisRuleCustom).
The list of collaboration members who are allowed to receive results of queries run\n with this configured table.
" + "smithy.api#documentation": "The list of collaboration members who are allowed to receive results of queries run with this configured table.
" } }, "allowedAdditionalAnalyses": { @@ -4260,7 +4259,7 @@ "allowedResultReceivers": { "target": "com.amazonaws.cleanrooms#AllowedResultReceivers", "traits": { - "smithy.api#documentation": "The list of collaboration members who are allowed to receive results of queries run\n with this configured table.
" + "smithy.api#documentation": "The list of collaboration members who are allowed to receive results of queries run with this configured table.
" } }, "allowedAdditionalAnalyses": { @@ -4425,7 +4424,7 @@ "membershipId": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "The unique ID for the membership that the configured table association belongs\n to.
", + "smithy.api#documentation": "The unique ID for the membership that the configured table association belongs to.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" } @@ -4433,14 +4432,14 @@ "membershipArn": { "target": "com.amazonaws.cleanrooms#MembershipArn", "traits": { - "smithy.api#documentation": "The unique ARN for the membership that the configured table association belongs\n to.
", + "smithy.api#documentation": "The unique ARN for the membership that the configured table association belongs to.
", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.cleanrooms#TableAlias", "traits": { - "smithy.api#documentation": "The name of the configured table association. The table is identified by this name when\n running Protected Queries against the underlying data.
", + "smithy.api#documentation": "The name of the configured table association. The table is identified by this name when running Protected Queries against the underlying data.
", "smithy.api#required": {} } }, @@ -4476,7 +4475,7 @@ "analysisRuleTypes": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRuleTypeList", "traits": { - "smithy.api#documentation": "The analysis rule types that are associated with the configured table \n associations in this summary.
" + "smithy.api#documentation": "The analysis rule types that are associated with the configured table associations in this summary.
" } } }, @@ -4596,7 +4595,7 @@ "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "The analysis method for the configured tables.
\n\n DIRECT_QUERY allows SQL queries to be run directly on this table.
\n DIRECT_JOB allows PySpark jobs to be run directly on this table.
\n MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
The analysis method for the configured tables.
DIRECT_QUERY allows SQL queries to be run directly on this table.
DIRECT_JOB allows PySpark jobs to be run directly on this table.
MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
The information in the analysis template. Currently supports text, the\n query text for the analysis template.
The information in the analysis template. Currently supports text, the query text for the analysis template.
An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.
" + "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" } }, "analysisParameters": { @@ -5080,32 +5079,32 @@ "dataEncryptionMetadata": { "target": "com.amazonaws.cleanrooms#DataEncryptionMetadata", "traits": { - "smithy.api#documentation": "The settings for client-side encryption with Cryptographic Computing for Clean\n Rooms.
" + "smithy.api#documentation": "The settings for client-side encryption with Cryptographic Computing for Clean Rooms.
" } }, "queryLogStatus": { "target": "com.amazonaws.cleanrooms#CollaborationQueryLogStatus", "traits": { - "smithy.api#documentation": "An indicator as to whether query logging has been enabled or disabled for the\n collaboration.
\nWhen ENABLED, Clean Rooms logs details about queries run within this\n collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is\n DISABLED.
An indicator as to whether query logging has been enabled or disabled for the collaboration.
When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
Specifies whether job logs are enabled for this collaboration.
\nWhen ENABLED, Clean Rooms logs details about jobs run within this\n collaboration; those logs can be viewed in Amazon CloudWatch Logs. The default value is\n DISABLED.
Specifies whether job logs are enabled for this collaboration.
When ENABLED, Clean Rooms logs details about jobs run within this collaboration; those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.
" + "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" } }, "creatorPaymentConfiguration": { "target": "com.amazonaws.cleanrooms#PaymentConfiguration", "traits": { - "smithy.api#documentation": "The collaboration creator's payment responsibilities set by the collaboration creator.
\nIf the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer.
" + "smithy.api#documentation": "The collaboration creator's payment responsibilities set by the collaboration creator.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
" } }, "analyticsEngine": { @@ -5175,7 +5174,7 @@ "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for one of your memberships for a collaboration. The configured\n audience model is associated to the collaboration that this membership belongs to. Accepts\n a membership ID.
", + "smithy.api#documentation": "A unique identifier for one of your memberships for a collaboration. The configured audience model is associated to the collaboration that this membership belongs to. Accepts a membership ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" @@ -5198,14 +5197,14 @@ "manageResourcePolicies": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "When TRUE, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When FALSE, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.
Setting this to TRUE requires you to have permissions to create, update, and delete the resource policy for the cleanrooms-ml resource when you call the DeleteConfiguredAudienceModelAssociation resource. In addition, if you are the collaboration creator and specify TRUE, you must have the same permissions when you call the DeleteMember and DeleteCollaboration APIs.
When TRUE, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When FALSE, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.
Setting this to TRUE requires you to have permissions to create, update, and delete the resource policy for the cleanrooms-ml resource when you call the DeleteConfiguredAudienceModelAssociation resource. In addition, if you are the collaboration creator and specify TRUE, you must have the same permissions when you call the DeleteMember and DeleteCollaboration APIs.
An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.
" + "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" } }, "description": { @@ -5309,7 +5308,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create analysis rules for configured tables", - "smithy.api#documentation": "Creates a new analysis rule for a configured table. Currently, only one analysis rule\n can be created for a given configured table.
", + "smithy.api#documentation": "Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -5324,7 +5323,7 @@ "configuredTableIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", "traits": { - "smithy.api#documentation": "The identifier for the configured table to create the analysis rule for. Currently\n accepts the configured table ID.
", + "smithy.api#documentation": "The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableId" @@ -5394,7 +5393,7 @@ "aws.iam#requiredActions": [ "iam:PassRole" ], - "smithy.api#documentation": "Creates a configured table association. A configured table association links a\n configured table with a collaboration.
", + "smithy.api#documentation": "Creates a configured table association. A configured table association links a configured table with a collaboration.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -5449,7 +5448,7 @@ "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" @@ -5458,7 +5457,7 @@ "configuredTableAssociationIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", "traits": { - "smithy.api#documentation": "The unique ID for the configured table association. Currently accepts the\n configured table association ID.
", + "smithy.api#documentation": "The unique ID for the configured table association. Currently accepts the configured table association ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" @@ -5474,7 +5473,7 @@ "analysisRulePolicy": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRulePolicy", "traits": { - "smithy.api#documentation": "The analysis rule policy that was created for the configured table\n association.
", + "smithy.api#documentation": "The analysis rule policy that was created for the configured table association.
", "smithy.api#required": {} } } @@ -5489,7 +5488,7 @@ "analysisRule": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRule", "traits": { - "smithy.api#documentation": "The analysis rule for the con\ufb01gured table association. In the console, the\n ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.
The analysis rule for the con\ufb01gured table association. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.
The name of the configured table association. This name is used to query the underlying\n configured table.
", + "smithy.api#documentation": "The name of the configured table association. This name is used to query the underlying configured table.
", "smithy.api#required": {} } }, @@ -5517,7 +5516,7 @@ "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for one of your memberships for a collaboration. The configured\n table is associated to the collaboration that this membership belongs to. Currently accepts\n a membership ID.
", + "smithy.api#documentation": "A unique identifier for one of your memberships for a collaboration. The configured table is associated to the collaboration that this membership belongs to. Currently accepts a membership ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" @@ -5526,7 +5525,7 @@ "configuredTableIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the configured table to be associated to. Currently accepts a\n configured table ID.
", + "smithy.api#documentation": "A unique identifier for the configured table to be associated to. Currently accepts a configured table ID.
", "smithy.api#required": {} } }, @@ -5540,7 +5539,7 @@ "tags": { "target": "com.amazonaws.cleanrooms#TagMap", "traits": { - "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.
" + "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" } } } @@ -5576,34 +5575,34 @@ "tableReference": { "target": "com.amazonaws.cleanrooms#TableReference", "traits": { - "smithy.api#documentation": "A reference to the\n table\n being configured.
", + "smithy.api#documentation": "A reference to the table being configured.
", "smithy.api#required": {} } }, "allowedColumns": { "target": "com.amazonaws.cleanrooms#AllowedColumnList", "traits": { - "smithy.api#documentation": "The columns of the underlying table that can be used by collaborations or analysis\n rules.
", + "smithy.api#documentation": "The columns of the underlying table that can be used by collaborations or analysis rules.
", "smithy.api#required": {} } }, "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "The analysis method allowed for the configured tables.
\n\n DIRECT_QUERY allows SQL queries to be run directly on this table.
\n DIRECT_JOB allows PySpark jobs to be run directly on this table.
\n MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
The analysis method allowed for the configured tables.
DIRECT_QUERY allows SQL queries to be run directly on this table.
DIRECT_JOB allows PySpark jobs to be run directly on this table.
MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
The analysis methods to enable for the configured table. \n When configured, you must specify at least two analysis methods.
" + "smithy.api#documentation": "The analysis methods to enable for the configured table. When configured, you must specify at least two analysis methods.
" } }, "tags": { "target": "com.amazonaws.cleanrooms#TagMap", "traits": { - "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.
" + "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" } } } @@ -5696,7 +5695,7 @@ "tags": { "target": "com.amazonaws.cleanrooms#TagMap", "traits": { - "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.
" + "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" } }, "kmsKeyArn": { @@ -5788,7 +5787,7 @@ "tags": { "target": "com.amazonaws.cleanrooms#TagMap", "traits": { - "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.
" + "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" } }, "name": { @@ -5863,7 +5862,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to join collaborations by creating a membership", - "smithy.api#documentation": "Creates a membership for a specific collaboration identifier and joins the\n collaboration.
", + "smithy.api#documentation": "Creates a membership for a specific collaboration identifier and joins the collaboration.
", "smithy.api#http": { "code": 200, "method": "POST", @@ -5884,38 +5883,38 @@ "queryLogStatus": { "target": "com.amazonaws.cleanrooms#MembershipQueryLogStatus", "traits": { - "smithy.api#documentation": "An indicator as to whether query logging has been enabled or disabled for the\n membership.
\nWhen ENABLED, Clean Rooms logs details about queries run within this\n collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is\n DISABLED.
An indicator as to whether query logging has been enabled or disabled for the membership.
When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
An indicator as to whether job logging has been enabled or disabled \n for the collaboration.
\nWhen ENABLED, Clean Rooms logs details about jobs run within this\n collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is\n DISABLED.
An indicator as to whether job logging has been enabled or disabled for the collaboration.
When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.
" + "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" } }, "defaultResultConfiguration": { "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration", "traits": { - "smithy.api#documentation": "The default protected query result configuration as specified by the member who can\n receive results.
" + "smithy.api#documentation": "The default protected query result configuration as specified by the member who can receive results.
" } }, "defaultJobResultConfiguration": { "target": "com.amazonaws.cleanrooms#MembershipProtectedJobResultConfiguration", "traits": { - "smithy.api#documentation": "The default job result configuration that determines how job results are \n protected and managed within this membership. This configuration applies to all \n jobs.
" + "smithy.api#documentation": "The default job result configuration that determines how job results are protected and managed within this membership. This configuration applies to all jobs.
" } }, "paymentConfiguration": { "target": "com.amazonaws.cleanrooms#MembershipPaymentConfiguration", "traits": { - "smithy.api#documentation": "The payment responsibilities accepted by the collaboration member.
\nNot required if the collaboration member has the member ability to run queries.
\nRequired if the collaboration member doesn't have the member ability to run queries but\n is configured as a payer by the collaboration creator.
" + "smithy.api#documentation": "The payment responsibilities accepted by the collaboration member.
Not required if the collaboration member has the member ability to run queries.
Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator.
" } } } @@ -5985,7 +5984,7 @@ "autoRefresh": { "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateAutoRefresh", "traits": { - "smithy.api#documentation": "How often the privacy budget refreshes.
\nIf you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
How often the privacy budget refreshes.
If you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.
" + "smithy.api#documentation": "An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
" } } }, @@ -6064,28 +6063,28 @@ "allowCleartext": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether encrypted tables can contain cleartext data (TRUE) or are\n to cryptographically process every column (FALSE).
Indicates whether encrypted tables can contain cleartext data (TRUE) or are to cryptographically process every column (FALSE).
Indicates whether Fingerprint columns can contain duplicate entries (TRUE)\n or are to contain only non-repeated values (FALSE).
Indicates whether Fingerprint columns can contain duplicate entries (TRUE) or are to contain only non-repeated values (FALSE).
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with\n a different name (TRUE) or can only be joined on Fingerprint columns of the\n same name (FALSE).
Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (TRUE) or can only be joined on Fingerprint columns of the same name (FALSE).
Indicates whether NULL values are to be copied as NULL to encrypted tables\n (TRUE) or cryptographically processed (FALSE).
Indicates whether NULL values are to be copied as NULL to encrypted tables (TRUE) or cryptographically processed (FALSE).
The unique identifier for the configured table that the analysis rule applies to.\n Currently accepts the configured table ID.
", + "smithy.api#documentation": "The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableId" @@ -6370,7 +6369,7 @@ "analysisRuleType": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", "traits": { - "smithy.api#documentation": "The analysis rule type to be deleted. Configured table analysis rules are uniquely\n identified by their configured table identifier and analysis rule type.
", + "smithy.api#documentation": "The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6470,7 +6469,7 @@ "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" @@ -6479,7 +6478,7 @@ "configuredTableAssociationIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", "traits": { - "smithy.api#documentation": "The identi\ufb01er for the con\ufb01gured table association that's related to the analysis rule\n that you want to delete.
", + "smithy.api#documentation": "The identi\ufb01er for the con\ufb01gured table association that's related to the analysis rule that you want to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" @@ -6511,7 +6510,7 @@ "configuredTableAssociationIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", "traits": { - "smithy.api#documentation": "The unique ID for the configured table association to be deleted. Currently accepts the\n configured table ID.
", + "smithy.api#documentation": "The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" @@ -6520,7 +6519,7 @@ "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" @@ -6721,7 +6720,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to delete members from a collaboration", - "smithy.api#documentation": "Removes the specified member from a collaboration. The removed member is placed in the\n Removed status and can't interact with the collaboration. The removed member's data is\n inaccessible to active members of the collaboration.
", + "smithy.api#documentation": "Removes the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed member's data is inaccessible to active members of the collaboration.
", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -7431,7 +7430,7 @@ "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.
", + "smithy.api#documentation": "A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" @@ -7440,7 +7439,7 @@ "analysisTemplateArn": { "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the analysis template within a\n collaboration.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "AnalysisTemplateArn" @@ -7872,7 +7871,7 @@ "configuredTableIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", "traits": { - "smithy.api#documentation": "The unique identifier for the configured table to retrieve. Currently accepts the\n configured table ID.
", + "smithy.api#documentation": "The unique identifier for the configured table to retrieve. Currently accepts the configured table ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableId" @@ -7881,7 +7880,7 @@ "analysisRuleType": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", "traits": { - "smithy.api#documentation": "The analysis rule to be retrieved. Configured table analysis rules are uniquely\n identified by their configured table identifier and analysis rule type.
", + "smithy.api#documentation": "The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7980,7 +7979,7 @@ "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" @@ -7989,7 +7988,7 @@ "configuredTableAssociationIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", "traits": { - "smithy.api#documentation": "The identi\ufb01er for the con\ufb01gured table association that's related to the analysis\n rule.
", + "smithy.api#documentation": "The identi\ufb01er for the con\ufb01gured table association that's related to the analysis rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" @@ -8014,7 +8013,7 @@ "analysisRule": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRule", "traits": { - "smithy.api#documentation": "The analysis rule for the con\ufb01gured table association. In the console, the\n ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.
The analysis rule for the con\ufb01gured table association. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.
The unique ID for the configured table association to retrieve. Currently accepts the\n configured table ID.
", + "smithy.api#documentation": "The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" @@ -8038,7 +8037,7 @@ "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" @@ -8603,7 +8602,7 @@ "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the collaboration that the schema belongs to. Currently accepts\n a collaboration ID.
", + "smithy.api#documentation": "A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" @@ -8620,7 +8619,7 @@ "type": { "target": "com.amazonaws.cleanrooms#AnalysisRuleType", "traits": { - "smithy.api#documentation": "The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely\n identified by a combination of the collaboration, the schema name, and their type.
", + "smithy.api#documentation": "The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8645,7 +8644,7 @@ "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the collaboration that the schema belongs to. Currently accepts\n a collaboration ID.
", + "smithy.api#documentation": "A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" @@ -8740,7 +8739,7 @@ "target": "smithy.api#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "An indicator as to whether you can use your column as a dimension column in the ID mapping table (TRUE) or not (FALSE).
Default is FALSE.
An indicator as to whether you can use your column as a dimension column in the ID mapping table (TRUE) or not (FALSE).
Default is FALSE.
When TRUE, Clean Rooms manages permissions for the ID mapping table resource.
When FALSE, the resource owner manages permissions for the ID mapping table resource.
When TRUE, Clean Rooms manages permissions for the ID mapping table resource.
When FALSE, the resource owner manages permissions for the ID mapping table resource.
When TRUE, Clean Rooms manages permissions for the ID namespace association resource.
When FALSE, the resource owner manages permissions for the ID namespace association resource.
When TRUE, Clean Rooms manages permissions for the ID namespace association resource.
When FALSE, the resource owner manages permissions for the ID namespace association resource.
Indicates whether the collaboration creator has configured the collaboration\n member to pay for query and job compute costs (TRUE) or has not configured the \n collaboration member to pay for query and job compute costs (FALSE).
Exactly one member can be configured to pay for query and job compute costs. An error\n is returned if the collaboration creator sets a TRUE value for more \n than one member in the collaboration.
An error is returned if the collaboration creator sets a \n FALSE value for the member who can run queries and jobs.
Indicates whether the collaboration creator has configured the collaboration member to pay for query and job compute costs (TRUE) or has not configured the collaboration member to pay for query and job compute costs (FALSE).
Exactly one member can be configured to pay for query and job compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
An error is returned if the collaboration creator sets a FALSE value for the member who can run queries and jobs.
An object representing the collaboration member's payment responsibilities \n set by the collaboration creator for query and job compute costs.
" + "smithy.api#documentation": "An object representing the collaboration member's payment responsibilities set by the collaboration creator for query and job compute costs.
" } }, "com.amazonaws.cleanrooms#JoinOperator": { @@ -9575,7 +9574,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -9644,7 +9643,7 @@ "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.
", + "smithy.api#documentation": "A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" @@ -9660,7 +9659,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -9748,7 +9747,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -9936,7 +9935,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -10031,7 +10030,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } }, @@ -10117,7 +10116,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } }, @@ -10211,7 +10210,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -10286,7 +10285,7 @@ "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the membership to list configured table associations for.\n Currently accepts the membership ID.
", + "smithy.api#documentation": "A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10301,7 +10300,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -10374,7 +10373,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -10645,7 +10644,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -10718,7 +10717,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } }, @@ -10812,7 +10811,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -10914,7 +10913,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -11016,7 +11015,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. \n The service chooses a default number if you don't set one. The service might \n return a `nextToken` even if the `maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -11116,7 +11115,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n `maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -11185,7 +11184,7 @@ "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the collaboration that the schema belongs to. Currently accepts\n a collaboration ID.
", + "smithy.api#documentation": "A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" @@ -11208,7 +11207,7 @@ "maxResults": { "target": "com.amazonaws.cleanrooms#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the \n`maxResults` value has not been met.
", + "smithy.api#documentation": "The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.
", "smithy.api#httpQuery": "maxResults" } } @@ -11264,7 +11263,7 @@ "resourceArn": { "target": "com.amazonaws.cleanrooms#CleanroomsArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the resource you want to list tags\n on.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the resource you want to list tags on.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11321,7 +11320,7 @@ } }, "traits": { - "smithy.api#documentation": "An object representing the collaboration member's machine learning payment responsibilities set by the\n collaboration creator.
" + "smithy.api#documentation": "An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
" } }, "com.amazonaws.cleanrooms#MaxResults": { @@ -11383,7 +11382,7 @@ "accountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.
", + "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", "smithy.api#required": {} } }, @@ -11410,7 +11409,7 @@ "paymentConfiguration": { "target": "com.amazonaws.cleanrooms#PaymentConfiguration", "traits": { - "smithy.api#documentation": "The collaboration member's payment responsibilities set by the collaboration creator.
\nIf the collaboration creator hasn't speci\ufb01ed anyone as the member paying for query\n compute costs, then the member who can query is the default payer.
" + "smithy.api#documentation": "The collaboration member's payment responsibilities set by the collaboration creator.
If the collaboration creator hasn't speci\ufb01ed anyone as the member paying for query compute costs, then the member who can query is the default payer.
" } } }, @@ -11447,7 +11446,7 @@ "accountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.
", + "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "AccountId" } @@ -11558,7 +11557,7 @@ "collaborationCreatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.
", + "smithy.api#documentation": "The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
", "smithy.api#required": {} } }, @@ -11613,20 +11612,20 @@ "queryLogStatus": { "target": "com.amazonaws.cleanrooms#MembershipQueryLogStatus", "traits": { - "smithy.api#documentation": "An indicator as to whether query logging has been enabled or disabled for the\n membership.
\nWhen ENABLED, Clean Rooms logs details about queries run within this\n collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is\n DISABLED.
An indicator as to whether query logging has been enabled or disabled for the membership.
When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
An indicator as to whether job logging has been enabled or disabled \n for the collaboration.
\nWhen ENABLED, Clean Rooms logs details about jobs run within this\n collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is\n DISABLED.
An indicator as to whether job logging has been enabled or disabled for the collaboration.
When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
The default protected query result configuration as specified by the member who can\n receive results.
" + "smithy.api#documentation": "The default protected query result configuration as specified by the member who can receive results.
" } }, "defaultJobResultConfiguration": { @@ -11672,13 +11671,13 @@ "isResponsible": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether the collaboration member has accepted to pay for job \n compute costs (TRUE) or has not accepted to pay for query and job compute costs\n (FALSE).
There is only one member who pays for queries and jobs.
\nAn error message is returned for the following reasons:
\nIf you set the value to FALSE but you are responsible to \n pay for query and job compute costs.
If you set the value to TRUE but you are not responsible to\n pay for query and job compute costs.
Indicates whether the collaboration member has accepted to pay for job compute costs (TRUE) or has not accepted to pay for query and job compute costs (FALSE).
There is only one member who pays for queries and jobs.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for query and job compute costs.
If you set the value to TRUE but you are not responsible to pay for query and job compute costs.
An object representing the payment responsibilities accepted by the \n collaboration member for query and job compute costs.
" + "smithy.api#documentation": "An object representing the payment responsibilities accepted by the collaboration member for query and job compute costs.
" } }, "com.amazonaws.cleanrooms#MembershipJobLogStatus": { @@ -11715,7 +11714,7 @@ } }, "traits": { - "smithy.api#documentation": "An object representing the collaboration member's machine learning payment responsibilities set by the\n collaboration creator.
" + "smithy.api#documentation": "An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
" } }, "com.amazonaws.cleanrooms#MembershipModelInferencePaymentConfig": { @@ -11724,13 +11723,13 @@ "isResponsible": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether the collaboration member has accepted to pay for model inference costs\n (TRUE) or has not accepted to pay for model inference costs\n (FALSE).
If the collaboration creator has not specified anyone to pay for model inference costs,\n then the member who can query is the default payer.
\nAn error message is returned for the following reasons:
\nIf you set the value to FALSE but you are responsible to pay for\n model inference costs.
If you set the value to TRUE but you are not responsible to pay for\n model inference costs.
Indicates whether the collaboration member has accepted to pay for model inference costs (TRUE) or has not accepted to pay for model inference costs (FALSE).
If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model inference costs.
If you set the value to TRUE but you are not responsible to pay for model inference costs.
An object representing the collaboration member's model inference payment responsibilities set by the\n collaboration creator.
" + "smithy.api#documentation": "An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator.
" } }, "com.amazonaws.cleanrooms#MembershipModelTrainingPaymentConfig": { @@ -11739,13 +11738,13 @@ "isResponsible": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether the collaboration member has accepted to pay for model training costs\n (TRUE) or has not accepted to pay for model training costs\n (FALSE).
If the collaboration creator has not specified anyone to pay for model training costs,\n then the member who can query is the default payer.
\nAn error message is returned for the following reasons:
\nIf you set the value to FALSE but you are responsible to pay for\n model training costs.
If you set the value to TRUE but you are not responsible to pay for\n model training costs.
Indicates whether the collaboration member has accepted to pay for model training costs (TRUE) or has not accepted to pay for model training costs (FALSE).
If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for model training costs.
If you set the value to TRUE but you are not responsible to pay for model training costs.
An object representing the collaboration member's model training payment responsibilities set by the\n collaboration creator.
" + "smithy.api#documentation": "An object representing the collaboration member's model training payment responsibilities set by the collaboration creator.
" } }, "com.amazonaws.cleanrooms#MembershipPaymentConfiguration": { @@ -11754,25 +11753,25 @@ "queryCompute": { "target": "com.amazonaws.cleanrooms#MembershipQueryComputePaymentConfig", "traits": { - "smithy.api#documentation": "The payment responsibilities accepted by the collaboration member for query compute\n costs.
", + "smithy.api#documentation": "The payment responsibilities accepted by the collaboration member for query compute costs.
", "smithy.api#required": {} } }, "machineLearning": { "target": "com.amazonaws.cleanrooms#MembershipMLPaymentConfig", "traits": { - "smithy.api#documentation": "The payment responsibilities accepted by the collaboration member for machine learning\n costs.
" + "smithy.api#documentation": "The payment responsibilities accepted by the collaboration member for machine learning costs.
" } }, "jobCompute": { "target": "com.amazonaws.cleanrooms#MembershipJobComputePaymentConfig", "traits": { - "smithy.api#documentation": "The payment responsibilities accepted by the collaboration member for job compute\n costs.
" + "smithy.api#documentation": "The payment responsibilities accepted by the collaboration member for job compute costs.
" } } }, "traits": { - "smithy.api#documentation": "An object representing the payment responsibilities accepted by the collaboration\n member.
" + "smithy.api#documentation": "An object representing the payment responsibilities accepted by the collaboration member.
" } }, "com.amazonaws.cleanrooms#MembershipProtectedJobOutputConfiguration": { @@ -11802,7 +11801,7 @@ "roleArn": { "target": "com.amazonaws.cleanrooms#RoleArn", "traits": { - "smithy.api#documentation": "The unique ARN for an IAM role that is used by Clean Rooms to write protected\n job results to the result location, given by the member who can receive results.
", + "smithy.api#documentation": "The unique ARN for an IAM role that is used by Clean Rooms to write protected job results to the result location, given by the member who can receive results.
", "smithy.api#required": {} } } @@ -11835,7 +11834,7 @@ "roleArn": { "target": "com.amazonaws.cleanrooms#RoleArn", "traits": { - "smithy.api#documentation": "The unique ARN for an IAM role that is used by Clean Rooms to write protected\n query results to the result location, given by the member who can receive results.
" + "smithy.api#documentation": "The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.
" } } }, @@ -11849,13 +11848,13 @@ "isResponsible": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether the collaboration member has accepted to pay for query compute costs\n (TRUE) or has not accepted to pay for query compute costs\n (FALSE).
If the collaboration creator has not specified anyone to pay for query compute costs,\n then the member who can query is the default payer.
\nAn error message is returned for the following reasons:
\nIf you set the value to FALSE but you are responsible to pay for\n query compute costs.
If you set the value to TRUE but you are not responsible to pay for\n query compute costs.
Indicates whether the collaboration member has accepted to pay for query compute costs (TRUE) or has not accepted to pay for query compute costs (FALSE).
If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.
An error message is returned for the following reasons:
If you set the value to FALSE but you are responsible to pay for query compute costs.
If you set the value to TRUE but you are not responsible to pay for query compute costs.
An object representing the payment responsibilities accepted by the collaboration member\n for query compute costs.
" + "smithy.api#documentation": "An object representing the payment responsibilities accepted by the collaboration member for query compute costs.
" } }, "com.amazonaws.cleanrooms#MembershipQueryLogStatus": { @@ -11994,7 +11993,7 @@ "collaborationCreatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon Web Services principal that created the collaboration. Currently only\n supports Amazon Web Services account ID.
", + "smithy.api#documentation": "The identifier of the Amazon Web Services principal that created the collaboration. Currently only supports Amazon Web Services account ID.
", "smithy.api#required": {} } }, @@ -12070,13 +12069,13 @@ "isResponsible": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether the collaboration creator has configured the collaboration member to\n pay for model inference costs (TRUE) or has not configured the collaboration\n member to pay for model inference costs (FALSE).
Exactly one member can be configured to pay for model inference costs. An error is\n returned if the collaboration creator sets a TRUE value for more than one\n member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if\n the collaboration creator sets a FALSE value for the member who can\n query.
Indicates whether the collaboration creator has configured the collaboration member to pay for model inference costs (TRUE) or has not configured the collaboration member to pay for model inference costs (FALSE).
Exactly one member can be configured to pay for model inference costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model inference costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
An object representing the collaboration member's model inference payment responsibilities set by the\n collaboration creator.
" + "smithy.api#documentation": "An object representing the collaboration member's model inference payment responsibilities set by the collaboration creator.
" } }, "com.amazonaws.cleanrooms#ModelTrainingPaymentConfig": { @@ -12085,13 +12084,13 @@ "isResponsible": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether the collaboration creator has configured the collaboration member to\n pay for model training costs (TRUE) or has not configured the collaboration\n member to pay for model training costs (FALSE).
Exactly one member can be configured to pay for model training costs. An error is\n returned if the collaboration creator sets a TRUE value for more than one\n member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if\n the collaboration creator sets a FALSE value for the member who can\n query.
Indicates whether the collaboration creator has configured the collaboration member to pay for model training costs (TRUE) or has not configured the collaboration member to pay for model training costs (FALSE).
Exactly one member can be configured to pay for model training costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for model training costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
An object representing the collaboration member's model training payment responsibilities set by the\n collaboration creator.
" + "smithy.api#documentation": "An object representing the collaboration member's model training payment responsibilities set by the collaboration creator.
" } }, "com.amazonaws.cleanrooms#PaginationToken": { @@ -12309,14 +12308,14 @@ "queryCompute": { "target": "com.amazonaws.cleanrooms#QueryComputePaymentConfig", "traits": { - "smithy.api#documentation": "The collaboration member's payment responsibilities set by the collaboration creator for\n query compute costs.
", + "smithy.api#documentation": "The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
", "smithy.api#required": {} } }, "machineLearning": { "target": "com.amazonaws.cleanrooms#MLPaymentConfig", "traits": { - "smithy.api#documentation": "An object representing the collaboration member's machine learning payment responsibilities set by the\n collaboration creator.
" + "smithy.api#documentation": "An object representing the collaboration member's machine learning payment responsibilities set by the collaboration creator.
" } }, "jobCompute": { @@ -12327,7 +12326,7 @@ } }, "traits": { - "smithy.api#documentation": "An object representing the collaboration member's payment responsibilities set by the\n collaboration creator.
" + "smithy.api#documentation": "An object representing the collaboration member's payment responsibilities set by the collaboration creator.
" } }, "com.amazonaws.cleanrooms#PopulateIdMappingTable": { @@ -12674,7 +12673,7 @@ "autoRefresh": { "target": "com.amazonaws.cleanrooms#PrivacyBudgetTemplateAutoRefresh", "traits": { - "smithy.api#documentation": "How often the privacy budget refreshes.
\nIf you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
How often the privacy budget refreshes.
If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
The Amazon Web Services account ID of the member in the collaboration who can receive \n results from analyses.
", + "smithy.api#documentation": "The Amazon Web Services account ID of the member in the collaboration who can receive results from analyses.
", "smithy.api#required": {} } } @@ -13531,6 +13530,61 @@ "smithy.api#documentation": "The parameters for an Clean Rooms protected query.
" } }, + "com.amazonaws.cleanrooms#ProtectedQueryDistributeOutput": { + "type": "structure", + "members": { + "s3": { + "target": "com.amazonaws.cleanrooms#ProtectedQueryS3Output" + }, + "memberList": { + "target": "com.amazonaws.cleanrooms#ProtectedQueryMemberOutputList", + "traits": { + "smithy.api#documentation": "Contains the output results for each member location specified in the distribute output configuration. Each entry provides details about the result distribution to a specific collaboration member.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the output information for a protected query with a distribute output configuration.
This output type allows query results to be distributed to multiple receivers, including S3 and collaboration members. It is only available for queries using the Spark analytics engine.
" + } + }, + "com.amazonaws.cleanrooms#ProtectedQueryDistributeOutputConfiguration": { + "type": "structure", + "members": { + "locations": { + "target": "com.amazonaws.cleanrooms#ProtectedQueryDistributeOutputConfigurationLocations", + "traits": { + "smithy.api#documentation": "A list of locations where you want to distribute the protected query results. Each location must specify either an S3 destination or a collaboration member destination.
You can't specify more than one S3 location.
You can't specify the query runner's account as a member location.
You must include either an S3 or member output configuration for each location, but not both.
Specifies the configuration for distributing protected query results to multiple receivers, including S3 and collaboration members.
" + } + }, + "com.amazonaws.cleanrooms#ProtectedQueryDistributeOutputConfigurationLocation": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.cleanrooms#ProtectedQueryS3OutputConfiguration" + }, + "member": { + "target": "com.amazonaws.cleanrooms#ProtectedQueryMemberOutputConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "Specifies where you'll distribute the results of your protected query. You must configure either an S3 destination or a collaboration member destination.
" + } + }, + "com.amazonaws.cleanrooms#ProtectedQueryDistributeOutputConfigurationLocations": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#ProtectedQueryDistributeOutputConfigurationLocation" + } + }, "com.amazonaws.cleanrooms#ProtectedQueryError": { "type": "structure", "members": { @@ -13590,7 +13644,7 @@ "s3": { "target": "com.amazonaws.cleanrooms#ProtectedQueryS3Output", "traits": { - "smithy.api#documentation": "If present, the output for a protected query with an `S3` output type.
" + "smithy.api#documentation": "If present, the output for a protected query with an S3 output type.
The list of member Amazon Web Services account(s) that received the results of the query.
" } + }, + "distribute": { + "target": "com.amazonaws.cleanrooms#ProtectedQueryDistributeOutput", + "traits": { + "smithy.api#documentation": "Contains output information for protected queries that use a distribute output type. This output type lets you send query results to multiple locations - either to S3 or to collaboration members.
You can only use the distribute output type with the Spark analytics engine.
Required configuration for a protected query with a member output type.
Required configuration for a protected query with a distribute output type.
Indicates whether files should be output as a single file (TRUE) or output\n as multiple files (FALSE). This parameter is only supported for analyses with\n the Spark analytics engine.
Indicates whether files should be output as a single file (TRUE) or output as multiple files (FALSE). This parameter is only supported for analyses with the Spark analytics engine.
The Amazon Resource Name (ARN) associated with the analysis template within a\n collaboration.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
" } }, "parameters": { @@ -13744,7 +13810,7 @@ "accountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID of the member in the collaboration who can receive results for the\n query.
", + "smithy.api#documentation": "The Amazon Web Services account ID of the member in the collaboration who can receive results for the query.
", "smithy.api#required": {} } } @@ -13883,13 +13949,13 @@ "isResponsible": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "Indicates whether the collaboration creator has configured the collaboration member to\n pay for query compute costs (TRUE) or has not configured the collaboration\n member to pay for query compute costs (FALSE).
Exactly one member can be configured to pay for query compute costs. An error is\n returned if the collaboration creator sets a TRUE value for more than one\n member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for query\n compute costs, then the member who can query is the default payer. An error is returned if\n the collaboration creator sets a FALSE value for the member who can\n query.
Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (TRUE) or has not configured the collaboration member to pay for query compute costs (FALSE).
Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.
If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
An object representing the collaboration member's payment responsibilities set by the\n collaboration creator for query compute costs.
" + "smithy.api#documentation": "An object representing the collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
" } }, "com.amazonaws.cleanrooms#QueryConstraint": { @@ -14223,14 +14289,14 @@ "analysisRuleTypes": { "target": "com.amazonaws.cleanrooms#AnalysisRuleTypeList", "traits": { - "smithy.api#documentation": "The analysis rule types that are associated with the schema. Currently, only one entry is\n present.
", + "smithy.api#documentation": "The analysis rule types that are associated with the schema. Currently, only one entry is present.
", "smithy.api#required": {} } }, "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "The analysis method for the schema.
\n\n DIRECT_QUERY allows SQL queries to be run directly on this table.
\n DIRECT_JOB allows PySpark jobs to be run directly on this table.
\n MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
The analysis method for the schema.
DIRECT_QUERY allows SQL queries to be run directly on this table.
DIRECT_JOB allows PySpark jobs to be run directly on this table.
MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
A name for the schema. The schema relation is referred to by this name when queried by a\n protected query.
", + "smithy.api#documentation": "A name for the schema. The schema relation is referred to by this name when queried by a protected query.
", "smithy.api#required": {} } }, @@ -14436,13 +14502,13 @@ "target": "com.amazonaws.cleanrooms#AnalysisType", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "The type of analysis that can be performed on the schema.
\nA schema can have an analysisType of DIRECT_ANALYSIS, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.
The type of analysis that can be performed on the schema.
A schema can have an analysisType of DIRECT_ANALYSIS, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.
Information about the schema status.
\nA status of READY means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.
Information about the schema status.
A status of READY means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.
The analysis method for the associated schema.
\n\n DIRECT_QUERY allows SQL queries to be run directly on this table.
\n DIRECT_JOB allows PySpark jobs to be run directly on this table.
\n MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
The analysis method for the associated schema.
DIRECT_QUERY allows SQL queries to be run directly on this table.
DIRECT_JOB allows PySpark jobs to be run directly on this table.
MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
The column's data type. Supported data types: ARRAY, BIGINT,\n BOOLEAN, CHAR, DATE,\n DECIMAL, DOUBLE, DOUBLE PRECISION,\n FLOAT, FLOAT4, INT, INTEGER,\n MAP, NUMERIC, NUMBER, REAL,\n SMALLINT, STRING, TIMESTAMP,\n TIMESTAMP_LTZ, TIMESTAMP_NTZ, DATETIME,\n TINYINT, VARCHAR, TEXT, CHARACTER.
The column's data type. Supported data types: ARRAY, BIGINT, BOOLEAN, CHAR, DATE, DECIMAL, DOUBLE, DOUBLE PRECISION, FLOAT, FLOAT4, INT, INTEGER, MAP, NUMERIC, NUMBER, REAL, SMALLINT, STRING, TIMESTAMP, TIMESTAMP_LTZ, TIMESTAMP_NTZ, DATETIME, TINYINT, VARCHAR, TEXT, CHARACTER.
A unique identifier for the membership to run this job against. \n Currently accepts a membership ID.
", + "smithy.api#documentation": "A unique identifier for the membership to run this job against. Currently accepts a membership ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" @@ -15007,7 +15073,7 @@ "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the membership to run this query against. Currently accepts a\n membership ID.
", + "smithy.api#documentation": "A unique identifier for the membership to run this query against. Currently accepts a membership ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" @@ -15082,7 +15148,7 @@ "glue": { "target": "com.amazonaws.cleanrooms#GlueTableReference", "traits": { - "smithy.api#documentation": "If present, a reference to the Glue table referred to by this table\n reference.
" + "smithy.api#documentation": "If present, a reference to the Glue table referred to by this table reference.
" } }, "snowflake": { @@ -15280,7 +15346,7 @@ "resourceArn": { "target": "com.amazonaws.cleanrooms#CleanroomsArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the resource you want to remove the tag\n from.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -15428,7 +15494,7 @@ "name": { "target": "com.amazonaws.cleanrooms#CollaborationName", "traits": { - "smithy.api#documentation": "A human-readable identifier provided by the collaboration owner. Display names are not\n unique.
" + "smithy.api#documentation": "A human-readable identifier provided by the collaboration owner. Display names are not unique.
" } }, "description": { @@ -15627,7 +15693,7 @@ "configuredTableIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", "traits": { - "smithy.api#documentation": "The unique identifier for the configured table that the analysis rule applies to.\n Currently accepts the configured table ID.
", + "smithy.api#documentation": "The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableId" @@ -15636,7 +15702,7 @@ "analysisRuleType": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", "traits": { - "smithy.api#documentation": "The analysis rule type to be updated. Configured table analysis rules are uniquely\n identified by their configured table identifier and analysis rule type.
", + "smithy.api#documentation": "The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -15749,7 +15815,7 @@ "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to.\n Currently accepts the membership ID.
", + "smithy.api#documentation": "A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" @@ -15790,7 +15856,7 @@ "analysisRule": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationAnalysisRule", "traits": { - "smithy.api#documentation": " The updated analysis rule for the con\ufb01gured table association. In the console, the\n ConfiguredTableAssociationAnalysisRule is referred to as the\n collaboration analysis rule.
The updated analysis rule for the con\ufb01gured table association. In the console, the ConfiguredTableAssociationAnalysisRule is referred to as the collaboration analysis rule.
The unique identifier for the configured table association to update. Currently accepts\n the configured table association ID.
", + "smithy.api#documentation": "The unique identifier for the configured table association to update. Currently accepts the configured table association ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" @@ -15814,7 +15880,7 @@ "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "The unique ID for the membership that the configured table association belongs\n to.
", + "smithy.api#documentation": "The unique ID for the membership that the configured table association belongs to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" @@ -15852,7 +15918,7 @@ "configuredTableIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", "traits": { - "smithy.api#documentation": "The identifier for the configured table to update. Currently accepts the configured\n table ID.
", + "smithy.api#documentation": "The identifier for the configured table to update. Currently accepts the configured table ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableId" @@ -15873,7 +15939,7 @@ "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "The analysis method for the configured table.
\n\n DIRECT_QUERY allows SQL queries to be run directly on this table.
\n DIRECT_JOB allows PySpark jobs to be run directly on this table.
\n MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
The analysis method for the configured table.
DIRECT_QUERY allows SQL queries to be run directly on this table.
DIRECT_JOB allows PySpark jobs to be run directly on this table.
MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.
An indicator as to whether query logging has been enabled or disabled for the\n membership.
\nWhen ENABLED, Clean Rooms logs details about queries run within this\n collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is\n DISABLED.
An indicator as to whether query logging has been enabled or disabled for the membership.
When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
An indicator as to whether job logging has been enabled or disabled \n for the collaboration.
\nWhen ENABLED, Clean Rooms logs details about jobs run within this\n collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is\n DISABLED.
An indicator as to whether job logging has been enabled or disabled for the collaboration.
When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.
The default protected query result configuration as specified by the member who can\n receive results.
" + "smithy.api#documentation": "The default protected query result configuration as specified by the member who can receive results.
" } }, "defaultJobResultConfiguration": { @@ -16321,7 +16387,7 @@ "targetStatus": { "target": "com.amazonaws.cleanrooms#TargetProtectedJobStatus", "traits": { - "smithy.api#documentation": "The target status of a protected job. Used to update the execution status \n of a currently running job.
", + "smithy.api#documentation": "The target status of a protected job. Used to update the execution status of a currently running job.
", "smithy.api#required": {} } } @@ -16407,7 +16473,7 @@ "targetStatus": { "target": "com.amazonaws.cleanrooms#TargetProtectedQueryStatus", "traits": { - "smithy.api#documentation": "The target status of a query. Used to update the execution status of a currently running\n query.
", + "smithy.api#documentation": "The target status of a query. Used to update the execution status of a currently running query.
", "smithy.api#required": {} } } @@ -16531,7 +16597,7 @@ } }, "traits": { - "smithy.api#documentation": "The configuration of the compute resources for workers running an analysis with the\n Clean Rooms SQL analytics engine.
" + "smithy.api#documentation": "The configuration of the compute resources for workers running an analysis with the Clean Rooms SQL analytics engine.
" } }, "com.amazonaws.cleanrooms#WorkerComputeType": { diff --git a/cleanroomsml/service/2023-09-06/cleanroomsml-2023-09-06.json b/models/cleanroomsml/service/2023-09-06/cleanroomsml-2023-09-06.json similarity index 100% rename from cleanroomsml/service/2023-09-06/cleanroomsml-2023-09-06.json rename to models/cleanroomsml/service/2023-09-06/cleanroomsml-2023-09-06.json diff --git a/cloud9/service/2017-09-23/cloud9-2017-09-23.json b/models/cloud9/service/2017-09-23/cloud9-2017-09-23.json similarity index 100% rename from cloud9/service/2017-09-23/cloud9-2017-09-23.json rename to models/cloud9/service/2017-09-23/cloud9-2017-09-23.json diff --git a/cloudcontrol/service/2021-09-30/cloudcontrol-2021-09-30.json b/models/cloudcontrol/service/2021-09-30/cloudcontrol-2021-09-30.json similarity index 100% rename from cloudcontrol/service/2021-09-30/cloudcontrol-2021-09-30.json rename to models/cloudcontrol/service/2021-09-30/cloudcontrol-2021-09-30.json diff --git a/clouddirectory/service/2017-01-11/clouddirectory-2017-01-11.json b/models/clouddirectory/service/2017-01-11/clouddirectory-2017-01-11.json similarity index 100% rename from clouddirectory/service/2017-01-11/clouddirectory-2017-01-11.json rename to models/clouddirectory/service/2017-01-11/clouddirectory-2017-01-11.json diff --git a/cloudformation/service/2010-05-15/cloudformation-2010-05-15.json b/models/cloudformation/service/2010-05-15/cloudformation-2010-05-15.json similarity index 100% rename from cloudformation/service/2010-05-15/cloudformation-2010-05-15.json rename to models/cloudformation/service/2010-05-15/cloudformation-2010-05-15.json diff --git a/cloudfront-keyvaluestore/service/2022-07-26/cloudfront-keyvaluestore-2022-07-26.json b/models/cloudfront-keyvaluestore/service/2022-07-26/cloudfront-keyvaluestore-2022-07-26.json similarity index 100% rename from cloudfront-keyvaluestore/service/2022-07-26/cloudfront-keyvaluestore-2022-07-26.json rename to models/cloudfront-keyvaluestore/service/2022-07-26/cloudfront-keyvaluestore-2022-07-26.json diff --git a/cloudfront/service/2020-05-31/cloudfront-2020-05-31.json b/models/cloudfront/service/2020-05-31/cloudfront-2020-05-31.json similarity index 88% rename from cloudfront/service/2020-05-31/cloudfront-2020-05-31.json rename to models/cloudfront/service/2020-05-31/cloudfront-2020-05-31.json index 8c19bc5c..5d989924 100644 --- a/cloudfront/service/2020-05-31/cloudfront-2020-05-31.json +++ b/models/cloudfront/service/2020-05-31/cloudfront-2020-05-31.json @@ -431,6 +431,188 @@ "smithy.api#input": {} } }, + "com.amazonaws.cloudfront#AssociateDistributionTenantWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#AssociateDistributionTenantWebACLRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#AssociateDistributionTenantWebACLResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" + }, + { + "target": "com.amazonaws.cloudfront#PreconditionFailed" + } + ], + "traits": { + "smithy.api#documentation": "Associates the WAF web ACL with a distribution tenant.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/2020-05-31/distribution-tenant/{Id}/associate-web-acl", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#AssociateDistributionTenantWebACLRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the distribution tenant.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WebACLArn": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the WAF web ACL to associate.
", + "smithy.api#required": {} + } + }, + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current ETag of the distribution tenant. This value is returned in the response of the GetDistributionTenant API operation.
The ID of the distribution tenant.
" + } + }, + "WebACLArn": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ARN of the WAF web ACL that you associated with the distribution tenant.
" + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the distribution tenant.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudfront#AssociateDistributionWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#AssociateDistributionWebACLRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#AssociateDistributionWebACLResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" + }, + { + "target": "com.amazonaws.cloudfront#PreconditionFailed" + } + ], + "traits": { + "smithy.api#documentation": "Associates the WAF web ACL with a distribution.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/2020-05-31/distribution/{Id}/associate-web-acl", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#AssociateDistributionWebACLRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the distribution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WebACLArn": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the WAF web ACL to associate.
", + "smithy.api#required": {} + } + }, + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The value of the ETag header that you received when retrieving the distribution that you're associating with the WAF web ACL.
The ID of the distribution.
" + } + }, + "WebACLArn": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ARN of the WAF web ACL that you associated with the distribution.
" + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the distribution.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudfront#AwsAccountNumberList": { "type": "list", "member": { @@ -1004,6 +1186,21 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.cloudfront#Certificate": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ACM certificate.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Certificate Manager (ACM) certificate associated with your distribution.
" + } + }, "com.amazonaws.cloudfront#CertificateSource": { "type": "enum", "members": { @@ -1027,6 +1224,23 @@ } } }, + "com.amazonaws.cloudfront#CertificateTransparencyLoggingPreference": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enabled" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } + } + } + }, "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentity": { "type": "structure", "members": { @@ -1196,6 +1410,12 @@ { "target": "com.amazonaws.cloudfront#AssociateAlias" }, + { + "target": "com.amazonaws.cloudfront#AssociateDistributionTenantWebACL" + }, + { + "target": "com.amazonaws.cloudfront#AssociateDistributionWebACL" + }, { "target": "com.amazonaws.cloudfront#CopyDistribution" }, @@ -1208,12 +1428,18 @@ { "target": "com.amazonaws.cloudfront#CreateCloudFrontOriginAccessIdentity" }, + { + "target": "com.amazonaws.cloudfront#CreateConnectionGroup" + }, { "target": "com.amazonaws.cloudfront#CreateContinuousDeploymentPolicy" }, { "target": "com.amazonaws.cloudfront#CreateDistribution" }, + { + "target": "com.amazonaws.cloudfront#CreateDistributionTenant" + }, { "target": "com.amazonaws.cloudfront#CreateDistributionWithTags" }, @@ -1229,6 +1455,9 @@ { "target": "com.amazonaws.cloudfront#CreateInvalidation" }, + { + "target": "com.amazonaws.cloudfront#CreateInvalidationForDistributionTenant" + }, { "target": "com.amazonaws.cloudfront#CreateKeyGroup" }, @@ -1271,12 +1500,18 @@ { "target": "com.amazonaws.cloudfront#DeleteCloudFrontOriginAccessIdentity" }, + { + "target": "com.amazonaws.cloudfront#DeleteConnectionGroup" + }, { "target": "com.amazonaws.cloudfront#DeleteContinuousDeploymentPolicy" }, { "target": "com.amazonaws.cloudfront#DeleteDistribution" }, + { + "target": "com.amazonaws.cloudfront#DeleteDistributionTenant" + }, { "target": "com.amazonaws.cloudfront#DeleteFieldLevelEncryptionConfig" }, @@ -1322,6 +1557,12 @@ { "target": "com.amazonaws.cloudfront#DescribeKeyValueStore" }, + { + "target": "com.amazonaws.cloudfront#DisassociateDistributionTenantWebACL" + }, + { + "target": "com.amazonaws.cloudfront#DisassociateDistributionWebACL" + }, { "target": "com.amazonaws.cloudfront#GetAnycastIpList" }, @@ -1337,6 +1578,12 @@ { "target": "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfig" }, + { + "target": "com.amazonaws.cloudfront#GetConnectionGroup" + }, + { + "target": "com.amazonaws.cloudfront#GetConnectionGroupByRoutingEndpoint" + }, { "target": "com.amazonaws.cloudfront#GetContinuousDeploymentPolicy" }, @@ -1349,6 +1596,12 @@ { "target": "com.amazonaws.cloudfront#GetDistributionConfig" }, + { + "target": "com.amazonaws.cloudfront#GetDistributionTenant" + }, + { + "target": "com.amazonaws.cloudfront#GetDistributionTenantByDomain" + }, { "target": "com.amazonaws.cloudfront#GetFieldLevelEncryption" }, @@ -1367,12 +1620,18 @@ { "target": "com.amazonaws.cloudfront#GetInvalidation" }, + { + "target": "com.amazonaws.cloudfront#GetInvalidationForDistributionTenant" + }, { "target": "com.amazonaws.cloudfront#GetKeyGroup" }, { "target": "com.amazonaws.cloudfront#GetKeyGroupConfig" }, + { + "target": "com.amazonaws.cloudfront#GetManagedCertificateDetails" + }, { "target": "com.amazonaws.cloudfront#GetMonitoringSubscription" }, @@ -1424,6 +1683,9 @@ { "target": "com.amazonaws.cloudfront#ListConflictingAliases" }, + { + "target": "com.amazonaws.cloudfront#ListConnectionGroups" + }, { "target": "com.amazonaws.cloudfront#ListContinuousDeploymentPolicies" }, @@ -1436,6 +1698,9 @@ { "target": "com.amazonaws.cloudfront#ListDistributionsByCachePolicyId" }, + { + "target": "com.amazonaws.cloudfront#ListDistributionsByConnectionMode" + }, { "target": "com.amazonaws.cloudfront#ListDistributionsByKeyGroup" }, @@ -1454,6 +1719,15 @@ { "target": "com.amazonaws.cloudfront#ListDistributionsByWebACLId" }, + { + "target": "com.amazonaws.cloudfront#ListDistributionTenants" + }, + { + "target": "com.amazonaws.cloudfront#ListDistributionTenantsByCustomization" + }, + { + "target": "com.amazonaws.cloudfront#ListDomainConflicts" + }, { "target": "com.amazonaws.cloudfront#ListFieldLevelEncryptionConfigs" }, @@ -1466,6 +1740,9 @@ { "target": "com.amazonaws.cloudfront#ListInvalidations" }, + { + "target": "com.amazonaws.cloudfront#ListInvalidationsForDistributionTenant" + }, { "target": "com.amazonaws.cloudfront#ListKeyGroups" }, @@ -1514,15 +1791,24 @@ { "target": "com.amazonaws.cloudfront#UpdateCloudFrontOriginAccessIdentity" }, + { + "target": "com.amazonaws.cloudfront#UpdateConnectionGroup" + }, { "target": "com.amazonaws.cloudfront#UpdateContinuousDeploymentPolicy" }, { "target": "com.amazonaws.cloudfront#UpdateDistribution" }, + { + "target": "com.amazonaws.cloudfront#UpdateDistributionTenant" + }, { "target": "com.amazonaws.cloudfront#UpdateDistributionWithStagingConfig" }, + { + "target": "com.amazonaws.cloudfront#UpdateDomainAssociation" + }, { "target": "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionConfig" }, @@ -1558,6 +1844,9 @@ }, { "target": "com.amazonaws.cloudfront#UpdateVpcOrigin" + }, + { + "target": "com.amazonaws.cloudfront#VerifyDnsConfiguration" } ], "traits": { @@ -2526,39 +2815,237 @@ "smithy.api#documentation": "A list of aliases (also called CNAMEs) and the CloudFront distributions and Amazon Web Services accounts\n\t\t\tthat they are associated with. In the list, the distribution and account IDs are\n\t\t\tpartially hidden, which allows you to identify the distributions and accounts that you\n\t\t\town, but helps to protect the information of ones that you don't own.
" } }, - "com.amazonaws.cloudfront#ContentTypeProfile": { + "com.amazonaws.cloudfront#ConnectionGroup": { "type": "structure", "members": { - "Format": { - "target": "com.amazonaws.cloudfront#Format", + "Id": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The format for a field-level encryption content type-profile mapping.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ID of the connection group.
" } }, - "ProfileId": { + "Name": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The profile ID for a field-level encryption content type-profile mapping.
" + "smithy.api#documentation": "The name of the connection group.
" } }, - "ContentType": { + "Arn": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The content type for a field-level encryption content type-profile mapping.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the connection group.
" } - } - }, - "traits": { - "smithy.api#documentation": "A field-level encryption content type profile.
" - } - }, - "com.amazonaws.cloudfront#ContentTypeProfileConfig": { - "type": "structure", - "members": { - "ForwardWhenContentTypeIsUnknown": { - "target": "com.amazonaws.cloudfront#boolean", + }, + "CreatedTime": { + "target": "com.amazonaws.cloudfront#timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the connection group was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.cloudfront#timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the connection group was updated.
" + } + }, + "Tags": { + "target": "com.amazonaws.cloudfront#Tags" + }, + "Ipv6Enabled": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "IPv6 is enabled for the connection group.
" + } + }, + "RoutingEndpoint": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.
" + } + }, + "AnycastIpListId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the Anycast static IP list.
" + } + }, + "Status": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The status of the connection group.
" + } + }, + "Enabled": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "Whether the connection group is enabled.
" + } + }, + "IsDefault": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "Whether the connection group is the default connection group for the distribution tenants.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The connection group for your distribution tenants. When you first create a distribution tenant and you don't specify a connection group, CloudFront will automatically create a default connection group for you. When you create a new distribution tenant and don't specify a connection group, the default one will be associated with your distribution tenant.
" + } + }, + "com.amazonaws.cloudfront#ConnectionGroupAssociationFilter": { + "type": "structure", + "members": { + "AnycastIpListId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the Anycast static IP list.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about what CloudFront resources your connection groups are associated with.
" + } + }, + "com.amazonaws.cloudfront#ConnectionGroupSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the connection group.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The name of the connection group.
", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the connection group.
", + "smithy.api#required": {} + } + }, + "RoutingEndpoint": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.
", + "smithy.api#required": {} + } + }, + "CreatedTime": { + "target": "com.amazonaws.cloudfront#timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the connection group was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.cloudfront#timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the connection group was updated.
", + "smithy.api#required": {} + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the connection group.
", + "smithy.api#required": {} + } + }, + "AnycastIpListId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the Anycast static IP list.
" + } + }, + "Enabled": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "Whether the connection group is enabled
" + } + }, + "Status": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The status of the connection group.
" + } + }, + "IsDefault": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "Whether the connection group is the default connection group for the distribution tenants.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary that contains details about your connection groups.
" + } + }, + "com.amazonaws.cloudfront#ConnectionGroupSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudfront#ConnectionGroupSummary", + "traits": { + "smithy.api#xmlName": "ConnectionGroupSummary" + } + } + }, + "com.amazonaws.cloudfront#ConnectionMode": { + "type": "enum", + "members": { + "Direct": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "direct" + } + }, + "TenantOnly": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tenant-only" + } + } + } + }, + "com.amazonaws.cloudfront#ContentTypeProfile": { + "type": "structure", + "members": { + "Format": { + "target": "com.amazonaws.cloudfront#Format", + "traits": { + "smithy.api#documentation": "The format for a field-level encryption content type-profile mapping.
", + "smithy.api#required": {} + } + }, + "ProfileId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The profile ID for a field-level encryption content type-profile mapping.
" + } + }, + "ContentType": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The content type for a field-level encryption content type-profile mapping.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A field-level encryption content type profile.
" + } + }, + "com.amazonaws.cloudfront#ContentTypeProfileConfig": { + "type": "structure", + "members": { + "ForwardWhenContentTypeIsUnknown": { + "target": "com.amazonaws.cloudfront#boolean", "traits": { "smithy.api#documentation": "The setting in a field-level encryption content type-profile mapping that specifies\n\t\t\twhat to do when an unknown content type is provided for the profile. If true, content is\n\t\t\tforwarded without being encrypted when the content type is unknown. If false (the\n\t\t\tdefault), an error is returned when the content type is unknown.
", "smithy.api#required": {} @@ -3185,7 +3672,7 @@ "IpCount": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The number of static IP addresses that are allocated to the Anycast static IP list.
", + "smithy.api#documentation": "The number of static IP addresses that are allocated to the Anycast static IP list. Valid values: 21 or 3.
", "smithy.api#required": {} } }, @@ -3390,6 +3877,101 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudfront#CreateConnectionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#CreateConnectionGroupRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#CreateConnectionGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityAlreadyExists" + }, + { + "target": "com.amazonaws.cloudfront#EntityLimitExceeded" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#InvalidTagging" + } + ], + "traits": { + "smithy.api#documentation": "Creates a connection group.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-05-31/connection-group", + "code": 201 + } + } + }, + "com.amazonaws.cloudfront#CreateConnectionGroupRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The name of the connection group. Enter a friendly identifier that is unique within your Amazon Web Services account. This name can't be updated after you create the connection group.
", + "smithy.api#required": {} + } + }, + "Ipv6Enabled": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "Enable IPv6 for the connection group. The default is true. For more information, see Enable IPv6 in the \n \tAmazon CloudFront Developer Guide.
The ID of the Anycast static IP list.
" + } + }, + "Enabled": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "Enable the connection group.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#CreateConnectionGroupResult": { + "type": "structure", + "members": { + "ConnectionGroup": { + "target": "com.amazonaws.cloudfront#ConnectionGroup", + "traits": { + "smithy.api#documentation": "The connection group that you created.
", + "smithy.api#httpPayload": {} + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the connection group.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudfront#CreateContinuousDeploymentPolicy": { "type": "operation", "input": { @@ -3494,6 +4076,9 @@ { "target": "com.amazonaws.cloudfront#DistributionAlreadyExists" }, + { + "target": "com.amazonaws.cloudfront#EntityLimitExceeded" + }, { "target": "com.amazonaws.cloudfront#EntityNotFound" }, @@ -3738,13 +4323,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.cloudfront#CreateDistributionWithTags": { + "com.amazonaws.cloudfront#CreateDistributionTenant": { "type": "operation", "input": { - "target": "com.amazonaws.cloudfront#CreateDistributionWithTagsRequest" + "target": "com.amazonaws.cloudfront#CreateDistributionTenantRequest" }, "output": { - "target": "com.amazonaws.cloudfront#CreateDistributionWithTagsResult" + "target": "com.amazonaws.cloudfront#CreateDistributionTenantResult" }, "errors": [ { @@ -3754,7 +4339,135 @@ "target": "com.amazonaws.cloudfront#CNAMEAlreadyExists" }, { - "target": "com.amazonaws.cloudfront#ContinuousDeploymentPolicyInUse" + "target": "com.amazonaws.cloudfront#EntityAlreadyExists" + }, + { + "target": "com.amazonaws.cloudfront#EntityLimitExceeded" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#InvalidAssociation" + }, + { + "target": "com.amazonaws.cloudfront#InvalidTagging" + } + ], + "traits": { + "smithy.api#documentation": "Creates a distribution tenant.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-05-31/distribution-tenant", + "code": 201 + } + } + }, + "com.amazonaws.cloudfront#CreateDistributionTenantRequest": { + "type": "structure", + "members": { + "DistributionId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the multi-tenant distribution to use for creating the distribution tenant.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The name of the distribution tenant. Enter a friendly identifier that is unique within your Amazon Web Services account. This name can't be updated after you create the distribution tenant.
", + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]{1,126}[a-zA-Z0-9]$", + "smithy.api#required": {} + } + }, + "Domains": { + "target": "com.amazonaws.cloudfront#DomainList", + "traits": { + "smithy.api#documentation": "The domains associated with the distribution tenant. You must specify at least one domain in the request.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.cloudfront#Tags" + }, + "Customizations": { + "target": "com.amazonaws.cloudfront#Customizations", + "traits": { + "smithy.api#documentation": "Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
" + } + }, + "Parameters": { + "target": "com.amazonaws.cloudfront#Parameters", + "traits": { + "smithy.api#documentation": "A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
" + } + }, + "ConnectionGroupId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the connection group to associate with the distribution tenant.
" + } + }, + "ManagedCertificateRequest": { + "target": "com.amazonaws.cloudfront#ManagedCertificateRequest", + "traits": { + "smithy.api#documentation": "The configuration for the CloudFront managed ACM certificate request.
" + } + }, + "Enabled": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the distribution tenant should be enabled when created. If the distribution tenant is disabled, the distribution tenant won't serve traffic.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#CreateDistributionTenantResult": { + "type": "structure", + "members": { + "DistributionTenant": { + "target": "com.amazonaws.cloudfront#DistributionTenant", + "traits": { + "smithy.api#documentation": "The distribution tenant that you created.
", + "smithy.api#httpPayload": {} + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the distribution tenant.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudfront#CreateDistributionWithTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#CreateDistributionWithTagsRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#CreateDistributionWithTagsResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#CNAMEAlreadyExists" + }, + { + "target": "com.amazonaws.cloudfront#ContinuousDeploymentPolicyInUse" }, { "target": "com.amazonaws.cloudfront#DistributionAlreadyExists" @@ -4364,6 +5077,91 @@ } } }, + "com.amazonaws.cloudfront#CreateInvalidationForDistributionTenant": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#CreateInvalidationForDistributionTenantRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#CreateInvalidationForDistributionTenantResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#BatchTooLarge" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, + { + "target": "com.amazonaws.cloudfront#InconsistentQuantities" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#MissingBody" + }, + { + "target": "com.amazonaws.cloudfront#TooManyInvalidationsInProgress" + } + ], + "traits": { + "smithy.api#documentation": "Creates an invalidation for a distribution tenant. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-05-31/distribution-tenant/{Id}/invalidation", + "code": 201 + } + } + }, + "com.amazonaws.cloudfront#CreateInvalidationForDistributionTenantRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the distribution tenant.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InvalidationBatch": { + "target": "com.amazonaws.cloudfront#InvalidationBatch", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "InvalidationBatch" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#CreateInvalidationForDistributionTenantResult": { + "type": "structure", + "members": { + "Location": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The location for the invalidation.
", + "smithy.api#httpHeader": "Location" + } + }, + "Invalidation": { + "target": "com.amazonaws.cloudfront#Invalidation", + "traits": { + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudfront#CreateInvalidationRequest": { "type": "structure", "members": { @@ -5567,6 +6365,49 @@ "smithy.api#documentation": "A custom origin. A custom origin is any origin that is not an\n\t\t\tAmazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with\n\t\t\t\tstatic website hosting\n is a custom origin.
" } }, + "com.amazonaws.cloudfront#CustomizationActionType": { + "type": "enum", + "members": { + "override": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "override" + } + }, + "disable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disable" + } + } + } + }, + "com.amazonaws.cloudfront#Customizations": { + "type": "structure", + "members": { + "WebAcl": { + "target": "com.amazonaws.cloudfront#WebAclCustomization", + "traits": { + "smithy.api#documentation": "The WAF web ACL.
" + } + }, + "Certificate": { + "target": "com.amazonaws.cloudfront#Certificate", + "traits": { + "smithy.api#documentation": "The Certificate Manager (ACM) certificate.
" + } + }, + "GeoRestrictions": { + "target": "com.amazonaws.cloudfront#GeoRestrictionCustomization", + "traits": { + "smithy.api#documentation": "The geographic restrictions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
" + } + }, "com.amazonaws.cloudfront#DefaultCacheBehavior": { "type": "structure", "members": { @@ -5877,10 +6718,10 @@ "smithy.api#input": {} } }, - "com.amazonaws.cloudfront#DeleteContinuousDeploymentPolicy": { + "com.amazonaws.cloudfront#DeleteConnectionGroup": { "type": "operation", "input": { - "target": "com.amazonaws.cloudfront#DeleteContinuousDeploymentPolicyRequest" + "target": "com.amazonaws.cloudfront#DeleteConnectionGroupRequest" }, "output": { "target": "smithy.api#Unit" @@ -5890,37 +6731,37 @@ "target": "com.amazonaws.cloudfront#AccessDenied" }, { - "target": "com.amazonaws.cloudfront#ContinuousDeploymentPolicyInUse" + "target": "com.amazonaws.cloudfront#CannotDeleteEntityWhileInUse" }, { - "target": "com.amazonaws.cloudfront#InvalidArgument" + "target": "com.amazonaws.cloudfront#EntityNotFound" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { - "target": "com.amazonaws.cloudfront#NoSuchContinuousDeploymentPolicy" + "target": "com.amazonaws.cloudfront#PreconditionFailed" }, { - "target": "com.amazonaws.cloudfront#PreconditionFailed" + "target": "com.amazonaws.cloudfront#ResourceNotDisabled" } ], "traits": { - "smithy.api#documentation": "Deletes a continuous deployment policy.
\nYou cannot delete a continuous deployment policy that's attached to a primary\n\t\t\tdistribution. First update your distribution to remove the continuous deployment policy,\n\t\t\tthen you can delete the policy.
", + "smithy.api#documentation": "Deletes a connection group.
", "smithy.api#http": { "method": "DELETE", - "uri": "/2020-05-31/continuous-deployment-policy/{Id}", + "uri": "/2020-05-31/connection-group/{Id}", "code": 204 } } }, - "com.amazonaws.cloudfront#DeleteContinuousDeploymentPolicyRequest": { + "com.amazonaws.cloudfront#DeleteConnectionGroupRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The identifier of the continuous deployment policy that you are deleting.
", + "smithy.api#documentation": "The ID of the connection group to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5928,8 +6769,9 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The current version (ETag value) of the continuous deployment policy that\n\t\t\tyou are deleting.
The value of the ETag header that you received when retrieving the connection group to delete.
Delete a distribution.
", + "smithy.api#documentation": "Deletes a continuous deployment policy.
\nYou cannot delete a continuous deployment policy that's attached to a primary\n\t\t\tdistribution. First update your distribution to remove the continuous deployment policy,\n\t\t\tthen you can delete the policy.
", "smithy.api#http": { "method": "DELETE", - "uri": "/2020-05-31/distribution/{Id}", + "uri": "/2020-05-31/continuous-deployment-policy/{Id}", "code": 204 } } }, - "com.amazonaws.cloudfront#DeleteDistributionRequest": { + "com.amazonaws.cloudfront#DeleteContinuousDeploymentPolicyRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The distribution ID.
", + "smithy.api#documentation": "The identifier of the continuous deployment policy that you are deleting.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5985,20 +6830,19 @@ "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The value of the ETag header that you received when you disabled the\n\t\t\tdistribution. For example: E2QWRUHAPOMQZL.
The current version (ETag value) of the continuous deployment policy that\n\t\t\tyou are deleting.
This action deletes a web distribution. To delete a web distribution using the CloudFront\n\t\t\tAPI, perform the following steps.
\n\n To delete a web distribution using the CloudFront API:\n
\nDisable the web distribution
\nSubmit a GET Distribution Config request to get the current\n\t\t\t\t\tconfiguration and the Etag header for the distribution.
Update the XML document that was returned in the response to your GET\n\t\t\t\t\t\tDistribution Config request to change the value of\n\t\t\t\t\t\tEnabled to false.
Submit a PUT Distribution Config request to update the\n\t\t\t\t\tconfiguration for your distribution. In the request body, include the XML\n\t\t\t\t\tdocument that you updated in Step 3. Set the value of the HTTP\n\t\t\t\t\t\tIf-Match header to the value of the ETag header\n\t\t\t\t\tthat CloudFront returned when you submitted the GET Distribution Config\n\t\t\t\t\trequest in Step 2.
Review the response to the PUT Distribution Config request to\n\t\t\t\t\tconfirm that the distribution was successfully disabled.
Submit a GET Distribution request to confirm that your changes\n\t\t\t\t\thave propagated. When propagation is complete, the value of Status\n\t\t\t\t\tis Deployed.
Submit a DELETE Distribution request. Set the value of the HTTP\n\t\t\t\t\t\tIf-Match header to the value of the ETag header\n\t\t\t\t\tthat CloudFront returned when you submitted the GET Distribution Config\n\t\t\t\t\trequest in Step 6.
Review the response to your DELETE Distribution request to\n\t\t\t\t\tconfirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a\n\t\t\t\tDistribution in the Amazon CloudFront Developer Guide.
", "smithy.api#input": {} } }, - "com.amazonaws.cloudfront#DeleteFieldLevelEncryptionConfig": { + "com.amazonaws.cloudfront#DeleteDistribution": { "type": "operation", "input": { - "target": "com.amazonaws.cloudfront#DeleteFieldLevelEncryptionConfigRequest" + "target": "com.amazonaws.cloudfront#DeleteDistributionRequest" }, "output": { "target": "smithy.api#Unit" @@ -6008,13 +6852,132 @@ "target": "com.amazonaws.cloudfront#AccessDenied" }, { - "target": "com.amazonaws.cloudfront#FieldLevelEncryptionConfigInUse" + "target": "com.amazonaws.cloudfront#DistributionNotDisabled" }, { "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { - "target": "com.amazonaws.cloudfront#NoSuchFieldLevelEncryptionConfig" + "target": "com.amazonaws.cloudfront#NoSuchDistribution" + }, + { + "target": "com.amazonaws.cloudfront#PreconditionFailed" + }, + { + "target": "com.amazonaws.cloudfront#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "Delete a distribution.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2020-05-31/distribution/{Id}", + "code": 204 + } + } + }, + "com.amazonaws.cloudfront#DeleteDistributionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The distribution ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The value of the ETag header that you received when you disabled the\n\t\t\tdistribution. For example: E2QWRUHAPOMQZL.
This action deletes a web distribution. To delete a web distribution using the CloudFront\n\t\t\tAPI, perform the following steps.
\n\n To delete a web distribution using the CloudFront API:\n
\nDisable the web distribution
\nSubmit a GET Distribution Config request to get the current\n\t\t\t\t\tconfiguration and the Etag header for the distribution.
Update the XML document that was returned in the response to your GET\n\t\t\t\t\t\tDistribution Config request to change the value of\n\t\t\t\t\t\tEnabled to false.
Submit a PUT Distribution Config request to update the\n\t\t\t\t\tconfiguration for your distribution. In the request body, include the XML\n\t\t\t\t\tdocument that you updated in Step 3. Set the value of the HTTP\n\t\t\t\t\t\tIf-Match header to the value of the ETag header\n\t\t\t\t\tthat CloudFront returned when you submitted the GET Distribution Config\n\t\t\t\t\trequest in Step 2.
Review the response to the PUT Distribution Config request to\n\t\t\t\t\tconfirm that the distribution was successfully disabled.
Submit a GET Distribution request to confirm that your changes\n\t\t\t\t\thave propagated. When propagation is complete, the value of Status\n\t\t\t\t\tis Deployed.
Submit a DELETE Distribution request. Set the value of the HTTP\n\t\t\t\t\t\tIf-Match header to the value of the ETag header\n\t\t\t\t\tthat CloudFront returned when you submitted the GET Distribution Config\n\t\t\t\t\trequest in Step 6.
Review the response to your DELETE Distribution request to\n\t\t\t\t\tconfirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a\n\t\t\t\tDistribution in the Amazon CloudFront Developer Guide.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#DeleteDistributionTenant": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#DeleteDistributionTenantRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, + { + "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" + }, + { + "target": "com.amazonaws.cloudfront#PreconditionFailed" + }, + { + "target": "com.amazonaws.cloudfront#ResourceNotDisabled" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a distribution tenant. If you use this API operation to delete a distribution tenant that is currently enabled, the request will fail.
\nTo delete a distribution tenant, you must first disable the distribution tenant by using the UpdateDistributionTenant API operation.
The ID of the distribution tenant to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The value of the ETag header that you received when retrieving the distribution tenant. This value is returned in the response of the\n\t\t\tGetDistributionTenant API operation.
Disassociates a distribution tenant from the WAF web ACL.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/2020-05-31/distribution-tenant/{Id}/disassociate-web-acl", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#DisassociateDistributionTenantWebACLRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the distribution tenant.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the distribution tenant that you're disassociating from the WAF web ACL. This is the ETag value returned in the response to the\n\t\t\t\tGetDistributionTenant API operation.
The ID of the distribution tenant.
" + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the distribution tenant.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudfront#DisassociateDistributionWebACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#DisassociateDistributionWebACLRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#DisassociateDistributionWebACLResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" + }, + { + "target": "com.amazonaws.cloudfront#PreconditionFailed" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates a distribution from the WAF web ACL.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/2020-05-31/distribution/{Id}/disassociate-web-acl", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#DisassociateDistributionWebACLRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the distribution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The value of the ETag header that you received when retrieving the distribution that you're disassociating from the WAF web ACL.
The ID of the distribution.
" + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the distribution.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudfront#Distribution": { "type": "structure", "members": { @@ -7187,6 +8306,18 @@ "traits": { "smithy.api#documentation": "ID of the Anycast static IP list that is associated with the distribution.
" } + }, + "TenantConfig": { + "target": "com.amazonaws.cloudfront#TenantConfig", + "traits": { + "smithy.api#documentation": "A distribution tenant configuration.
" + } + }, + "ConnectionMode": { + "target": "com.amazonaws.cloudfront#ConnectionMode", + "traits": { + "smithy.api#documentation": "The connection mode to filter distributions by.
" + } } }, "traits": { @@ -7333,21 +8464,64 @@ "smithy.api#httpError": 409 } }, - "com.amazonaws.cloudfront#DistributionSummary": { + "com.amazonaws.cloudfront#DistributionResourceId": { "type": "structure", "members": { - "Id": { + "DistributionId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The identifier for the distribution. For example: EDFDVBD632BHDS5.
The ID of the multi-tenant distribution.
" } }, - "ARN": { + "DistributionTenantId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The ARN (Amazon Resource Name) for the distribution. For example:\n\t\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where\n\t\t\t\t123456789012 is your Amazon Web Services account ID.
The ID of the distribution tenant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The IDs for the distribution resources.
" + } + }, + "com.amazonaws.cloudfront#DistributionResourceType": { + "type": "enum", + "members": { + "Distribution": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "distribution" + } + }, + "DistributionTenant": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "distribution-tenant" + } + } + } + }, + "com.amazonaws.cloudfront#DistributionSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The identifier for the distribution. For example: EDFDVBD632BHDS5.
The ARN (Amazon Resource Name) for the distribution. For example:\n\t\t\t\tarn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where\n\t\t\t\t123456789012 is your Amazon Web Services account ID.
The current version of the distribution.
" } }, "Status": { @@ -7481,6 +8655,12 @@ "smithy.api#required": {} } }, + "ConnectionMode": { + "target": "com.amazonaws.cloudfront#ConnectionMode", + "traits": { + "smithy.api#documentation": "The connection mode to filter distributions by.
" + } + }, "AnycastIpListId": { "target": "com.amazonaws.cloudfront#string", "traits": { @@ -7501,6 +8681,376 @@ } } }, + "com.amazonaws.cloudfront#DistributionTenant": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the distribution tenant.
" + } + }, + "DistributionId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the multi-tenant distribution.
" + } + }, + "Name": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The name of the distribution tenant.
" + } + }, + "Arn": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the distribution tenant.
" + } + }, + "Domains": { + "target": "com.amazonaws.cloudfront#DomainResultList", + "traits": { + "smithy.api#documentation": "The domains associated with the distribution tenant.
" + } + }, + "Tags": { + "target": "com.amazonaws.cloudfront#Tags" + }, + "Customizations": { + "target": "com.amazonaws.cloudfront#Customizations", + "traits": { + "smithy.api#documentation": "Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
" + } + }, + "Parameters": { + "target": "com.amazonaws.cloudfront#Parameters", + "traits": { + "smithy.api#documentation": "A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
" + } + }, + "ConnectionGroupId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the connection group for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.cloudfront#timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the distribution tenant was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.cloudfront#timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the distribution tenant was updated.
" + } + }, + "Enabled": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the distribution tenant is in an enabled state. If disabled, the distribution tenant won't serve traffic.
" + } + }, + "Status": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The status of the distribution tenant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The distribution tenant.
" + } + }, + "com.amazonaws.cloudfront#DistributionTenantAssociationFilter": { + "type": "structure", + "members": { + "DistributionId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The distribution ID to filter by. You can find distribution tenants associated with a specific distribution.
" + } + }, + "ConnectionGroupId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the connection group to filter by. You can find distribution tenants associated with a specific connection group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Filter by the associated distribution ID or connection group ID.
" + } + }, + "com.amazonaws.cloudfront#DistributionTenantList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudfront#DistributionTenantSummary", + "traits": { + "smithy.api#xmlName": "DistributionTenantSummary" + } + } + }, + "com.amazonaws.cloudfront#DistributionTenantSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the distribution tenant.
", + "smithy.api#required": {} + } + }, + "DistributionId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The identifier for the multi-tenant distribution. For example: EDFDVBD632BHDS5.
The name of the distribution tenant.
", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the distribution tenant.
", + "smithy.api#required": {} + } + }, + "Domains": { + "target": "com.amazonaws.cloudfront#DomainResultList", + "traits": { + "smithy.api#documentation": "The domains associated with the distribution tenant.
", + "smithy.api#required": {} + } + }, + "ConnectionGroupId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the connection group ID for the distribution tenant. If you don't specify a connection group, CloudFront uses the default connection group.
" + } + }, + "Customizations": { + "target": "com.amazonaws.cloudfront#Customizations", + "traits": { + "smithy.api#documentation": "Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.cloudfront#timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the distribution tenant was created.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.cloudfront#timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the distribution tenant was updated.
", + "smithy.api#required": {} + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the distribution tenant.
", + "smithy.api#required": {} + } + }, + "Enabled": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the distribution tenants are in an enabled state. If disabled, the distribution tenant won't service traffic.
" + } + }, + "Status": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The status of the distribution tenant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the information about a distribution tenant.
" + } + }, + "com.amazonaws.cloudfront#DnsConfiguration": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The domain name that you're verifying.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.cloudfront#DnsConfigurationStatus", + "traits": { + "smithy.api#documentation": "The status of your domain name.
\n\n valid-configuration: The domain name is correctly configured and points to the correct routing endpoint of the connection group.
\n invalid-configuration: There is either a missing DNS record or the DNS record exists but it's using an incorrect routing endpoint. Update the DNS record to point to the correct routing endpoint.
\n unknown-configuration: CloudFront can't validate your DNS configuration. This status can appear if CloudFront can't verify the DNS record, or the DNS lookup request failed or timed out.
Explains the status of the DNS configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The DNS configuration for your domain names.
" + } + }, + "com.amazonaws.cloudfront#DnsConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudfront#DnsConfiguration", + "traits": { + "smithy.api#xmlName": "DnsConfiguration" + } + } + }, + "com.amazonaws.cloudfront#DnsConfigurationStatus": { + "type": "enum", + "members": { + "Valid": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "valid-configuration" + } + }, + "Invalid": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "invalid-configuration" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknown-configuration" + } + } + } + }, + "com.amazonaws.cloudfront#DomainConflict": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The domain used to find existing conflicts for domain configurations.
", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.cloudfront#DistributionResourceType", + "traits": { + "smithy.api#documentation": "The CloudFront resource type that has a domain conflict.
", + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the resource that has a domain conflict.
", + "smithy.api#required": {} + } + }, + "AccountId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account for the domain conflict.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the domain conflict. Use this information to determine the affected domain, the related resource, and the affected Amazon Web Services account.
" + } + }, + "com.amazonaws.cloudfront#DomainConflictsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudfront#DomainConflict", + "traits": { + "smithy.api#xmlName": "DomainConflicts" + } + } + }, + "com.amazonaws.cloudfront#DomainItem": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The domain name.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The domain for the specified distribution tenant.
" + } + }, + "com.amazonaws.cloudfront#DomainList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudfront#DomainItem" + } + }, + "com.amazonaws.cloudfront#DomainResult": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The specified domain.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.cloudfront#DomainStatus", + "traits": { + "smithy.api#documentation": "Whether the domain is active or inactive.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details about the domain result.
" + } + }, + "com.amazonaws.cloudfront#DomainResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudfront#DomainResult" + } + }, + "com.amazonaws.cloudfront#DomainStatus": { + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "active" + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inactive" + } + } + } + }, "com.amazonaws.cloudfront#EncryptionEntities": { "type": "structure", "members": { @@ -7573,12 +9123,12 @@ "KinesisStreamConfig": { "target": "com.amazonaws.cloudfront#KinesisStreamConfig", "traits": { - "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data.
" + "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data in a real-time log configuration.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you are sending real-time\n\t\t\tlog data in a real-time log configuration.
" + "smithy.api#documentation": "Contains information about the Amazon Kinesis data stream where you're sending real-time log data in a real-time log configuration.
" } }, "com.amazonaws.cloudfront#EndPointList": { @@ -8448,7 +9998,7 @@ "RestrictionType": { "target": "com.amazonaws.cloudfront#GeoRestrictionType", "traits": { - "smithy.api#documentation": "The method that you want to use to restrict distribution of your content by\n\t\t\tcountry:
\n\n none: No geo restriction is enabled, meaning access to content is\n\t\t\t\t\tnot restricted by client geo location.
\n blacklist: The Location elements specify the\n\t\t\t\t\tcountries in which you don't want CloudFront to distribute your content.
\n whitelist: The Location elements specify the\n\t\t\t\t\tcountries in which you want CloudFront to distribute your content.
The method that you want to use to restrict distribution of your content by country:
\n\n none: No geo restriction is enabled, meaning access to content is\n\t\t\t\t\tnot restricted by client geo location.
\n blacklist: The Location elements specify the\n\t\t\t\t\tcountries in which you don't want CloudFront to distribute your content.
\n whitelist: The Location elements specify the\n\t\t\t\t\tcountries in which you want CloudFront to distribute your content.
A complex type that controls the countries in which your content is distributed. CloudFront\n\t\t\tdetermines the location of your users using MaxMind GeoIP databases.\n\t\t
The method that you want to use to restrict distribution of your content by\n\t\t\tcountry:
\n\n none: No geographic restriction is enabled, meaning access to content is\n\t\t\t\t\tnot restricted by client geo location.
\n blacklist: The Location elements specify the\n\t\t\t\t\tcountries in which you don't want CloudFront to distribute your content.
\n whitelist: The Location elements specify the\n\t\t\t\t\tcountries in which you want CloudFront to distribute your content.
The locations for geographic restrictions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The customizations that you specified for the distribution tenant for geographic restrictions.
" + } + }, "com.amazonaws.cloudfront#GeoRestrictionType": { "type": "enum", "members": { @@ -8666,155 +10237,280 @@ "smithy.api#input": {} } }, - "com.amazonaws.cloudfront#GetCachePolicyResult": { + "com.amazonaws.cloudfront#GetCachePolicyResult": { + "type": "structure", + "members": { + "CachePolicy": { + "target": "com.amazonaws.cloudfront#CachePolicy", + "traits": { + "smithy.api#documentation": "The cache policy.
", + "smithy.api#httpPayload": {} + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the cache policy.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentity": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchCloudFrontOriginAccessIdentity" + } + ], + "traits": { + "smithy.api#documentation": "Get the information about an origin access identity.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-05-31/origin-access-identity/cloudfront/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfigRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfigResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchCloudFrontOriginAccessIdentity" + } + ], + "traits": { + "smithy.api#documentation": "Get the configuration information about an origin access identity.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-05-31/origin-access-identity/cloudfront/{Id}/config", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfigRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The identity's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The origin access identity's configuration information. For more information, see\n\t\t\t\tCloudFrontOriginAccessIdentityConfig.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfigResult": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityConfig": { + "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityConfig", + "traits": { + "smithy.api#documentation": "The origin access identity's configuration information.
", + "smithy.api#httpPayload": {} + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the configuration. For example:\n\t\t\tE2QWRUHAPOMQZL.
The returned result of the corresponding request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The identity's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request to get an origin access identity's information.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityResult": { "type": "structure", "members": { - "CachePolicy": { - "target": "com.amazonaws.cloudfront#CachePolicy", + "CloudFrontOriginAccessIdentity": { + "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentity", "traits": { - "smithy.api#documentation": "The cache policy.
", + "smithy.api#documentation": "The origin access identity's information.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The current version of the cache policy.
", + "smithy.api#documentation": "The current version of the origin access identity's information. For example:\n\t\t\t\tE2QWRUHAPOMQZL.
The returned result of the corresponding request.
", "smithy.api#output": {} } }, - "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentity": { + "com.amazonaws.cloudfront#GetConnectionGroup": { "type": "operation", "input": { - "target": "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityRequest" + "target": "com.amazonaws.cloudfront#GetConnectionGroupRequest" }, "output": { - "target": "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityResult" + "target": "com.amazonaws.cloudfront#GetConnectionGroupResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { - "target": "com.amazonaws.cloudfront#NoSuchCloudFrontOriginAccessIdentity" + "target": "com.amazonaws.cloudfront#EntityNotFound" } ], "traits": { - "smithy.api#documentation": "Get the information about an origin access identity.
", + "smithy.api#documentation": "Gets information about a connection group.
", "smithy.api#http": { "method": "GET", - "uri": "/2020-05-31/origin-access-identity/cloudfront/{Id}", + "uri": "/2020-05-31/connection-group/{Identifier}", "code": 200 } } }, - "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfig": { + "com.amazonaws.cloudfront#GetConnectionGroupByRoutingEndpoint": { "type": "operation", "input": { - "target": "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfigRequest" + "target": "com.amazonaws.cloudfront#GetConnectionGroupByRoutingEndpointRequest" }, "output": { - "target": "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfigResult" + "target": "com.amazonaws.cloudfront#GetConnectionGroupByRoutingEndpointResult" }, "errors": [ { "target": "com.amazonaws.cloudfront#AccessDenied" }, { - "target": "com.amazonaws.cloudfront#NoSuchCloudFrontOriginAccessIdentity" + "target": "com.amazonaws.cloudfront#EntityNotFound" } ], "traits": { - "smithy.api#documentation": "Get the configuration information about an origin access identity.
", + "smithy.api#documentation": "Gets information about a connection group by using the endpoint that you specify.
", "smithy.api#http": { "method": "GET", - "uri": "/2020-05-31/origin-access-identity/cloudfront/{Id}/config", + "uri": "/2020-05-31/connection-group", "code": 200 } } }, - "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfigRequest": { + "com.amazonaws.cloudfront#GetConnectionGroupByRoutingEndpointRequest": { "type": "structure", "members": { - "Id": { + "RoutingEndpoint": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The identity's ID.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The routing endpoint for the target connection group, such as d111111abcdef8.cloudfront.net.
", + "smithy.api#httpQuery": "RoutingEndpoint", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The origin access identity's configuration information. For more information, see\n\t\t\t\tCloudFrontOriginAccessIdentityConfig.
", "smithy.api#input": {} } }, - "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityConfigResult": { + "com.amazonaws.cloudfront#GetConnectionGroupByRoutingEndpointResult": { "type": "structure", "members": { - "CloudFrontOriginAccessIdentityConfig": { - "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityConfig", + "ConnectionGroup": { + "target": "com.amazonaws.cloudfront#ConnectionGroup", "traits": { - "smithy.api#documentation": "The origin access identity's configuration information.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The current version of the configuration. For example:\n\t\t\tE2QWRUHAPOMQZL.
The current version of the connection group.
", "smithy.api#httpHeader": "ETag" } } }, "traits": { - "smithy.api#documentation": "The returned result of the corresponding request.
", "smithy.api#output": {} } }, - "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityRequest": { + "com.amazonaws.cloudfront#GetConnectionGroupRequest": { "type": "structure", "members": { - "Id": { + "Identifier": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The identity's ID.
", + "smithy.api#documentation": "The ID, name, or Amazon Resource Name (ARN) of the connection group.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The request to get an origin access identity's information.
", "smithy.api#input": {} } }, - "com.amazonaws.cloudfront#GetCloudFrontOriginAccessIdentityResult": { + "com.amazonaws.cloudfront#GetConnectionGroupResult": { "type": "structure", "members": { - "CloudFrontOriginAccessIdentity": { - "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentity", + "ConnectionGroup": { + "target": "com.amazonaws.cloudfront#ConnectionGroup", "traits": { - "smithy.api#documentation": "The origin access identity's information.
", + "smithy.api#documentation": "The connection group that you retrieved.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The current version of the origin access identity's information. For example:\n\t\t\t\tE2QWRUHAPOMQZL.
The current version of the connection group.
", "smithy.api#httpHeader": "ETag" } } }, "traits": { - "smithy.api#documentation": "The returned result of the corresponding request.
", "smithy.api#output": {} } }, @@ -9092,6 +10788,131 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudfront#GetDistributionTenant": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#GetDistributionTenantRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#GetDistributionTenantResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a distribution tenant.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-05-31/distribution-tenant/{Identifier}", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#GetDistributionTenantByDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#GetDistributionTenantByDomainRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#GetDistributionTenantByDomainResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a distribution tenant by the associated domain.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-05-31/distribution-tenant", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#GetDistributionTenantByDomainRequest": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "A domain name associated with the target distribution tenant.
", + "smithy.api#httpQuery": "domain", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#GetDistributionTenantByDomainResult": { + "type": "structure", + "members": { + "DistributionTenant": { + "target": "com.amazonaws.cloudfront#DistributionTenant", + "traits": { + "smithy.api#httpPayload": {} + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the distribution tenant.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudfront#GetDistributionTenantRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the distribution tenant. You can specify the ARN ID, or name of the distribution tenant.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#GetDistributionTenantResult": { + "type": "structure", + "members": { + "DistributionTenant": { + "target": "com.amazonaws.cloudfront#DistributionTenant", + "traits": { + "smithy.api#documentation": "The distribution tenant that you retrieved.
", + "smithy.api#httpPayload": {} + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the distribution tenant.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudfront#GetFieldLevelEncryption": { "type": "operation", "input": { @@ -9468,6 +11289,91 @@ } } }, + "com.amazonaws.cloudfront#GetInvalidationForDistributionTenant": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#GetInvalidationForDistributionTenantRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#GetInvalidationForDistributionTenantResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchInvalidation" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a specific invalidation for a distribution tenant.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-05-31/distribution-tenant/{DistributionTenantId}/invalidation/{Id}", + "code": 200 + }, + "smithy.waiters#waitable": { + "InvalidationForDistributionTenantCompleted": { + "documentation": "Wait until an invalidation for distribution tenant has completed.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Invalidation.Status", + "expected": "Completed", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 20, + "maxDelay": 600 + } + } + } + }, + "com.amazonaws.cloudfront#GetInvalidationForDistributionTenantRequest": { + "type": "structure", + "members": { + "DistributionTenantId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the distribution tenant.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the invalidation to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#GetInvalidationForDistributionTenantResult": { + "type": "structure", + "members": { + "Invalidation": { + "target": "com.amazonaws.cloudfront#Invalidation", + "traits": { + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudfront#GetInvalidationRequest": { "type": "structure", "members": { @@ -9575,7 +11481,45 @@ "KeyGroupConfig": { "target": "com.amazonaws.cloudfront#KeyGroupConfig", "traits": { - "smithy.api#documentation": "The key group configuration.
", + "smithy.api#documentation": "The key group configuration.
", + "smithy.api#httpPayload": {} + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The identifier for this version of the key group.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudfront#GetKeyGroupRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The identifier of the key group that you are getting. To get the identifier, use\n\t\t\t\tListKeyGroups.
The key group.
", "smithy.api#httpPayload": {} } }, @@ -9591,13 +11535,38 @@ "smithy.api#output": {} } }, - "com.amazonaws.cloudfront#GetKeyGroupRequest": { + "com.amazonaws.cloudfront#GetManagedCertificateDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#GetManagedCertificateDetailsRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#GetManagedCertificateDetailsResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Gets details about the CloudFront managed ACM certificate.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-05-31/managed-certificate/{Identifier}", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#GetManagedCertificateDetailsRequest": { "type": "structure", "members": { - "Id": { + "Identifier": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The identifier of the key group that you are getting. To get the identifier, use\n\t\t\t\tListKeyGroups.
The identifier of the multi-tenant distribution.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9607,22 +11576,15 @@ "smithy.api#input": {} } }, - "com.amazonaws.cloudfront#GetKeyGroupResult": { + "com.amazonaws.cloudfront#GetManagedCertificateDetailsResult": { "type": "structure", "members": { - "KeyGroup": { - "target": "com.amazonaws.cloudfront#KeyGroup", + "ManagedCertificateDetails": { + "target": "com.amazonaws.cloudfront#ManagedCertificateDetails", "traits": { - "smithy.api#documentation": "The key group.
", + "smithy.api#documentation": "Contains details about the CloudFront managed ACM certificate.
", "smithy.api#httpPayload": {} } - }, - "ETag": { - "target": "com.amazonaws.cloudfront#string", - "traits": { - "smithy.api#documentation": "The identifier for this version of the key group.
", - "smithy.api#httpHeader": "ETag" - } } }, "traits": { @@ -10716,6 +12678,19 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudfront#InvalidAssociation": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "The specified CloudFront resource can't be associated.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.cloudfront#InvalidDefaultRootObject": { "type": "structure", "members": { @@ -11782,129 +13757,389 @@ "smithy.api#output": {} } }, - "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentities": { + "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentities": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentitiesRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentitiesResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + } + ], + "traits": { + "smithy.api#documentation": "Lists origin access identities.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-05-31/origin-access-identity/cloudfront", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "CloudFrontOriginAccessIdentityList.NextMarker", + "items": "CloudFrontOriginAccessIdentityList.Items", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentitiesRequest": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "Use this when paginating results to indicate where to begin in your list of origin\n\t\t\taccess identities. The results include identities in the list that occur after the\n\t\t\tmarker. To get the next page of results, set the Marker to the value of the\n\t\t\t\tNextMarker from the current page's response (which is also the ID of\n\t\t\tthe last identity on that page).
The maximum number of origin access identities you want in the response body.
", + "smithy.api#httpQuery": "MaxItems" + } + } + }, + "traits": { + "smithy.api#documentation": "The request to list origin access identities.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentitiesResult": { + "type": "structure", + "members": { + "CloudFrontOriginAccessIdentityList": { + "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityList", + "traits": { + "smithy.api#documentation": "The CloudFrontOriginAccessIdentityList type.
The returned result of the corresponding request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudfront#ListConflictingAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#ListConflictingAliasesRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#ListConflictingAliasesResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchDistribution" + } + ], + "traits": { + "smithy.api#documentation": "Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or\n\t\t\toverlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services\n\t\t\taccounts for each conflicting alias. In the returned list, the distribution and account\n\t\t\tIDs are partially hidden, which allows you to identify the distributions and accounts\n\t\t\tthat you own, but helps to protect the information of ones that you don't own.
\nUse this operation to find aliases that are in use in CloudFront that conflict or overlap\n\t\t\twith the provided alias. For example, if you provide www.example.com as\n\t\t\tinput, the returned list can include www.example.com and the overlapping\n\t\t\twildcard alternate domain name (*.example.com), if they exist. If you\n\t\t\tprovide *.example.com as input, the returned list can include\n\t\t\t\t*.example.com and any alternate domain names covered by that wildcard\n\t\t\t(for example, www.example.com, test.example.com,\n\t\t\t\tdev.example.com, and so on), if they exist.
To list conflicting aliases, you provide the alias to search and the ID of a\n\t\t\tdistribution in your account that has an attached SSL/TLS certificate that includes the\n\t\t\tprovided alias. For more information, including how to set up the distribution and\n\t\t\tcertificate, see Moving an alternate domain name to a different\n\t\t\t\tdistribution in the Amazon CloudFront Developer Guide.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
The ID of a distribution in your account that has an attached SSL/TLS certificate that\n\t\t\tincludes the provided alias.
", + "smithy.api#httpQuery": "DistributionId", + "smithy.api#required": {} + } + }, + "Alias": { + "target": "com.amazonaws.cloudfront#aliasString", + "traits": { + "smithy.api#documentation": "The alias (also called a CNAME) to search for conflicting aliases.
", + "smithy.api#httpQuery": "Alias", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "Use this field when paginating results to indicate where to begin in the list of\n\t\t\tconflicting aliases. The response includes conflicting aliases in the list that occur\n\t\t\tafter the marker. To get the next page of the list, set this field's value to the value\n\t\t\tof NextMarker from the current page's response.
The maximum number of conflicting aliases that you want in the response.
", + "smithy.api#httpQuery": "MaxItems" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#ListConflictingAliasesResult": { + "type": "structure", + "members": { + "ConflictingAliasesList": { + "target": "com.amazonaws.cloudfront#ConflictingAliasesList", + "traits": { + "smithy.api#documentation": "A list of conflicting aliases.
", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudfront#ListConnectionGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#ListConnectionGroupsRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#ListConnectionGroupsResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + } + ], + "traits": { + "smithy.api#documentation": "Lists the connection groups in your Amazon Web Services account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-05-31/connection-groups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "ConnectionGroups", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.cloudfront#ListConnectionGroupsRequest": { + "type": "structure", + "members": { + "AssociationFilter": { + "target": "com.amazonaws.cloudfront#ConnectionGroupAssociationFilter", + "traits": { + "smithy.api#documentation": "Filter by associated Anycast IP list ID.
" + } + }, + "Marker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The marker for the next set of connection groups to retrieve.
" + } + }, + "MaxItems": { + "target": "com.amazonaws.cloudfront#integer", + "traits": { + "smithy.api#documentation": "The maximum number of connection groups to return.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#ListConnectionGroupsResult": { + "type": "structure", + "members": { + "NextMarker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.
" + } + }, + "ConnectionGroups": { + "target": "com.amazonaws.cloudfront#ConnectionGroupSummaryList", + "traits": { + "smithy.api#documentation": "The list of connection groups that you retrieved.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudfront#ListContinuousDeploymentPolicies": { "type": "operation", "input": { - "target": "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentitiesRequest" + "target": "com.amazonaws.cloudfront#ListContinuousDeploymentPoliciesRequest" }, "output": { - "target": "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentitiesResult" + "target": "com.amazonaws.cloudfront#ListContinuousDeploymentPoliciesResult" }, "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, { "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#NoSuchContinuousDeploymentPolicy" } ], "traits": { - "smithy.api#documentation": "Lists origin access identities.
", + "smithy.api#documentation": "Gets a list of the continuous deployment policies in your Amazon Web Services account.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Use this when paginating results to indicate where to begin in your list of origin\n\t\t\taccess identities. The results include identities in the list that occur after the\n\t\t\tmarker. To get the next page of results, set the Marker to the value of the\n\t\t\t\tNextMarker from the current page's response (which is also the ID of\n\t\t\tthe last identity on that page).
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tcontinuous deployment policies. The response includes policies in the list that occur\n\t\t\tafter the marker. To get the next page of the list, set this field's value to the value\n\t\t\tof NextMarker from the current page's response.
The maximum number of origin access identities you want in the response body.
", + "smithy.api#documentation": "The maximum number of continuous deployment policies that you want returned in the\n\t\t\tresponse.
", "smithy.api#httpQuery": "MaxItems" } } }, "traits": { - "smithy.api#documentation": "The request to list origin access identities.
", "smithy.api#input": {} } }, - "com.amazonaws.cloudfront#ListCloudFrontOriginAccessIdentitiesResult": { + "com.amazonaws.cloudfront#ListContinuousDeploymentPoliciesResult": { "type": "structure", "members": { - "CloudFrontOriginAccessIdentityList": { - "target": "com.amazonaws.cloudfront#CloudFrontOriginAccessIdentityList", + "ContinuousDeploymentPolicyList": { + "target": "com.amazonaws.cloudfront#ContinuousDeploymentPolicyList", "traits": { - "smithy.api#documentation": "The CloudFrontOriginAccessIdentityList type.
A list of continuous deployment policies.
", "smithy.api#httpPayload": {} } } }, "traits": { - "smithy.api#documentation": "The returned result of the corresponding request.
", "smithy.api#output": {} } }, - "com.amazonaws.cloudfront#ListConflictingAliases": { + "com.amazonaws.cloudfront#ListDistributionTenants": { "type": "operation", "input": { - "target": "com.amazonaws.cloudfront#ListConflictingAliasesRequest" + "target": "com.amazonaws.cloudfront#ListDistributionTenantsRequest" }, "output": { - "target": "com.amazonaws.cloudfront#ListConflictingAliasesResult" + "target": "com.amazonaws.cloudfront#ListDistributionTenantsResult" }, "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, { "target": "com.amazonaws.cloudfront#InvalidArgument" + } + ], + "traits": { + "smithy.api#documentation": "Lists the distribution tenants in your Amazon Web Services account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-05-31/distribution-tenants", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "DistributionTenantList", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.cloudfront#ListDistributionTenantsByCustomization": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#ListDistributionTenantsByCustomizationRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#ListDistributionTenantsByCustomizationResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" }, { - "target": "com.amazonaws.cloudfront#NoSuchDistribution" + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" } ], "traits": { - "smithy.api#documentation": "Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or\n\t\t\toverlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services\n\t\t\taccounts for each conflicting alias. In the returned list, the distribution and account\n\t\t\tIDs are partially hidden, which allows you to identify the distributions and accounts\n\t\t\tthat you own, but helps to protect the information of ones that you don't own.
\nUse this operation to find aliases that are in use in CloudFront that conflict or overlap\n\t\t\twith the provided alias. For example, if you provide www.example.com as\n\t\t\tinput, the returned list can include www.example.com and the overlapping\n\t\t\twildcard alternate domain name (*.example.com), if they exist. If you\n\t\t\tprovide *.example.com as input, the returned list can include\n\t\t\t\t*.example.com and any alternate domain names covered by that wildcard\n\t\t\t(for example, www.example.com, test.example.com,\n\t\t\t\tdev.example.com, and so on), if they exist.
To list conflicting aliases, you provide the alias to search and the ID of a\n\t\t\tdistribution in your account that has an attached SSL/TLS certificate that includes the\n\t\t\tprovided alias. For more information, including how to set up the distribution and\n\t\t\tcertificate, see Moving an alternate domain name to a different\n\t\t\t\tdistribution in the Amazon CloudFront Developer Guide.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Lists distribution tenants by the customization that you specify.
\nYou must specify either the CertificateArn parameter or WebACLArn parameter, but not both in the same request.
The ID of a distribution in your account that has an attached SSL/TLS certificate that\n\t\t\tincludes the provided alias.
", - "smithy.api#httpQuery": "DistributionId", - "smithy.api#required": {} + "smithy.api#documentation": "Filter by the ARN of the associated WAF web ACL.
" } }, - "Alias": { - "target": "com.amazonaws.cloudfront#aliasString", + "CertificateArn": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The alias (also called a CNAME) to search for conflicting aliases.
", - "smithy.api#httpQuery": "Alias", - "smithy.api#required": {} + "smithy.api#documentation": "Filter by the ARN of the associated ACM certificate.
" } }, "Marker": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "Use this field when paginating results to indicate where to begin in the list of\n\t\t\tconflicting aliases. The response includes conflicting aliases in the list that occur\n\t\t\tafter the marker. To get the next page of the list, set this field's value to the value\n\t\t\tof NextMarker from the current page's response.
The marker for the next set of results.
" } }, "MaxItems": { - "target": "com.amazonaws.cloudfront#listConflictingAliasesMaxItemsInteger", + "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The maximum number of conflicting aliases that you want in the response.
", - "smithy.api#httpQuery": "MaxItems" + "smithy.api#documentation": "The maximum number of distribution tenants to return by the specified customization.
" } } }, @@ -11912,14 +14147,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.cloudfront#ListConflictingAliasesResult": { + "com.amazonaws.cloudfront#ListDistributionTenantsByCustomizationResult": { "type": "structure", "members": { - "ConflictingAliasesList": { - "target": "com.amazonaws.cloudfront#ConflictingAliasesList", + "NextMarker": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "A list of conflicting aliases.
", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.
" + } + }, + "DistributionTenantList": { + "target": "com.amazonaws.cloudfront#DistributionTenantList", + "traits": { + "smithy.api#documentation": "A list of distribution tenants with the specified customization.
" } } }, @@ -11927,49 +14167,22 @@ "smithy.api#output": {} } }, - "com.amazonaws.cloudfront#ListContinuousDeploymentPolicies": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudfront#ListContinuousDeploymentPoliciesRequest" - }, - "output": { - "target": "com.amazonaws.cloudfront#ListContinuousDeploymentPoliciesResult" - }, - "errors": [ - { - "target": "com.amazonaws.cloudfront#AccessDenied" - }, - { - "target": "com.amazonaws.cloudfront#InvalidArgument" - }, - { - "target": "com.amazonaws.cloudfront#NoSuchContinuousDeploymentPolicy" - } - ], - "traits": { - "smithy.api#documentation": "Gets a list of the continuous deployment policies in your Amazon Web Services account.
\nYou can optionally specify the maximum number of items to receive in the response. If\n\t\t\tthe total number of items in the list exceeds the maximum that you specify, or the\n\t\t\tdefault maximum, the response is paginated. To get the next page of items, send a\n\t\t\tsubsequent request that specifies the NextMarker value from the current\n\t\t\tresponse as the Marker value in the subsequent request.
Use this field when paginating results to indicate where to begin in your list of\n\t\t\tcontinuous deployment policies. The response includes policies in the list that occur\n\t\t\tafter the marker. To get the next page of the list, set this field's value to the value\n\t\t\tof NextMarker from the current page's response.
The marker for the next set of results.
" } }, "MaxItems": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The maximum number of continuous deployment policies that you want returned in the\n\t\t\tresponse.
", - "smithy.api#httpQuery": "MaxItems" + "smithy.api#documentation": "The maximum number of distribution tenants to return.
" } } }, @@ -11977,14 +14190,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.cloudfront#ListContinuousDeploymentPoliciesResult": { + "com.amazonaws.cloudfront#ListDistributionTenantsResult": { "type": "structure", "members": { - "ContinuousDeploymentPolicyList": { - "target": "com.amazonaws.cloudfront#ContinuousDeploymentPolicyList", + "NextMarker": { + "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "A list of continuous deployment policies.
", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.
" + } + }, + "DistributionTenantList": { + "target": "com.amazonaws.cloudfront#DistributionTenantList", + "traits": { + "smithy.api#documentation": "The list of distribution tenants that you retrieved.
" } } }, @@ -12168,6 +14386,81 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudfront#ListDistributionsByConnectionMode": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#ListDistributionsByConnectionModeRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#ListDistributionsByConnectionModeResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + } + ], + "traits": { + "smithy.api#documentation": "Lists the distributions by the connection mode that you specify.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-05-31/distributionsByConnectionMode/{ConnectionMode}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "DistributionList.NextMarker", + "items": "DistributionList.Items", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.cloudfront#ListDistributionsByConnectionModeRequest": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The marker for the next set of distributions to retrieve.
", + "smithy.api#httpQuery": "Marker" + } + }, + "MaxItems": { + "target": "com.amazonaws.cloudfront#integer", + "traits": { + "smithy.api#documentation": "The maximum number of distributions to return.
", + "smithy.api#httpQuery": "MaxItems" + } + }, + "ConnectionMode": { + "target": "com.amazonaws.cloudfront#ConnectionMode", + "traits": { + "smithy.api#documentation": "The connection mode to filter distributions by.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#ListDistributionsByConnectionModeResult": { + "type": "structure", + "members": { + "DistributionList": { + "target": "com.amazonaws.cloudfront#DistributionList", + "traits": { + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudfront#ListDistributionsByKeyGroup": { "type": "operation", "input": { @@ -12588,18 +14881,57 @@ "WebACLId": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The ID of the WAF web ACL that you want to list the associated distributions. If you\n\t\t\tspecify \"null\" for the ID, the request returns a list of the distributions that aren't\n\t\t\tassociated with a web ACL.
\nFor WAFV2, this is the ARN of the web ACL, such as\n\t\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
For WAF Classic, this is the ID of the web ACL, such as a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
The ID of the WAF web ACL that you want to list the associated distributions. If you\n\t\t\tspecify \"null\" for the ID, the request returns a list of the distributions that aren't\n\t\t\tassociated with a web ACL.
\nFor WAFV2, this is the ARN of the web ACL, such as\n\t\t\t\tarn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
For WAF Classic, this is the ID of the web ACL, such as a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
The request to list distributions that are associated with a specified WAF web\n\t\t\tACL.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#ListDistributionsByWebACLIdResult": { + "type": "structure", + "members": { + "DistributionList": { + "target": "com.amazonaws.cloudfront#DistributionList", + "traits": { + "smithy.api#documentation": "The DistributionList type.
The response to a request to list the distributions that are associated with a\n\t\t\tspecified WAF web ACL.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudfront#ListDistributionsRequest": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "Use this when paginating results to indicate where to begin in your list of\n\t\t\tdistributions. The results include distributions in the list that occur after the\n\t\t\tmarker. To get the next page of results, set the Marker to the value of the\n\t\t\t\tNextMarker from the current page's response (which is also the ID of\n\t\t\tthe last distribution on that page).
The maximum number of distributions you want in the response body.
", + "smithy.api#httpQuery": "MaxItems" } } }, "traits": { - "smithy.api#documentation": "The request to list distributions that are associated with a specified WAF web\n\t\t\tACL.
", + "smithy.api#documentation": "The request to list your distributions.
", "smithy.api#input": {} } }, - "com.amazonaws.cloudfront#ListDistributionsByWebACLIdResult": { + "com.amazonaws.cloudfront#ListDistributionsResult": { "type": "structure", "members": { "DistributionList": { @@ -12611,46 +14943,95 @@ } }, "traits": { - "smithy.api#documentation": "The response to a request to list the distributions that are associated with a\n\t\t\tspecified WAF web ACL.
", + "smithy.api#documentation": "The returned result of the corresponding request.
", "smithy.api#output": {} } }, - "com.amazonaws.cloudfront#ListDistributionsRequest": { + "com.amazonaws.cloudfront#ListDomainConflicts": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#ListDomainConflictsRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#ListDomainConflictsResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + } + ], + "traits": { + "smithy.api#documentation": "Lists existing domain associations that conflict with the domain that you specify.
\nYou can use this API operation when transferring domains to identify potential domain conflicts. Domain conflicts must be resolved first before they can be moved.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-05-31/domain-conflicts", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "DomainConflicts", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.cloudfront#ListDomainConflictsRequest": { "type": "structure", "members": { - "Marker": { + "Domain": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "Use this when paginating results to indicate where to begin in your list of\n\t\t\tdistributions. The results include distributions in the list that occur after the\n\t\t\tmarker. To get the next page of results, set the Marker to the value of the\n\t\t\t\tNextMarker from the current page's response (which is also the ID of\n\t\t\tthe last distribution on that page).
The domain to check for conflicts.
", + "smithy.api#required": {} + } + }, + "DomainControlValidationResource": { + "target": "com.amazonaws.cloudfront#DistributionResourceId", + "traits": { + "smithy.api#documentation": "The distribution resource identifier. This can be the distribution or distribution tenant that has a\n\t\t\tvalid certificate, which covers the domain that you specify.
", + "smithy.api#required": {} } }, "MaxItems": { "target": "com.amazonaws.cloudfront#integer", "traits": { - "smithy.api#documentation": "The maximum number of distributions you want in the response body.
", - "smithy.api#httpQuery": "MaxItems" + "smithy.api#documentation": "The maximum number of domain conflicts to return.
" + } + }, + "Marker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The marker for the next set of domain conflicts.
" } } }, "traits": { - "smithy.api#documentation": "The request to list your distributions.
", "smithy.api#input": {} } }, - "com.amazonaws.cloudfront#ListDistributionsResult": { + "com.amazonaws.cloudfront#ListDomainConflictsResult": { "type": "structure", "members": { - "DistributionList": { - "target": "com.amazonaws.cloudfront#DistributionList", + "DomainConflicts": { + "target": "com.amazonaws.cloudfront#DomainConflictsList", "traits": { - "smithy.api#documentation": "The DistributionList type.
Contains details about the domain conflicts.
" + } + }, + "NextMarker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "A token used for pagination of results returned in the response. You can use the token from the previous request to define where the current request should begin.
" } } }, "traits": { - "smithy.api#documentation": "The returned result of the corresponding request.
", "smithy.api#output": {} } }, @@ -12875,6 +15256,84 @@ } } }, + "com.amazonaws.cloudfront#ListInvalidationsForDistributionTenant": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#ListInvalidationsForDistributionTenantRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#ListInvalidationsForDistributionTenantResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + } + ], + "traits": { + "smithy.api#documentation": "Lists the invalidations for a distribution tenant.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2020-05-31/distribution-tenant/{Id}/invalidation", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "InvalidationList.NextMarker", + "items": "InvalidationList.Items", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.cloudfront#ListInvalidationsForDistributionTenantRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the distribution tenant.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "Use this parameter when paginating results to indicate where to begin in your list of\n\t\t\tinvalidation batches. Because the results are returned in decreasing order from most\n\t\t\trecent to oldest, the most recent results are on the first page, the second page will\n\t\t\tcontain earlier results, and so on. To get the next page of results, set\n\t\t\t\tMarker to the value of the NextMarker from the current\n\t\t\tpage's response. This value is the same as the ID of the last invalidation batch on that\n\t\t\tpage.
The maximum number of invalidations to return for the distribution tenant.
", + "smithy.api#httpQuery": "MaxItems" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#ListInvalidationsForDistributionTenantResult": { + "type": "structure", + "members": { + "InvalidationList": { + "target": "com.amazonaws.cloudfront#InvalidationList", + "traits": { + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudfront#ListInvalidationsRequest": { "type": "structure", "members": { @@ -13692,6 +16151,112 @@ "smithy.api#documentation": "A complex type that specifies whether access logs are written for the distribution.
\nIf you already enabled standard logging (legacy) and you want to enable standard logging\n\t\t\t\t(v2) to send your access logs to Amazon S3, we recommend that you specify a\n\t\t\t\t\tdifferent Amazon S3 bucket or use a separate\n\t\t\t\t\tpath in the same bucket (for example, use a log prefix or\n\t\t\t\tpartitioning). This helps you keep track of which log files are associated with\n\t\t\t\twhich logging subscription and prevents log files from overwriting each other. For\n\t\t\t\tmore information, see Standard logging (access logs) in the\n\t\t\t\t\tAmazon CloudFront Developer Guide.
\nThe ARN of the CloudFront managed ACM certificate.
" + } + }, + "CertificateStatus": { + "target": "com.amazonaws.cloudfront#ManagedCertificateStatus", + "traits": { + "smithy.api#documentation": "The status of the CloudFront managed ACM certificate.
\nYour distribution tenant will be updated with the latest certificate status. When calling the UpdateDistributionTenant operation, use the latest value for the ETag.
Contains details about the validation token host of the specified CloudFront managed ACM certificate.
\nFor cloudfront, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.
For self-hosted, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.
This setting only affects the initial certificate request. Once the DNS points to CloudFront, all future certificate renewals are automatically handled through CloudFront.
\nContains details about the validation token of the specified CloudFront managed ACM certificate.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the CloudFront managed ACM certificate.
" + } + }, + "com.amazonaws.cloudfront#ManagedCertificateRequest": { + "type": "structure", + "members": { + "ValidationTokenHost": { + "target": "com.amazonaws.cloudfront#ValidationTokenHost", + "traits": { + "smithy.api#documentation": "Specify how the HTTP validation token will be served when requesting the CloudFront managed ACM certificate.
\nFor cloudfront, CloudFront will automatically serve the validation token. Choose this mode if you can point the domain's DNS to CloudFront immediately.
For self-hosted, you serve the validation token from your existing infrastructure. Choose this mode when you need to maintain current traffic flow while your certificate is being issued. You can place the validation token at the well-known path on your existing web server, wait for ACM to validate and issue the certificate, and then update your DNS to point to CloudFront.
The primary domain name associated with the CloudFront managed ACM certificate.
" + } + }, + "CertificateTransparencyLoggingPreference": { + "target": "com.amazonaws.cloudfront#CertificateTransparencyLoggingPreference", + "traits": { + "smithy.api#documentation": "You can opt out of certificate transparency logging by specifying the disabled\n\t\t\toption. Opt in by specifying enabled. For more information, see Certificate\n\t\t\t\tTransparency Logging in the Certificate Manager User\n\t\t\tGuide.
An object that represents the request for the Amazon CloudFront managed ACM certificate.
" + } + }, + "com.amazonaws.cloudfront#ManagedCertificateStatus": { + "type": "enum", + "members": { + "PendingValidation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending-validation" + } + }, + "Issued": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "issued" + } + }, + "Inactive": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "inactive" + } + }, + "Expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "expired" + } + }, + "ValidationTimedOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "validation-timed-out" + } + }, + "Revoked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "revoked" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + } + } + }, "com.amazonaws.cloudfront#Method": { "type": "enum", "members": { @@ -14997,23 +17562,112 @@ "com.amazonaws.cloudfront#Origins": { "type": "structure", "members": { - "Quantity": { - "target": "com.amazonaws.cloudfront#integer", - "traits": { - "smithy.api#documentation": "The number of origins for this distribution.
", - "smithy.api#required": {} - } - }, - "Items": { - "target": "com.amazonaws.cloudfront#OriginList", + "Quantity": { + "target": "com.amazonaws.cloudfront#integer", + "traits": { + "smithy.api#documentation": "The number of origins for this distribution.
", + "smithy.api#required": {} + } + }, + "Items": { + "target": "com.amazonaws.cloudfront#OriginList", + "traits": { + "smithy.api#documentation": "A list of origins.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the origins for this distribution.
" + } + }, + "com.amazonaws.cloudfront#Parameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudfront#ParameterName", + "traits": { + "smithy.api#documentation": "The parameter name.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.cloudfront#ParameterValue", + "traits": { + "smithy.api#documentation": "The parameter value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
" + } + }, + "com.amazonaws.cloudfront#ParameterDefinition": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudfront#ParameterName", + "traits": { + "smithy.api#documentation": "The name of the parameter.
", + "smithy.api#required": {} + } + }, + "Definition": { + "target": "com.amazonaws.cloudfront#ParameterDefinitionSchema", + "traits": { + "smithy.api#documentation": "The value that you assigned to the parameter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
" + } + }, + "com.amazonaws.cloudfront#ParameterDefinitionSchema": { + "type": "structure", + "members": { + "StringSchema": { + "target": "com.amazonaws.cloudfront#StringSchemaConfig", "traits": { - "smithy.api#documentation": "A list of origins.
", - "smithy.api#required": {} + "smithy.api#documentation": "An object that contains information about the string schema.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about the origins for this distribution.
" + "smithy.api#documentation": "An object that contains information about the parameter definition.
" + } + }, + "com.amazonaws.cloudfront#ParameterDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudfront#ParameterDefinition" + } + }, + "com.amazonaws.cloudfront#ParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.cloudfront#ParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudfront#Parameters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudfront#Parameter" } }, "com.amazonaws.cloudfront#ParametersInCacheKeyAndForwardedToOrigin": { @@ -15121,6 +17775,12 @@ "traits": { "smithy.api#enumValue": "PriceClass_All" } + }, + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } } } }, @@ -15760,6 +18420,19 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.cloudfront#ResourceNotDisabled": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudfront#string" + } + }, + "traits": { + "smithy.api#documentation": "The specified CloudFront resource hasn't been disabled yet.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.cloudfront#ResponseHeadersPolicy": { "type": "structure", "members": { @@ -16504,6 +19177,8 @@ "OriginAccessIdentity": { "target": "com.amazonaws.cloudfront#string", "traits": { + "smithy.api#addedDefault": {}, + "smithy.api#default": "", "smithy.api#documentation": "If you're using origin access control (OAC) instead of origin access identity,\n\t\t\t\tspecify an empty OriginAccessIdentity element. For more information,\n\t\t\t\tsee Restricting access to an Amazon Web Services in the\n\t\t\t\t\tAmazon CloudFront Developer Guide.
The CloudFront origin access identity to associate with the origin. Use an origin access\n\t\t\tidentity to configure the origin so that viewers can only access\n\t\t\tobjects in an Amazon S3 bucket through CloudFront. The format of the value is:
\n\n origin-access-identity/cloudfront/ID-of-origin-access-identity\n
The \n ID-of-origin-access-identity\n is the value that CloudFront\n\t\t\treturned in the ID element when you created the origin access\n\t\t\tidentity.
If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3\n\t\t\tURL, specify an empty OriginAccessIdentity element.
To delete the origin access identity from an existing distribution, update the\n\t\t\tdistribution configuration and include an empty OriginAccessIdentity\n\t\t\telement.
To replace the origin access identity, update the distribution configuration and\n\t\t\tspecify the new origin access identity.
\nFor more information about the origin access identity, see Serving Private\n\t\t\t\tContent through CloudFront in the Amazon CloudFront Developer Guide.
", "smithy.api#required": {} } @@ -17050,6 +19725,33 @@ "smithy.api#documentation": "A complex type that controls whether access logs are written for this streaming\n\t\t\tdistribution.
" } }, + "com.amazonaws.cloudfront#StringSchemaConfig": { + "type": "structure", + "members": { + "Comment": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "A comment to describe the parameter.
" + } + }, + "DefaultValue": { + "target": "com.amazonaws.cloudfront#ParameterValue", + "traits": { + "smithy.api#documentation": "The default value of the parameter.
" + } + }, + "Required": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "Whether the defined parameter is required.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a string schema.
" + } + }, "com.amazonaws.cloudfront#Tag": { "type": "structure", "members": { @@ -17195,6 +19897,20 @@ "smithy.api#documentation": "A complex type that contains zero or more Tag elements.
The parameters that you specify for a distribution tenant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for a distribution tenant.
" + } + }, "com.amazonaws.cloudfront#TestFunction": { "type": "operation", "input": { @@ -18401,6 +21117,113 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudfront#UpdateConnectionGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#UpdateConnectionGroupRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#UpdateConnectionGroupResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityAlreadyExists" + }, + { + "target": "com.amazonaws.cloudfront#EntityLimitExceeded" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" + }, + { + "target": "com.amazonaws.cloudfront#PreconditionFailed" + }, + { + "target": "com.amazonaws.cloudfront#ResourceInUse" + } + ], + "traits": { + "smithy.api#documentation": "Updates a connection group.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/2020-05-31/connection-group/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#UpdateConnectionGroupRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the connection group.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Ipv6Enabled": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "Enable IPv6 for the connection group. For more information, see Enable IPv6 in the \n\t\t\tAmazon CloudFront Developer Guide.
" + } + }, + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The value of the ETag header that you received when retrieving the connection group that you're updating.
The ID of the Anycast static IP list.
" + } + }, + "Enabled": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "Whether the connection group is enabled.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#UpdateConnectionGroupResult": { + "type": "structure", + "members": { + "ConnectionGroup": { + "target": "com.amazonaws.cloudfront#ConnectionGroup", + "traits": { + "smithy.api#documentation": "The connection group that you updated.
", + "smithy.api#httpPayload": {} + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the connection group.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudfront#UpdateContinuousDeploymentPolicy": { "type": "operation", "input": { @@ -18679,95 +21502,229 @@ "target": "com.amazonaws.cloudfront#TooManyHeadersInForwardedValues" }, { - "target": "com.amazonaws.cloudfront#TooManyKeyGroupsAssociatedToDistribution" + "target": "com.amazonaws.cloudfront#TooManyKeyGroupsAssociatedToDistribution" + }, + { + "target": "com.amazonaws.cloudfront#TooManyLambdaFunctionAssociations" + }, + { + "target": "com.amazonaws.cloudfront#TooManyOriginCustomHeaders" + }, + { + "target": "com.amazonaws.cloudfront#TooManyOriginGroupsPerDistribution" + }, + { + "target": "com.amazonaws.cloudfront#TooManyOrigins" + }, + { + "target": "com.amazonaws.cloudfront#TooManyQueryStringParameters" + }, + { + "target": "com.amazonaws.cloudfront#TooManyTrustedSigners" + }, + { + "target": "com.amazonaws.cloudfront#TrustedKeyGroupDoesNotExist" + }, + { + "target": "com.amazonaws.cloudfront#TrustedSignerDoesNotExist" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration for a CloudFront distribution.
\nThe update process includes getting the current distribution configuration, updating\n\t\t\tit to make your changes, and then submitting an UpdateDistribution request\n\t\t\tto make the updates.
\n To update a web distribution using the CloudFront\n\t\t\tAPI\n
\nUse GetDistributionConfig to get the current configuration,\n\t\t\t\t\tincluding the version identifier (ETag).
Update the distribution configuration that was returned in the response. Note\n\t\t\t\t\tthe following important requirements and restrictions:
\nYou must copy the ETag field value from the response. (You'll use it for the IfMatch parameter in your request.) Then, remove the ETag\n\t\t\t\t\t\t\tfield from the distribution configuration.
You can't change the value of CallerReference.
Submit an UpdateDistribution request, providing the updated distribution\n\t\t\t\t\tconfiguration. The new configuration replaces the existing configuration. The\n\t\t\t\t\tvalues that you specify in an UpdateDistribution request are not\n\t\t\t\t\tmerged into your existing configuration. Make sure to include all fields: the\n\t\t\t\t\tones that you modified and also the ones that you didn't.
The distribution's configuration information.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {}, + "smithy.api#xmlName": "DistributionConfig" + } + }, + "Id": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The distribution's id.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IfMatch": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The value of the ETag header that you received when retrieving the\n\t\t\tdistribution's configuration. For example: E2QWRUHAPOMQZL.
The request to update a distribution.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#UpdateDistributionResult": { + "type": "structure", + "members": { + "Distribution": { + "target": "com.amazonaws.cloudfront#Distribution", + "traits": { + "smithy.api#documentation": "The distribution's information.
", + "smithy.api#httpPayload": {} + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the configuration. For example:\n\t\t\tE2QWRUHAPOMQZL.
The returned result of the corresponding request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudfront#UpdateDistributionTenant": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#UpdateDistributionTenantRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#UpdateDistributionTenantResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" }, { - "target": "com.amazonaws.cloudfront#TooManyLambdaFunctionAssociations" + "target": "com.amazonaws.cloudfront#CNAMEAlreadyExists" }, { - "target": "com.amazonaws.cloudfront#TooManyOriginCustomHeaders" + "target": "com.amazonaws.cloudfront#EntityAlreadyExists" }, { - "target": "com.amazonaws.cloudfront#TooManyOriginGroupsPerDistribution" + "target": "com.amazonaws.cloudfront#EntityLimitExceeded" }, { - "target": "com.amazonaws.cloudfront#TooManyOrigins" + "target": "com.amazonaws.cloudfront#EntityNotFound" }, { - "target": "com.amazonaws.cloudfront#TooManyQueryStringParameters" + "target": "com.amazonaws.cloudfront#InvalidArgument" }, { - "target": "com.amazonaws.cloudfront#TooManyTrustedSigners" + "target": "com.amazonaws.cloudfront#InvalidAssociation" }, { - "target": "com.amazonaws.cloudfront#TrustedKeyGroupDoesNotExist" + "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" }, { - "target": "com.amazonaws.cloudfront#TrustedSignerDoesNotExist" + "target": "com.amazonaws.cloudfront#PreconditionFailed" } ], "traits": { - "smithy.api#documentation": "Updates the configuration for a CloudFront distribution.
\nThe update process includes getting the current distribution configuration, updating\n\t\t\tit to make your changes, and then submitting an UpdateDistribution request\n\t\t\tto make the updates.
\n To update a web distribution using the CloudFront\n\t\t\tAPI\n
\nUse GetDistributionConfig to get the current configuration,\n\t\t\t\t\tincluding the version identifier (ETag).
Update the distribution configuration that was returned in the response. Note\n\t\t\t\t\tthe following important requirements and restrictions:
\nYou must copy the ETag field value from the response. (You'll use it for the IfMatch parameter in your request.) Then, remove the ETag\n\t\t\t\t\t\t\tfield from the distribution configuration.
You can't change the value of CallerReference.
Submit an UpdateDistribution request, providing the updated distribution\n\t\t\t\t\tconfiguration. The new configuration replaces the existing configuration. The\n\t\t\t\t\tvalues that you specify in an UpdateDistribution request are not\n\t\t\t\t\tmerged into your existing configuration. Make sure to include all fields: the\n\t\t\t\t\tones that you modified and also the ones that you didn't.
Updates a distribution tenant.
", "smithy.api#http": { "method": "PUT", - "uri": "/2020-05-31/distribution/{Id}/config", + "uri": "/2020-05-31/distribution-tenant/{Id}", "code": 200 } } }, - "com.amazonaws.cloudfront#UpdateDistributionRequest": { + "com.amazonaws.cloudfront#UpdateDistributionTenantRequest": { "type": "structure", "members": { - "DistributionConfig": { - "target": "com.amazonaws.cloudfront#DistributionConfig", - "traits": { - "smithy.api#documentation": "The distribution's configuration information.
", - "smithy.api#httpPayload": {}, - "smithy.api#required": {}, - "smithy.api#xmlName": "DistributionConfig" - } - }, "Id": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The distribution's id.
", + "smithy.api#documentation": "The ID of the distribution tenant.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, + "DistributionId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID for the multi-tenant distribution.
" + } + }, + "Domains": { + "target": "com.amazonaws.cloudfront#DomainList", + "traits": { + "smithy.api#documentation": "The domains to update for the distribution tenant. A domain object can contain only a domain property. You must specify at least one domain. Each distribution tenant can have up to 5 domains.
" + } + }, + "Customizations": { + "target": "com.amazonaws.cloudfront#Customizations", + "traits": { + "smithy.api#documentation": "Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.
" + } + }, + "Parameters": { + "target": "com.amazonaws.cloudfront#Parameters", + "traits": { + "smithy.api#documentation": "A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.
" + } + }, + "ConnectionGroupId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the target connection group.
" + } + }, "IfMatch": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The value of the ETag header that you received when retrieving the\n\t\t\tdistribution's configuration. For example: E2QWRUHAPOMQZL.
The value of the ETag header that you received when retrieving the distribution tenant to update. This value is returned in the response of the GetDistributionTenant API operation.
An object that contains the CloudFront managed ACM certificate request.
" + } + }, + "Enabled": { + "target": "com.amazonaws.cloudfront#boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the distribution tenant should be updated to an enabled state. If you update the distribution tenant and it's not enabled, the distribution tenant won't serve traffic.
" } } }, "traits": { - "smithy.api#documentation": "The request to update a distribution.
", "smithy.api#input": {} } }, - "com.amazonaws.cloudfront#UpdateDistributionResult": { + "com.amazonaws.cloudfront#UpdateDistributionTenantResult": { "type": "structure", "members": { - "Distribution": { - "target": "com.amazonaws.cloudfront#Distribution", + "DistributionTenant": { + "target": "com.amazonaws.cloudfront#DistributionTenant", "traits": { - "smithy.api#documentation": "The distribution's information.
", + "smithy.api#documentation": "The distribution tenant that you're updating.
", "smithy.api#httpPayload": {} } }, "ETag": { "target": "com.amazonaws.cloudfront#string", "traits": { - "smithy.api#documentation": "The current version of the configuration. For example:\n\t\t\tE2QWRUHAPOMQZL.
The current version of the distribution tenant.
", "smithy.api#httpHeader": "ETag" } } }, "traits": { - "smithy.api#documentation": "The returned result of the corresponding request.
", "smithy.api#output": {} } }, @@ -19027,6 +21984,99 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudfront#UpdateDomainAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#UpdateDomainAssociationRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#UpdateDomainAssociationResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, + { + "target": "com.amazonaws.cloudfront#IllegalUpdate" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + }, + { + "target": "com.amazonaws.cloudfront#InvalidIfMatchVersion" + }, + { + "target": "com.amazonaws.cloudfront#PreconditionFailed" + } + ], + "traits": { + "smithy.api#documentation": "Moves a domain from its current distribution or distribution tenant to another one.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-05-31/domain-association", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#UpdateDomainAssociationRequest": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The domain to update.
", + "smithy.api#required": {} + } + }, + "TargetResource": { + "target": "com.amazonaws.cloudfront#DistributionResourceId", + "traits": { + "smithy.api#documentation": "The target distribution resource for the domain. You can specify either DistributionId or DistributionTenantId, but not both.
The value of the ETag identifier for the distribution or distribution tenant that will be associated with the domain.
The domain that you're moving.
" + } + }, + "ResourceId": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The intended destination for the domain.
" + } + }, + "ETag": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The current version of the target distribution or distribution tenant that was associated with the domain.
", + "smithy.api#httpHeader": "ETag" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudfront#UpdateFieldLevelEncryptionConfig": { "type": "operation", "input": { @@ -20343,6 +23393,119 @@ "smithy.api#output": {} } }, + "com.amazonaws.cloudfront#ValidationTokenDetail": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The domain name.
", + "smithy.api#required": {} + } + }, + "RedirectTo": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The domain to redirect to.
" + } + }, + "RedirectFrom": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The domain to redirect from.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about the validation token.
" + } + }, + "com.amazonaws.cloudfront#ValidationTokenDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudfront#ValidationTokenDetail" + } + }, + "com.amazonaws.cloudfront#ValidationTokenHost": { + "type": "enum", + "members": { + "CloudFront": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cloudfront" + } + }, + "SelfHosted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "self-hosted" + } + } + } + }, + "com.amazonaws.cloudfront#VerifyDnsConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudfront#VerifyDnsConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.cloudfront#VerifyDnsConfigurationResult" + }, + "errors": [ + { + "target": "com.amazonaws.cloudfront#AccessDenied" + }, + { + "target": "com.amazonaws.cloudfront#EntityNotFound" + }, + { + "target": "com.amazonaws.cloudfront#InvalidArgument" + } + ], + "traits": { + "smithy.api#documentation": "Verify the DNS configuration for your domain names. This API operation checks whether your domain name points to the correct routing endpoint of the connection group, such as d111111abcdef8.cloudfront.net. You can use this API operation to troubleshoot and resolve DNS configuration issues.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2020-05-31/verify-dns-configuration", + "code": 200 + } + } + }, + "com.amazonaws.cloudfront#VerifyDnsConfigurationRequest": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The domain name that you're verifying.
" + } + }, + "Identifier": { + "target": "com.amazonaws.cloudfront#string", + "traits": { + "smithy.api#documentation": "The ID of the distribution tenant.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudfront#VerifyDnsConfigurationResult": { + "type": "structure", + "members": { + "DnsConfigurationList": { + "target": "com.amazonaws.cloudfront#DnsConfigurationList", + "traits": { + "smithy.api#documentation": "The list of domain names, their statuses, and a description of each status.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudfront#ViewerCertificate": { "type": "structure", "members": { @@ -20367,7 +23530,7 @@ "SSLSupportMethod": { "target": "com.amazonaws.cloudfront#SSLSupportMethod", "traits": { - "smithy.api#documentation": "If the distribution uses Aliases (alternate domain names or CNAMEs),\n\t\t\tspecify which viewers the distribution accepts HTTPS connections from.
\n sni-only \u2013 The distribution accepts HTTPS connections from only\n\t\t\t\t\tviewers that support server name\n\t\t\t\t\t\tindication (SNI). This is recommended. Most browsers and clients\n\t\t\t\t\tsupport SNI.
\n vip \u2013 The distribution accepts HTTPS connections from all viewers\n\t\t\t\t\tincluding those that don't support SNI. This is not recommended, and results in\n\t\t\t\t\tadditional monthly charges from CloudFront.
\n static-ip - Do not specify this value unless your distribution\n\t\t\t\t\thas been enabled for this feature by the CloudFront team. If you have a use case\n\t\t\t\t\tthat requires static IP addresses for a distribution, contact CloudFront through\n\t\t\t\t\tthe Amazon Web ServicesSupport Center.
If the distribution uses the CloudFront domain name such as\n\t\t\t\td111111abcdef8.cloudfront.net, don't set a value for this field.
If the distribution uses Aliases (alternate domain names or CNAMEs),\n\t\t\tspecify which viewers the distribution accepts HTTPS connections from.
\n sni-only \u2013 The distribution accepts HTTPS connections from only\n\t\t\t\t\tviewers that support server name\n\t\t\t\t\t\tindication (SNI). This is recommended. Most browsers and clients\n\t\t\t\t\tsupport SNI.
\n vip \u2013 The distribution accepts HTTPS connections from all viewers\n\t\t\t\t\tincluding those that don't support SNI. This is not recommended, and results in\n\t\t\t\t\tadditional monthly charges from CloudFront.
\n static-ip - Do not specify this value unless your distribution\n\t\t\t\t\thas been enabled for this feature by the CloudFront team. If you have a use case\n\t\t\t\t\tthat requires static IP addresses for a distribution, contact CloudFront through\n\t\t\t\t\tthe Amazon Web Services Support Center.
If the distribution uses the CloudFront domain name such as\n\t\t\t\td111111abcdef8.cloudfront.net, don't set a value for this field.
The action for the WAF web ACL customization. You can specify override to specify a separate WAF web ACL for the distribution tenant. If you specify disable, the distribution tenant won't have WAF web ACL protections and won't inherit from the multi-tenant distribution.
The Amazon Resource Name (ARN) of the WAF web ACL.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The WAF web ACL customization specified for the distribution tenant.
" + } + }, "com.amazonaws.cloudfront#aliasString": { "type": "string", "traits": { diff --git a/cloudhsm-v2/service/2017-04-28/cloudhsm-v2-2017-04-28.json b/models/cloudhsm-v2/service/2017-04-28/cloudhsm-v2-2017-04-28.json similarity index 100% rename from cloudhsm-v2/service/2017-04-28/cloudhsm-v2-2017-04-28.json rename to models/cloudhsm-v2/service/2017-04-28/cloudhsm-v2-2017-04-28.json diff --git a/cloudhsm/service/2014-05-30/cloudhsm-2014-05-30.json b/models/cloudhsm/service/2014-05-30/cloudhsm-2014-05-30.json similarity index 100% rename from cloudhsm/service/2014-05-30/cloudhsm-2014-05-30.json rename to models/cloudhsm/service/2014-05-30/cloudhsm-2014-05-30.json diff --git a/cloudsearch-domain/service/2013-01-01/cloudsearch-domain-2013-01-01.json b/models/cloudsearch-domain/service/2013-01-01/cloudsearch-domain-2013-01-01.json similarity index 100% rename from cloudsearch-domain/service/2013-01-01/cloudsearch-domain-2013-01-01.json rename to models/cloudsearch-domain/service/2013-01-01/cloudsearch-domain-2013-01-01.json diff --git a/cloudsearch/service/2013-01-01/cloudsearch-2013-01-01.json b/models/cloudsearch/service/2013-01-01/cloudsearch-2013-01-01.json similarity index 100% rename from cloudsearch/service/2013-01-01/cloudsearch-2013-01-01.json rename to models/cloudsearch/service/2013-01-01/cloudsearch-2013-01-01.json diff --git a/cloudtrail-data/service/2021-08-11/cloudtrail-data-2021-08-11.json b/models/cloudtrail-data/service/2021-08-11/cloudtrail-data-2021-08-11.json similarity index 100% rename from cloudtrail-data/service/2021-08-11/cloudtrail-data-2021-08-11.json rename to models/cloudtrail-data/service/2021-08-11/cloudtrail-data-2021-08-11.json diff --git a/cloudtrail/service/2013-11-01/cloudtrail-2013-11-01.json b/models/cloudtrail/service/2013-11-01/cloudtrail-2013-11-01.json similarity index 100% rename from cloudtrail/service/2013-11-01/cloudtrail-2013-11-01.json rename to models/cloudtrail/service/2013-11-01/cloudtrail-2013-11-01.json diff --git a/cloudwatch-events/service/2015-10-07/cloudwatch-events-2015-10-07.json b/models/cloudwatch-events/service/2015-10-07/cloudwatch-events-2015-10-07.json similarity index 100% rename from cloudwatch-events/service/2015-10-07/cloudwatch-events-2015-10-07.json rename to models/cloudwatch-events/service/2015-10-07/cloudwatch-events-2015-10-07.json diff --git a/cloudwatch-logs/service/2014-03-28/cloudwatch-logs-2014-03-28.json b/models/cloudwatch-logs/service/2014-03-28/cloudwatch-logs-2014-03-28.json similarity index 99% rename from cloudwatch-logs/service/2014-03-28/cloudwatch-logs-2014-03-28.json rename to models/cloudwatch-logs/service/2014-03-28/cloudwatch-logs-2014-03-28.json index d5ab4fbf..238e8853 100644 --- a/cloudwatch-logs/service/2014-03-28/cloudwatch-logs-2014-03-28.json +++ b/models/cloudwatch-logs/service/2014-03-28/cloudwatch-logs-2014-03-28.json @@ -538,7 +538,7 @@ } ], "traits": { - "smithy.api#documentation": "Associates the specified KMS key with either one log group in the account, or with all stored\n CloudWatch Logs query insights results in the account.
\nWhen you use AssociateKmsKey, you specify either the logGroupName parameter\n or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName parameter to cause log events ingested into that log group to\n be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.
Associating a KMS key with a log group overrides any existing\n associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted\n using the KMS key. This association is stored as long as the data encrypted\n with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
\nAssociating\n a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query\n results encrypted with a KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier\n parameter that specifies a query-result resource.
Specify the resourceIdentifier parameter with a query-result resource, \n to use that key to encrypt the stored results of all future \n StartQuery\n operations in the account. The response from a \n GetQueryResults\n operation will still return\n the query results in plain text.
Even if you have not associated a key with your query results, the query results are encrypted when stored,\n using the default CloudWatch Logs method.
\nIf you run a query from a monitoring account that queries logs in a source account, the\n query results key from the monitoring account, if any, is used.
\nIf you delete the key that is used to encrypt log events or log group query results,\n then all the associated stored log events or query results that were encrypted with that key \n will be unencryptable and unusable.
\nCloudWatch Logs supports only symmetric KMS keys. Do not use an associate\n an asymmetric KMS key with your log group or query results. For more information, see Using\n Symmetric and Asymmetric Keys.
\nIt can take up to 5 minutes for this operation to take effect.
\nIf you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an\n InvalidParameterException error.
Associates the specified KMS key with either one log group in the account, or with all stored\n CloudWatch Logs query insights results in the account.
\nWhen you use AssociateKmsKey, you specify either the logGroupName parameter\n or the resourceIdentifier parameter. You can't specify both of those parameters in the same operation.
Specify the logGroupName parameter to cause log events ingested into that log group to\n be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.
Associating a KMS key with a log group overrides any existing\n associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted\n using the KMS key. This association is stored as long as the data encrypted\n with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.
\nAssociating\n a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query\n results encrypted with a KMS key, you must use an AssociateKmsKey operation with the resourceIdentifier\n parameter that specifies a query-result resource.
Specify the resourceIdentifier parameter with a query-result resource, \n to use that key to encrypt the stored results of all future \n StartQuery\n operations in the account. The response from a \n GetQueryResults\n operation will still return\n the query results in plain text.
Even if you have not associated a key with your query results, the query results are encrypted when stored,\n using the default CloudWatch Logs method.
\nIf you run a query from a monitoring account that queries logs in a source account, the\n query results key from the monitoring account, if any, is used.
\nIf you delete the key that is used to encrypt log events or log group query results,\n then all the associated stored log events or query results that were encrypted with that key \n will be unencryptable and unusable.
\nCloudWatch Logs supports only symmetric KMS keys. Do not associate\n an asymmetric KMS key with your log group or query results. For more information, see Using\n Symmetric and Asymmetric Keys.
\nIt can take up to 5 minutes for this operation to take effect.
\nIf you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an\n InvalidParameterException error.
Creates an export task so that you can efficiently export data from a log group to an\n Amazon S3 bucket. When you perform a CreateExportTask operation, you must use\n credentials that have permission to write to the S3 bucket that you specify as the\n destination.
Exporting log data to S3 buckets that are encrypted by KMS is supported.\n Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a\n retention period is also supported.
\nExporting to S3 buckets that are encrypted with AES-256 is supported.
\nThis is an asynchronous call. If all the required information is provided, this \n operation initiates an export task and responds with the ID of the task. After the task has started,\n you can use DescribeExportTasks to get the status of the export task. Each account can\n only have one active (RUNNING or PENDING) export task at a time.\n To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3\n bucket. To separate log data for each export task, specify a prefix to be used as the Amazon\n S3 key prefix for all exported objects.
\nWe recommend that you don't regularly export to Amazon S3 as a way to continuously archive your logs. For that use case, we instaed recommend that \n you use subscriptions. For more information about subscriptions, see \n Real-time processing of log data with subscriptions.
\nTime-based sorting on chunks of log data inside an exported file is not guaranteed. You can\n sort the exported log field data by using Linux utilities.
\nCreates an export task so that you can efficiently export data from a log group to an\n Amazon S3 bucket. When you perform a CreateExportTask operation, you must use\n credentials that have permission to write to the S3 bucket that you specify as the\n destination.
Exporting log data to S3 buckets that are encrypted by KMS is supported.\n Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a\n retention period is also supported.
\nExporting to S3 buckets that are encrypted with AES-256 is supported.
\nThis is an asynchronous call. If all the required information is provided, this \n operation initiates an export task and responds with the ID of the task. After the task has started,\n you can use DescribeExportTasks to get the status of the export task. Each account can\n only have one active (RUNNING or PENDING) export task at a time.\n To cancel an export task, use CancelExportTask.
You can export logs from multiple log groups or multiple time ranges to the same S3\n bucket. To separate log data for each export task, specify a prefix to be used as the Amazon\n S3 key prefix for all exported objects.
\nWe recommend that you don't regularly export to Amazon S3 as a way to continuously archive your logs. For that use case, we instead recommend that \n you use subscriptions. For more information about subscriptions, see \n Real-time processing of log data with subscriptions.
\nTime-based sorting on chunks of log data inside an exported file is not guaranteed. You can\n sort the exported log field data by using Linux utilities.
\nUse this parameter to specify the log group class for this log group. There are two classes:
\nThe Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.
If you omit this parameter, the default of STANDARD is used.
The value of logGroupClass can't be changed after a log group is created.
For details about the features supported by each class, see \n Log classes\n
" + "smithy.api#documentation": "Use this parameter to specify the log group class for this log group. There are three classes:
\nThe Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.
Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or \n Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as\n CloudWatch Logs Insights queries.
If you omit this parameter, the default of STANDARD is used.
The value of logGroupClass can't be changed after a log group is created.
For details about the features supported by each class, see \n Log classes\n
" } } }, @@ -2522,7 +2522,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of all CloudWatch Logs account policies in the account.
\nTo use this operation, you must be signed on with the correct permissions depending on the type of policy that you are retrieving information for.
\nTo see data protection policies, you must have the logs:GetDataProtectionPolicy and \n logs:DescribeAccountPolicies permissions.
To see subscription filter policies, you must have the logs:DescrubeSubscriptionFilters and \n logs:DescribeAccountPolicies permissions.
To see transformer policies, you must have the logs:GetTransformer and logs:DescribeAccountPolicies permissions.
To see field index policies, you must have the logs:DescribeIndexPolicies and \n logs:DescribeAccountPolicies permissions.
Returns a list of all CloudWatch Logs account policies in the account.
\nTo use this operation, you must be signed on with the correct permissions depending on the type of policy that you are retrieving information for.
\nTo see data protection policies, you must have the logs:GetDataProtectionPolicy and \n logs:DescribeAccountPolicies permissions.
To see subscription filter policies, you must have the logs:DescribeSubscriptionFilters and \n logs:DescribeAccountPolicies permissions.
To see transformer policies, you must have the logs:GetTransformer and logs:DescribeAccountPolicies permissions.
To see field index policies, you must have the logs:DescribeIndexPolicies and \n logs:DescribeAccountPolicies permissions.
Specifies the log group class for this log group. There are two classes:
\nThe Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.
For details about the features supported by each class, see \n Log classes\n
" + "smithy.api#documentation": "Specifies the log group class for this log group. There are three classes:
\nThe Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.
Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or \n Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as\n CloudWatch Logs Insights queries.
For details about the features supported by each class, see \n Log classes\n
" } } }, @@ -5693,7 +5693,7 @@ "message": { "target": "com.amazonaws.cloudwatchlogs#EventMessage", "traits": { - "smithy.api#documentation": "The raw event message. Each log event can be no larger than 256 KB.
", + "smithy.api#documentation": "The raw event message. Each log event can be no larger than 1 MB.
", "smithy.api#required": {} } } @@ -6614,7 +6614,7 @@ "logGroupClass": { "target": "com.amazonaws.cloudwatchlogs#LogGroupClass", "traits": { - "smithy.api#documentation": "This specifies the log group class for this log group. There are two classes:
\nThe Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.
For details about the features supported by each class, see \n Log classes\n
" + "smithy.api#documentation": "This specifies the log group class for this log group. There are three classes:
\nThe Standard log class supports all CloudWatch Logs features.
The Infrequent Access log class supports a subset of CloudWatch Logs features\n and incurs lower costs.
Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or \n Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as\n CloudWatch Logs Insights queries.
For details about the features supported by the Standard and Infrequent Access classes, see \n Log classes\n
" } }, "logGroupArn": { @@ -6658,6 +6658,12 @@ "traits": { "smithy.api#enumValue": "INFREQUENT_ACCESS" } + }, + "DELIVERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELIVERY" + } } } }, @@ -10090,7 +10096,7 @@ } ], "traits": { - "smithy.api#documentation": "Uploads a batch of log events to the specified log stream.
\nThe sequence token is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are always accepted and never return InvalidSequenceTokenException or\n DataAlreadyAcceptedException even if the sequence token is not valid. You can use\n parallel PutLogEvents actions on the same log stream.
The batch of events must satisfy the following constraints:
\nThe maximum batch size is 1,048,576 bytes. This size is calculated as the sum of\n all event messages in UTF-8, plus 26 bytes for each log event.
\nNone of the log events in the batch can be more than 2 hours in the future.
\nNone of the log events in the batch can be more than 14 days in the past. Also,\n none of the log events can be from earlier than the retention period of the log\n group.
\nThe log events in the batch must be in chronological order by their timestamp. The\n timestamp is the time that the event occurred, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell\n and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format:\n yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
\nEach log event can be no larger than 256 KB.
\nThe maximum number of log events in a batch is 10,000.
\nThe quota of five requests per second per log stream\n has been removed. Instead, PutLogEvents actions are throttled based on a \n per-second per-account quota. You can request an increase to the per-second throttling\n quota by using the Service Quotas service.
If a call to PutLogEvents returns \"UnrecognizedClientException\" the most\n likely cause is a non-valid Amazon Web Services access key ID or secret key.
Uploads a batch of log events to the specified log stream.
\nThe sequence token is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are always accepted and never return InvalidSequenceTokenException or\n DataAlreadyAcceptedException even if the sequence token is not valid. You can use\n parallel PutLogEvents actions on the same log stream.
The batch of events must satisfy the following constraints:
\nThe maximum batch size is 1,048,576 bytes. This size is calculated as the sum of\n all event messages in UTF-8, plus 26 bytes for each log event.
\nNone of the log events in the batch can be more than 2 hours in the future.
\nNone of the log events in the batch can be more than 14 days in the past. Also,\n none of the log events can be from earlier than the retention period of the log\n group.
\nThe log events in the batch must be in chronological order by their timestamp. The\n timestamp is the time that the event occurred, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell\n and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format:\n yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
\nEach log event can be no larger than 1 MB.
\nThe maximum number of log events in a batch is 10,000.
\nThe quota of five requests per second per log stream\n has been removed. Instead, PutLogEvents actions are throttled based on a \n per-second per-account quota. You can request an increase to the per-second throttling\n quota by using the Service Quotas service.
If a call to PutLogEvents returns \"UnrecognizedClientException\" the most\n likely cause is a non-valid Amazon Web Services access key ID or secret key.
Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of \n log events that have\n been recently ingested in the log groups. For more information, see \n Use Live Tail to view logs in near real time.\n
\nThe response to this operation is a response stream, over which \n the server sends live log events and the client receives them.
\nThe following objects are sent over the stream:
\nA single LiveTailSessionStart \n object is sent at the start of the session.
\nEvery second, a LiveTailSessionUpdate\n object is sent. Each of these objects contains an array of the actual log events.
\nIf no new log events were ingested in the past second, the \n LiveTailSessionUpdate object will contain an empty array.
The array of log events contained in a LiveTailSessionUpdate can include\n as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the\n log events are sampled down to 500 log events to be included in each LiveTailSessionUpdate object.
If your client consumes the log events slower than the server produces them, CloudWatch Logs\n buffers up to 10 LiveTailSessionUpdate events or 5000 log events, after \n which it starts dropping the oldest events.
A SessionStreamingException \n object is returned if an unknown error occurs on the server side.
\nA SessionTimeoutException \n object is returned when the session times out, after it has been kept open for three hours.
\nYou can end a session before it times out by closing the session stream or by closing the client that is receiving the \n stream. The session also ends if the established connection between the client and the server breaks.
\nFor examples of using an SDK to start a Live Tail session, see \n \n Start a Live Tail session using an Amazon Web Services SDK.
", + "smithy.api#documentation": "Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of \n log events that have\n been recently ingested in the log groups. For more information, see \n Use Live Tail to view logs in near real time.\n
\nThe response to this operation is a response stream, over which \n the server sends live log events and the client receives them.
\nThe following objects are sent over the stream:
\nA single LiveTailSessionStart \n object is sent at the start of the session.
\nEvery second, a LiveTailSessionUpdate\n object is sent. Each of these objects contains an array of the actual log events.
\nIf no new log events were ingested in the past second, the \n LiveTailSessionUpdate object will contain an empty array.
The array of log events contained in a LiveTailSessionUpdate can include\n as many as 500 log events. If the number of log events matching the request exceeds 500 per second, the\n log events are sampled down to 500 log events to be included in each LiveTailSessionUpdate object.
If your client consumes the log events slower than the server produces them, CloudWatch Logs\n buffers up to 10 LiveTailSessionUpdate events or 5000 log events, after \n which it starts dropping the oldest events.
A SessionStreamingException \n object is returned if an unknown error occurs on the server side.
\nA SessionTimeoutException \n object is returned when the session times out, after it has been kept open for three hours.
\nThe StartLiveTail API routes requests to streaming-logs.Region.amazonaws.com using SDK host prefix injection. \n VPC endpoint support is not available for this API.
You can end a session before it times out by closing the session stream or by closing the client that is receiving the \n stream. The session also ends if the established connection between the client and the server breaks.
\nFor examples of using an SDK to start a Live Tail session, see \n \n Start a Live Tail session using an Amazon Web Services SDK.
", "smithy.api#endpoint": { "hostPrefix": "streaming-" } diff --git a/cloudwatch/service/2010-08-01/cloudwatch-2010-08-01.json b/models/cloudwatch/service/2010-08-01/cloudwatch-2010-08-01.json similarity index 100% rename from cloudwatch/service/2010-08-01/cloudwatch-2010-08-01.json rename to models/cloudwatch/service/2010-08-01/cloudwatch-2010-08-01.json diff --git a/codeartifact/service/2018-09-22/codeartifact-2018-09-22.json b/models/codeartifact/service/2018-09-22/codeartifact-2018-09-22.json similarity index 100% rename from codeartifact/service/2018-09-22/codeartifact-2018-09-22.json rename to models/codeartifact/service/2018-09-22/codeartifact-2018-09-22.json diff --git a/codebuild/service/2016-10-06/codebuild-2016-10-06.json b/models/codebuild/service/2016-10-06/codebuild-2016-10-06.json similarity index 100% rename from codebuild/service/2016-10-06/codebuild-2016-10-06.json rename to models/codebuild/service/2016-10-06/codebuild-2016-10-06.json diff --git a/codecatalyst/service/2022-09-28/codecatalyst-2022-09-28.json b/models/codecatalyst/service/2022-09-28/codecatalyst-2022-09-28.json similarity index 100% rename from codecatalyst/service/2022-09-28/codecatalyst-2022-09-28.json rename to models/codecatalyst/service/2022-09-28/codecatalyst-2022-09-28.json diff --git a/codecommit/service/2015-04-13/codecommit-2015-04-13.json b/models/codecommit/service/2015-04-13/codecommit-2015-04-13.json similarity index 100% rename from codecommit/service/2015-04-13/codecommit-2015-04-13.json rename to models/codecommit/service/2015-04-13/codecommit-2015-04-13.json diff --git a/codeconnections/service/2023-12-01/codeconnections-2023-12-01.json b/models/codeconnections/service/2023-12-01/codeconnections-2023-12-01.json similarity index 100% rename from codeconnections/service/2023-12-01/codeconnections-2023-12-01.json rename to models/codeconnections/service/2023-12-01/codeconnections-2023-12-01.json diff --git a/codedeploy/service/2014-10-06/codedeploy-2014-10-06.json b/models/codedeploy/service/2014-10-06/codedeploy-2014-10-06.json similarity index 100% rename from codedeploy/service/2014-10-06/codedeploy-2014-10-06.json rename to models/codedeploy/service/2014-10-06/codedeploy-2014-10-06.json diff --git a/codeguru-reviewer/service/2019-09-19/codeguru-reviewer-2019-09-19.json b/models/codeguru-reviewer/service/2019-09-19/codeguru-reviewer-2019-09-19.json similarity index 100% rename from codeguru-reviewer/service/2019-09-19/codeguru-reviewer-2019-09-19.json rename to models/codeguru-reviewer/service/2019-09-19/codeguru-reviewer-2019-09-19.json diff --git a/codeguru-security/service/2018-05-10/codeguru-security-2018-05-10.json b/models/codeguru-security/service/2018-05-10/codeguru-security-2018-05-10.json similarity index 100% rename from codeguru-security/service/2018-05-10/codeguru-security-2018-05-10.json rename to models/codeguru-security/service/2018-05-10/codeguru-security-2018-05-10.json diff --git a/codeguruprofiler/service/2019-07-18/codeguruprofiler-2019-07-18.json b/models/codeguruprofiler/service/2019-07-18/codeguruprofiler-2019-07-18.json similarity index 100% rename from codeguruprofiler/service/2019-07-18/codeguruprofiler-2019-07-18.json rename to models/codeguruprofiler/service/2019-07-18/codeguruprofiler-2019-07-18.json diff --git a/codepipeline/service/2015-07-09/codepipeline-2015-07-09.json b/models/codepipeline/service/2015-07-09/codepipeline-2015-07-09.json similarity index 100% rename from codepipeline/service/2015-07-09/codepipeline-2015-07-09.json rename to models/codepipeline/service/2015-07-09/codepipeline-2015-07-09.json diff --git a/codestar-connections/service/2019-12-01/codestar-connections-2019-12-01.json b/models/codestar-connections/service/2019-12-01/codestar-connections-2019-12-01.json similarity index 100% rename from codestar-connections/service/2019-12-01/codestar-connections-2019-12-01.json rename to models/codestar-connections/service/2019-12-01/codestar-connections-2019-12-01.json diff --git a/codestar-notifications/service/2019-10-15/codestar-notifications-2019-10-15.json b/models/codestar-notifications/service/2019-10-15/codestar-notifications-2019-10-15.json similarity index 100% rename from codestar-notifications/service/2019-10-15/codestar-notifications-2019-10-15.json rename to models/codestar-notifications/service/2019-10-15/codestar-notifications-2019-10-15.json diff --git a/cognito-identity-provider/service/2016-04-18/cognito-identity-provider-2016-04-18.json b/models/cognito-identity-provider/service/2016-04-18/cognito-identity-provider-2016-04-18.json similarity index 100% rename from cognito-identity-provider/service/2016-04-18/cognito-identity-provider-2016-04-18.json rename to models/cognito-identity-provider/service/2016-04-18/cognito-identity-provider-2016-04-18.json diff --git a/cognito-identity/service/2014-06-30/cognito-identity-2014-06-30.json b/models/cognito-identity/service/2014-06-30/cognito-identity-2014-06-30.json similarity index 100% rename from cognito-identity/service/2014-06-30/cognito-identity-2014-06-30.json rename to models/cognito-identity/service/2014-06-30/cognito-identity-2014-06-30.json diff --git a/cognito-sync/service/2014-06-30/cognito-sync-2014-06-30.json b/models/cognito-sync/service/2014-06-30/cognito-sync-2014-06-30.json similarity index 100% rename from cognito-sync/service/2014-06-30/cognito-sync-2014-06-30.json rename to models/cognito-sync/service/2014-06-30/cognito-sync-2014-06-30.json diff --git a/comprehend/service/2017-11-27/comprehend-2017-11-27.json b/models/comprehend/service/2017-11-27/comprehend-2017-11-27.json similarity index 100% rename from comprehend/service/2017-11-27/comprehend-2017-11-27.json rename to models/comprehend/service/2017-11-27/comprehend-2017-11-27.json diff --git a/comprehendmedical/service/2018-10-30/comprehendmedical-2018-10-30.json b/models/comprehendmedical/service/2018-10-30/comprehendmedical-2018-10-30.json similarity index 100% rename from comprehendmedical/service/2018-10-30/comprehendmedical-2018-10-30.json rename to models/comprehendmedical/service/2018-10-30/comprehendmedical-2018-10-30.json diff --git a/compute-optimizer/service/2019-11-01/compute-optimizer-2019-11-01.json b/models/compute-optimizer/service/2019-11-01/compute-optimizer-2019-11-01.json similarity index 100% rename from compute-optimizer/service/2019-11-01/compute-optimizer-2019-11-01.json rename to models/compute-optimizer/service/2019-11-01/compute-optimizer-2019-11-01.json diff --git a/config-service/service/2014-11-12/config-service-2014-11-12.json b/models/config-service/service/2014-11-12/config-service-2014-11-12.json similarity index 100% rename from config-service/service/2014-11-12/config-service-2014-11-12.json rename to models/config-service/service/2014-11-12/config-service-2014-11-12.json diff --git a/connect-contact-lens/service/2020-08-21/connect-contact-lens-2020-08-21.json b/models/connect-contact-lens/service/2020-08-21/connect-contact-lens-2020-08-21.json similarity index 100% rename from connect-contact-lens/service/2020-08-21/connect-contact-lens-2020-08-21.json rename to models/connect-contact-lens/service/2020-08-21/connect-contact-lens-2020-08-21.json diff --git a/connect/service/2017-08-08/connect-2017-08-08.json b/models/connect/service/2017-08-08/connect-2017-08-08.json similarity index 95% rename from connect/service/2017-08-08/connect-2017-08-08.json rename to models/connect/service/2017-08-08/connect-2017-08-08.json index 1925d9f9..fffde102 100644 --- a/connect/service/2017-08-08/connect-2017-08-08.json +++ b/models/connect/service/2017-08-08/connect-2017-08-08.json @@ -463,6 +463,36 @@ }, "Capabilities": { "target": "com.amazonaws.connect#ParticipantCapabilities" + }, + "AfterContactWorkDuration": { + "target": "com.amazonaws.connect#Duration", + "traits": { + "smithy.api#documentation": "The difference in time, in whole seconds, between\n AfterContactWorkStartTimestamp and\n AfterContactWorkEndTimestamp.
The date and time when the agent started doing After Contact Work for the contact, in UTC\n time.
" + } + }, + "AfterContactWorkEndTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the agent ended After Contact Work for the contact, in UTC time. In\n cases when agent finishes doing AfterContactWork for chat contacts and switches\n their activity status to offline or equivalent without clearing the contact in CCP, discrepancies\n may be noticed for AfterContactWorkEndTimestamp.
The total hold duration in seconds initiated by the agent.
" + } + }, + "StateTransitions": { + "target": "com.amazonaws.connect#StateTransitions", + "traits": { + "smithy.api#documentation": "List of StateTransition for a supervisor.
Represents a list of target field values for the fieldId specified in CaseSlaConfiguration. \n The SLA is considered met if any one of these target field values matches the actual field value.
" + "smithy.api#documentation": "Represents a list of target field values for the fieldId specified in CaseSlaConfiguration.\n The SLA is considered met if any one of these target field values matches the actual field\n value.
" } }, "TargetSlaMinutes": { @@ -5937,6 +5967,36 @@ "traits": { "smithy.api#documentation": "A set of system defined key-value pairs stored on individual contact segments using an\n attribute map. The attributes are standard Amazon Connect attributes and can be accessed in\n flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used\n to show channel subtype. For example, connect:Guide or\n connect:SMS.
If recording was enabled, this is information about the recordings.
" + } + }, + "DisconnectReason": { + "target": "com.amazonaws.connect#String", + "traits": { + "smithy.api#documentation": "The disconnect reason for the contact.
" + } + }, + "ContactEvaluations": { + "target": "com.amazonaws.connect#ContactEvaluations", + "traits": { + "smithy.api#documentation": "Information about the contact evaluations where the key is the FormId, which is a unique\n identifier for the form.
" + } + }, + "ContactDetails": { + "target": "com.amazonaws.connect#ContactDetails", + "traits": { + "smithy.api#documentation": "A map of string key/value pairs that contain user-defined attributes which are lightly typed\n within the contact. This object is used only for task contacts.
" + } + }, + "Attributes": { + "target": "com.amazonaws.connect#Attributes", + "traits": { + "smithy.api#documentation": "The attributes of the contact.
" + } } }, "traits": { @@ -6041,6 +6101,103 @@ } } }, + "com.amazonaws.connect#ContactDetailDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.connect#ContactDetailName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.connect#ContactDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ContactDetailName", + "traits": { + "smithy.api#documentation": "The name of the contact details.
" + } + }, + "Description": { + "target": "com.amazonaws.connect#ContactDetailDescription", + "traits": { + "smithy.api#documentation": "Teh description of the contact details.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A map of string key/value pairs that contain user-defined attributes which are lightly typed\n within the contact. This object is used only for task contacts.
" + } + }, + "com.amazonaws.connect#ContactEvaluation": { + "type": "structure", + "members": { + "FormId": { + "target": "com.amazonaws.connect#FormId", + "traits": { + "smithy.api#documentation": "The FormId of the contact evaluation.
The Amazon Resource Name for the evaluation form. It is always present.
" + } + }, + "Status": { + "target": "com.amazonaws.connect#Status", + "traits": { + "smithy.api#documentation": "The status of the evaluation.
" + } + }, + "StartTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the evaluation was started, in UTC time.
" + } + }, + "EndTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the evaluation was submitted, in UTC time.
" + } + }, + "DeleteTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the evaluation was deleted, in UTC time.
" + } + }, + "ExportLocation": { + "target": "com.amazonaws.connect#ExportLocation", + "traits": { + "smithy.api#documentation": "The path where evaluation was exported.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the contact evaluations where the key is the FormId, which is a unique\n identifier for the form.
" + } + }, + "com.amazonaws.connect#ContactEvaluations": { + "type": "map", + "key": { + "target": "com.amazonaws.connect#EvaluationId" + }, + "value": { + "target": "com.amazonaws.connect#ContactEvaluation" + } + }, "com.amazonaws.connect#ContactFilter": { "type": "structure", "members": { @@ -7329,7 +7486,7 @@ } ], "traits": { - "smithy.api#documentation": "Only the EMAIL and VOICE channels are supported. The supported initiation methods for EMAIL are: OUTBOUND,\n AGENT_REPLY, and FLOW. For VOICE the supported initiation methods are TRANSFER and the subtype connect:ExternalAudio.
\nCreates a new EMAIL or VOICE contact.
", + "smithy.api#documentation": "Only the EMAIL and VOICE channels are supported. The supported initiation methods for EMAIL\n are: OUTBOUND, AGENT_REPLY, and FLOW. For VOICE the supported initiation methods are TRANSFER\n and the subtype connect:ExternalAudio.
\nCreates a new EMAIL or VOICE contact.
", "smithy.api#http": { "method": "PUT", "uri": "/contact/create-contact", @@ -7731,14 +7888,14 @@ "Channel": { "target": "com.amazonaws.connect#Channel", "traits": { - "smithy.api#documentation": "The channel for the contact
\nCreateContact only supports the EMAIL and VOICE channels. The following information that states other\n channels are supported is incorrect. We are working to update this topic.
\nThe channel for the contact
\nCreateContact only supports the EMAIL and VOICE channels. The following information that\n states other channels are supported is incorrect. We are working to update this topic.
\nIndicates how the contact was initiated.
\nCreateContact only supports the following initiation methods:
\nFor EMAIL: OUTBOUND, AGENT_REPLY, and\n FLOW.
\nFor VOICE: TRANSFER and the subtype connect:ExternalAudio.
\nThe following information that states other initiation methods are supported is incorrect.\n We are working to update this topic.
\nIndicates how the contact was initiated.
\nCreateContact only supports the following initiation methods:
\nFor EMAIL: OUTBOUND, AGENT_REPLY, and FLOW.
\nFor VOICE: TRANSFER and the subtype connect:ExternalAudio.
\nThe following information that states other initiation methods are supported is incorrect.\n We are working to update this topic.
\nThe ID of the previous contact when creating a transfer contact. This value can be provided\n only for external audio contacts. For more information, see Integrate Amazon Connect Contact Lens\n with external voice systems in the Amazon Connect Administrator Guide.
" + "smithy.api#documentation": "The ID of the previous contact when creating a transfer contact. This value can be provided\n only for external audio contacts. For more information, see Integrate Amazon Connect Contact Lens\n with external voice systems in the Amazon Connect Administrator\n Guide.
" } } }, @@ -10510,7 +10667,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator\n Guide.
" + "smithy.api#documentation": "Contains information about a real-time metric. For a description of each metric, see Metrics\n definitions in the Amazon Connect Administrator Guide.
" } }, "com.amazonaws.connect#CurrentMetricData": { @@ -12934,7 +13091,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nDescribes the specified contact.
\n\n CustomerEndpoint and SystemEndpoint are only populated for\n EMAIL contacts.
Contact information remains available in Amazon Connect for 24 months from the\n InitiationTimestamp, and then it is deleted. Only contact information that is\n available in Amazon Connect is returned by this API.
This API is in preview release for Amazon Connect and is subject to change.
\nDescribes the specified contact.
\n\n SystemEndpoint is not populated for contacts with initiation method of\n MONITOR, QUEUE_TRANSFER, or CALLBACK
Contact information remains available in Amazon Connect for 24 months from the\n InitiationTimestamp, and then it is deleted. Only contact information that is\n available in Amazon Connect is returned by this API.
Gets the real-time metric data from the specified Amazon Connect instance.
\nFor a description of each metric, see Real-time Metrics\n Definitions in the Amazon Connect Administrator Guide.
", + "smithy.api#documentation": "Gets the real-time metric data from the specified Amazon Connect instance.
\nFor a description of each metric, see Metrics definitions in the\n Amazon Connect Administrator Guide.
", "smithy.api#http": { "method": "POST", "uri": "/metrics/current/{InstanceId}", @@ -18720,7 +18906,7 @@ "CurrentMetrics": { "target": "com.amazonaws.connect#CurrentMetrics", "traits": { - "smithy.api#documentation": "The metrics to retrieve. Specify the name and unit for each metric. The following metrics\n are available. For a description of all the metrics, see Real-time Metrics\n Definitions in the Amazon Connect Administrator Guide.
\nUnit: COUNT
\nName in real-time metrics report: ACW\n
\nUnit: COUNT
\nName in real-time metrics report: Available\n
\nUnit: COUNT
\nName in real-time metrics report: Error\n
\nUnit: COUNT
\nName in real-time metrics report: NPT (Non-Productive Time)\n
\nUnit: COUNT
\nName in real-time metrics report: On\n contact\n
\nUnit: COUNT
\nName in real-time metrics report: On\n contact\n
\nUnit: COUNT
\nName in real-time metrics report: Online\n
\nUnit: COUNT
\nName in real-time metrics report: Staffed\n
\nUnit: COUNT
\nName in real-time metrics report: In\n queue\n
\nUnit: COUNT
\nName in real-time metrics report: Scheduled\n
\nUnit: SECONDS
\nWhen you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
\nWhen you do not use groupings, Unit says SECONDS but the Value is returned in\n MILLISECONDS. For example, if you get a response like this:
\n\n { \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0\n }
The actual OLDEST_CONTACT_AGE is 24 seconds.
\nWhen the filter RoutingStepExpression is used, this metric is still\n calculated from enqueue time. For example, if a contact that has been queued under\n OLDEST_CONTACT_AGE for this queue will be counted starting\n from 10, not 0.
Name in real-time metrics report: Oldest\n
\nUnit: COUNT
\nName in real-time metrics report: Active\n
\nUnit: COUNT
\nName in real-time metrics report: Availability\n
\nThe metrics to retrieve. Specify the name and unit for each metric. The following metrics\n are available. For a description of all the metrics, see Metrics definitions in the\n Amazon Connect Administrator Guide.
\nUnit: COUNT
\nName in real-time metrics report: ACW\n
\nUnit: COUNT
\nName in real-time metrics report: Available\n
\nUnit: COUNT
\nName in real-time metrics report: Error\n
\nUnit: COUNT
\nName in real-time metrics report: NPT\n (Non-Productive Time)\n
\nUnit: COUNT
\nName in real-time metrics report: On\n contact\n
\nUnit: COUNT
\nName in real-time metrics report: On\n contact\n
\nUnit: COUNT
\nName in real-time metrics report: Online\n
\nUnit: COUNT
\nName in real-time metrics report: Staffed\n
\nUnit: COUNT
\nName in real-time metrics report: In\n queue\n
\nUnit: COUNT
\nName in real-time metrics report: Scheduled\n
\nUnit: SECONDS
\nWhen you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
\nWhen you do not use groupings, Unit says SECONDS but the Value is returned in\n MILLISECONDS. For example, if you get a response like this:
\n\n { \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0\n }
The actual OLDEST_CONTACT_AGE is 24 seconds.
\nWhen the filter RoutingStepExpression is used, this metric is still\n calculated from enqueue time. For example, if a contact that has been queued under\n OLDEST_CONTACT_AGE for this queue will be counted starting\n from 10, not 0.
Name in real-time metrics report: Oldest\n
\nUnit: COUNT
\nName in real-time metrics report: Active\n
\nUnit: COUNT
\nName in real-time metrics report: Availability\n
\nGets historical metric data from the specified Amazon Connect instance.
\nFor a description of each historical metric, see Historical Metrics\n Definitions in the Amazon Connect Administrator Guide.
\nWe recommend using the GetMetricDataV2 API. It\n provides more flexibility, features, and the ability to query longer time ranges than\n GetMetricData. Use it to retrieve historical agent and contact metrics for the\n last 3 months, at varying intervals. You can also use it to build custom dashboards to measure\n historical queue and agent performance. For example, you can track the number of incoming\n contacts for the last 7 days, with data split by day, to see how contact volume changed per day\n of the week.
Gets historical metric data from the specified Amazon Connect instance.
\nFor a description of each historical metric, see Metrics definitions in the\n Amazon Connect Administrator Guide.
\nWe recommend using the GetMetricDataV2 API. It\n provides more flexibility, features, and the ability to query longer time ranges than\n GetMetricData. Use it to retrieve historical agent and contact metrics for the\n last 3 months, at varying intervals. You can also use it to build custom dashboards to measure\n historical queue and agent performance. For example, you can track the number of incoming\n contacts for the last 7 days, with data split by day, to see how contact volume changed per day\n of the week.
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The\n following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator\n Guide.
\nThis API does not support a contacts\n incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
\nUnit: SECONDS
\nStatistic: AVG
\nUnit: SECONDS
\nStatistic: AVG
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: SECONDS
\nStatistic: AVG
\nUnit: SECONDS
\nStatistic: AVG
\nUnit: SECONDS
\nStatistic: AVG
\nUnit: SECONDS
\nStatistic: AVG
\nUnit: PERCENT
\nStatistic: AVG
\nUnit: SECONDS
\nStatistic: AVG
\nUnit: SECONDS
\nStatistic: MAX
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: PERCENT
\nStatistic: AVG
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The\n following historical metrics are available. For a description of each metric, see Metrics\n definition in the Amazon Connect Administrator Guide.
\nThis API does not support a contacts\n incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
\nUnit: SECONDS
\nStatistic: AVG
\nUnit: SECONDS
\nStatistic: AVG
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: COUNT
\nStatistic: SUM
\nUnit: SECONDS
\nStatistic: AVG
\nUnit: SECONDS
\nStatistic: AVG
\nUnit: SECONDS
\nStatistic: AVG
\nUnit: SECONDS
\nStatistic: AVG
\nUnit: PERCENT
\nStatistic: AVG
\nUnit: SECONDS
\nStatistic: AVG
\nUnit: SECONDS
\nStatistic: MAX
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: PERCENT
\nStatistic: AVG
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Gets metric data from the specified Amazon Connect instance.
\n\n GetMetricDataV2 offers more features than GetMetricData, the previous\n version of this API. It has new metrics, offers filtering at a metric level, and offers the\n ability to filter and group data by channels, queues, routing profiles, agents, and agent\n hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It\n does not support agent queues.
For a description of the historical metrics that are supported by\n GetMetricDataV2 and GetMetricData, see Historical metrics\n definitions in the Amazon Connect Administrator Guide.
Gets metric data from the specified Amazon Connect instance.
\n\n GetMetricDataV2 offers more features than GetMetricData, the previous\n version of this API. It has new metrics, offers filtering at a metric level, and offers the\n ability to filter and group data by channels, queues, routing profiles, agents, and agent\n hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It\n does not support agent queues.
For a description of the historical metrics that are supported by\n GetMetricDataV2 and GetMetricData, see Metrics definitions in the\n Amazon Connect Administrator Guide.
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator\n Guide.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Abandonment rate\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherent time\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent answer rate\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-adherent time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent\n non-response\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nData for this metric is available starting from October 1, 2023 0:00:00 GMT.
\nUI name: Agent non-response without customer abandons\n
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Occupancy\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherence\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Scheduled time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average queue abandon time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Average active time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average after contact work time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average agent API connecting time\n
\nThe Negate key in metric-level filters is not applicable for this\n metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Average agent pause time\n
\nUnit: Seconds
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID
\nUI name: Average\n bot conversation time\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID
\nUI name: Average bot conversation turns\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average contacts per case\n
\nUnit: Seconds
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average case resolution time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average contact duration\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average conversation duration\n
\nThis metric is available only for outbound campaigns that use the agent assisted voice\n and automated voice delivery modes.
\nUnit: Count
\nValid groupings and filters: Agent, Campaign, Queue, Routing Profile
\nUI name: Average dials per minute\n
\nUnit: Percent
\nValid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID,\n Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
\nUI name: Average agent evaluation score\n
\nUnit: Seconds
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Average flow time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent greeting time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: Average handle time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer hold time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer hold time all contacts\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average holds\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\n \nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interaction time\n
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interruptions\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interruption time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average non-talk time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average queue answer time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nUI name: Average resolution time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer talk time\n
\nThis metric is available only for outbound campaigns that use the agent assisted voice\n and automated voice delivery modes.
\nUnit: Seconds
\nValid groupings and filters: Campaign
\nUI name: Average wait time after customer connection\n
\nUnit: Percent
\nValid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID,\n Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
\nUI name: Average weighted agent evaluation score\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID
\nUI name: Bot\n conversations\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type,\n Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource\n type, Parent flows resource ID
\nUI name: Bot intents\n completed\n
\nThis metric is available only for outbound campaigns using the agent assisted voice and\n automated voice delivery modes.
\nUnit: Count
\nValid groupings and filters: Agent, Campaign
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter GT (for\n Greater than).
UI name: Campaign contacts abandoned after X\n
\nThis metric is available only for outbound campaigns using the agent assisted voice and\n automated voice delivery modes.
\nUnit: Percent
\nValid groupings and filters: Agent, Campaign
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter GT (for\n Greater than).
UI name: Campaign contacts abandoned after X rate\n
\nThis metric is available only for outbound campaigns using the email delivery mode.
\nUnit: Count
\nValid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
\nValid groupings and filters: Campaign
\nUI name: Campaign interactions\n
\nThis metric is available only for outbound campaigns.
\nUnit: Count
\nValid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype
\nUI name: Campaign send attempts\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases created\n
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts created\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
\nUI name: API contacts handled\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\n \nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts hold disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts hold agent disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts hold customer disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts put on hold\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts transferred out external\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts transferred out internal\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts queued\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts queued (enqueue timestamp)\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").
UI name: Contacts removed from queue in X seconds\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").
UI name: Contacts resolved in X\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out by agent\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out queue\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Current cases\n
\nThis metric is available only for outbound campaigns.
\nUnit: Count
\nValid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS,\n CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON\n
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery\n EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue,\n Routing Profile
\nUI name: Delivery attempts\n
\nCampaign Delivery EventType filter and grouping are only available for SMS and Email\n campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status\n and Disconnect Reason are only available for agent assisted voice and automated voice\n delivery modes.
\nThis metric is available only for outbound campaigns. Dispositions for the agent assisted\n voice and automated voice delivery modes are only available with answering machine detection\n enabled.
\nUnit: Percent
\nValid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS,\n CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON\n
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel,\n contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
\nUI name: Delivery attempt disposition rate\n
\nCampaign Delivery Event Type filter and grouping are only available for SMS and Email\n campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status\n and Disconnect Reason are only available for agent assisted voice and automated voice\n delivery modes.
\nUnit: Count
\nValid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form\n Version, Queue, Routing Profile
\nUI name: Evaluations performed\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Flows outcome\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows resource ID, Initiation method, Resource published timestamp
\nUI name: Flows started\n
\nThis metric is available only for outbound campaigns. Dispositions for the agent assisted\n voice and automated voice delivery modes are only available with answering machine detection\n enabled.
\nUnit: Count
\nValid groupings and filters: Agent, Campaign
\nUI name: Human answered\n
\nUnit: Seconds
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Maximum flow time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Maximum queued time\n
\nUnit: Seconds
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Minimum flow time\n
\nUnit: Percent
\nValid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form\n Version, Queue, Routing Profile
\nUI name: Automatic fails percent\n
\nUnit: Percent
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID
\nUI name: Percent bot conversations outcome\n
\nUnit: Percent
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type,\n Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource\n type, Parent flows resource ID
\nUI name: Percent\n bot intents outcome\n
\nUnit: Percent
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved on first contact\n
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.
\nUnit: Percent
\nValid metric filter key: FLOWS_OUTCOME_TYPE\n
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Flows outcome percentage.
\nThe FLOWS_OUTCOME_TYPE is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Non-talk\n time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Talk time\n percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Agent\n talk time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Customer talk time percent\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases reopened\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved\n
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").
UI name: Service level X\n
\nUnit: Count
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: After\n contact work time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. This metric only supports the\n following filter keys as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent API connecting time\n
\nThe Negate key in metric-level filters is not applicable for this\n metric.
Unit: Count
\nMetric filter:
\nValid values: API| Incoming | Outbound |\n Transfer | Callback | Queue_Transfer|\n Disconnect\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
\nUI name: Contact abandoned\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").
UI name: Contacts abandoned in X seconds\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").
UI name: Contacts answered in X seconds\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contact flow time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent on contact time\n
\nValid metric filter key: DISCONNECT_REASON\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contact disconnected\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Error status time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contact handle time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Customer hold time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent idle time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Agent interaction and hold time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent interaction time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-Productive Time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Online time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nUI name: Callback attempts\n
\nThe metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Metrics\n definition in the Amazon Connect Administrator Guide.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Abandonment\n rate\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherent time\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent answer\n rate\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Non-adherent\n time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent\n non-response\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nData for this metric is available starting from October 1, 2023 0:00:00 GMT.
\nUI name: Agent non-response without customer abandons\n
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Occupancy\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Adherence\n
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Scheduled\n time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average\n queue abandon time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Average active\n time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average\n after contact work time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Average agent API connecting time\n
\nThe Negate key in metric-level filters is not applicable for this\n metric.
Unit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Average\n agent pause time\n
\nUnit: Seconds
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID
\nUI name: Average bot\n conversation time\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID
\nUI name: Average bot\n conversation turns\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average\n contacts per case\n
\nUnit: Seconds
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Average\n case resolution time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average\n contact duration\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average conversation duration\n
\nThis metric is available only for outbound campaigns that use the agent assisted voice\n and automated voice delivery modes.
\nUnit: Count
\nValid groupings and filters: Agent, Campaign, Queue, Routing Profile
\nUI name: Average\n dials per minute\n
\nUnit: Percent
\nValid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID,\n Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
\nUI name: Average\n evaluation score\n
\nUnit: Seconds
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Average flow\n time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average\n agent greeting time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression
\nUI name: Average handle\n time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average\n customer hold time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average customer hold time all contacts\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average holds\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\n \nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interaction time\n
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average\n agent interruptions\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average agent interruption time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average\n non-talk time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average\n queue answer time\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nUI name: Average\n resolution time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average talk\n time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average\n agent talk time\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Average\n customer talk time\n
\nThis metric is available only for outbound campaigns that use the agent assisted voice\n and automated voice delivery modes.
\nUnit: Seconds
\nValid groupings and filters: Campaign
\nUI name: Average wait time after customer connection\n
\nUnit: Percent
\nValid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID,\n Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
\nUI name: Average weighted evaluation score\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID
\nUI name: Bot\n conversations completed\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type,\n Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource\n type, Parent flows resource ID
\nUI name: Bot intents\n completed\n
\nThis metric is available only for outbound campaigns using the agent assisted voice and\n automated voice delivery modes.
\nUnit: Count
\nValid groupings and filters: Agent, Campaign
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter GT (for\n Greater than).
UI name: Campaign contacts abandoned after X\n
\nThis metric is available only for outbound campaigns using the agent assisted voice and\n automated voice delivery modes.
\nUnit: Percent
\nValid groupings and filters: Agent, Campaign
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter GT (for\n Greater than).
UI name: Campaign contacts abandoned after X rate\n
\nThis metric is available only for outbound campaigns using the email delivery mode.
\nUnit: Count
\nValid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
\nValid groupings and filters: Campaign
\nUI name: Campaign\n interactions\n
\nThis metric is available only for outbound campaigns.
\nUnit: Count
\nValid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype
\nUI name: Campaign send\n attempts\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases created\n
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts\n created\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
\nUI name: API contacts\n handled\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\n \nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts\n hold disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts hold agent disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts hold customer disconnect\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts put on\n hold\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts transferred out external\n
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contacts transferred out internal\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts\n queued\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype
\nUI name: Contacts\n queued (enqueue timestamp)\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").
UI name: Contacts\n removed from queue in X seconds\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").
UI name: Contacts resolved\n in X\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts\n transferred out\n
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out by agent\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contacts transferred out queue\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Current cases\n
\nThis metric is available only for outbound campaigns.
\nUnit: Count
\nValid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS,\n CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON\n
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery\n EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue,\n Routing Profile
\nUI name: Delivery\n attempts\n
\nCampaign Delivery EventType filter and grouping are only available for SMS and Email\n campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status\n and Disconnect Reason are only available for agent assisted voice and automated voice\n delivery modes.
\nThis metric is available only for outbound campaigns. Dispositions for the agent assisted\n voice and automated voice delivery modes are only available with answering machine detection\n enabled.
\nUnit: Percent
\nValid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS,\n CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON\n
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel,\n contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
\nUI name: Delivery attempt disposition rate\n
\nCampaign Delivery Event Type filter and grouping are only available for SMS and Email\n campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status\n and Disconnect Reason are only available for agent assisted voice and automated voice\n delivery modes.
\nUnit: Count
\nValid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form\n Version, Queue, Routing Profile
\nUI name: Evaluations\n performed\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Flows\n outcome\n
\nUnit: Count
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows resource ID, Initiation method, Resource published timestamp
\nUI name: Flows\n started\n
\nThis metric is available only for outbound campaigns. Dispositions for the agent assisted\n voice and automated voice delivery modes are only available with answering machine detection\n enabled.
\nUnit: Count
\nValid groupings and filters: Agent, Campaign
\nUI name: Human\n answered\n
\nUnit: Seconds
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Maximum flow\n time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Maximum queued\n time\n
\nUnit: Seconds
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Minimum flow\n time\n
\nUnit: Percent
\nValid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form\n Version, Queue, Routing Profile
\nUI name: Automatic\n fails percent\n
\nUnit: Percent
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,\n Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows\n resource ID
\nUI name: Percent\n bot conversations outcome\n
\nUnit: Percent
\nValid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot\n version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type,\n Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource\n type, Parent flows resource ID
\nUI name: Percent bot\n intents outcome\n
\nUnit: Percent
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases resolved on first contact\n
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.
\nUnit: Percent
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.
\nUnit: Percent
\nValid metric filter key: FLOWS_OUTCOME_TYPE\n
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module\n resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows\n resource ID, Initiation method, Resource published timestamp
\nUI name: Flows\n outcome percentage.
\nThe FLOWS_OUTCOME_TYPE is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Non-talk time\n percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Talk time\n percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Agent talk\n time percent\n
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Percentage
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Customer\n talk time percent\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases\n reopened\n
\nUnit: Count
\nRequired filter key: CASE_TEMPLATE_ARN
\nValid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
\nUI name: Cases\n resolved\n
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").
UI name: Service level\n X\n
\nUnit: Count
\nValid groupings and filters: Queue, RoutingStepExpression
\nUI name: This metric is available in Real-time Metrics UI but not on the Historical\n Metrics UI.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: After\n contact work time\n
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. This metric only supports the\n following filter keys as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent API\n connecting time\n
\nThe Negate key in metric-level filters is not applicable for this\n metric.
Unit: Count
\nMetric filter:
\nValid values: API| Incoming | Outbound |\n Transfer | Callback | Queue_Transfer|\n Disconnect\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
\nUI name: Contact\n abandoned\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").
UI name: Contacts abandoned in X seconds\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you can use LT (for \"Less\n than\") or LTE (for \"Less than equal\").
UI name: Contacts answered in X seconds\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contact flow\n time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent on\n contact time\n
\nValid metric filter key: DISCONNECT_REASON\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,\n contact/segmentAttributes/connect:Subtype, Q in Connect
\nUI name: Contact\n disconnected\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Error status\n time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Contact handle\n time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Customer hold\n time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent idle\n time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
\nUI name: Agent interaction and hold time\n
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent\n interaction time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Agent\n non-productive time\n
\nUnit: Seconds
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nUI name: Online time\n
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,\n Q in Connect
\nUI name: Callback\n attempts\n
\nContains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator\n Guide.
" + "smithy.api#documentation": "Contains information about a historical metric. For a description of each metric, see Metrics\n definitions in the Amazon Connect Administrator Guide.
" } }, "com.amazonaws.connect#HistoricalMetricData": { @@ -27247,6 +27433,23 @@ "com.amazonaws.connect#MediaRegion": { "type": "string" }, + "com.amazonaws.connect#MediaStreamType": { + "type": "enum", + "members": { + "AUDIO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUDIO" + } + }, + "VIDEO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VIDEO" + } + } + } + }, "com.amazonaws.connect#Meeting": { "type": "structure", "members": { @@ -27381,7 +27584,7 @@ "MetricFilterValues": { "target": "com.amazonaws.connect#MetricFilterValueList", "traits": { - "smithy.api#documentation": "The values to use for filtering data. Values for metric-level filters can be either a fixed\n set of values or a customized list, depending on the use case.
\nFor valid values of metric-level filters INITIATION_METHOD,\n DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the\n description for the Flow outcome metric in the Amazon Connect Administrator\n Guide.
For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE, see\n the description for the Bot\n conversations completed in the Amazon Connect Administrator\n Guide.
For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE, see the\n description for the Bot intents\n completed metric in the Amazon Connect Administrator\n Guide.
The values to use for filtering data. Values for metric-level filters can be either a fixed\n set of values or a customized list, depending on the use case.
\nFor valid values of metric-level filters INITIATION_METHOD,\n DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the\n description for the Flow outcome\n metric in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE, see\n the description for the Bot\n conversations completed in the Amazon Connect Administrator\n Guide.
For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE, see the\n description for the Bot intents\n completed metric in the Amazon Connect Administrator\n Guide.
The credentials used by the participant.
" } }, + "com.amazonaws.connect#ParticipantType": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "MANAGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGER" + } + }, + "AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT" + } + }, + "CUSTOMER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER" + } + }, + "THIRDPARTY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THIRDPARTY" + } + } + } + }, "com.amazonaws.connect#Password": { "type": "string", "traits": { @@ -32334,6 +32601,109 @@ "target": "com.amazonaws.connect#RealtimeContactAnalysisSegment" } }, + "com.amazonaws.connect#RecordingDeletionReason": { + "type": "string" + }, + "com.amazonaws.connect#RecordingInfo": { + "type": "structure", + "members": { + "StorageType": { + "target": "com.amazonaws.connect#StorageType", + "traits": { + "smithy.api#documentation": "Where the recording/transcript is stored.
" + } + }, + "Location": { + "target": "com.amazonaws.connect#RecordingLocation", + "traits": { + "smithy.api#documentation": "The location, in Amazon S3, for the recording/transcript.
" + } + }, + "MediaStreamType": { + "target": "com.amazonaws.connect#MediaStreamType", + "traits": { + "smithy.api#documentation": "Information about the media stream used during the conversation.
" + } + }, + "ParticipantType": { + "target": "com.amazonaws.connect#ParticipantType", + "traits": { + "smithy.api#documentation": "Information about the conversation participant, whether they are an agent or contact. The\n participant types are as follows:
\nAll
\nManager
\nAgent
\nCustomer
\nThirdparty
\nSupervisor
\nThe number that identifies the Kinesis Video Streams fragment where the customer audio\n stream started.
" + } + }, + "FragmentStopNumber": { + "target": "com.amazonaws.connect#FragmentNumber", + "traits": { + "smithy.api#documentation": "The number that identifies the Kinesis Video Streams fragment where the customer audio\n stream stopped.
" + } + }, + "StartTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "When the conversation of the last leg of the recording started in UTC time.
" + } + }, + "StopTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "When the conversation of the last leg of recording stopped in UTC time.
" + } + }, + "Status": { + "target": "com.amazonaws.connect#RecordingStatus", + "traits": { + "smithy.api#documentation": "The status of the recording/transcript.
" + } + }, + "DeletionReason": { + "target": "com.amazonaws.connect#RecordingDeletionReason", + "traits": { + "smithy.api#documentation": "If the recording/transcript was deleted, this is the reason entered for the deletion.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a voice recording, chat transcript, or screen recording.
" + } + }, + "com.amazonaws.connect#RecordingLocation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.connect#RecordingStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.connect#Recordings": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RecordingInfo" + } + }, "com.amazonaws.connect#Reference": { "type": "structure", "members": { @@ -38649,6 +39019,38 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#StateTransition": { + "type": "structure", + "members": { + "State": { + "target": "com.amazonaws.connect#ParticipantState", + "traits": { + "smithy.api#documentation": "The state of the transition.
" + } + }, + "StateStartTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the state started in UTC time.
" + } + }, + "StateEndTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the state ended in UTC time.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the state transition of a supervisor.
" + } + }, + "com.amazonaws.connect#StateTransitions": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#StateTransition" + } + }, "com.amazonaws.connect#Statistic": { "type": "enum", "members": { @@ -38672,6 +39074,29 @@ } } }, + "com.amazonaws.connect#Status": { + "type": "enum", + "members": { + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, "com.amazonaws.connect#Step": { "type": "structure", "members": { @@ -39206,7 +39631,7 @@ } ], "traits": { - "smithy.api#documentation": "When a contact is being recorded, this API suspends recording whatever is selected in the\n flow configuration: call (IVR or agent), screen, or both. If only call recording or only screen\n recording is enabled, then it would be suspended. For example, you might suspend the screen\n recording while collecting sensitive information, such as a credit card number. Then use\n ResumeContactRecording\n to restart recording the screen.
\nThe period of time that the recording is suspended is filled with silence in the final recording.\n
\nVoice (IVR, agent) and screen recordings are supported.
", + "smithy.api#documentation": "When a contact is being recorded, this API suspends recording whatever is selected in the\n flow configuration: call (IVR or agent), screen, or both. If only call recording or only screen\n recording is enabled, then it would be suspended. For example, you might suspend the screen\n recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.
\nThe period of time that the recording is suspended is filled with silence in the final\n recording.
\nVoice (IVR, agent) and screen recordings are supported.
", "smithy.api#http": { "method": "POST", "uri": "/contact/suspend-recording", diff --git a/connectcampaigns/service/2021-01-30/connectcampaigns-2021-01-30.json b/models/connectcampaigns/service/2021-01-30/connectcampaigns-2021-01-30.json similarity index 100% rename from connectcampaigns/service/2021-01-30/connectcampaigns-2021-01-30.json rename to models/connectcampaigns/service/2021-01-30/connectcampaigns-2021-01-30.json diff --git a/connectcampaignsv2/service/2024-04-23/connectcampaignsv2-2024-04-23.json b/models/connectcampaignsv2/service/2024-04-23/connectcampaignsv2-2024-04-23.json similarity index 100% rename from connectcampaignsv2/service/2024-04-23/connectcampaignsv2-2024-04-23.json rename to models/connectcampaignsv2/service/2024-04-23/connectcampaignsv2-2024-04-23.json diff --git a/connectcases/service/2022-10-03/connectcases-2022-10-03.json b/models/connectcases/service/2022-10-03/connectcases-2022-10-03.json similarity index 99% rename from connectcases/service/2022-10-03/connectcases-2022-10-03.json rename to models/connectcases/service/2022-10-03/connectcases-2022-10-03.json index f095d662..64a3fa16 100644 --- a/connectcases/service/2022-10-03/connectcases-2022-10-03.json +++ b/models/connectcases/service/2022-10-03/connectcases-2022-10-03.json @@ -2472,6 +2472,17 @@ "smithy.api#timestampFormat": "date-time" } }, + "com.amazonaws.connectcases#CustomEntity": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 500 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-\\.@:/ ]*[a-zA-Z0-9_\\-\\.@:/]$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.connectcases#DeleteCaseRule": { "type": "operation", "input": { @@ -5580,7 +5591,7 @@ "smithy.api#documentation": "The maximum number of cases to return. The current maximum supported value is 25. This is\n also the default value when no other value is provided.
", "smithy.api#range": { "min": 1, - "max": 25 + "max": 100 } } }, @@ -5642,7 +5653,7 @@ "traits": { "smithy.api#documentation": "A list of case documents where each case contains the properties CaseId and\n Fields where each field is a complex union structure.
Represents the Amazon Connect ARN of the user.
" } + }, + "customEntity": { + "target": "com.amazonaws.connectcases#CustomEntity", + "traits": { + "smithy.api#documentation": "Any provided entity.
" + } } }, "traits": { - "smithy.api#documentation": "Represents the identity of the person who performed the action.
" + "smithy.api#documentation": "Represents the entity that performed the action.
" } }, "com.amazonaws.connectcases#ValidationException": { diff --git a/connectparticipant/service/2018-09-07/connectparticipant-2018-09-07.json b/models/connectparticipant/service/2018-09-07/connectparticipant-2018-09-07.json similarity index 100% rename from connectparticipant/service/2018-09-07/connectparticipant-2018-09-07.json rename to models/connectparticipant/service/2018-09-07/connectparticipant-2018-09-07.json diff --git a/controlcatalog/service/2018-05-10/controlcatalog-2018-05-10.json b/models/controlcatalog/service/2018-05-10/controlcatalog-2018-05-10.json similarity index 100% rename from controlcatalog/service/2018-05-10/controlcatalog-2018-05-10.json rename to models/controlcatalog/service/2018-05-10/controlcatalog-2018-05-10.json diff --git a/controltower/service/2018-05-10/controltower-2018-05-10.json b/models/controltower/service/2018-05-10/controltower-2018-05-10.json similarity index 100% rename from controltower/service/2018-05-10/controltower-2018-05-10.json rename to models/controltower/service/2018-05-10/controltower-2018-05-10.json diff --git a/cost-and-usage-report-service/service/2017-01-06/cost-and-usage-report-service-2017-01-06.json b/models/cost-and-usage-report-service/service/2017-01-06/cost-and-usage-report-service-2017-01-06.json similarity index 100% rename from cost-and-usage-report-service/service/2017-01-06/cost-and-usage-report-service-2017-01-06.json rename to models/cost-and-usage-report-service/service/2017-01-06/cost-and-usage-report-service-2017-01-06.json diff --git a/cost-explorer/service/2017-10-25/cost-explorer-2017-10-25.json b/models/cost-explorer/service/2017-10-25/cost-explorer-2017-10-25.json similarity index 100% rename from cost-explorer/service/2017-10-25/cost-explorer-2017-10-25.json rename to models/cost-explorer/service/2017-10-25/cost-explorer-2017-10-25.json diff --git a/cost-optimization-hub/service/2022-07-26/cost-optimization-hub-2022-07-26.json b/models/cost-optimization-hub/service/2022-07-26/cost-optimization-hub-2022-07-26.json similarity index 100% rename from cost-optimization-hub/service/2022-07-26/cost-optimization-hub-2022-07-26.json rename to models/cost-optimization-hub/service/2022-07-26/cost-optimization-hub-2022-07-26.json diff --git a/customer-profiles/service/2020-08-15/customer-profiles-2020-08-15.json b/models/customer-profiles/service/2020-08-15/customer-profiles-2020-08-15.json similarity index 100% rename from customer-profiles/service/2020-08-15/customer-profiles-2020-08-15.json rename to models/customer-profiles/service/2020-08-15/customer-profiles-2020-08-15.json diff --git a/data-pipeline/service/2012-10-29/data-pipeline-2012-10-29.json b/models/data-pipeline/service/2012-10-29/data-pipeline-2012-10-29.json similarity index 100% rename from data-pipeline/service/2012-10-29/data-pipeline-2012-10-29.json rename to models/data-pipeline/service/2012-10-29/data-pipeline-2012-10-29.json diff --git a/database-migration-service/service/2016-01-01/database-migration-service-2016-01-01.json b/models/database-migration-service/service/2016-01-01/database-migration-service-2016-01-01.json similarity index 100% rename from database-migration-service/service/2016-01-01/database-migration-service-2016-01-01.json rename to models/database-migration-service/service/2016-01-01/database-migration-service-2016-01-01.json diff --git a/databrew/service/2017-07-25/databrew-2017-07-25.json b/models/databrew/service/2017-07-25/databrew-2017-07-25.json similarity index 100% rename from databrew/service/2017-07-25/databrew-2017-07-25.json rename to models/databrew/service/2017-07-25/databrew-2017-07-25.json diff --git a/dataexchange/service/2017-07-25/dataexchange-2017-07-25.json b/models/dataexchange/service/2017-07-25/dataexchange-2017-07-25.json similarity index 100% rename from dataexchange/service/2017-07-25/dataexchange-2017-07-25.json rename to models/dataexchange/service/2017-07-25/dataexchange-2017-07-25.json diff --git a/datasync/service/2018-11-09/datasync-2018-11-09.json b/models/datasync/service/2018-11-09/datasync-2018-11-09.json similarity index 100% rename from datasync/service/2018-11-09/datasync-2018-11-09.json rename to models/datasync/service/2018-11-09/datasync-2018-11-09.json diff --git a/datazone/service/2018-05-10/datazone-2018-05-10.json b/models/datazone/service/2018-05-10/datazone-2018-05-10.json similarity index 99% rename from datazone/service/2018-05-10/datazone-2018-05-10.json rename to models/datazone/service/2018-05-10/datazone-2018-05-10.json index 838e255a..1d71029f 100644 --- a/datazone/service/2018-05-10/datazone-2018-05-10.json +++ b/models/datazone/service/2018-05-10/datazone-2018-05-10.json @@ -24751,6 +24751,12 @@ "traits": { "smithy.api#enumValue": "CREATE_PROJECT_FROM_PROJECT_PROFILE" } + }, + "USE_ASSET_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USE_ASSET_TYPE" + } } } }, @@ -25976,6 +25982,12 @@ "traits": { "smithy.api#documentation": "Specifies whether to create a project from project profile.
" } + }, + "useAssetType": { + "target": "com.amazonaws.datazone#UseAssetTypePolicyGrantDetail", + "traits": { + "smithy.api#documentation": "Specifies the domain unit(s) whose projects can use this asset type while creating asset or asset revisions.
" + } } }, "traits": { @@ -31649,6 +31661,12 @@ "traits": { "smithy.api#enumValue": "ENVIRONMENT_PROFILE" } + }, + "ASSET_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSET_TYPE" + } } } }, @@ -35385,7 +35403,7 @@ "authorizedPrincipals": { "target": "com.amazonaws.datazone#AuthorizedPrincipalIdentifiers", "traits": { - "smithy.api#documentation": "The authorized principals to be updated as part of the\n UpdateSubscriptionTarget action.
The authorized principals to be updated as part of the\n UpdateSubscriptionTarget action. Updates are supported in batches of 5 at a\n time.
The ID of the domain unit.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the domain unit(s) whose projects can use this asset type while creating asset or asset revisions.
" + } + }, "com.amazonaws.datazone#UserAssignment": { "type": "enum", "members": { diff --git a/dax/service/2017-04-19/dax-2017-04-19.json b/models/dax/service/2017-04-19/dax-2017-04-19.json similarity index 100% rename from dax/service/2017-04-19/dax-2017-04-19.json rename to models/dax/service/2017-04-19/dax-2017-04-19.json diff --git a/deadline/service/2023-10-12/deadline-2023-10-12.json b/models/deadline/service/2023-10-12/deadline-2023-10-12.json similarity index 99% rename from deadline/service/2023-10-12/deadline-2023-10-12.json rename to models/deadline/service/2023-10-12/deadline-2023-10-12.json index 1874f631..3341836d 100644 --- a/deadline/service/2023-10-12/deadline-2023-10-12.json +++ b/models/deadline/service/2023-10-12/deadline-2023-10-12.json @@ -3744,6 +3744,12 @@ "smithy.api#httpHeader": "X-Amz-Client-Token", "smithy.api#idempotencyToken": {} } + }, + "tags": { + "target": "com.amazonaws.deadline#Tags", + "traits": { + "smithy.api#documentation": "Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
" + } } }, "traits": { @@ -3820,6 +3826,12 @@ "traits": { "smithy.api#documentation": "The storage profile ID.
" } + }, + "tagPropagationMode": { + "target": "com.amazonaws.deadline#TagPropagationMode", + "traits": { + "smithy.api#documentation": "Specifies whether tags associated with a fleet are attached to workers when the worker\n is launched.
\nWhen the tagPropagationMode is set to\n PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH any tag associated with a fleet is\n attached to workers when they launch. If the tags for a fleet change, the tags associated\n with running workers do not change.
If you don't specify tagPropagationMode, the default is\n NO_PROPAGATION.
Specifies how Deadline Cloud matches your search term in the results. If you don't\n specify a matchType the default is FUZZY_MATCH.
\n FUZZY_MATCH - Matches if a portion of the search term is found in the result.
\n CONTAINS - Matches if the exact search term is contained in the result.
Specifies how Deadline Cloud matches your search term in the results. If you don't\n specify a matchType the default is FUZZY_MATCH.
\n FUZZY_MATCH - Matches if a portion of the search term is found in the\n result.
\n CONTAINS - Matches if the exact search term is contained in the\n result.
The details of a synced job attachment.
" } }, + "com.amazonaws.deadline#TagPropagationMode": { + "type": "enum", + "members": { + "NO_PROPAGATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_PROPAGATION" + } + }, + "PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROPAGATE_TAGS_TO_WORKERS_AT_LAUNCH" + } + } + } + }, "com.amazonaws.deadline#TagResource": { "type": "operation", "input": { @@ -19178,7 +19214,8 @@ "traits": { "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", - "aws:TagKeys" + "aws:TagKeys", + "deadline:CalledAction" ], "aws.iam#iamAction": { "name": "TagResource", diff --git a/detective/service/2018-10-26/detective-2018-10-26.json b/models/detective/service/2018-10-26/detective-2018-10-26.json similarity index 100% rename from detective/service/2018-10-26/detective-2018-10-26.json rename to models/detective/service/2018-10-26/detective-2018-10-26.json diff --git a/device-farm/service/2015-06-23/device-farm-2015-06-23.json b/models/device-farm/service/2015-06-23/device-farm-2015-06-23.json similarity index 99% rename from device-farm/service/2015-06-23/device-farm-2015-06-23.json rename to models/device-farm/service/2015-06-23/device-farm-2015-06-23.json index bf567b21..8978ac32 100644 --- a/device-farm/service/2015-06-23/device-farm-2015-06-23.json +++ b/models/device-farm/service/2015-06-23/device-farm-2015-06-23.json @@ -3901,6 +3901,12 @@ "traits": { "smithy.api#documentation": "An object that contains information about the settings for a run.
" } + }, + "projectArn": { + "target": "com.amazonaws.devicefarm#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the project for which you want to check\n device pool compatibility.
" + } } }, "traits": { diff --git a/devops-guru/service/2020-12-01/devops-guru-2020-12-01.json b/models/devops-guru/service/2020-12-01/devops-guru-2020-12-01.json similarity index 100% rename from devops-guru/service/2020-12-01/devops-guru-2020-12-01.json rename to models/devops-guru/service/2020-12-01/devops-guru-2020-12-01.json diff --git a/direct-connect/service/2012-10-25/direct-connect-2012-10-25.json b/models/direct-connect/service/2012-10-25/direct-connect-2012-10-25.json similarity index 100% rename from direct-connect/service/2012-10-25/direct-connect-2012-10-25.json rename to models/direct-connect/service/2012-10-25/direct-connect-2012-10-25.json diff --git a/directory-service-data/service/2023-05-31/directory-service-data-2023-05-31.json b/models/directory-service-data/service/2023-05-31/directory-service-data-2023-05-31.json similarity index 100% rename from directory-service-data/service/2023-05-31/directory-service-data-2023-05-31.json rename to models/directory-service-data/service/2023-05-31/directory-service-data-2023-05-31.json diff --git a/directory-service/service/2015-04-16/directory-service-2015-04-16.json b/models/directory-service/service/2015-04-16/directory-service-2015-04-16.json similarity index 90% rename from directory-service/service/2015-04-16/directory-service-2015-04-16.json rename to models/directory-service/service/2015-04-16/directory-service-2015-04-16.json index f2a38f9d..7abe97cf 100644 --- a/directory-service/service/2015-04-16/directory-service-2015-04-16.json +++ b/models/directory-service/service/2015-04-16/directory-service-2015-04-16.json @@ -143,7 +143,23 @@ } ], "traits": { - "smithy.api#documentation": "If the DNS server for your self-managed domain uses a publicly addressable IP address,\n you must add a CIDR address block to correctly route traffic to and from your Microsoft AD\n on Amazon Web Services. AddIpRoutes adds this address block. You can\n also use AddIpRoutes to facilitate routing traffic that uses public IP\n ranges from your Microsoft AD on Amazon Web Services to a peer VPC.
\nBefore you call AddIpRoutes, ensure that all of the required\n permissions have been explicitly granted through a policy. For details about what\n permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
" + "smithy.api#documentation": "If the DNS server for your self-managed domain uses a publicly addressable IP address,\n you must add a CIDR address block to correctly route traffic to and from your Microsoft AD\n on Amazon Web Services. AddIpRoutes adds this address block. You can\n also use AddIpRoutes to facilitate routing traffic that uses public IP\n ranges from your Microsoft AD on Amazon Web Services to a peer VPC.
\nBefore you call AddIpRoutes, ensure that all of the required\n permissions have been explicitly granted through a policy. For details about what\n permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
", + "smithy.api#examples": [ + { + "title": "To add a CIDR address block that routes traffic for Microsoft AD", + "documentation": "The following example adds a CIDR address block to correctly route traffic to and from your Microsoft AD on AWS.", + "input": { + "DirectoryId": "d-92654abfed", + "IpRoutes": [ + { + "Description": "my IpRoute", + "CidrIp": "12.12.12.12/32" + } + ] + }, + "output": {} + } + ] } }, "com.amazonaws.directoryservice#AddIpRoutesRequest": { @@ -287,7 +303,23 @@ } ], "traits": { - "smithy.api#documentation": "Adds or overwrites one or more tags for the specified directory. Each directory can\n have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be\n unique to each resource.
" + "smithy.api#documentation": "Adds or overwrites one or more tags for the specified directory. Each directory can\n have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be\n unique to each resource.
", + "smithy.api#examples": [ + { + "title": "To add tags to a directory", + "documentation": "The following example adds or overwrites one or more tags for the specified directory.", + "input": { + "ResourceId": "d-92654abfed", + "Tags": [ + { + "Key": "environment", + "Value": "production" + } + ] + }, + "output": {} + } + ] } }, "com.amazonaws.directoryservice#AddTagsToResourceRequest": { @@ -425,7 +457,18 @@ } ], "traits": { - "smithy.api#documentation": "Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema\n extension has started replicating to all domain controllers, the task can no longer be\n canceled. A schema extension can be canceled during any of the following states;\n Initializing, CreatingSnapshot, and\n UpdatingSchema.
Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema\n extension has started replicating to all domain controllers, the task can no longer be\n canceled. A schema extension can be canceled during any of the following states;\n Initializing, CreatingSnapshot, and\n UpdatingSchema.
The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.
The function that the registered certificate performs. Valid values include\n ClientLDAPS or ClientCertAuth. The default value is\n ClientLDAPS.
A ClientCertAuthSettings object that contains client certificate authentication settings.
A ClientCertAuthSettings object that contains client certificate\n authentication settings.
The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.
The function that the registered certificate performs. Valid values include\n ClientLDAPS or ClientCertAuth. The default value is\n ClientLDAPS.
The type of client authentication for the specified directory. If no type is specified, a list of all client authentication types that are supported for the directory is retrieved.
" + "smithy.api#documentation": "The type of client authentication for the specified directory. If no type is specified, a\n list of all client authentication types that are supported for the directory is retrieved.\n
" } }, "Status": { "target": "com.amazonaws.directoryservice#ClientAuthenticationStatus", "traits": { - "smithy.api#documentation": "Whether the client authentication type is enabled or disabled for the specified directory.
" + "smithy.api#documentation": "Whether the client authentication type is enabled or disabled for the specified\n directory.
" } }, "LastUpdatedDateTime": { "target": "com.amazonaws.directoryservice#LastUpdatedDateTime", "traits": { - "smithy.api#documentation": "The date and time when the status of the client authentication type was last updated.
" + "smithy.api#documentation": "The date and time when the status of the client authentication type was last\n updated.
" } } }, @@ -786,12 +829,12 @@ "OCSPUrl": { "target": "com.amazonaws.directoryservice#OCSPUrl", "traits": { - "smithy.api#documentation": "Specifies the URL of the default OCSP server used to check for revocation status. A secondary value to any OCSP address found in the AIA extension of the user certificate.
" + "smithy.api#documentation": "Specifies the URL of the default OCSP server used to check for revocation status. A\n secondary value to any OCSP address found in the AIA extension of the user certificate.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about the client certificate authentication settings for the RegisterCertificate and DescribeCertificate operations.
Contains information about the client certificate authentication settings for the\n RegisterCertificate and DescribeCertificate operations.
Creates an AD Connector to connect to a self-managed directory.
\nBefore you call ConnectDirectory, ensure that all of the required permissions\n have been explicitly granted through a policy. For details about what permissions are required\n to run the ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions\n Reference.
Creates an AD Connector to connect to a self-managed directory.
\nBefore you call ConnectDirectory, ensure that all of the required permissions\n have been explicitly granted through a policy. For details about what permissions are required\n to run the ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
Creates an alias for a directory and assigns the alias to the directory. The alias is used\n to construct the access URL for the directory, such as\n http://.
After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
\nCreates an alias for a directory and assigns the alias to the directory. The alias is used\n to construct the access URL for the directory, such as\n http://.
After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
\nCreates an Active Directory computer object in the specified directory.
" + "smithy.api#documentation": "Creates an Active Directory computer object in the specified directory.
", + "smithy.api#examples": [ + { + "title": "To create a computer account", + "documentation": "The following example creates a computer account in the specified directory, and joins the computer to the directory.", + "input": { + "DirectoryId": "d-92654abfed", + "ComputerName": "labcomputer", + "Password": "Str0ngP@ssw0rd", + "OrganizationalUnitDistinguishedName": "OU=Computers,OU=example,DC=corp,DC=example,DC=com", + "ComputerAttributes": [ + { + "Name": "ip", + "Value": "192.168.101.100" + } + ] + }, + "output": { + "Computer": { + "ComputerAttributes": [ + { + "Name": "DistinguishedName", + "Value": "CN=labcomputer,OU=Computers,OU=nickcorp,DC=seattle,DC=nickcorp,DC=com" + }, + { + "Name": "WindowsSamName", + "Value": "labcomputer$" + } + ], + "ComputerId": "S-1-5-21-1932691875-1648176379-1176097576-1124", + "ComputerName": "labcomputer" + } + } + } + ] } }, "com.amazonaws.directoryservice#CreateComputerRequest": { @@ -1205,7 +1323,21 @@ } ], "traits": { - "smithy.api#documentation": "Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional\n forwarders are required in order to set up a trust relationship with another domain. The\n conditional forwarder points to the trusted domain.
" + "smithy.api#documentation": "Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional\n forwarders are required in order to set up a trust relationship with another domain. The\n conditional forwarder points to the trusted domain.
", + "smithy.api#examples": [ + { + "title": "To create a conditional forwarder", + "documentation": "The following example creates a conditional forwarder associated with your AWS directory.", + "input": { + "DirectoryId": "d-92654abfed", + "RemoteDomainName": "sales.example.com", + "DnsIpAddrs": [ + "172.30.21.228" + ] + }, + "output": {} + } + ] } }, "com.amazonaws.directoryservice#CreateConditionalForwarderRequest": { @@ -1269,7 +1401,30 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin\n Guide.
\nBefore you call CreateDirectory, ensure that all of the required permissions\n have been explicitly granted through a policy. For details about what permissions are required\n to run the CreateDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions\n Reference.
Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide.
\nBefore you call CreateDirectory, ensure that all of the required permissions\n have been explicitly granted through a policy. For details about what permissions are required\n to run the CreateDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.
\nBefore you call CreateMicrosoftAD, ensure that all of the required\n permissions have been explicitly granted through a policy. For details about what permissions\n are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
" + "smithy.api#documentation": "Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.
\nBefore you call CreateMicrosoftAD, ensure that all of the required\n permissions have been explicitly granted through a policy. For details about what permissions\n are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
", + "smithy.api#examples": [ + { + "title": "To create a Microsoft AD directory", + "documentation": "The following example creates a Microsoft AD directory in the AWS cloud.", + "input": { + "Name": "ad.example.com", + "ShortName": "ad", + "Password": "Str0ngP@ssw0rd", + "Description": "Corporate AD directory", + "VpcSettings": { + "SubnetIds": [ + "subnet-ba0146de", + "subnet-bef46bc8" + ], + "VpcId": "vpc-45025421" + } + }, + "output": { + "DirectoryId": "d-92654abfed" + } + } + ] } }, "com.amazonaws.directoryservice#CreateMicrosoftADRequest": { @@ -1526,7 +1703,20 @@ } ], "traits": { - "smithy.api#documentation": "Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
\nYou cannot take snapshots of AD Connector directories.
\nCreates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
\nYou cannot take snapshots of AD Connector directories.
\nDirectory Service for Microsoft Active Directory allows you to configure trust relationships. For\n example, you can establish a trust between your Managed Microsoft AD directory, and your existing\n self-managed Microsoft Active Directory. This would allow you to provide users and groups\n access to resources in either domain, with a single set of credentials.
\nThis action initiates the creation of the Amazon Web Services side of a trust relationship between an\n Managed Microsoft AD directory and an external domain. You can create either a forest trust or an\n external trust.
" + "smithy.api#documentation": "Directory Service for Microsoft Active Directory allows you to configure trust relationships. For\n example, you can establish a trust between your Managed Microsoft AD directory, and your existing\n self-managed Microsoft Active Directory. This would allow you to provide users and groups\n access to resources in either domain, with a single set of credentials.
\nThis action initiates the creation of the Amazon Web Services side of a trust relationship between an\n Managed Microsoft AD directory and an external domain. You can create either a forest trust or an\n external trust.
", + "smithy.api#examples": [ + { + "title": "To create a trust", + "documentation": "The following example creates a trust between Microsoft AD in the AWS cloud and an external domain.", + "input": { + "DirectoryId": "d-92654abfed", + "RemoteDomainName": "europe.example.com", + "TrustPassword": "Str0ngP@ssw0rd", + "TrustDirection": "One-Way: Outgoing", + "TrustType": "Forest", + "ConditionalForwarderIpAddrs": [ + "172.30.21.228" + ] + }, + "output": { + "TrustId": "t-9267353743" + } + } + ] } }, "com.amazonaws.directoryservice#CreateTrustRequest": { @@ -1769,7 +1978,18 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a conditional forwarder that has been set up for your Amazon Web Services\n directory.
" + "smithy.api#documentation": "Deletes a conditional forwarder that has been set up for your Amazon Web Services\n directory.
", + "smithy.api#examples": [ + { + "title": "To delete a conditional forwarder", + "documentation": "The following example deletes a conditional forwarder. ", + "input": { + "DirectoryId": "d-92654abfed", + "RemoteDomainName": "sales.example.com" + }, + "output": {} + } + ] } }, "com.amazonaws.directoryservice#DeleteConditionalForwarderRequest": { @@ -1823,7 +2043,19 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an Directory Service directory.
\nBefore you call DeleteDirectory, ensure that all of the required permissions\n have been explicitly granted through a policy. For details about what permissions are required\n to run the DeleteDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions\n Reference.
Deletes an Directory Service directory.
\nBefore you call DeleteDirectory, ensure that all of the required permissions\n have been explicitly granted through a policy. For details about what permissions are required\n to run the DeleteDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
Deletes a directory snapshot.
" + "smithy.api#documentation": "Deletes a directory snapshot.
", + "smithy.api#examples": [ + { + "title": "To delete a snapshot", + "documentation": "The following example deletes a directory snapshot.", + "input": { + "SnapshotId": "s-9267f8d3f0" + }, + "output": { + "SnapshotId": "s-9267f8d3f0" + } + } + ] } }, "com.amazonaws.directoryservice#DeleteSnapshotRequest": { @@ -1988,7 +2232,20 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing trust relationship between your Managed Microsoft AD directory and an external\n domain.
" + "smithy.api#documentation": "Deletes an existing trust relationship between your Managed Microsoft AD directory and an external\n domain.
", + "smithy.api#examples": [ + { + "title": "To delete a trust", + "documentation": "The following example deletes an existing trust between your Microsoft AD in the AWS cloud and an external domain.", + "input": { + "TrustId": "t-9267353743", + "DeleteAssociatedConditionalForwarder": true + }, + "output": { + "TrustId": "t-9267353743" + } + } + ] } }, "com.amazonaws.directoryservice#DeleteTrustRequest": { @@ -2064,7 +2321,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
" + "smithy.api#documentation": "Deletes from the system the certificate that was registered for secure LDAP or client\n certificate authentication.
" } }, "com.amazonaws.directoryservice#DeregisterCertificateRequest": { @@ -2119,7 +2376,18 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specified directory as a publisher to the specified Amazon SNS topic.
" + "smithy.api#documentation": "Removes the specified directory as a publisher to the specified Amazon SNS topic.
", + "smithy.api#examples": [ + { + "title": "To remove an event topic", + "documentation": "The following example removes the specified directory as a publisher to the specified SNS topic.", + "input": { + "DirectoryId": "d-92654abfed", + "TopicName": "snstopicexample" + }, + "output": {} + } + ] } }, "com.amazonaws.directoryservice#DeregisterEventTopicRequest": { @@ -2182,7 +2450,7 @@ } ], "traits": { - "smithy.api#documentation": "Displays information about the certificate registered for secure LDAP or client certificate authentication.
" + "smithy.api#documentation": "Displays information about the certificate registered for secure LDAP or client\n certificate authentication.
" } }, "com.amazonaws.directoryservice#DescribeCertificateRequest": { @@ -2250,7 +2518,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported.\n
Retrieves information about the type of client authentication for the specified directory,\n if the type is specified. If no type is specified, information about all client authentication\n types that are supported for the specified directory is retrieved. Currently, only\n SmartCard is supported.
The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.
" + "smithy.api#documentation": "The type of client authentication for which to retrieve information. If no type is\n specified, a list of all client authentication types that are supported for the specified\n directory is retrieved.
" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { - "smithy.api#documentation": "The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call.
" + "smithy.api#documentation": "The DescribeClientAuthenticationSettingsResult.NextToken value from a\n previous call to DescribeClientAuthenticationSettings. Pass null if this is\n the first call.
" } }, "Limit": { "target": "com.amazonaws.directoryservice#PageLimit", "traits": { - "smithy.api#documentation": "The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
" + "smithy.api#documentation": "The maximum number of items to return. If this value is zero, the maximum number of items\n is specified by the limitations of the operation.
" } } }, @@ -2298,13 +2566,13 @@ "ClientAuthenticationSettingsInfo": { "target": "com.amazonaws.directoryservice#ClientAuthenticationSettingsInfo", "traits": { - "smithy.api#documentation": "Information about the type of client authentication for the specified directory. The following information is retrieved: The date and time when the status of the client authentication type was last updated, whether the client authentication type is enabled or disabled, and the type of client authentication.
" + "smithy.api#documentation": "Information about the type of client authentication for the specified directory. The\n following information is retrieved: The date and time when the status of the client\n authentication type was last updated, whether the client authentication type is enabled or\n disabled, and the type of client authentication.
" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { - "smithy.api#documentation": "The next token used to retrieve the client authentication settings if the number of setting types exceeds\n page limit and there is another page.
" + "smithy.api#documentation": "The next token used to retrieve the client authentication settings if the number of\n setting types exceeds page limit and there is another page.
" } } }, @@ -2341,7 +2609,22 @@ } ], "traits": { - "smithy.api#documentation": "Obtains information about the conditional forwarders for this account.
\nIf no input parameters are provided for RemoteDomainNames, this request describes all\n conditional forwarders for the specified directory ID.
" + "smithy.api#documentation": "Obtains information about the conditional forwarders for this account.
\nIf no input parameters are provided for RemoteDomainNames, this request describes all\n conditional forwarders for the specified directory ID.
", + "smithy.api#examples": [ + { + "title": "To describe conditional forwarders", + "documentation": "The following example obtains information about the conditional forwarders for a specified directory.", + "input": { + "DirectoryId": "d-92654abfed", + "RemoteDomainNames": [ + "sales.example.com" + ] + }, + "output": { + "ConditionalForwarders": [] + } + } + ] } }, "com.amazonaws.directoryservice#DescribeConditionalForwardersRequest": { @@ -2408,6 +2691,49 @@ ], "traits": { "smithy.api#documentation": "Obtains information about the directories that belong to this account.
\nYou can retrieve information about specific directories by passing the directory\n identifiers in the DirectoryIds parameter. Otherwise, all directories that belong\n to the current account are returned.
This operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the\n DescribeDirectoriesResult.NextToken member contains a token that you pass in\n the next call to DescribeDirectories to retrieve the next set of\n items.
You can also specify a maximum number of return results with the Limit\n parameter.
The list of DirectoryDescription objects that were retrieved.
\nIt is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the requested\n number of items left to retrieve, or if the limitations of the operation have been\n exceeded.
The list of available DirectoryDescription objects that were retrieved.
\nIt is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the requested\n number of items left to retrieve, or if the limitations of the operation have been\n exceeded.
Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.
" + "smithy.api#documentation": "Obtains status of directory data access enablement through the Directory Service Data API for the\n specified directory.
" } }, "com.amazonaws.directoryservice#DescribeDirectoryDataAccessRequest": { @@ -2648,7 +2974,29 @@ } ], "traits": { - "smithy.api#documentation": "Obtains information about which Amazon SNS topics receive status messages from the specified\n directory.
\nIf no input parameters are provided, such as DirectoryId or TopicName, this request\n describes all of the associations in the account.
" + "smithy.api#documentation": "Obtains information about which Amazon SNS topics receive status messages from the specified\n directory.
\nIf no input parameters are provided, such as DirectoryId or TopicName, this request\n describes all of the associations in the account.
", + "smithy.api#examples": [ + { + "title": "To describe event topics", + "documentation": "The following example obtains information about which SNS topics receive status messages from the specified directory.", + "input": { + "DirectoryId": "d-92654abfed", + "TopicNames": [ + "snstopicexample" + ] + }, + "output": { + "EventTopics": [ + { + "DirectoryId": "d-92654abfed", + "Status": "Registered", + "TopicArn": "arn:aws:sns:us-east-2:123456789012:snstopicexample", + "TopicName": "snstopicexample" + } + ] + } + } + ] } }, "com.amazonaws.directoryservice#DescribeEventTopicsRequest": { @@ -2936,13 +3284,13 @@ "SettingEntries": { "target": "com.amazonaws.directoryservice#SettingEntries", "traits": { - "smithy.api#documentation": "The list of SettingEntry objects that were retrieved.
\nIt is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the requested\n number of items left to retrieve, or if the limitations of the operation have been\n exceeded.
The list of SettingEntry objects that were retrieved.
\nIt is possible that this list contains less than the number of items specified in the\n Limit member of the request. This occurs if there are less than the requested\n number of items left to retrieve, or if the limitations of the operation have been\n exceeded.
If not null, token that indicates that more results are available. \n Pass this value for the NextToken parameter in a subsequent \n call to DescribeSettings to retrieve the next set of items.
If not null, token that indicates that more results are available. Pass this value for the\n NextToken parameter in a subsequent call to DescribeSettings to\n retrieve the next set of items.
Obtains information about the directory snapshots that belong to this account.
\nThis operation supports pagination with the use of the NextToken request and\n response parameters. If more results are available, the DescribeSnapshots.NextToken\n member contains a token that you pass in the next call to DescribeSnapshots to\n retrieve the next set of items.
\nYou can also specify a maximum number of return results with the Limit\n parameter.
", + "smithy.api#examples": [ + { + "title": "To describe snapshots", + "documentation": "The following example obtains information about a specified directory snapshot.", + "input": { + "DirectoryId": "d-92654abfed", + "SnapshotIds": [ + "s-9267f6da4e" + ], + "Limit": 0 + }, + "output": { + "Snapshots": [ + { + "DirectoryId": "d-92673c8a8f", + "SnapshotId": "s-9267f6da4e", + "StartTime": 1481289211.615, + "Status": "Completed", + "Type": "Auto" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3160,6 +3532,35 @@ ], "traits": { "smithy.api#documentation": "Obtains information about the trust relationships for this account.
\nIf no input parameters are provided, such as DirectoryId or TrustIds, this request\n describes all the trust relationships belonging to the account.
", + "smithy.api#examples": [ + { + "title": "To describe a trust ", + "documentation": "The following example obtains information about the trust relationship for a specified directory.", + "input": { + "DirectoryId": "d-92654abfed", + "TrustIds": [ + "t-9267353df0" + ], + "Limit": 0 + }, + "output": { + "Trusts": [ + { + "CreatedDateTime": 1481749250.657, + "DirectoryId": "d-92654abfed", + "LastUpdatedDateTime": 1481749260.156, + "RemoteDomainName": "sales.example.com", + "StateLastUpdatedDateTime": 1481749260.156, + "TrustDirection": "One-Way: Outgoing", + "TrustId": "t-9267353df0", + "TrustState": "Failed", + "TrustStateReason": "The specified domain either does not exist or could not be contacted. Name: sales.example.com", + "TrustType": "Forest" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3251,7 +3652,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Describes the updates of a directory for a particular update type.\n
", + "smithy.api#documentation": "Describes the updates of a directory for a particular update type.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3265,27 +3666,27 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "\n The unique identifier of the directory.\n
", + "smithy.api#documentation": "The unique identifier of the directory.
", "smithy.api#required": {} } }, "UpdateType": { "target": "com.amazonaws.directoryservice#UpdateType", "traits": { - "smithy.api#documentation": "\n The type of updates you want to describe for the directory.\n
", + "smithy.api#documentation": "The type of updates you want to describe for the directory.
", "smithy.api#required": {} } }, "RegionName": { "target": "com.amazonaws.directoryservice#RegionName", "traits": { - "smithy.api#documentation": "\n The name of the Region.\n
" + "smithy.api#documentation": "The name of the Region.
" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { - "smithy.api#documentation": "\n The DescribeUpdateDirectoryResult. NextToken value from a previous call to DescribeUpdateDirectory. Pass null if this is the first call.\n
The DescribeUpdateDirectoryResult. NextToken value from a previous call to\n DescribeUpdateDirectory. Pass null if this is the first call.
\n The list of update activities on a directory for the requested update type.\n
" + "smithy.api#documentation": "The list of update activities on a directory for the requested update type.
" } }, "NextToken": { "target": "com.amazonaws.directoryservice#NextToken", "traits": { - "smithy.api#documentation": "\n If not null, more results are available. Pass this value for the NextToken parameter.\n
If not null, more results are available. Pass this value for the NextToken\n parameter.
The Region you specified is the same Region where the Managed Microsoft AD directory\n was created. Specify a different Region and try again.
", + "smithy.api#documentation": "The Region you specified is the same Region where the Managed Microsoft AD directory was created.\n Specify a different Region and try again.
", "smithy.api#error": "client" } }, @@ -3463,7 +3864,7 @@ "CustomerDnsIps": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { - "smithy.api#documentation": "A list of one or more IP addresses of DNS servers or domain controllers in your self-managed\n directory.
", + "smithy.api#documentation": "A list of one or more IP addresses of DNS servers or domain controllers in your\n self-managed directory.
", "smithy.api#required": {} } }, @@ -3577,7 +3978,7 @@ "DnsIpAddrs": { "target": "com.amazonaws.directoryservice#DnsIpAddrs", "traits": { - "smithy.api#documentation": "The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD\n directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For\n an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers\n in your self-managed directory to which the AD Connector is connected.
" + "smithy.api#documentation": "The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD\n directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers.\n For an AD Connector directory, these are the IP addresses of the DNS servers or domain\n controllers in your self-managed directory to which the AD Connector is connected.
" } }, "Stage": { @@ -3595,7 +3996,7 @@ "ShareMethod": { "target": "com.amazonaws.directoryservice#ShareMethod", "traits": { - "smithy.api#documentation": "The method used when sharing a directory to determine whether the directory should be\n shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by\n sending a shared directory request (HANDSHAKE).
The method used when sharing a directory to determine whether the directory should be\n shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account\n by sending a shared directory request (HANDSHAKE).
A DirectoryVpcSettingsDescription object that contains additional\n information about a directory. This member is only present if the directory is a Simple AD or\n Managed Microsoft AD directory.
" + "smithy.api#documentation": "A DirectoryVpcSettingsDescription object that contains additional\n information about a directory. This member is only present if the directory is a Simple AD\n or Managed Microsoft AD directory.
" } }, "ConnectSettings": { @@ -3755,7 +4156,7 @@ } }, "traits": { - "smithy.api#documentation": "\n The directory is already updated to desired update type settings.\n
", + "smithy.api#documentation": "The directory is already updated to desired update type settings.
", "smithy.api#error": "client" } }, @@ -5231,7 +5632,7 @@ "SubnetIds": { "target": "com.amazonaws.directoryservice#SubnetIds", "traits": { - "smithy.api#documentation": "The identifiers of the subnets for the directory servers. The two subnets must be in\n different Availability Zones. Directory Service creates a directory server and a DNS\n server in each of these subnets.
", + "smithy.api#documentation": "The identifiers of the subnets for the directory servers. The two subnets must be in\n different Availability Zones. Directory Service creates a directory server and a DNS server in each of\n these subnets.
", "smithy.api#required": {} } } @@ -5317,7 +5718,7 @@ "Type": { "target": "com.amazonaws.directoryservice#ClientAuthenticationType", "traits": { - "smithy.api#documentation": "The type of client authentication to disable. Currently the only parameter \"SmartCard\" is supported.
The type of client authentication to disable. Currently the only parameter\n \"SmartCard\" is supported.
Deactivates access to directory data via the Directory Service Data API for the specified directory.
" + "smithy.api#documentation": "Deactivates access to directory data via the Directory Service Data API for the specified\n directory. For\n more information, see Directory Service Data API Reference.
" } }, "com.amazonaws.directoryservice#DisableDirectoryDataAccessRequest": { @@ -5474,7 +5875,17 @@ } ], "traits": { - "smithy.api#documentation": "Disables multi-factor authentication (MFA) with the Remote Authentication Dial In\n User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
" + "smithy.api#documentation": "Disables multi-factor authentication (MFA) with the Remote Authentication Dial In\n User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
", + "smithy.api#examples": [ + { + "title": "To disable radius", + "documentation": "The following example disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.", + "input": { + "DirectoryId": "d-92654abfed" + }, + "output": {} + } + ] } }, "com.amazonaws.directoryservice#DisableRadiusRequest": { @@ -5527,7 +5938,19 @@ } ], "traits": { - "smithy.api#documentation": "Disables single-sign on for a directory.
" + "smithy.api#documentation": "Disables single-sign on for a directory.
", + "smithy.api#examples": [ + { + "title": "To disable SSO", + "documentation": "The following example disables single sign-on for a specified directory.", + "input": { + "DirectoryId": "d-92654abfed", + "UserName": "Admin", + "Password": "Str0ngP@ssw0rd" + }, + "output": {} + } + ] } }, "com.amazonaws.directoryservice#DisableSsoRequest": { @@ -5777,7 +6200,7 @@ "Type": { "target": "com.amazonaws.directoryservice#ClientAuthenticationType", "traits": { - "smithy.api#documentation": "The type of client authentication to enable. Currently only the value SmartCard is\n supported. Smart card authentication in AD Connector requires that you enable Kerberos\n Constrained Delegation for the Service User to the LDAP service in your self-managed AD.\n
The type of client authentication to enable. Currently only the value\n SmartCard is supported. Smart card authentication in AD Connector requires\n that you enable Kerberos Constrained Delegation for the Service User to the LDAP service in\n your self-managed AD.
Enables access to directory data via the Directory Service Data API for the specified directory.
" + "smithy.api#documentation": "Enables access to directory data via the Directory Service Data API for the specified directory. For\n more information, see Directory Service Data API Reference.
" } }, "com.amazonaws.directoryservice#EnableDirectoryDataAccessRequest": { @@ -5943,7 +6366,29 @@ } ], "traits": { - "smithy.api#documentation": "Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User\n Service (RADIUS) server for an AD Connector or Microsoft AD directory.
" + "smithy.api#documentation": "Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User\n Service (RADIUS) server for an AD Connector or Microsoft AD directory.
", + "smithy.api#examples": [ + { + "title": "To enable radius", + "documentation": "The following example enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.", + "input": { + "DirectoryId": "d-92654abfed", + "RadiusSettings": { + "DisplayLabel": "MyRadius", + "UseSameUsername": true, + "RadiusTimeout": 1, + "AuthenticationProtocol": "PAP", + "RadiusPort": 1200, + "RadiusRetries": 2, + "SharedSecret": "123456789", + "RadiusServers": [ + "172.168.111.12" + ] + } + }, + "output": {} + } + ] } }, "com.amazonaws.directoryservice#EnableRadiusRequest": { @@ -6003,7 +6448,19 @@ } ], "traits": { - "smithy.api#documentation": "Enables single sign-on for a directory. Single sign-on allows users in your directory to\n access certain Amazon Web Services services from a computer joined to the directory without having to enter\n their credentials separately.
" + "smithy.api#documentation": "Enables single sign-on for a directory. Single sign-on allows users in your directory to\n access certain Amazon Web Services services from a computer joined to the directory without having to enter\n their credentials separately.
", + "smithy.api#examples": [ + { + "title": "To enable SSO", + "documentation": "To enable single sign-on for a specified directory.", + "input": { + "DirectoryId": "d-92654abfed", + "UserName": "Admin", + "Password": "Str0ngP@ssw0rd" + }, + "output": {} + } + ] } }, "com.amazonaws.directoryservice#EnableSsoRequest": { @@ -6145,7 +6602,26 @@ } ], "traits": { - "smithy.api#documentation": "Obtains directory limit information for the current Region.
" + "smithy.api#documentation": "Obtains directory limit information for the current Region.
", + "smithy.api#examples": [ + { + "title": "To get directory limits", + "documentation": "The following example obtains directory limit information for the current region.", + "output": { + "DirectoryLimits": { + "CloudOnlyDirectoriesCurrentCount": 2, + "CloudOnlyDirectoriesLimit": 10, + "CloudOnlyDirectoriesLimitReached": false, + "CloudOnlyMicrosoftADCurrentCount": 2, + "CloudOnlyMicrosoftADLimit": 10, + "CloudOnlyMicrosoftADLimitReached": false, + "ConnectedDirectoriesCurrentCount": 1, + "ConnectedDirectoriesLimit": 10, + "ConnectedDirectoriesLimitReached": false + } + } + } + ] } }, "com.amazonaws.directoryservice#GetDirectoryLimitsRequest": { @@ -6191,7 +6667,23 @@ } ], "traits": { - "smithy.api#documentation": "Obtains the manual snapshot limits for a directory.
" + "smithy.api#documentation": "Obtains the manual snapshot limits for a directory.
", + "smithy.api#examples": [ + { + "title": "To get snapshot limits", + "documentation": "The following example obtains the manual snapshot limits for a specified directory.", + "input": { + "DirectoryId": "d-92654abfed" + }, + "output": { + "SnapshotLimits": { + "ManualSnapshotsCurrentCount": 1, + "ManualSnapshotsLimit": 5, + "ManualSnapshotsLimitReached": false + } + } + } + ] } }, "com.amazonaws.directoryservice#GetSnapshotLimitsRequest": { @@ -6637,7 +7129,7 @@ } ], "traits": { - "smithy.api#documentation": "For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
", + "smithy.api#documentation": "For the specified directory, lists all the certificates registered for a secure LDAP or\n client certificate authentication.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6720,6 +7212,27 @@ ], "traits": { "smithy.api#documentation": "Lists the address blocks that you have added to a directory.
", + "smithy.api#examples": [ + { + "title": "To list IP routes", + "documentation": "The following example lists the address blocks that have been added to a specified directory.", + "input": { + "DirectoryId": "d-92654abfed", + "Limit": 0 + }, + "output": { + "IpRoutesInfo": [ + { + "AddedDateTime": 1481577631.63, + "CidrIp": "12.12.12.12/32", + "Description": "example", + "DirectoryId": "d-92654abfed", + "IpRouteStatusMsg": "Added" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6813,7 +7326,7 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "If a DirectoryID is provided, lists only the log subscription\n associated with that directory. If no DirectoryId is provided, lists all\n log subscriptions associated with your Amazon Web Services account. If there are no log subscriptions for the\n Amazon Web Services account or the directory, an empty list will be returned.
" + "smithy.api#documentation": "If a DirectoryID is provided, lists only the log subscription\n associated with that directory. If no DirectoryId is provided, lists all\n log subscriptions associated with your Amazon Web Services account. If there are no log subscriptions for\n the Amazon Web Services account or the directory, an empty list will be returned.
" } }, "NextToken": { @@ -6839,7 +7352,7 @@ "LogSubscriptions": { "target": "com.amazonaws.directoryservice#LogSubscriptions", "traits": { - "smithy.api#documentation": "A list of active LogSubscription objects for calling the Amazon Web Services account.
" + "smithy.api#documentation": "A list of active LogSubscription objects for calling the\n Amazon Web Services account.
" } }, "NextToken": { @@ -6877,6 +7390,29 @@ ], "traits": { "smithy.api#documentation": "Lists all schema extensions applied to a Microsoft AD Directory.
", + "smithy.api#examples": [ + { + "title": "To list schema extensions", + "documentation": "The following example lists all schema extensions applied to a specified Microsoft AD Directory.", + "input": { + "DirectoryId": "d-92654abfed", + "Limit": 0 + }, + "output": { + "SchemaExtensionsInfo": [ + { + "Description": "example text", + "DirectoryId": "d-92654abfed", + "EndDateTime": 1481586088.301, + "SchemaExtensionId": "e-926731d2a0", + "SchemaExtensionStatus": "Cancelled", + "SchemaExtensionStatusReason": "Cancellation is complete. No schema updates were applied to your directory.", + "StartDateTime": 1481584463.548 + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6959,6 +7495,24 @@ ], "traits": { "smithy.api#documentation": "Lists all tags on a directory.
", + "smithy.api#examples": [ + { + "title": "To list tags for a directory", + "documentation": "The following example lists all tags associated with a specified directory.", + "input": { + "ResourceId": "d-92654abfed", + "Limit": 0 + }, + "output": { + "Tags": [ + { + "Key": "environment", + "Value": "production" + } + ] + } + } + ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7076,7 +7630,7 @@ } }, "traits": { - "smithy.api#documentation": "Client authentication setup could not be completed because at least one valid certificate must be\n registered in the system.
", + "smithy.api#documentation": "Client authentication setup could not be completed because at least one valid certificate\n must be registered in the system.
", "smithy.api#error": "client" } }, @@ -7106,12 +7660,12 @@ "OSVersion": { "target": "com.amazonaws.directoryservice#OSVersion", "traits": { - "smithy.api#documentation": "\n OS version that the directory needs to be updated to.\n
" + "smithy.api#documentation": "OS version that the directory needs to be updated to.
" } } }, "traits": { - "smithy.api#documentation": "\n OS version that the directory needs to be updated to.\n
" + "smithy.api#documentation": "OS version that the directory needs to be updated to.
" } }, "com.amazonaws.directoryservice#OSVersion": { @@ -7161,7 +7715,7 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "Identifier of the Managed Microsoft AD directory in the directory owner\n account.
" + "smithy.api#documentation": "Identifier of the Managed Microsoft AD directory in the directory owner account.
" } }, "AccountId": { @@ -7560,13 +8114,13 @@ "Type": { "target": "com.amazonaws.directoryservice#CertificateType", "traits": { - "smithy.api#documentation": "The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.
The function that the registered certificate performs. Valid values include\n ClientLDAPS or ClientCertAuth. The default value is\n ClientLDAPS.
A ClientCertAuthSettings object that contains client certificate authentication settings.
A ClientCertAuthSettings object that contains client certificate\n authentication settings.
Associates a directory with an Amazon SNS topic. This establishes the directory as a\n publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when\n the status of your directory changes. You get notified if your directory goes from an Active\n status to an Impaired or Inoperable status. You also receive a notification when the directory\n returns to an Active status.
" + "smithy.api#documentation": "Associates a directory with an Amazon SNS topic. This establishes the directory as a\n publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when\n the status of your directory changes. You get notified if your directory goes from an Active\n status to an Impaired or Inoperable status. You also receive a notification when the directory\n returns to an Active status.
", + "smithy.api#examples": [ + { + "title": "To register an event topic", + "documentation": "The following example associates a directory with an SNS topic.", + "input": { + "DirectoryId": "d-92654abfed", + "TopicName": "snstopicexample" + }, + "output": {} + } + ] } }, "com.amazonaws.directoryservice#RegisterEventTopicRequest": { @@ -7745,7 +8310,20 @@ } ], "traits": { - "smithy.api#documentation": "Removes IP address blocks from a directory.
" + "smithy.api#documentation": "Removes IP address blocks from a directory.
", + "smithy.api#examples": [ + { + "title": "To remove IP routes", + "documentation": "The following example removes IP address blocks from a specified directory.", + "input": { + "DirectoryId": "d-92654abfed", + "CidrIps": [ + "12.12.12.12/32" + ] + }, + "output": {} + } + ] } }, "com.amazonaws.directoryservice#RemoveIpRoutesRequest": { @@ -7854,7 +8432,20 @@ } ], "traits": { - "smithy.api#documentation": "Removes tags from a directory.
" + "smithy.api#documentation": "Removes tags from a directory.
", + "smithy.api#examples": [ + { + "title": "To remove tags from a directory", + "documentation": "The following example removes a tag from a specified directory.", + "input": { + "ResourceId": "d-92654abfed", + "TagKeys": [ + "environment" + ] + }, + "output": {} + } + ] } }, "com.amazonaws.directoryservice#RemoveTagsFromResourceRequest": { @@ -7936,7 +8527,7 @@ } ], "traits": { - "smithy.api#documentation": "Resets the password for any user in your Managed Microsoft AD or Simple AD\n directory. Disabled users will become enabled and can be authenticated following the API call.
\nYou can reset the password for any user in your directory with the following\n exceptions:
\nFor Simple AD, you cannot reset the password for any user that is a member of either\n the Domain Admins or Enterprise\n Admins group except for the administrator user.
\nFor Managed Microsoft AD, you can only reset the password for a user that is in an\n OU based off of the NetBIOS name that you typed when you created your directory. For\n example, you cannot reset the password for a user in the Amazon Web Services\n Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration\n Guide.
\nResets the password for any user in your Managed Microsoft AD or Simple AD directory. Disabled\n users will become enabled and can be authenticated following the API call.
\nYou can reset the password for any user in your directory with the following\n exceptions:
\nFor Simple AD, you cannot reset the password for any user that is a member of either\n the Domain Admins or Enterprise\n Admins group except for the administrator user.
\nFor Managed Microsoft AD, you can only reset the password for a user that is in an OU based\n off of the NetBIOS name that you typed when you created your directory. For example, you\n cannot reset the password for a user in the Amazon Web Services\n Reserved OU. For more information about the OU structure for an Managed Microsoft AD\n directory, see What Gets Created in the Directory Service Administration\n Guide.
\nIdentifier of the Managed Microsoft AD or Simple AD directory in which the user\n resides.
", + "smithy.api#documentation": "Identifier of the Managed Microsoft AD or Simple AD directory in which the user resides.
", "smithy.api#required": {} } }, @@ -8004,7 +8595,17 @@ } ], "traits": { - "smithy.api#documentation": "Restores a directory using an existing directory snapshot.
\nWhen you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.
\nThis action returns as soon as the restore operation is initiated. You can monitor the\n progress of the restore operation by calling the DescribeDirectories operation with\n the directory identifier. When the DirectoryDescription.Stage value changes to\n Active, the restore operation is complete.
Restores a directory using an existing directory snapshot.
\nWhen you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.
\nThis action returns as soon as the restore operation is initiated. You can monitor the\n progress of the restore operation by calling the DescribeDirectories operation with\n the directory identifier. When the DirectoryDescription.Stage value changes to\n Active, the restore operation is complete.
The value of the directory setting for which to retrieve information. For example, for TLS_1_0, the valid values are: Enable and Disable.
The value of the directory setting for which to retrieve information. For example, for\n TLS_1_0, the valid values are: Enable and\n Disable.
The type, or category, of a directory setting. Similar settings have the same type. For example, Protocol, Cipher, \n or Certificate-Based Authentication.
The type, or category, of a directory setting. Similar settings have the same type. For\n example, Protocol, Cipher, or Certificate-Based\n Authentication.
The valid range of values for the directory setting. These values depend on the DataType of your directory.
The valid range of values for the directory setting. These values depend on the\n DataType of your directory.
The overall status of the request to update the directory setting request. If the directory setting is deployed in more than one region, and the request fails in any region, the overall status is Failed.
The overall status of the request to update the directory setting request. If the\n directory setting is deployed in more than one region, and the request fails in any region,\n the overall status is Failed.
Details about the status of the request to update the directory setting. If the directory setting is deployed in more than one region, status is returned for the request in each region where the setting is deployed.
" + "smithy.api#documentation": "Details about the status of the request to update the directory setting. If the directory\n setting is deployed in more than one region, status is returned for the request in each region\n where the setting is deployed.
" } }, "RequestStatusMessage": { @@ -8306,13 +8907,13 @@ "LastRequestedDateTime": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingLastRequestedDateTime", "traits": { - "smithy.api#documentation": "The date and time when the request to update a directory setting was last submitted.
" + "smithy.api#documentation": "The date and time when the request to update a directory setting was last\n submitted.
" } }, "DataType": { "target": "com.amazonaws.directoryservice#DirectoryConfigurationSettingDataType", "traits": { - "smithy.api#documentation": "The data type of a directory setting. This is used to define the AllowedValues of a setting.\n For example a data type can be Boolean, DurationInSeconds, or Enum.
The data type of a directory setting. This is used to define the\n AllowedValues of a setting. For example a data type can be\n Boolean, DurationInSeconds, or Enum.
Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory\n owner) with another Amazon Web Services account (directory consumer). With this operation you can use your\n directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.
When you share your Managed Microsoft AD directory, Directory Service creates a\n shared directory in the directory consumer account. This shared directory contains the\n metadata to provide access to the directory within the directory owner account. The shared\n directory is visible in all VPCs in the directory consumer account.
\nThe ShareMethod parameter determines whether the specified directory can be\n shared between Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It\n also determines whether you can share the directory with any other Amazon Web Services account either inside\n or outside of the organization (HANDSHAKE).
The ShareNotes parameter is only used when HANDSHAKE is called,\n which sends a directory sharing request to the directory consumer.
Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory\n owner) with another Amazon Web Services account (directory consumer). With this operation you can use your\n directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.
When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the\n directory consumer account. This shared directory contains the metadata to provide access to\n the directory within the directory owner account. The shared directory is visible in all VPCs\n in the directory consumer account.
\nThe ShareMethod parameter determines whether the specified directory can be\n shared between Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS).\n It also determines whether you can share the directory with any other Amazon Web Services account either\n inside or outside of the organization (HANDSHAKE).
The ShareNotes parameter is only used when HANDSHAKE is called,\n which sends a directory sharing request to the directory consumer.
Identifier of the Managed Microsoft AD directory that you want to share with other Amazon Web Services accounts.
", + "smithy.api#documentation": "Identifier of the Managed Microsoft AD directory that you want to share with other\n Amazon Web Services accounts.
", "smithy.api#required": {} } }, @@ -8396,7 +8997,7 @@ "ShareMethod": { "target": "com.amazonaws.directoryservice#ShareMethod", "traits": { - "smithy.api#documentation": "The method used when sharing a directory to determine whether the directory should be\n shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by\n sending a directory sharing request (HANDSHAKE).
The method used when sharing a directory to determine whether the directory should be\n shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account\n by sending a directory sharing request (HANDSHAKE).
The method used when sharing a directory to determine whether the directory should be\n shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by\n sending a shared directory request (HANDSHAKE).
The method used when sharing a directory to determine whether the directory should be\n shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account\n by sending a shared directory request (HANDSHAKE).
Applies a schema extension to a Microsoft AD directory.
" + "smithy.api#documentation": "Applies a schema extension to a Microsoft AD directory.
", + "smithy.api#examples": [ + { + "title": "To start a schema extension", + "documentation": "The following example applies a schema extension to a specified Microsoft AD directory.", + "input": { + "CreateSnapshotBeforeSchemaExtension": true, + "DirectoryId": "d-92654abfed", + "LdifContent": "dn: CN=User,CN=Schema,CN=Configuration,DC=sales,DC=example,DC=com\nchangetype: modify\nadd: mayContain\nmayContain: drink\n-\n\nDN:\nchangetype: modify\nreplace: schemaupdatenow\nschemaupdatenow: 1\n-", + "Description": "Adds maycontain attribute to user class. Precede each line as it would be formatted in an ldif file." + }, + "output": { + "SchemaExtensionId": "e-926731dc50" + } + } + ] } }, "com.amazonaws.directoryservice#StartSchemaExtensionRequest": { @@ -9265,7 +9881,7 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "The identifier of the Managed Microsoft AD directory that you want to stop\n sharing.
", + "smithy.api#documentation": "The identifier of the Managed Microsoft AD directory that you want to stop sharing.
", "smithy.api#required": {} } }, @@ -9382,7 +9998,21 @@ } ], "traits": { - "smithy.api#documentation": "Updates a conditional forwarder that has been set up for your Amazon Web Services\n directory.
" + "smithy.api#documentation": "Updates a conditional forwarder that has been set up for your Amazon Web Services\n directory.
", + "smithy.api#examples": [ + { + "title": "To update a conditional forwarder", + "documentation": "The following example updates a conditional forwarder for a specified directory.", + "input": { + "DirectoryId": "d-92654abfed", + "RemoteDomainName": "sales.example.com", + "DnsIpAddrs": [ + "172.168.101.11" + ] + }, + "output": {} + } + ] } }, "com.amazonaws.directoryservice#UpdateConditionalForwarderRequest": { @@ -9461,7 +10091,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Updates the directory for a particular update type.\n
" + "smithy.api#documentation": "Updates the directory for a particular update type.
" } }, "com.amazonaws.directoryservice#UpdateDirectorySetupRequest": { @@ -9470,28 +10100,28 @@ "DirectoryId": { "target": "com.amazonaws.directoryservice#DirectoryId", "traits": { - "smithy.api#documentation": "\n The identifier of the directory on which you want to perform the update.\n
", + "smithy.api#documentation": "The identifier of the directory on which you want to perform the update.
", "smithy.api#required": {} } }, "UpdateType": { "target": "com.amazonaws.directoryservice#UpdateType", "traits": { - "smithy.api#documentation": "\n The type of update that needs to be performed on the directory. For example, OS.\n
", + "smithy.api#documentation": "The type of update that needs to be performed on the directory. For example, OS.
", "smithy.api#required": {} } }, "OSUpdateSettings": { "target": "com.amazonaws.directoryservice#OSUpdateSettings", "traits": { - "smithy.api#documentation": "\n The settings for the OS update that needs to be performed on the directory.\n
" + "smithy.api#documentation": "The settings for the OS update that needs to be performed on the directory.
" } }, "CreateSnapshotBeforeUpdate": { "target": "com.amazonaws.directoryservice#CreateSnapshotBeforeUpdate", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "\n The boolean that specifies if a snapshot for the directory needs to be taken before updating the directory.\n
" + "smithy.api#documentation": "The boolean that specifies if a snapshot for the directory needs to be taken before\n updating the directory.
" } } }, @@ -9512,54 +10142,54 @@ "Region": { "target": "com.amazonaws.directoryservice#RegionName", "traits": { - "smithy.api#documentation": "\n The name of the Region.\n
" + "smithy.api#documentation": "The name of the Region.
" } }, "Status": { "target": "com.amazonaws.directoryservice#UpdateStatus", "traits": { - "smithy.api#documentation": "\n The status of the update performed on the directory.\n
" + "smithy.api#documentation": "The status of the update performed on the directory.
" } }, "StatusReason": { "target": "com.amazonaws.directoryservice#UpdateStatusReason", "traits": { - "smithy.api#documentation": "\n The reason for the current status of the update type activity.\n
" + "smithy.api#documentation": "The reason for the current status of the update type activity.
" } }, "InitiatedBy": { "target": "com.amazonaws.directoryservice#InitiatedBy", "traits": { - "smithy.api#documentation": "\n This specifies if the update was initiated by the customer or by the service team.\n
" + "smithy.api#documentation": "This specifies if the update was initiated by the customer or by the service team.\n
" } }, "NewValue": { "target": "com.amazonaws.directoryservice#UpdateValue", "traits": { - "smithy.api#documentation": "\n The new value of the target setting.\n
" + "smithy.api#documentation": "The new value of the target setting.
" } }, "PreviousValue": { "target": "com.amazonaws.directoryservice#UpdateValue", "traits": { - "smithy.api#documentation": "\n The old value of the target setting.\n
" + "smithy.api#documentation": "The old value of the target setting.
" } }, "StartTime": { "target": "com.amazonaws.directoryservice#StartDateTime", "traits": { - "smithy.api#documentation": "\n The start time of the UpdateDirectorySetup for the particular type.\n
The start time of the UpdateDirectorySetup for the particular type.
\n The last updated date and time of a particular directory setting.\n
" + "smithy.api#documentation": "The last updated date and time of a particular directory setting.
" } } }, "traits": { - "smithy.api#documentation": "\n An entry of update information related to a requested update type.\n
" + "smithy.api#documentation": "An entry of update information related to a requested update type.
" } }, "com.amazonaws.directoryservice#UpdateNumberOfDomainControllers": { @@ -9649,7 +10279,29 @@ } ], "traits": { - "smithy.api#documentation": "Updates the Remote Authentication Dial In User Service (RADIUS) server information\n for an AD Connector or Microsoft AD directory.
" + "smithy.api#documentation": "Updates the Remote Authentication Dial In User Service (RADIUS) server information\n for an AD Connector or Microsoft AD directory.
", + "smithy.api#examples": [ + { + "title": "To update Radius", + "documentation": "The following example updates the Remote Authentication Dial In User Service (RADIUS) server settings for an AD Connector directory.", + "input": { + "DirectoryId": "d-92654abfed", + "RadiusSettings": { + "DisplayLabel": "MyRadius", + "UseSameUsername": true, + "RadiusTimeout": 1, + "AuthenticationProtocol": "PAP", + "RadiusPort": 1027, + "RadiusRetries": 1, + "SharedSecret": "12345678", + "RadiusServers": [ + "172.168.101.113" + ] + } + }, + "output": {} + } + ] } }, "com.amazonaws.directoryservice#UpdateRadiusRequest": { @@ -9870,12 +10522,12 @@ "OSUpdateSettings": { "target": "com.amazonaws.directoryservice#OSUpdateSettings", "traits": { - "smithy.api#documentation": "\n The OS update related settings.\n
" + "smithy.api#documentation": "The OS update related settings.
" } } }, "traits": { - "smithy.api#documentation": "\n The value for a given type of UpdateSettings.\n
The value for a given type of UpdateSettings.
Directory Service for Microsoft Active Directory allows you to configure and verify trust\n relationships.
\nThis action verifies a trust relationship between your Managed Microsoft AD directory and an\n external domain.
" + "smithy.api#documentation": "Directory Service for Microsoft Active Directory allows you to configure and verify trust\n relationships.
\nThis action verifies a trust relationship between your Managed Microsoft AD directory and an\n external domain.
", + "smithy.api#examples": [ + { + "title": "To verify a trust", + "documentation": "The following example verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.", + "input": { + "TrustId": "t-9267353df0" + }, + "output": { + "TrustId": "t-9267353df0" + } + } + ] } }, "com.amazonaws.directoryservice#VerifyTrustRequest": { diff --git a/dlm/service/2018-01-12/dlm-2018-01-12.json b/models/dlm/service/2018-01-12/dlm-2018-01-12.json similarity index 100% rename from dlm/service/2018-01-12/dlm-2018-01-12.json rename to models/dlm/service/2018-01-12/dlm-2018-01-12.json diff --git a/docdb-elastic/service/2022-11-28/docdb-elastic-2022-11-28.json b/models/docdb-elastic/service/2022-11-28/docdb-elastic-2022-11-28.json similarity index 100% rename from docdb-elastic/service/2022-11-28/docdb-elastic-2022-11-28.json rename to models/docdb-elastic/service/2022-11-28/docdb-elastic-2022-11-28.json diff --git a/docdb/service/2014-10-31/docdb-2014-10-31.json b/models/docdb/service/2014-10-31/docdb-2014-10-31.json similarity index 100% rename from docdb/service/2014-10-31/docdb-2014-10-31.json rename to models/docdb/service/2014-10-31/docdb-2014-10-31.json diff --git a/drs/service/2020-02-26/drs-2020-02-26.json b/models/drs/service/2020-02-26/drs-2020-02-26.json similarity index 100% rename from drs/service/2020-02-26/drs-2020-02-26.json rename to models/drs/service/2020-02-26/drs-2020-02-26.json diff --git a/dsql/service/2018-05-10/dsql-2018-05-10.json b/models/dsql/service/2018-05-10/dsql-2018-05-10.json similarity index 100% rename from dsql/service/2018-05-10/dsql-2018-05-10.json rename to models/dsql/service/2018-05-10/dsql-2018-05-10.json diff --git a/dynamodb-streams/service/2012-08-10/dynamodb-streams-2012-08-10.json b/models/dynamodb-streams/service/2012-08-10/dynamodb-streams-2012-08-10.json similarity index 100% rename from dynamodb-streams/service/2012-08-10/dynamodb-streams-2012-08-10.json rename to models/dynamodb-streams/service/2012-08-10/dynamodb-streams-2012-08-10.json diff --git a/dynamodb/service/2012-08-10/dynamodb-2012-08-10.json b/models/dynamodb/service/2012-08-10/dynamodb-2012-08-10.json similarity index 99% rename from dynamodb/service/2012-08-10/dynamodb-2012-08-10.json rename to models/dynamodb/service/2012-08-10/dynamodb-2012-08-10.json index d56c104b..1d0cdfef 100644 --- a/dynamodb/service/2012-08-10/dynamodb-2012-08-10.json +++ b/models/dynamodb/service/2012-08-10/dynamodb-2012-08-10.json @@ -4118,8 +4118,8 @@ "authSchemes": [ { "signingRegion": "us-east-1", - "signingName": "dynamodb", - "name": "sigv4" + "name": "sigv4", + "signingName": "dynamodb" } ] }, @@ -14658,13 +14658,13 @@ "ProvisionedThroughput": { "target": "com.amazonaws.dynamodb#ProvisionedThroughput", "traits": { - "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary\n index.
\nFor current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "Represents the provisioned throughput settings for the specified global secondary\n index. You must use either\n OnDemandThroughput or ProvisionedThroughput based\n on your table's capacity mode.
For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.
" } }, "OnDemandThroughput": { "target": "com.amazonaws.dynamodb#OnDemandThroughput", "traits": { - "smithy.api#documentation": "The maximum number of read and write units for the specified global secondary index.\n If you use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both.
The maximum number of read and write units for the specified global secondary index.\n If you use this parameter, you must specify MaxReadRequestUnits,\n MaxWriteRequestUnits, or both. You must use either\n OnDemandThroughput or ProvisionedThroughput based\n on your table's capacity mode.
Enable or disable the client route enforcement feature.
\nValid values: true | false\n
Default value: false\n
Enable or disable Client Route Enforcement. The state can either be true\n\t\t\t(enabled) or false (disabled). The default is false.
Valid values: true | false\n
Default value: false\n
Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T\n\t\this feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
\nClient route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, \n\t\t\treverting it back to the expected route configurations.
" + "smithy.api#documentation": "Client Route Enforcement is a feature of Client VPN that helps enforce administrator defined\n\t\t\troutes on devices connected through the VPN. This feature helps improve your security\n\t\t\tposture by ensuring that network traffic originating from a connected client is not\n\t\t\tinadvertently sent outside the VPN tunnel.
\nClient Route Enforcement works by monitoring the route table of a connected device for\n\t\t\trouting policy changes to the VPN connection. If the feature detects any VPN routing\n\t\t\tpolicy modifications, it will automatically force an update to the route table,\n\t\t\treverting it back to the expected route configurations.
" } }, "com.amazonaws.ec2#ClientRouteEnforcementResponseOptions": { @@ -13179,13 +13197,13 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "Enforced", - "smithy.api#documentation": "Status of the client route enforcement feature.
\nValid values: true | false\n
Default value: false\n
Status of the client route enforcement feature, indicating whether Client Route Enforcement\n\t\t\tis true (enabled) or false (disabled).
Valid values: true | false\n
Default value: false\n
The current status of client route enforcement. The state will either be true (enabled) or false (disabled).
The current status of Client Route Enforcement.
" } }, "com.amazonaws.ec2#ClientSecretType": { @@ -17646,6 +17664,12 @@ "traits": { "smithy.api#documentation": "Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
" } + }, + "MeteredAccount": { + "target": "com.amazonaws.ec2#IpamMeteredAccount", + "traits": { + "smithy.api#documentation": "A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
\nPossible values:
\n\n ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
\n resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
Create a virtual interface for a local gateway.
" + } + }, + "com.amazonaws.ec2#CreateLocalGatewayVirtualInterfaceGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateLocalGatewayVirtualInterfaceGroupRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateLocalGatewayVirtualInterfaceGroupResult" + }, + "traits": { + "smithy.api#documentation": "Create a local gateway virtual interface group.
" + } + }, + "com.amazonaws.ec2#CreateLocalGatewayVirtualInterfaceGroupRequest": { + "type": "structure", + "members": { + "LocalGatewayId": { + "target": "com.amazonaws.ec2#LocalGatewayId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the local gateway.
", + "smithy.api#required": {} + } + }, + "LocalBgpAsn": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
" + } + }, + "LocalBgpAsnExtended": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "smithy.api#documentation": "The extended 32-bit ASN for the local BGP configuration.
" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "The tags to apply to the local gateway virtual interface group when the resource is\n being created.
", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Information about the created local gateway virtual interface group.
", + "smithy.api#xmlName": "localGatewayVirtualInterfaceGroup" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayVirtualInterfaceRequest": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the local gateway virtual interface group.
", + "smithy.api#required": {} + } + }, + "OutpostLagId": { + "target": "com.amazonaws.ec2#OutpostLagId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "References the Link Aggregation Group (LAG) that connects the Outpost to on-premises network devices.
", + "smithy.api#required": {} + } + }, + "Vlan": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The virtual local area network (VLAN) used for the local gateway virtual interface.
", + "smithy.api#required": {} + } + }, + "LocalAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IP address assigned to the local gateway virtual interface on the Outpost side. Only IPv4 is supported.
", + "smithy.api#required": {} + } + }, + "PeerAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The peer IP address for the local gateway virtual interface. Only IPv4 is\n supported.
", + "smithy.api#required": {} + } + }, + "PeerBgpAsn": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "The Autonomous System Number (ASN) of the Border Gateway Protocol (BGP) peer.
" + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "The tags to apply to a resource when the local gateway virtual interface is being created.
", + "smithy.api#xmlName": "TagSpecification" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The extended 32-bit ASN of the BGP peer for use with larger ASN values.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateLocalGatewayVirtualInterfaceResult": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterface": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterface", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterface", + "smithy.api#documentation": "Information about the local gateway virtual interface.
", + "smithy.api#xmlName": "localGatewayVirtualInterface" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#CreateManagedPrefixList": { "type": "operation", "input": { @@ -23345,7 +23539,7 @@ "PrivateDnsEnabled": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "(Interface endpoint) Indicates whether to associate a private hosted zone with the\n specified VPC. The private hosted zone contains a record set for the default public DNS\n name for the service for the Region (for example,\n kinesis.us-east-1.amazonaws.com), which resolves to the private IP\n addresses of the endpoint network interfaces in the VPC. This enables you to make\n requests to the default public DNS name for the service instead of the public DNS names\n that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to\n true: enableDnsHostnames and\n enableDnsSupport. Use ModifyVpcAttribute to set the VPC\n attributes.
Default: true\n
(Interface endpoint) Indicates whether to associate a private hosted zone with the\n specified VPC. The private hosted zone contains a record set for the default public DNS\n name for the service for the Region (for example,\n kinesis.us-east-1.amazonaws.com), which resolves to the private IP\n addresses of the endpoint network interfaces in the VPC. This enables you to make\n requests to the default public DNS name for the service instead of the public DNS names\n that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to\n true: enableDnsHostnames and\n enableDnsSupport. Use ModifyVpcAttribute to set the VPC\n attributes.
Deletes the specified local gateway virtual interface.
" + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayVirtualInterfaceGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayVirtualInterfaceGroupRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DeleteLocalGatewayVirtualInterfaceGroupResult" + }, + "traits": { + "smithy.api#documentation": "Delete the specified local gateway interface group.
" + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayVirtualInterfaceGroupRequest": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceGroupId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the local gateway virtual interface group to delete.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Information about the deleted local gateway virtual interface group.
", + "smithy.api#xmlName": "localGatewayVirtualInterfaceGroup" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ec2#DeleteLocalGatewayVirtualInterfaceRequest": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceId": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the local virtual interface to delete.
", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Information about the deleted local gateway virtual interface.
", + "smithy.api#xmlName": "localGatewayVirtualInterface" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DeleteManagedPrefixList": { "type": "operation", "input": { @@ -30324,7 +30618,7 @@ "target": "com.amazonaws.ec2#DescribeCapacityBlockOfferingsResult" }, "traits": { - "smithy.api#documentation": "Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you purchase a\n\t\t\tspecific instance type for a period of time.
\nTo search for an available Capacity Block offering, you specify a reservation duration\n and instance count. You must select one of the following options.
\nFor reservation durations 1-day increments\n up 14 days and 7-day increments up to 182 days total\n
\nFor instance count 1, 2, 4, 8, 16, 32, or\n 64 instances\n
\nDescribes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you purchase a\n\t\t\tspecific instance type for a period of time.
\nTo search for an available Capacity Block offering, you specify a reservation duration\n and instance count.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -30360,7 +30654,7 @@ "InstanceCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "The number of instances for which to reserve capacity.
" + "smithy.api#documentation": "The number of instances for which to reserve capacity. Each Capacity Block \n\t\t\tcan have up to 64 instances, and you can have up to 256 instances across Capacity \n\t\t\tBlocks.
" } }, "StartDateRange": { @@ -30379,7 +30673,7 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The number of hours for which to reserve Capacity Block.
", + "smithy.api#documentation": "The reservation duration for the Capacity Block, in hours. You must specify \n\t\t\tthe duration in 1-day increments up 14 days, and in 7-day increments up to \n\t\t\t182 days.
", "smithy.api#required": {} } }, @@ -38564,6 +38858,82 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DescribeOutpostLags": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeOutpostLagsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeOutpostLagsResult" + }, + "traits": { + "smithy.api#documentation": "Describes the Outposts link aggregation groups (LAGs).
" + } + }, + "com.amazonaws.ec2#DescribeOutpostLagsRequest": { + "type": "structure", + "members": { + "OutpostLagIds": { + "target": "com.amazonaws.ec2#OutpostLagIdSet", + "traits": { + "smithy.api#documentation": "The IDs of the Outpost LAGs.
", + "smithy.api#xmlName": "OutpostLagId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "The filters to use for narrowing down the request. The following filters are\n supported:
\n\n service-link-virtual-interface-id - The ID of the service link virtual interface.
\n service-link-virtual-interface-arn - The ARN of the service link virtual interface.
\n outpost-id - The Outpost ID.
\n outpost-arn - The Outpost ARN.
\n owner-id - The ID of the Amazon Web Services account that owns the service link virtual interface.
\n vlan - The ID of the address pool.
\n local-address - The local address.
\n peer-address - The peer address.
\n peer-bgp-asn - The peer BGP ASN.
\n outpost-lag-id - The Outpost LAG ID.
\n configuration-state - The configuration state of the service link virtual interface.
The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The Outpost LAGs.
", + "smithy.api#xmlName": "outpostLagSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the Outpost service link virtual interfaces.
" + } + }, + "com.amazonaws.ec2#DescribeServiceLinkVirtualInterfacesRequest": { + "type": "structure", + "members": { + "ServiceLinkVirtualInterfaceIds": { + "target": "com.amazonaws.ec2#ServiceLinkVirtualInterfaceIdSet", + "traits": { + "smithy.api#documentation": "The IDs of the service link virtual interfaces.
", + "smithy.api#xmlName": "ServiceLinkVirtualInterfaceId" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "The filters to use for narrowing down the request. The following filters are\n supported:
\n\n outpost-lag-id - The ID of the Outpost LAG.
\n outpost-arn - The Outpost ARN.
\n owner-id - The ID of the Amazon Web Services account that owns the service link virtual interface.
\n state - The state of the Outpost LAG.
\n vlan - The ID of the address pool.
\n service-link-virtual-interface-id - The ID of the service link virtual interface.
\n local-gateway-virtual-interface-id - The ID of the local gateway virtual interface.
The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
" + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
Describes the service link virtual interfaces.
", + "smithy.api#xmlName": "serviceLinkVirtualInterfaceSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Indicates whether the encryption state of an EBS volume is changed while being restored\n from a backing snapshot. The effect of setting the encryption state to true\n depends on the volume origin (new or from a snapshot), starting encryption state,\n ownership, and whether encryption by default is enabled. For more information, see Amazon EBS\n encryption in the Amazon EBS User Guide.
In no case can you remove encryption from an encrypted volume.
\nEncrypted volumes can only be attached to instances that support Amazon EBS encryption. For\n more information, see Supported instance types.
\nThis parameter is not returned by .
\nFor and , whether\n you can include this parameter, and the allowed values differ depending on the type of\n block device mapping you are creating.
\nIf you are creating a block device mapping for a new (empty)\n volume, you can include this parameter, and specify either\n true for an encrypted volume, or false for an\n unencrypted volume. If you omit this parameter, it defaults to false\n (unencrypted).
If you are creating a block device mapping from an existing encrypted or\n unencrypted snapshot, you must omit this parameter. If you include this\n parameter, the request will fail, regardless of the value that you specify.
\nIf you are creating a block device mapping from an existing unencrypted\n volume, you can include this parameter, but you must specify\n false. If you specify true, the request will fail. In\n this case, we recommend that you omit the parameter.
If you are creating a block device mapping from an existing encrypted\n volume, you can include this parameter, and specify either\n true or false. However, if you specify\n false, the parameter is ignored and the block device mapping is\n always encrypted. In this case, we recommend that you omit the parameter.
Indicates whether the encryption state of an EBS volume is changed while being restored\n from a backing snapshot. The effect of setting the encryption state to true\n depends on the volume origin (new or from a snapshot), starting encryption state,\n ownership, and whether encryption by default is enabled. For more information, see Amazon EBS\n encryption in the Amazon EBS User Guide.
In no case can you remove encryption from an encrypted volume.
\nEncrypted volumes can only be attached to instances that support Amazon EBS encryption. For\n more information, see Supported instance types.
\nThis parameter is not returned by DescribeImageAttribute.
\nFor CreateImage and RegisterImage, whether you\n can include this parameter, and the allowed values differ depending on the type of block\n device mapping you are creating.
\nIf you are creating a block device mapping for a new (empty)\n volume, you can include this parameter, and specify either\n true for an encrypted volume, or false for an\n unencrypted volume. If you omit this parameter, it defaults to false\n (unencrypted).
If you are creating a block device mapping from an existing encrypted or\n unencrypted snapshot, you must omit this parameter. If you include this\n parameter, the request will fail, regardless of the value that you specify.
\nIf you are creating a block device mapping from an existing unencrypted\n volume, you can include this parameter, but you must specify\n false. If you specify true, the request will fail. In\n this case, we recommend that you omit the parameter.
If you are creating a block device mapping from an existing encrypted\n volume, you can include this parameter, and specify either\n true or false. However, if you specify\n false, the parameter is ignored and the block device mapping is\n always encrypted. In this case, we recommend that you omit the parameter.
The ID of the AMI in the format ami-17characters00000.
Alternatively, you can specify a Systems Manager parameter, using one of the following\n formats. The Systems Manager parameter will resolve to an AMI ID on launch.
\nTo reference a public parameter:
\n\n resolve:ssm:public-parameter\n \n
To reference a parameter stored in the same account:
\n\n resolve:ssm:parameter-name\n \n
\n resolve:ssm:parameter-name:version-number\n \n
\n resolve:ssm:parameter-name:label\n \n
To reference a parameter shared from another Amazon Web Services account:
\n\n resolve:ssm:parameter-ARN\n \n
\n resolve:ssm:parameter-ARN:version-number\n \n
\n resolve:ssm:parameter-ARN:label\n \n
For more information, see Use a Systems Manager parameter instead of an AMI ID in the\n Amazon EC2 User Guide.
\nThis parameter is only available for fleets of type instant. For fleets\n of type maintain and request, you must specify the AMI ID in\n the launch template.
The accelerator types that must be on the instance type.
\nFor instance types with FPGA accelerators, specify fpga.
For instance types with GPU accelerators, specify gpu.
Default: Any accelerator type
", + "smithy.api#documentation": "The accelerator types that must be on the instance type.
\nFor instance types with FPGA accelerators, specify fpga.
For instance types with GPU accelerators, specify gpu.
For instance types with Inference accelerators, specify inference.
Default: Any accelerator type
", "smithy.api#xmlName": "acceleratorTypeSet" } }, @@ -65931,7 +66377,7 @@ "AcceleratorTypes": { "target": "com.amazonaws.ec2#AcceleratorTypeSet", "traits": { - "smithy.api#documentation": "The accelerator types that must be on the instance type.
\nFor instance types with FPGA accelerators, specify fpga.
For instance types with GPU accelerators, specify gpu.
Default: Any accelerator type
", + "smithy.api#documentation": "The accelerator types that must be on the instance type.
\nFor instance types with FPGA accelerators, specify fpga.
For instance types with GPU accelerators, specify gpu.
For instance types with Inference accelerators, specify inference.
Default: Any accelerator type
", "smithy.api#xmlName": "AcceleratorType" } }, @@ -72806,6 +73252,14 @@ "smithy.api#documentation": "Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
", "smithy.api#xmlName": "enablePrivateGua" } + }, + "MeteredAccount": { + "target": "com.amazonaws.ec2#IpamMeteredAccount", + "traits": { + "aws.protocols#ec2QueryName": "MeteredAccount", + "smithy.api#documentation": "A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
\nPossible values:
\n\n ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
\n resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
The ID of the local gateway virtual interface group.
", + "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupId" + } + }, + "LocalGatewayVirtualInterfaceArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceArn", + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the local gateway virtual interface.
", + "smithy.api#xmlName": "localGatewayVirtualInterfaceArn" + } + }, + "OutpostLagId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostLagId", + "smithy.api#documentation": "The Outpost LAG ID.
", + "smithy.api#xmlName": "outpostLagId" + } + }, "Vlan": { "target": "com.amazonaws.ec2#Integer", "traits": { @@ -79268,6 +79763,14 @@ "smithy.api#xmlName": "peerBgpAsn" } }, + "PeerBgpAsnExtended": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "PeerBgpAsnExtended", + "smithy.api#documentation": "The extended 32-bit ASN of the BGP peer for use with larger ASN values.
", + "smithy.api#xmlName": "peerBgpAsnExtended" + } + }, "OwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -79283,12 +79786,49 @@ "smithy.api#documentation": "The tags assigned to the virtual interface.
", "smithy.api#xmlName": "tagSet" } + }, + "ConfigurationState": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceConfigurationState", + "traits": { + "aws.protocols#ec2QueryName": "ConfigurationState", + "smithy.api#documentation": "The current state of the local gateway virtual interface.
", + "smithy.api#xmlName": "configurationState" + } } }, "traits": { "smithy.api#documentation": "Describes a local gateway virtual interface.
" } }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceConfigurationState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroup": { "type": "structure", "members": { @@ -79324,6 +79864,30 @@ "smithy.api#xmlName": "ownerId" } }, + "LocalBgpAsn": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "LocalBgpAsn", + "smithy.api#documentation": "The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP).
", + "smithy.api#xmlName": "localBgpAsn" + } + }, + "LocalBgpAsnExtended": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "LocalBgpAsnExtended", + "smithy.api#documentation": "The extended 32-bit ASN for the local BGP configuration.
", + "smithy.api#xmlName": "localBgpAsnExtended" + } + }, + "LocalGatewayVirtualInterfaceGroupArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceGroupArn", + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the local gateway virtual interface group.
", + "smithy.api#xmlName": "localGatewayVirtualInterfaceGroupArn" + } + }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -79331,12 +79895,55 @@ "smithy.api#documentation": "The tags assigned to the virtual interface group.
", "smithy.api#xmlName": "tagSet" } + }, + "ConfigurationState": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupConfigurationState", + "traits": { + "aws.protocols#ec2QueryName": "ConfigurationState", + "smithy.api#documentation": "The current state of the local gateway virtual interface group.
", + "smithy.api#xmlName": "configurationState" + } } }, "traits": { "smithy.api#documentation": "Describes a local gateway virtual interface group.
" } }, + "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupConfigurationState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "incomplete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "incomplete" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, "com.amazonaws.ec2#LocalGatewayVirtualInterfaceGroupId": { "type": "string" }, @@ -82386,6 +82993,12 @@ "traits": { "smithy.api#documentation": "Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default.
" } + }, + "MeteredAccount": { + "target": "com.amazonaws.ec2#IpamMeteredAccount", + "traits": { + "smithy.api#documentation": "A metered account is an Amazon Web Services account that is charged for active IP addresses managed in IPAM. For more information, see Enable cost distribution in the Amazon VPC IPAM User Guide.
\nPossible values:
\n\n ipam-owner (default): The Amazon Web Services account which owns the IPAM is charged for all active IP addresses managed in IPAM.
\n resource-owner: The Amazon Web Services account that owns the IP address is charged for the active IP address.
The Amazon Resource Number (ARN) of the Outpost LAG.
", + "smithy.api#xmlName": "outpostArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "The ID of the Outpost LAG owner.
", + "smithy.api#xmlName": "ownerId" + } + }, + "State": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "The current state of the Outpost LAG.
", + "smithy.api#xmlName": "state" + } + }, + "OutpostLagId": { + "target": "com.amazonaws.ec2#OutpostLagId", + "traits": { + "aws.protocols#ec2QueryName": "OutpostLagId", + "smithy.api#documentation": "The ID of the Outpost LAG.
", + "smithy.api#xmlName": "outpostLagId" + } + }, + "LocalGatewayVirtualInterfaceIds": { + "target": "com.amazonaws.ec2#LocalGatewayVirtualInterfaceIdSet", + "traits": { + "aws.protocols#ec2QueryName": "LocalGatewayVirtualInterfaceIdSet", + "smithy.api#documentation": "The IDs of the local gateway virtual interfaces associated with the Outpost LAG.
", + "smithy.api#xmlName": "localGatewayVirtualInterfaceIdSet" + } + }, + "ServiceLinkVirtualInterfaceIds": { + "target": "com.amazonaws.ec2#ServiceLinkVirtualInterfaceIdSet", + "traits": { + "aws.protocols#ec2QueryName": "ServiceLinkVirtualInterfaceIdSet", + "smithy.api#documentation": "The service link virtual interface IDs associated with the Outpost LAG.
", + "smithy.api#xmlName": "serviceLinkVirtualInterfaceIdSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "The tags associated with the Outpost LAG.
", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an Outpost link aggregation group (LAG).
" + } + }, + "com.amazonaws.ec2#OutpostLagId": { + "type": "string" + }, + "com.amazonaws.ec2#OutpostLagIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#OutpostLagId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#OutpostLagMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#OutpostLagSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#OutpostLag", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#OwnerStringList": { "type": "list", "member": { @@ -90163,7 +90870,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "InstanceFamily", - "smithy.api#documentation": "The instance family to use as a baseline reference.
\nEnsure that you specify the correct value for the instance family. The instance\n family is everything before the period (.) in the instance type name. For\n example, in the instance type c6i.large, the instance family is\n c6i, not c6. For more information, see Amazon EC2\n instance type naming conventions in Amazon EC2 Instance\n Types.
The following instance families are not supported for performance\n protection:
\n\n c1\n
\n g3 | g3s\n
\n hpc7g\n
\n m1 | m2\n
\n mac1 | mac2 | mac2-m1ultra |\n mac2-m2 | mac2-m2pro\n
\n p3dn | p4d | p5\n
\n t1\n
\n u-12tb1 | u-18tb1 | u-24tb1 |\n u-3tb1 | u-6tb1 | u-9tb1 |\n u7i-12tb | u7in-16tb | u7in-24tb |\n u7in-32tb\n
If you enable performance protection by specifying a supported instance family, the\n returned instance types will exclude the above unsupported instance families.
\nIf you specify an unsupported instance family as a value for baseline performance, the\n API returns an empty response for and an exception for , , , and .
", + "smithy.api#documentation": "The instance family to use as a baseline reference.
\nEnsure that you specify the correct value for the instance family. The instance\n family is everything before the period (.) in the instance type name. For\n example, in the instance type c6i.large, the instance family is\n c6i, not c6. For more information, see Amazon EC2\n instance type naming conventions in Amazon EC2 Instance\n Types.
The following instance families are not supported for performance\n protection:
\n\n c1\n
\n g3 | g3s\n
\n hpc7g\n
\n m1 | m2\n
\n mac1 | mac2 | mac2-m1ultra |\n mac2-m2 | mac2-m2pro\n
\n p3dn | p4d | p5\n
\n t1\n
\n u-12tb1 | u-18tb1 | u-24tb1 |\n u-3tb1 | u-6tb1 | u-9tb1 |\n u7i-12tb | u7in-16tb | u7in-24tb |\n u7in-32tb\n
If you enable performance protection by specifying a supported instance family, the\n returned instance types will exclude the above unsupported instance families.
\nIf you specify an unsupported instance family as a value for baseline performance, the\n API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest.
", "smithy.api#xmlName": "instanceFamily" } } @@ -90178,7 +90885,7 @@ "InstanceFamily": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The instance family to use as a baseline reference.
\nEnsure that you specify the correct value for the instance family. The instance\n family is everything before the period (.) in the instance type name. For\n example, in the instance type c6i.large, the instance family is\n c6i, not c6. For more information, see Amazon EC2\n instance type naming conventions in Amazon EC2 Instance\n Types.
The following instance families are not supported for performance\n protection:
\n\n c1\n
\n g3 | g3s\n
\n hpc7g\n
\n m1 | m2\n
\n mac1 | mac2 | mac2-m1ultra |\n mac2-m2 | mac2-m2pro\n
\n p3dn | p4d | p5\n
\n t1\n
\n u-12tb1 | u-18tb1 | u-24tb1 |\n u-3tb1 | u-6tb1 | u-9tb1 |\n u7i-12tb | u7in-16tb | u7in-24tb |\n u7in-32tb\n
If you enable performance protection by specifying a supported instance family, the\n returned instance types will exclude the above unsupported instance families.
\nIf you specify an unsupported instance family as a value for baseline performance, the\n API returns an empty response for and an exception for , , , and .
" + "smithy.api#documentation": "The instance family to use as a baseline reference.
\nEnsure that you specify the correct value for the instance family. The instance\n family is everything before the period (.) in the instance type name. For\n example, in the instance type c6i.large, the instance family is\n c6i, not c6. For more information, see Amazon EC2\n instance type naming conventions in Amazon EC2 Instance\n Types.
The following instance families are not supported for performance\n protection:
\n\n c1\n
\n g3 | g3s\n
\n hpc7g\n
\n m1 | m2\n
\n mac1 | mac2 | mac2-m1ultra |\n mac2-m2 | mac2-m2pro\n
\n p3dn | p4d | p5\n
\n t1\n
\n u-12tb1 | u-18tb1 | u-24tb1 |\n u-3tb1 | u-6tb1 | u-9tb1 |\n u7i-12tb | u7in-16tb | u7in-24tb |\n u7in-32tb\n
If you enable performance protection by specifying a supported instance family, the\n returned instance types will exclude the above unsupported instance families.
\nIf you specify an unsupported instance family as a value for baseline performance, the\n API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest.
" } } }, @@ -97574,6 +98281,12 @@ "smithy.api#enumValue": "network-insights-access-scope-analysis" } }, + "outpost_lag": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "outpost-lag" + } + }, "placement_group": { "target": "smithy.api#Unit", "traits": { @@ -97616,6 +98329,12 @@ "smithy.api#enumValue": "security-group-rule" } }, + "service_link_virtual_interface": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "service-link-virtual-interface" + } + }, "snapshot": { "target": "smithy.api#Unit", "traits": { @@ -103080,6 +103799,169 @@ } } }, + "com.amazonaws.ec2#ServiceLinkMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 5, + "max": 1000 + } + } + }, + "com.amazonaws.ec2#ServiceLinkVirtualInterface": { + "type": "structure", + "members": { + "ServiceLinkVirtualInterfaceId": { + "target": "com.amazonaws.ec2#ServiceLinkVirtualInterfaceId", + "traits": { + "aws.protocols#ec2QueryName": "ServiceLinkVirtualInterfaceId", + "smithy.api#documentation": "The ID of the service link virtual interface.
", + "smithy.api#xmlName": "serviceLinkVirtualInterfaceId" + } + }, + "ServiceLinkVirtualInterfaceArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "ServiceLinkVirtualInterfaceArn", + "smithy.api#documentation": "The Amazon Resource Number (ARN) for the service link virtual interface.
", + "smithy.api#xmlName": "serviceLinkVirtualInterfaceArn" + } + }, + "OutpostId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostId", + "smithy.api#documentation": "The Outpost ID for the service link virtual interface.
", + "smithy.api#xmlName": "outpostId" + } + }, + "OutpostArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OutpostArn", + "smithy.api#documentation": "The Outpost Amazon Resource Number (ARN) for the service link virtual interface.
", + "smithy.api#xmlName": "outpostArn" + } + }, + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the service link virtual interface..
", + "smithy.api#xmlName": "ownerId" + } + }, + "LocalAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LocalAddress", + "smithy.api#documentation": "The IPv4 address assigned to the local gateway virtual interface on the Outpost side.
", + "smithy.api#xmlName": "localAddress" + } + }, + "PeerAddress": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "PeerAddress", + "smithy.api#documentation": "The IPv4 peer address for the service link virtual interface.
", + "smithy.api#xmlName": "peerAddress" + } + }, + "PeerBgpAsn": { + "target": "com.amazonaws.ec2#Long", + "traits": { + "aws.protocols#ec2QueryName": "PeerBgpAsn", + "smithy.api#documentation": "The ASN for the Border Gateway Protocol (BGP) associated with the service link virtual interface.
", + "smithy.api#xmlName": "peerBgpAsn" + } + }, + "Vlan": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "Vlan", + "smithy.api#documentation": "The virtual local area network for the service link virtual interface.
", + "smithy.api#xmlName": "vlan" + } + }, + "OutpostLagId": { + "target": "com.amazonaws.ec2#OutpostLagId", + "traits": { + "aws.protocols#ec2QueryName": "OutpostLagId", + "smithy.api#documentation": "The link aggregation group (LAG) ID for the service link virtual interface.
", + "smithy.api#xmlName": "outpostLagId" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "The tags associated with the service link virtual interface.
", + "smithy.api#xmlName": "tagSet" + } + }, + "ConfigurationState": { + "target": "com.amazonaws.ec2#ServiceLinkVirtualInterfaceConfigurationState", + "traits": { + "aws.protocols#ec2QueryName": "ConfigurationState", + "smithy.api#documentation": "The current state of the service link virtual interface.
", + "smithy.api#xmlName": "configurationState" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the service link virtual interfaces that establish connectivity between Amazon Web Services Outpost and on-premises networks.
" + } + }, + "com.amazonaws.ec2#ServiceLinkVirtualInterfaceConfigurationState": { + "type": "enum", + "members": { + "pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "pending" + } + }, + "available": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "available" + } + }, + "deleting": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleting" + } + }, + "deleted": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "deleted" + } + } + } + }, + "com.amazonaws.ec2#ServiceLinkVirtualInterfaceId": { + "type": "string" + }, + "com.amazonaws.ec2#ServiceLinkVirtualInterfaceIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ServiceLinkVirtualInterfaceId", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, + "com.amazonaws.ec2#ServiceLinkVirtualInterfaceSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#ServiceLinkVirtualInterface", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#ServiceManaged": { "type": "enum", "members": { @@ -106018,7 +106900,7 @@ "target": "com.amazonaws.ec2#StopInstancesResult" }, "traits": { - "smithy.api#documentation": "Stops an Amazon EBS-backed instance. For more information, see Stop and start\n Amazon EC2 instances in the Amazon EC2 User\n Guide.
\nYou can use the Stop action to hibernate an instance if the instance is enabled\n for hibernation and it meets the hibernation\n prerequisites. For more information, see Hibernate your Amazon EC2\n instance in the Amazon EC2 User Guide.
\nWe don't charge usage for a stopped instance, or data transfer fees; however, your\n root partition Amazon EBS volume remains and continues to persist your data, and you are\n charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2\n charges a one-minute minimum for instance usage, and thereafter charges per second for\n instance usage.
\nYou can't stop or hibernate instance store-backed instances. You can't use the Stop\n action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate\n Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the\n Amazon EC2 User Guide.
\nWhen you stop or hibernate an instance, we shut it down. You can restart your instance\n at any time. Before stopping or hibernating an instance, make sure it is in a state from\n which it can be restarted. Stopping an instance does not preserve data stored in RAM,\n but hibernating an instance does preserve data stored in RAM. If an instance cannot\n hibernate successfully, a normal shutdown occurs.
\nStopping and hibernating an instance is different to rebooting or terminating it. For\n example, when you stop or hibernate an instance, the root device and any other devices\n attached to the instance persist. When you terminate an instance, the root device and\n any other devices attached during the instance launch are automatically deleted. For\n more information about the differences between rebooting, stopping, hibernating, and\n terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.
\nWhen you stop an instance, we attempt to shut it down forcibly after a short while. If\n your instance appears stuck in the stopping state after a period of time, there may be\n an issue with the underlying host computer. For more information, see Troubleshoot\n stopping your instance in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "Stops an Amazon EBS-backed instance. For more information, see Stop and start\n Amazon EC2 instances in the Amazon EC2 User\n Guide.
\nWhen you stop an instance, we shut it down. You can restart your instance at any\n time.
\nYou can use the Stop operation together with the Hibernate parameter to hibernate an\n instance if the instance is enabled for\n hibernation and meets the hibernation\n prerequisites. Stopping an instance doesn't preserve data stored in RAM,\n while hibernation does. If hibernation fails, a normal shutdown occurs. For more\n information, see Hibernate your Amazon EC2\n instance in the Amazon EC2 User Guide.
\nIf your instance appears stuck in the stopping state, there might be an\n issue with the underlying host computer. You can use the Stop operation together with\n the Force parameter to force stop your instance. For more information, see Troubleshoot\n Amazon EC2 instance stop issues in the\n Amazon EC2 User Guide.
Stopping and hibernating an instance differs from rebooting or terminating it. For\n example, a stopped or hibernated instance retains its root volume and any data volumes,\n unlike terminated instances where these volumes are automatically deleted. For more\n information about the differences between stopping, hibernating, rebooting, and\n terminating instances, see Amazon EC2\n instance state changes in the Amazon EC2 User Guide.
\nWe don't charge for instance usage or data transfer fees when an instance is stopped.\n However, the root volume and any data volumes remain and continue to persist your data,\n and you're charged for volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, followed by per-second\n billing.
\nYou can't stop or hibernate instance store-backed instances.
", "smithy.api#examples": [ { "title": "To stop a running EC2 instance", @@ -106077,7 +106959,7 @@ "target": "com.amazonaws.ec2#Boolean", "traits": { "aws.protocols#ec2QueryName": "Force", - "smithy.api#documentation": "Forces the instances to stop. The instances do not have an opportunity to flush file\n system caches or file system metadata. If you use this option, you must perform file\n system check and repair procedures. This option is not recommended for Windows\n instances.
\nDefault: false\n
Forces the instance to stop. The instance will first attempt a graceful shutdown,\n which includes flushing file system caches and metadata. If the graceful shutdown fails\n to complete within the timeout period, the instance shuts down forcibly without flushing\n the file system caches and metadata.
\nAfter using this option, you must perform file system check and repair procedures.\n This option is not recommended for Windows instances. For more information, see Troubleshoot\n Amazon EC2 instance stop issues in the\n Amazon EC2 User Guide.
\nDefault: false\n
Shuts down the specified instances. This operation is idempotent; if you terminate an\n instance more than once, each call succeeds.
\nIf you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.
\nIf you terminate multiple instances across multiple Availability Zones, and one or\n more of the specified instances are enabled for termination protection, the request\n fails with the following results:
\nThe specified instances that are in the same Availability Zone as the\n protected instance are not terminated.
\nThe specified instances that are in different Availability Zones, where no\n other specified instances are protected, are successfully terminated.
\nFor example, say you have the following instances:
\nInstance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:
\nInstance A and Instance B are successfully terminated because none of the\n specified instances in us-east-1a are enabled for termination\n protection.
Instance C and Instance D fail to terminate because at least one of the\n specified instances in us-east-1b (Instance C) is enabled for\n termination protection.
Terminated instances remain visible after termination (for approximately one\n hour).
\nBy default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.
\nYou can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop it or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Instance lifecycle\n in the Amazon EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the\n Amazon EC2 User Guide.
", + "smithy.api#documentation": "Shuts down the specified instances. This operation is idempotent; if you\n terminate an instance more than once, each call succeeds.
\nIf you specify multiple instances and the request fails (for example, because of a\n single incorrect instance ID), none of the instances are terminated.
\nIf you terminate multiple instances across multiple Availability Zones, and one or\n more of the specified instances are enabled for termination protection, the request\n fails with the following results:
\nThe specified instances that are in the same Availability Zone as the\n protected instance are not terminated.
\nThe specified instances that are in different Availability Zones, where no\n other specified instances are protected, are successfully terminated.
\nFor example, say you have the following instances:
\nInstance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected
If you attempt to terminate all of these instances in the same request, the request\n reports failure with the following results:
\nInstance A and Instance B are successfully terminated because none of the\n specified instances in us-east-1a are enabled for termination\n protection.
Instance C and Instance D fail to terminate because at least one of the\n specified instances in us-east-1b (Instance C) is enabled for\n termination protection.
Terminated instances remain visible after termination (for approximately one\n hour).
\nBy default, Amazon EC2 deletes all EBS volumes that were attached when the instance\n launched. Volumes attached after instance launch continue running.
\nYou can stop, start, and terminate EBS-backed instances. You can only terminate\n instance store-backed instances. What happens to an instance differs if you stop or\n terminate it. For example, when you stop an instance, the root device and any other\n devices attached to the instance persist. When you terminate an instance, any attached\n EBS volumes with the DeleteOnTermination block device mapping parameter set\n to true are automatically deleted. For more information about the\n differences between stopping and terminating instances, see Amazon EC2\n instance state changes in the Amazon EC2 User Guide.
For information about troubleshooting, see Troubleshooting terminating your instance in the\n Amazon EC2 User Guide.
", "smithy.api#examples": [ { "title": "To terminate an EC2 instance", diff --git a/ecr-public/service/2020-10-30/ecr-public-2020-10-30.json b/models/ecr-public/service/2020-10-30/ecr-public-2020-10-30.json similarity index 98% rename from ecr-public/service/2020-10-30/ecr-public-2020-10-30.json rename to models/ecr-public/service/2020-10-30/ecr-public-2020-10-30.json index 6d2ac2b1..6a4f6a7a 100644 --- a/ecr-public/service/2020-10-30/ecr-public-2020-10-30.json +++ b/models/ecr-public/service/2020-10-30/ecr-public-2020-10-30.json @@ -3131,6 +3131,31 @@ } ], "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr-public.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [], "endpoint": { @@ -3176,54 +3201,67 @@ "smithy.rules#endpointTests": { "testCases": [ { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr-public-fips.us-east-1.api.aws" + "url": "https://api.ecr-public.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true + "UseFIPS": false, + "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr-public-fips.us-east-1.amazonaws.com" + "url": "https://ecr-public.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", - "UseFIPS": true, + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr-public.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr-public.us-east-1.api.aws" + "url": "https://api.ecr-public-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", - "UseFIPS": false, + "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr-public.us-east-1.amazonaws.com" + "url": "https://api.ecr-public-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", - "UseFIPS": false, + "UseFIPS": true, "UseDualStack": false } }, diff --git a/ecr/service/2015-09-21/ecr-2015-09-21.json b/models/ecr/service/2015-09-21/ecr-2015-09-21.json similarity index 92% rename from ecr/service/2015-09-21/ecr-2015-09-21.json rename to models/ecr/service/2015-09-21/ecr-2015-09-21.json index 6cca36fe..ed6b5179 100644 --- a/ecr/service/2015-09-21/ecr-2015-09-21.json +++ b/models/ecr/service/2015-09-21/ecr-2015-09-21.json @@ -378,6 +378,56 @@ } ], "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr-fips.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr-fips.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [], "endpoint": { @@ -532,6 +582,81 @@ } ], "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-cn", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr.{Region}.api.amazonwebservices.com.cn", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://ecr.{Region}.api.aws", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, { "conditions": [], "endpoint": { @@ -590,356 +715,902 @@ } }, { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-east-1.amazonaws.com" + "url": "https://ecr.af-south-1.api.aws" } }, "params": { - "Region": "ap-east-1", + "Region": "af-south-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-northeast-1.amazonaws.com" + "url": "https://api.ecr.ap-east-1.amazonaws.com" } }, "params": { - "Region": "ap-northeast-1", + "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-northeast-2.amazonaws.com" + "url": "https://ecr.ap-east-1.api.aws" } }, "params": { - "Region": "ap-northeast-2", + "Region": "ap-east-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-northeast-3.amazonaws.com" + "url": "https://api.ecr.ap-northeast-1.amazonaws.com" } }, "params": { - "Region": "ap-northeast-3", + "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-south-1.amazonaws.com" + "url": "https://ecr.ap-northeast-1.api.aws" } }, "params": { - "Region": "ap-south-1", + "Region": "ap-northeast-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-southeast-1.amazonaws.com" + "url": "https://api.ecr.ap-northeast-2.amazonaws.com" } }, "params": { - "Region": "ap-southeast-1", + "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-southeast-2.amazonaws.com" + "url": "https://ecr.ap-northeast-2.api.aws" } }, "params": { - "Region": "ap-southeast-2", + "Region": "ap-northeast-2", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.ap-southeast-3.amazonaws.com" + "url": "https://api.ecr.ap-northeast-3.amazonaws.com" } }, "params": { - "Region": "ap-southeast-3", + "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.ca-central-1.amazonaws.com" + "url": "https://ecr.ap-northeast-3.api.aws" } }, "params": { - "Region": "ca-central-1", + "Region": "ap-northeast-3", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-central-1.amazonaws.com" + "url": "https://api.ecr.ap-south-1.amazonaws.com" } }, "params": { - "Region": "eu-central-1", + "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-north-1.amazonaws.com" + "url": "https://ecr.ap-south-1.api.aws" } }, "params": { - "Region": "eu-north-1", + "Region": "ap-south-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-south-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-south-1.amazonaws.com" + "url": "https://api.ecr.ap-south-2.amazonaws.com" } }, "params": { - "Region": "eu-south-1", + "Region": "ap-south-2", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-south-2 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-west-1.amazonaws.com" + "url": "https://ecr.ap-south-2.api.aws" } }, "params": { - "Region": "eu-west-1", + "Region": "ap-south-2", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-west-2.amazonaws.com" + "url": "https://api.ecr.ap-southeast-1.amazonaws.com" } }, "params": { - "Region": "eu-west-2", + "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.eu-west-3.amazonaws.com" + "url": "https://ecr.ap-southeast-1.api.aws" } }, "params": { - "Region": "eu-west-3", + "Region": "ap-southeast-1", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.me-south-1.amazonaws.com" + "url": "https://api.ecr.ap-southeast-2.amazonaws.com" } }, "params": { - "Region": "me-south-1", + "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.sa-east-1.amazonaws.com" + "url": "https://ecr.ap-southeast-2.api.aws" } }, "params": { - "Region": "sa-east-1", + "Region": "ap-southeast-2", "UseFIPS": false, - "UseDualStack": false + "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-east-1.amazonaws.com" + "url": "https://api.ecr.ap-southeast-3.amazonaws.com" } }, "params": { - "Region": "us-east-1", + "Region": "ap-southeast-3", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://ecr-fips.us-east-1.amazonaws.com" + "url": "https://ecr.ap-southeast-3.api.aws" } }, "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-east-2.amazonaws.com" + "url": "https://api.ecr.ap-southeast-4.amazonaws.com" } }, "params": { - "Region": "us-east-2", + "Region": "ap-southeast-4", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://ecr-fips.us-east-2.amazonaws.com" + "url": "https://ecr.ap-southeast-4.api.aws" } }, "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false + "Region": "ap-southeast-4", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-5 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-west-1.amazonaws.com" + "url": "https://api.ecr.ap-southeast-5.amazonaws.com" } }, "params": { - "Region": "us-west-1", + "Region": "ap-southeast-5", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-5 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://ecr-fips.us-west-1.amazonaws.com" + "url": "https://ecr.ap-southeast-5.api.aws" } }, "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false + "Region": "ap-southeast-5", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-southeast-7 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-west-2.amazonaws.com" + "url": "https://api.ecr.ap-southeast-7.amazonaws.com" } }, "params": { - "Region": "us-west-2", + "Region": "ap-southeast-7", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-7 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://ecr-fips.us-west-2.amazonaws.com" + "url": "https://ecr.ap-southeast-7.api.aws" } }, "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false + "Region": "ap-southeast-7", + "UseFIPS": false, + "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr-fips.us-east-1.api.aws" + "url": "https://api.ecr.ca-central-1.amazonaws.com" } }, "params": { - "Region": "us-east-1", - "UseFIPS": true, + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ca-central-1.api.aws" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region ca-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.ca-west-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.ca-west-1.api.aws" + } + }, + "params": { + "Region": "ca-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-central-1.api.aws" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-central-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-central-2.api.aws" + } + }, + "params": { + "Region": "eu-central-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-north-1.api.aws" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-south-1.api.aws" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-south-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-south-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-south-2.api.aws" + } + }, + "params": { + "Region": "eu-south-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-west-1.api.aws" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-west-2.api.aws" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.eu-west-3.api.aws" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region il-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.il-central-1.amazonaws.com" + } + }, + "params": { + "Region": "il-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region il-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.il-central-1.api.aws" + } + }, + "params": { + "Region": "il-central-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.me-central-1.amazonaws.com" + } + }, + "params": { + "Region": "me-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-central-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.me-central-1.api.aws" + } + }, + "params": { + "Region": "me-central-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.me-south-1.api.aws" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.sa-east-1.api.aws" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, "UseDualStack": true } }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-east-1.api.aws" + "url": "https://ecr.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.us-east-2.api.aws" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-east-2.api.aws" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.us-west-1.api.aws" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-west-1.api.aws" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.ecr.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.us-west-2.api.aws" + } + }, + "params": { + "Region": "us-west-2", "UseFIPS": false, "UseDualStack": true } }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-west-2.api.aws" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": true + } + }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { @@ -953,6 +1624,19 @@ "UseDualStack": false } }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { @@ -966,6 +1650,19 @@ "UseDualStack": false } }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr.cn-northwest-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { @@ -993,42 +1690,55 @@ } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://api.ecr.us-gov-east-1.amazonaws.com" } }, "params": { - "Region": "cn-north-1", + "Region": "us-gov-east-1", "UseFIPS": false, - "UseDualStack": true + "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-gov-east-1.amazonaws.com" + "url": "https://ecr-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", - "UseFIPS": false, + "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://ecr-fips.us-gov-east-1.amazonaws.com" + "url": "https://ecr.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://ecr-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, - "UseDualStack": false + "UseDualStack": true } }, { @@ -1058,28 +1768,28 @@ } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr-fips.us-gov-east-1.api.aws" + "url": "https://ecr.us-gov-west-1.api.aws" } }, "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, + "Region": "us-gov-west-1", + "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://api.ecr.us-gov-east-1.api.aws" + "url": "https://ecr-fips.us-gov-west-1.api.aws" } }, "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, + "Region": "us-gov-west-1", + "UseFIPS": true, "UseDualStack": true } }, @@ -1935,7 +2645,7 @@ "upstreamRegistryUrl": { "target": "com.amazonaws.ecr#Url", "traits": { - "smithy.api#documentation": "The registry URL of the upstream public registry to use as the source for the pull\n through cache rule. The following is the syntax to use for each supported upstream\n registry.
\nAmazon ECR (ecr) \u2013\n
Amazon ECR Public (ecr-public) \u2013 public.ecr.aws\n
Docker Hub (docker-hub) \u2013\n registry-1.docker.io\n
GitHub Container Registry (github-container-registry) \u2013\n ghcr.io\n
GitLab Container Registry (gitlab-container-registry) \u2013\n registry.gitlab.com\n
Kubernetes (k8s) \u2013 registry.k8s.io\n
Microsoft Azure Container Registry (azure-container-registry) \u2013\n
Quay (quay) \u2013 quay.io\n
The registry URL of the upstream public registry to use as the source for the pull\n through cache rule. The following is the syntax to use for each supported upstream\n registry.
\nAmazon ECR (ecr) \u2013\n dkr.ecr.\n
Amazon ECR Public (ecr-public) \u2013 public.ecr.aws\n
Docker Hub (docker-hub) \u2013\n registry-1.docker.io\n
GitHub Container Registry (github-container-registry) \u2013\n ghcr.io\n
GitLab Container Registry (gitlab-container-registry) \u2013\n registry.gitlab.com\n
Kubernetes (k8s) \u2013 registry.k8s.io\n
Microsoft Azure Container Registry (azure-container-registry) \u2013\n
Quay (quay) \u2013 quay.io\n
Returns metadata about the images in a repository.
\nStarting with Docker version 1.9, the Docker client compresses image layers before\n pushing them to a V2 Docker registry. The output of the docker images\n command shows the uncompressed image size. Therefore, Docker might return a larger\n image than the image shown in the Amazon Web Services Management Console.
Returns metadata about the images in a repository.
\nBeginning with Docker version 1.9, the Docker client compresses image layers\n before pushing them to a V2 Docker registry. The output of the docker\n images command shows the uncompressed image size, so it may return a\n larger image size than the image sizes returned by DescribeImages.
A list of authorization token data objects that correspond to the\n registryIds values in the request.
The size of the authorization token returned by Amazon ECR is not fixed. We recommend\n that you don't make assumptions about the maximum size.
\nA list of authorization token data objects that correspond to the\n registryIds values in the request.
The size, in bytes, of the image in the repository.
\nIf the image is a manifest list, this will be the max size of all manifests in the\n list.
\nStarting with Docker version 1.9, the Docker client compresses image layers before\n pushing them to a V2 Docker registry. The output of the docker images\n command shows the uncompressed image size. Therefore, Docker might return a larger\n image than the image shown in the Amazon Web Services Management Console.
The size, in bytes, of the image in the repository.
\nIf the image is a manifest list, this will be the max size of all manifests in the\n list.
\nStarting with Docker version 1.9, the Docker client compresses image layers before\n pushing them to a V2 Docker registry. The output of the docker images\n command shows the uncompressed image size. Therefore, Docker might return a larger\n image than the image sizes returned by DescribeImages.
These errors are usually caused by a client action. This client action might be using\n\t\t\tan action or resource on behalf of a user that doesn't have permissions to use the\n\t\t\taction or resource. Or, it might be specifying an identifier that isn't valid.
\nThe following list includes additional causes for the error:
\nThe RunTask could not be processed because you use managed\n\t\t\t\t\tscaling and there is a capacity error because the quota of tasks in the\n\t\t\t\t\t\tPROVISIONING per cluster has been reached. For information\n\t\t\t\t\tabout the service quotas, see Amazon ECS\n\t\t\t\t\t\tservice quotas.
These errors are usually caused by a client action. This client action might be using\n\t\t\tan action or resource on behalf of a user that doesn't have permissions to use the\n\t\t\taction or resource. Or, it might be specifying an identifier that isn't valid.
", "smithy.api#error": "client" } }, @@ -3821,7 +3821,7 @@ "principalArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the principal. It can be an user, role, or the\n\t\t\troot user. If you specify the root user, it disables the account setting for all users, roles,\n\t\t\tand the root user of the account unless a user or role explicitly overrides these settings.\n\t\t\tIf this field is omitted, the setting is changed only for the authenticated user.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the principal. It can be a user, role, or the\n\t\t\troot user. If you specify the root user, it disables the account setting for all users, roles,\n\t\t\tand the root user of the account unless a user or role explicitly overrides these settings.\n\t\t\tIf this field is omitted, the setting is changed only for the authenticated user.
\nIn order to use this parameter, you must be the root user, or the principal.
" } } }, @@ -7455,7 +7455,7 @@ "principalArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The ARN of the principal, which can be a user, role, or the root user. If this field is\n\t\t\tomitted, the account settings are listed only for the authenticated user.
\nFederated users assume the account setting of the root user and can't have explicit\n\t\t\t\taccount settings set for them.
\nThe ARN of the principal, which can be a user, role, or the root user. If this field is\n\t\t\tomitted, the account settings are listed only for the authenticated user.
\nIn order to use this parameter, you must be the root user, or the principal.
\nFederated users assume the account setting of the root user and can't have explicit\n\t\t\t\taccount settings set for them.
\nThe ARN of the principal, which can be a user, role, or the root user. If you specify\n\t\t\tthe root user, it modifies the account setting for all users, roles, and the root user of the\n\t\t\taccount unless a user or role explicitly overrides these settings. If this field is\n\t\t\tomitted, the setting is changed only for the authenticated user.
\nYou must use the root user when you set the Fargate wait time\n\t\t\t\t\t(fargateTaskRetirementWaitPeriod).
Federated users assume the account setting of the root user and can't have explicit\n\t\t\t\taccount settings set for them.
\nThe ARN of the principal, which can be a user, role, or the root user. If you specify\n\t\t\tthe root user, it modifies the account setting for all users, roles, and the root user of the\n\t\t\taccount unless a user or role explicitly overrides these settings. If this field is\n\t\t\tomitted, the setting is changed only for the authenticated user.
\nIn order to use this parameter, you must be the root user, or the principal.
\nYou must use the root user when you set the Fargate wait time\n\t\t\t\t\t(fargateTaskRetirementWaitPeriod).
Federated users assume the account setting of the root user and can't have explicit\n\t\t\t\taccount settings set for them.
\nStarts a new task using the specified task definition.
\nOn March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nYou can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the Amazon Elastic Container Service Developer Guide.
\nAlternatively, you can use StartTask to use your own scheduler or place\n\t\t\ttasks manually on specific container instances.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
\nThe Amazon ECS API follows an eventual consistency model. This is because of the\n\t\t\tdistributed nature of the system supporting the API. This means that the result of an\n\t\t\tAPI command you run that affects your Amazon ECS resources might not be immediately visible\n\t\t\tto all subsequent commands you run. Keep this in mind when you carry out an API command\n\t\t\tthat immediately follows a previous API command.
\nTo manage eventual consistency, you can do the following:
\nConfirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.
\nAdd wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.
\nIf you get a ConflictException error, the RunTask request could\n\t\t\tnot be processed due to conflicts. The provided clientToken is already in\n\t\t\tuse with a different RunTask request. The resourceIds are the\n\t\t\texisting task ARNs which are already associated with the clientToken.
To fix this issue:
\nRun RunTask with a unique clientToken.
Run RunTask with the clientToken and the original\n\t\t\t\t\tset of parameters
Starts a new task using the specified task definition.
\nOn March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
\nAmazon Elastic Inference (EI) is no longer available to customers.
\nYou can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the Amazon Elastic Container Service Developer Guide.
\nAlternatively, you can use StartTask to use your own scheduler or place\n\t\t\ttasks manually on specific container instances.
You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or\n\t\t\tupdating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
\nThe Amazon ECS API follows an eventual consistency model. This is because of the\n\t\t\tdistributed nature of the system supporting the API. This means that the result of an\n\t\t\tAPI command you run that affects your Amazon ECS resources might not be immediately visible\n\t\t\tto all subsequent commands you run. Keep this in mind when you carry out an API command\n\t\t\tthat immediately follows a previous API command.
\nTo manage eventual consistency, you can do the following:
\nConfirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.
\nAdd wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.
\nIf you get a ConflictException error, the RunTask request could\n\t\t\tnot be processed due to conflicts. The provided clientToken is already in\n\t\t\tuse with a different RunTask request. The resourceIds are the\n\t\t\texisting task ARNs which are already associated with the clientToken.
To fix this issue:
\nRun RunTask with a unique clientToken.
Run RunTask with the clientToken and the original\n\t\t\t\t\tset of parameters
If you get a ClientExceptionerror, the RunTask could not be processed because you use managed\n\t\t\t\t\tscaling and there is a capacity error because the quota of tasks in the\n\t\t\t\t\tPROVISIONING per cluster has been reached. For information\n\t\t\t\t\tabout the service quotas, see Amazon ECS\n\t\t\t\t\t\tservice quotas.
Stops an ongoing service deployment.
\nStopServiceDeployment isn't currently supported.
\nStops an ongoing service deployment.
\nThe following stop types are avaiable:
\nROLLBACK - This option rolls back the service deployment to the previous\n\t\t\t\t\tservice revision.
\nYou can use this option even if you didn't configure the service deployment\n\t\t\t\t\tfor the rollback option.
\nFor more information, see Stopping Amazon ECS\n\t\t\t\tservice deployments in the Amazon Elastic Container Service Developer\n\t\t\tGuide.
", "smithy.api#examples": [ { "title": "To stop a service deployment", @@ -12459,7 +12459,7 @@ "stopType": { "target": "com.amazonaws.ecs#StopServiceDeploymentStopType", "traits": { - "smithy.api#documentation": "How you want Amazon ECS to stop the service.
\nThe ROLLBACK and ABORT stopType aren't supported.
" + "smithy.api#documentation": "How you want Amazon ECS to stop the service.
\nThe valid values are ROLLBACK.
The base image for the container recipe.
" + "smithy.api#documentation": "The base image for customizations specified in the container recipe. This can \n\t\t\tcontain an Image Builder image resource ARN or a container image URI, for example \n\t\t\tamazonlinux:latest.
Configure export settings to deliver disk images created from your image build, using\n\t\t\ta file format that is compatible with your VMs in that Region.
" + "smithy.api#documentation": "Configure export settings to deliver disk images created from your image build, \n\t\t\tusing a file format that is compatible with your VMs in that Region.
" } }, "fastLaunchConfigurations": { @@ -3489,6 +3489,12 @@ "traits": { "smithy.api#documentation": "The Windows faster-launching configurations to use for AMI distribution.
" } + }, + "ssmParameterConfigurations": { + "target": "com.amazonaws.imagebuilder#SsmParameterConfigurationList", + "traits": { + "smithy.api#documentation": "Contains settings to update Amazon Web Services Systems Manager (SSM) Parameter Store Parameters with \n\t\t\toutput AMI IDs from the build by target Region.
" + } } }, "traits": { @@ -3519,7 +3525,7 @@ "distributions": { "target": "com.amazonaws.imagebuilder#DistributionList", "traits": { - "smithy.api#documentation": "The distribution objects that apply Region-specific settings for the deployment of the\n\t\t\timage to targeted Regions.
" + "smithy.api#documentation": "The distribution objects that apply Region-specific settings for the deployment of \n\t\t\tthe image to targeted Regions.
" } }, "timeoutMinutes": { @@ -5837,7 +5843,7 @@ "parentImage": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "The base image of the image recipe.
" + "smithy.api#documentation": "The base image for customizations specified in the image recipe. You can specify the \n\t\t\tparent image using one of the following options:
\nAMI ID
\nImage Builder image Amazon Resource Name (ARN)
\nAmazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, \n\t\t\t\t\tfollowed by the parameter name or ARN.
Amazon Web Services Marketplace product ID
\nThe AMI ID to use as the base image for a container build and test instance. If not\n\t\t\tspecified, Image Builder will use the appropriate ECS-optimized AMI as a base image.
" + "smithy.api#documentation": "The base image for a container build and test instance. This can contain an AMI ID \n\t\t\tor it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, \n\t\t\tfollowed by the parameter name or ARN.
If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.
" } }, "blockDeviceMappings": { @@ -11852,6 +11858,66 @@ "com.amazonaws.imagebuilder#SourceLayerHash": { "type": "string" }, + "com.amazonaws.imagebuilder#SsmParameterConfiguration": { + "type": "structure", + "members": { + "amiAccountId": { + "target": "com.amazonaws.imagebuilder#AccountId", + "traits": { + "smithy.api#documentation": "Specify the account that will own the Parameter in a given Region. During distribution, \n\t\t\tthis account must be specified in distribution settings as a target account for the \n\t\t\tRegion.
" + } + }, + "parameterName": { + "target": "com.amazonaws.imagebuilder#SsmParameterName", + "traits": { + "smithy.api#documentation": "This is the name of the Parameter in the target Region or account. The image \n\t\t\tdistribution creates the Parameter if it doesn't already exist. Otherwise, it updates \n\t\t\tthe parameter.
", + "smithy.api#required": {} + } + }, + "dataType": { + "target": "com.amazonaws.imagebuilder#SsmParameterDataType", + "traits": { + "smithy.api#documentation": "The data type specifies what type of value the Parameter contains. We recommend that \n\t\t\tyou use data type aws:ec2:image.
Configuration for a single Parameter in the Amazon Web Services Systems Manager (SSM) Parameter Store in \n\t\t\ta given Region.
" + } + }, + "com.amazonaws.imagebuilder#SsmParameterConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.imagebuilder#SsmParameterConfiguration" + } + }, + "com.amazonaws.imagebuilder#SsmParameterDataType": { + "type": "enum", + "members": { + "TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "text" + } + }, + "AWS_EC2_IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "aws:ec2:image" + } + } + } + }, + "com.amazonaws.imagebuilder#SsmParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.\\-\\/]+$" + } + }, "com.amazonaws.imagebuilder#StartImagePipelineExecution": { "type": "operation", "input": { @@ -12252,7 +12318,7 @@ "min": 3, "max": 100 }, - "smithy.api#pattern": "^[a-zA-Z0-9]{2,}(?:\\/[a-zA-z0-9-_+]+)*$" + "smithy.api#pattern": "^[a-zA-Z0-9]{2,}(?:\\/[a-zA-Z0-9-_+]+)*$" } }, "com.amazonaws.imagebuilder#UntagResource": { diff --git a/inspector-scan/service/2023-08-08/inspector-scan-2023-08-08.json b/models/inspector-scan/service/2023-08-08/inspector-scan-2023-08-08.json similarity index 100% rename from inspector-scan/service/2023-08-08/inspector-scan-2023-08-08.json rename to models/inspector-scan/service/2023-08-08/inspector-scan-2023-08-08.json diff --git a/inspector/service/2016-02-16/inspector-2016-02-16.json b/models/inspector/service/2016-02-16/inspector-2016-02-16.json similarity index 100% rename from inspector/service/2016-02-16/inspector-2016-02-16.json rename to models/inspector/service/2016-02-16/inspector-2016-02-16.json diff --git a/inspector2/service/2020-06-08/inspector2-2020-06-08.json b/models/inspector2/service/2020-06-08/inspector2-2020-06-08.json similarity index 100% rename from inspector2/service/2020-06-08/inspector2-2020-06-08.json rename to models/inspector2/service/2020-06-08/inspector2-2020-06-08.json diff --git a/internetmonitor/service/2021-06-03/internetmonitor-2021-06-03.json b/models/internetmonitor/service/2021-06-03/internetmonitor-2021-06-03.json similarity index 100% rename from internetmonitor/service/2021-06-03/internetmonitor-2021-06-03.json rename to models/internetmonitor/service/2021-06-03/internetmonitor-2021-06-03.json diff --git a/invoicing/service/2024-12-01/invoicing-2024-12-01.json b/models/invoicing/service/2024-12-01/invoicing-2024-12-01.json similarity index 100% rename from invoicing/service/2024-12-01/invoicing-2024-12-01.json rename to models/invoicing/service/2024-12-01/invoicing-2024-12-01.json diff --git a/iot-data-plane/service/2015-05-28/iot-data-plane-2015-05-28.json b/models/iot-data-plane/service/2015-05-28/iot-data-plane-2015-05-28.json similarity index 100% rename from iot-data-plane/service/2015-05-28/iot-data-plane-2015-05-28.json rename to models/iot-data-plane/service/2015-05-28/iot-data-plane-2015-05-28.json diff --git a/iot-events-data/service/2018-10-23/iot-events-data-2018-10-23.json b/models/iot-events-data/service/2018-10-23/iot-events-data-2018-10-23.json similarity index 100% rename from iot-events-data/service/2018-10-23/iot-events-data-2018-10-23.json rename to models/iot-events-data/service/2018-10-23/iot-events-data-2018-10-23.json diff --git a/iot-events/service/2018-07-27/iot-events-2018-07-27.json b/models/iot-events/service/2018-07-27/iot-events-2018-07-27.json similarity index 100% rename from iot-events/service/2018-07-27/iot-events-2018-07-27.json rename to models/iot-events/service/2018-07-27/iot-events-2018-07-27.json diff --git a/iot-jobs-data-plane/service/2017-09-29/iot-jobs-data-plane-2017-09-29.json b/models/iot-jobs-data-plane/service/2017-09-29/iot-jobs-data-plane-2017-09-29.json similarity index 100% rename from iot-jobs-data-plane/service/2017-09-29/iot-jobs-data-plane-2017-09-29.json rename to models/iot-jobs-data-plane/service/2017-09-29/iot-jobs-data-plane-2017-09-29.json diff --git a/iot-managed-integrations/service/2025-03-03/iot-managed-integrations-2025-03-03.json b/models/iot-managed-integrations/service/2025-03-03/iot-managed-integrations-2025-03-03.json similarity index 100% rename from iot-managed-integrations/service/2025-03-03/iot-managed-integrations-2025-03-03.json rename to models/iot-managed-integrations/service/2025-03-03/iot-managed-integrations-2025-03-03.json diff --git a/iot-wireless/service/2020-11-22/iot-wireless-2020-11-22.json b/models/iot-wireless/service/2020-11-22/iot-wireless-2020-11-22.json similarity index 100% rename from iot-wireless/service/2020-11-22/iot-wireless-2020-11-22.json rename to models/iot-wireless/service/2020-11-22/iot-wireless-2020-11-22.json diff --git a/iot/service/2015-05-28/iot-2015-05-28.json b/models/iot/service/2015-05-28/iot-2015-05-28.json similarity index 100% rename from iot/service/2015-05-28/iot-2015-05-28.json rename to models/iot/service/2015-05-28/iot-2015-05-28.json diff --git a/iotanalytics/service/2017-11-27/iotanalytics-2017-11-27.json b/models/iotanalytics/service/2017-11-27/iotanalytics-2017-11-27.json similarity index 100% rename from iotanalytics/service/2017-11-27/iotanalytics-2017-11-27.json rename to models/iotanalytics/service/2017-11-27/iotanalytics-2017-11-27.json diff --git a/iotdeviceadvisor/service/2020-09-18/iotdeviceadvisor-2020-09-18.json b/models/iotdeviceadvisor/service/2020-09-18/iotdeviceadvisor-2020-09-18.json similarity index 100% rename from iotdeviceadvisor/service/2020-09-18/iotdeviceadvisor-2020-09-18.json rename to models/iotdeviceadvisor/service/2020-09-18/iotdeviceadvisor-2020-09-18.json diff --git a/iotfleethub/service/2020-11-03/iotfleethub-2020-11-03.json b/models/iotfleethub/service/2020-11-03/iotfleethub-2020-11-03.json similarity index 100% rename from iotfleethub/service/2020-11-03/iotfleethub-2020-11-03.json rename to models/iotfleethub/service/2020-11-03/iotfleethub-2020-11-03.json diff --git a/iotfleetwise/service/2021-06-17/iotfleetwise-2021-06-17.json b/models/iotfleetwise/service/2021-06-17/iotfleetwise-2021-06-17.json similarity index 100% rename from iotfleetwise/service/2021-06-17/iotfleetwise-2021-06-17.json rename to models/iotfleetwise/service/2021-06-17/iotfleetwise-2021-06-17.json diff --git a/iotsecuretunneling/service/2018-10-05/iotsecuretunneling-2018-10-05.json b/models/iotsecuretunneling/service/2018-10-05/iotsecuretunneling-2018-10-05.json similarity index 100% rename from iotsecuretunneling/service/2018-10-05/iotsecuretunneling-2018-10-05.json rename to models/iotsecuretunneling/service/2018-10-05/iotsecuretunneling-2018-10-05.json diff --git a/iotsitewise/service/2019-12-02/iotsitewise-2019-12-02.json b/models/iotsitewise/service/2019-12-02/iotsitewise-2019-12-02.json similarity index 100% rename from iotsitewise/service/2019-12-02/iotsitewise-2019-12-02.json rename to models/iotsitewise/service/2019-12-02/iotsitewise-2019-12-02.json diff --git a/iotthingsgraph/service/2018-09-06/iotthingsgraph-2018-09-06.json b/models/iotthingsgraph/service/2018-09-06/iotthingsgraph-2018-09-06.json similarity index 100% rename from iotthingsgraph/service/2018-09-06/iotthingsgraph-2018-09-06.json rename to models/iotthingsgraph/service/2018-09-06/iotthingsgraph-2018-09-06.json diff --git a/iottwinmaker/service/2021-11-29/iottwinmaker-2021-11-29.json b/models/iottwinmaker/service/2021-11-29/iottwinmaker-2021-11-29.json similarity index 100% rename from iottwinmaker/service/2021-11-29/iottwinmaker-2021-11-29.json rename to models/iottwinmaker/service/2021-11-29/iottwinmaker-2021-11-29.json diff --git a/ivs-realtime/service/2020-07-14/ivs-realtime-2020-07-14.json b/models/ivs-realtime/service/2020-07-14/ivs-realtime-2020-07-14.json similarity index 100% rename from ivs-realtime/service/2020-07-14/ivs-realtime-2020-07-14.json rename to models/ivs-realtime/service/2020-07-14/ivs-realtime-2020-07-14.json diff --git a/ivs/service/2020-07-14/ivs-2020-07-14.json b/models/ivs/service/2020-07-14/ivs-2020-07-14.json similarity index 100% rename from ivs/service/2020-07-14/ivs-2020-07-14.json rename to models/ivs/service/2020-07-14/ivs-2020-07-14.json diff --git a/ivschat/service/2020-07-14/ivschat-2020-07-14.json b/models/ivschat/service/2020-07-14/ivschat-2020-07-14.json similarity index 100% rename from ivschat/service/2020-07-14/ivschat-2020-07-14.json rename to models/ivschat/service/2020-07-14/ivschat-2020-07-14.json diff --git a/kafka/service/2018-11-14/kafka-2018-11-14.json b/models/kafka/service/2018-11-14/kafka-2018-11-14.json similarity index 100% rename from kafka/service/2018-11-14/kafka-2018-11-14.json rename to models/kafka/service/2018-11-14/kafka-2018-11-14.json diff --git a/kafkaconnect/service/2021-09-14/kafkaconnect-2021-09-14.json b/models/kafkaconnect/service/2021-09-14/kafkaconnect-2021-09-14.json similarity index 100% rename from kafkaconnect/service/2021-09-14/kafkaconnect-2021-09-14.json rename to models/kafkaconnect/service/2021-09-14/kafkaconnect-2021-09-14.json diff --git a/kendra-ranking/service/2022-10-19/kendra-ranking-2022-10-19.json b/models/kendra-ranking/service/2022-10-19/kendra-ranking-2022-10-19.json similarity index 100% rename from kendra-ranking/service/2022-10-19/kendra-ranking-2022-10-19.json rename to models/kendra-ranking/service/2022-10-19/kendra-ranking-2022-10-19.json diff --git a/kendra/service/2019-02-03/kendra-2019-02-03.json b/models/kendra/service/2019-02-03/kendra-2019-02-03.json similarity index 100% rename from kendra/service/2019-02-03/kendra-2019-02-03.json rename to models/kendra/service/2019-02-03/kendra-2019-02-03.json diff --git a/keyspaces/service/2022-02-10/keyspaces-2022-02-10.json b/models/keyspaces/service/2022-02-10/keyspaces-2022-02-10.json similarity index 100% rename from keyspaces/service/2022-02-10/keyspaces-2022-02-10.json rename to models/keyspaces/service/2022-02-10/keyspaces-2022-02-10.json diff --git a/kinesis-analytics-v2/service/2018-05-23/kinesis-analytics-v2-2018-05-23.json b/models/kinesis-analytics-v2/service/2018-05-23/kinesis-analytics-v2-2018-05-23.json similarity index 100% rename from kinesis-analytics-v2/service/2018-05-23/kinesis-analytics-v2-2018-05-23.json rename to models/kinesis-analytics-v2/service/2018-05-23/kinesis-analytics-v2-2018-05-23.json diff --git a/kinesis-analytics/service/2015-08-14/kinesis-analytics-2015-08-14.json b/models/kinesis-analytics/service/2015-08-14/kinesis-analytics-2015-08-14.json similarity index 100% rename from kinesis-analytics/service/2015-08-14/kinesis-analytics-2015-08-14.json rename to models/kinesis-analytics/service/2015-08-14/kinesis-analytics-2015-08-14.json diff --git a/kinesis-video-archived-media/service/2017-09-30/kinesis-video-archived-media-2017-09-30.json b/models/kinesis-video-archived-media/service/2017-09-30/kinesis-video-archived-media-2017-09-30.json similarity index 100% rename from kinesis-video-archived-media/service/2017-09-30/kinesis-video-archived-media-2017-09-30.json rename to models/kinesis-video-archived-media/service/2017-09-30/kinesis-video-archived-media-2017-09-30.json diff --git a/kinesis-video-media/service/2017-09-30/kinesis-video-media-2017-09-30.json b/models/kinesis-video-media/service/2017-09-30/kinesis-video-media-2017-09-30.json similarity index 100% rename from kinesis-video-media/service/2017-09-30/kinesis-video-media-2017-09-30.json rename to models/kinesis-video-media/service/2017-09-30/kinesis-video-media-2017-09-30.json diff --git a/kinesis-video-signaling/service/2019-12-04/kinesis-video-signaling-2019-12-04.json b/models/kinesis-video-signaling/service/2019-12-04/kinesis-video-signaling-2019-12-04.json similarity index 100% rename from kinesis-video-signaling/service/2019-12-04/kinesis-video-signaling-2019-12-04.json rename to models/kinesis-video-signaling/service/2019-12-04/kinesis-video-signaling-2019-12-04.json diff --git a/kinesis-video-webrtc-storage/service/2018-05-10/kinesis-video-webrtc-storage-2018-05-10.json b/models/kinesis-video-webrtc-storage/service/2018-05-10/kinesis-video-webrtc-storage-2018-05-10.json similarity index 100% rename from kinesis-video-webrtc-storage/service/2018-05-10/kinesis-video-webrtc-storage-2018-05-10.json rename to models/kinesis-video-webrtc-storage/service/2018-05-10/kinesis-video-webrtc-storage-2018-05-10.json diff --git a/kinesis-video/service/2017-09-30/kinesis-video-2017-09-30.json b/models/kinesis-video/service/2017-09-30/kinesis-video-2017-09-30.json similarity index 100% rename from kinesis-video/service/2017-09-30/kinesis-video-2017-09-30.json rename to models/kinesis-video/service/2017-09-30/kinesis-video-2017-09-30.json diff --git a/kinesis/service/2013-12-02/kinesis-2013-12-02.json b/models/kinesis/service/2013-12-02/kinesis-2013-12-02.json similarity index 97% rename from kinesis/service/2013-12-02/kinesis-2013-12-02.json rename to models/kinesis/service/2013-12-02/kinesis-2013-12-02.json index 138ef9bf..dd262626 100644 --- a/kinesis/service/2013-12-02/kinesis-2013-12-02.json +++ b/models/kinesis/service/2013-12-02/kinesis-2013-12-02.json @@ -87,7 +87,7 @@ "Tags": { "target": "com.amazonaws.kinesis#TagMap", "traits": { - "smithy.api#documentation": "A set of up to 10 key-value pairs to use to create the tags.
", + "smithy.api#documentation": "A set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value. You can add up to 50 tags per resource.
", "smithy.api#required": {} } }, @@ -300,7 +300,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Kinesis data stream. A stream captures and transports data records that are\n continuously emitted from different data sources or producers.\n Scale-out within a stream is explicitly supported by means of shards, which are uniquely\n identified groups of data records in a stream.
\nYou can create your data stream using either on-demand or provisioned capacity mode.\n Data streams with an on-demand mode require no capacity planning and automatically scale\n to handle gigabytes of write and read throughput per minute. With the on-demand mode,\n Kinesis Data Streams automatically manages the shards in order to provide the necessary\n throughput. For the data streams with a provisioned mode, you must specify the number of\n shards for the data stream. Each shard can support reads up to five transactions per\n second, up to a maximum data read total of 2 MiB per second. Each shard can support\n writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per\n second. If the amount of data input increases or decreases, you can add or remove\n shards.
\nThe stream name identifies the stream. The name is scoped to the Amazon Web Services\n account used by the application. It is also scoped by Amazon Web Services Region. That\n is, two streams in two different accounts can have the same name, and two streams in the\n same account, but in two different Regions, can have the same name.
\n\n CreateStream is an asynchronous operation. Upon receiving a\n CreateStream request, Kinesis Data Streams immediately returns and sets\n the stream status to CREATING. After the stream is created, Kinesis Data\n Streams sets the stream status to ACTIVE. You should perform read and write\n operations only on an ACTIVE stream.
You receive a LimitExceededException when making a\n CreateStream request when you try to do one of the following:
Have more than five streams in the CREATING state at any point in\n time.
Create more shards than are authorized for your account.
\nFor the default shard limit for an Amazon Web Services account, see Amazon\n Kinesis Data Streams Limits in the Amazon Kinesis Data Streams\n Developer Guide. To increase this limit, contact Amazon Web Services\n Support.
\nYou can use DescribeStreamSummary to check the stream status, which\n is returned in StreamStatus.
\n CreateStream has a limit of five transactions per second per\n account.
\nYou can add tags to the stream when making a CreateStream request by\n setting the Tags parameter. If you pass Tags parameter, in\n addition to having kinesis:createStream permission, you must also have\n kinesis:addTagsToStream permission for the stream that will be created.\n Tags will take effect from the CREATING status of the stream.
Creates a Kinesis data stream. A stream captures and transports data records that are\n continuously emitted from different data sources or producers.\n Scale-out within a stream is explicitly supported by means of shards, which are uniquely\n identified groups of data records in a stream.
\nYou can create your data stream using either on-demand or provisioned capacity mode.\n Data streams with an on-demand mode require no capacity planning and automatically scale\n to handle gigabytes of write and read throughput per minute. With the on-demand mode,\n Kinesis Data Streams automatically manages the shards in order to provide the necessary\n throughput. For the data streams with a provisioned mode, you must specify the number of\n shards for the data stream. Each shard can support reads up to five transactions per\n second, up to a maximum data read total of 2 MiB per second. Each shard can support\n writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per\n second. If the amount of data input increases or decreases, you can add or remove\n shards.
\nThe stream name identifies the stream. The name is scoped to the Amazon Web Services\n account used by the application. It is also scoped by Amazon Web Services Region. That\n is, two streams in two different accounts can have the same name, and two streams in the\n same account, but in two different Regions, can have the same name.
\n\n CreateStream is an asynchronous operation. Upon receiving a\n CreateStream request, Kinesis Data Streams immediately returns and sets\n the stream status to CREATING. After the stream is created, Kinesis Data\n Streams sets the stream status to ACTIVE. You should perform read and write\n operations only on an ACTIVE stream.
You receive a LimitExceededException when making a\n CreateStream request when you try to do one of the following:
Have more than five streams in the CREATING state at any point in\n time.
Create more shards than are authorized for your account.
\nFor the default shard limit for an Amazon Web Services account, see Amazon\n Kinesis Data Streams Limits in the Amazon Kinesis Data Streams\n Developer Guide. To increase this limit, contact Amazon Web Services\n Support.
\nYou can use DescribeStreamSummary to check the stream status, which\n is returned in StreamStatus.
\n CreateStream has a limit of five transactions per second per\n account.
\nYou can add tags to the stream when making a CreateStream request by setting the Tags parameter. If you pass the Tags parameter, in addition to having the kinesis:CreateStream permission, you must also have the kinesis:AddTagsToStream permission for the stream that will be created. The kinesis:TagResource permission won\u2019t work to tag streams on creation. Tags will take effect from the CREATING status of the stream, but you can't make any updates to the tags until the stream is in ACTIVE state.
A set of up to 10 key-value pairs to use to create the tags.
" + "smithy.api#documentation": "A set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value.
" } } }, @@ -1173,6 +1173,9 @@ { "target": "com.amazonaws.kinesis#ExpiredIteratorException" }, + { + "target": "com.amazonaws.kinesis#InternalFailureException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -1363,6 +1366,9 @@ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, + { + "target": "com.amazonaws.kinesis#InternalFailureException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -1727,6 +1733,9 @@ { "target": "com.amazonaws.kinesis#ListStreams" }, + { + "target": "com.amazonaws.kinesis#ListTagsForResource" + }, { "target": "com.amazonaws.kinesis#ListTagsForStream" }, @@ -1760,6 +1769,12 @@ { "target": "com.amazonaws.kinesis#SubscribeToShard" }, + { + "target": "com.amazonaws.kinesis#TagResource" + }, + { + "target": "com.amazonaws.kinesis#UntagResource" + }, { "target": "com.amazonaws.kinesis#UpdateShardCount" }, @@ -6180,6 +6195,72 @@ "smithy.api#output": {} } }, + "com.amazonaws.kinesis#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesis#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.kinesis#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesis#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesis#LimitExceededException" + }, + { + "target": "com.amazonaws.kinesis#ResourceInUseException" + }, + { + "target": "com.amazonaws.kinesis#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "List all tags added to the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
\nFor more information about tagging Kinesis resources, see Tag your Amazon Kinesis Data Streams resources.
", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } + } + }, + "com.amazonaws.kinesis#ListTagsForResourceInput": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.kinesis#ResourceARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Kinesis resource for which to list tags.
", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceARN" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.kinesis#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.kinesis#TagList", + "traits": { + "smithy.api#documentation": "An array of tags associated with the specified Kinesis resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.kinesis#ListTagsForStream": { "type": "operation", "input": { @@ -6501,6 +6582,9 @@ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, + { + "target": "com.amazonaws.kinesis#InternalFailureException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -6629,6 +6713,9 @@ { "target": "com.amazonaws.kinesis#AccessDeniedException" }, + { + "target": "com.amazonaws.kinesis#InternalFailureException" + }, { "target": "com.amazonaws.kinesis#InvalidArgumentException" }, @@ -6938,7 +7025,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers a consumer with a Kinesis data stream. When you use this operation, the\n consumer you register can then call SubscribeToShard to receive data\n from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every\n shard you subscribe to. This rate is unaffected by the total number of consumers that\n read from the same stream.
\nYou can register up to 20 consumers per stream. A given consumer can only be\n registered with one stream at a time.
\nFor an example of how to use this operation, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.
\nThe use of this operation has a limit of five transactions per second per account.\n Also, only 5 consumers can be created simultaneously. In other words, you cannot have\n more than 5 consumers in a CREATING status at the same time. Registering a\n 6th consumer while there are 5 in a CREATING status results in a\n LimitExceededException.
Registers a consumer with a Kinesis data stream. When you use this operation, the\n consumer you register can then call SubscribeToShard to receive data\n from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every\n shard you subscribe to. This rate is unaffected by the total number of consumers that\n read from the same stream.
\nYou can add tags to the registered consumer when making a RegisterStreamConsumer request by setting the Tags parameter. If you pass the Tags parameter, in addition to having the kinesis:RegisterStreamConsumer permission, you must also have the kinesis:TagResource permission for the consumer that will be registered. Tags will take effect from the CREATING status of the consumer.
You can register up to 20 consumers per stream. A given consumer can only be\n registered with one stream at a time.
\nFor an example of how to use this operation, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.
\nThe use of this operation has a limit of five transactions per second per account.\n Also, only 5 consumers can be created simultaneously. In other words, you cannot have\n more than 5 consumers in a CREATING status at the same time. Registering a\n 6th consumer while there are 5 in a CREATING status results in a\n LimitExceededException.
For a given Kinesis data stream, each consumer must have a unique name. However,\n consumer names don't have to be unique across data streams.
", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.kinesis#TagMap", + "traits": { + "smithy.api#documentation": "A set of up to 50 key-value pairs. A tag consists of a required key and an optional value.
" + } } }, "traits": { @@ -8051,7 +8144,7 @@ } }, "traits": { - "smithy.api#documentation": "Metadata assigned to the stream, consisting of a key-value pair.
" + "smithy.api#documentation": "Metadata assigned to the stream or consumer, consisting of a key-value pair.
" } }, "com.amazonaws.kinesis#TagKey": { @@ -8102,6 +8195,65 @@ } } }, + "com.amazonaws.kinesis#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesis#TagResourceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesis#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesis#LimitExceededException" + }, + { + "target": "com.amazonaws.kinesis#ResourceInUseException" + }, + { + "target": "com.amazonaws.kinesis#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Adds or updates tags for the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources. You can assign up to 50 tags to a Kinesis resource.
", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } + } + }, + "com.amazonaws.kinesis#TagResourceInput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.kinesis#TagMap", + "traits": { + "smithy.api#documentation": "An array of tags to be added to the Kinesis resource. A tag consists of a required key and an optional value. You can add up to 50 tags per resource.
\nTags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
", + "smithy.api#required": {} + } + }, + "ResourceARN": { + "target": "com.amazonaws.kinesis#ResourceARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Kinesis resource to which to add tags.
", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceARN" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.kinesis#TagValue": { "type": "string", "traits": { @@ -8114,6 +8266,65 @@ "com.amazonaws.kinesis#Timestamp": { "type": "timestamp" }, + "com.amazonaws.kinesis#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesis#UntagResourceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.kinesis#AccessDeniedException" + }, + { + "target": "com.amazonaws.kinesis#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesis#LimitExceededException" + }, + { + "target": "com.amazonaws.kinesis#ResourceInUseException" + }, + { + "target": "com.amazonaws.kinesis#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Removes tags from the specified Kinesis resource. Removed tags are deleted and can't be recovered after this operation completes successfully.
", + "smithy.rules#staticContextParams": { + "OperationType": { + "value": "control" + } + } + } + }, + "com.amazonaws.kinesis#UntagResourceInput": { + "type": "structure", + "members": { + "TagKeys": { + "target": "com.amazonaws.kinesis#TagKeyList", + "traits": { + "smithy.api#documentation": "A list of tag key-value pairs. Existing tags of the resource whose keys are members of this list will be removed from the Kinesis resource.
", + "smithy.api#required": {} + } + }, + "ResourceARN": { + "target": "com.amazonaws.kinesis#ResourceARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Kinesis resource from which to remove tags.
", + "smithy.api#required": {}, + "smithy.rules#contextParam": { + "name": "ResourceARN" + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.kinesis#UpdateShardCount": { "type": "operation", "input": { diff --git a/kms/service/2014-11-01/kms-2014-11-01.json b/models/kms/service/2014-11-01/kms-2014-11-01.json similarity index 100% rename from kms/service/2014-11-01/kms-2014-11-01.json rename to models/kms/service/2014-11-01/kms-2014-11-01.json diff --git a/lakeformation/service/2017-03-31/lakeformation-2017-03-31.json b/models/lakeformation/service/2017-03-31/lakeformation-2017-03-31.json similarity index 100% rename from lakeformation/service/2017-03-31/lakeformation-2017-03-31.json rename to models/lakeformation/service/2017-03-31/lakeformation-2017-03-31.json diff --git a/lambda/service/2015-03-31/lambda-2015-03-31.json b/models/lambda/service/2015-03-31/lambda-2015-03-31.json similarity index 100% rename from lambda/service/2015-03-31/lambda-2015-03-31.json rename to models/lambda/service/2015-03-31/lambda-2015-03-31.json diff --git a/launch-wizard/service/2018-05-10/launch-wizard-2018-05-10.json b/models/launch-wizard/service/2018-05-10/launch-wizard-2018-05-10.json similarity index 100% rename from launch-wizard/service/2018-05-10/launch-wizard-2018-05-10.json rename to models/launch-wizard/service/2018-05-10/launch-wizard-2018-05-10.json diff --git a/lex-model-building-service/service/2017-04-19/lex-model-building-service-2017-04-19.json b/models/lex-model-building-service/service/2017-04-19/lex-model-building-service-2017-04-19.json similarity index 100% rename from lex-model-building-service/service/2017-04-19/lex-model-building-service-2017-04-19.json rename to models/lex-model-building-service/service/2017-04-19/lex-model-building-service-2017-04-19.json diff --git a/lex-models-v2/service/2020-08-07/lex-models-v2-2020-08-07.json b/models/lex-models-v2/service/2020-08-07/lex-models-v2-2020-08-07.json similarity index 100% rename from lex-models-v2/service/2020-08-07/lex-models-v2-2020-08-07.json rename to models/lex-models-v2/service/2020-08-07/lex-models-v2-2020-08-07.json diff --git a/lex-runtime-service/service/2016-11-28/lex-runtime-service-2016-11-28.json b/models/lex-runtime-service/service/2016-11-28/lex-runtime-service-2016-11-28.json similarity index 100% rename from lex-runtime-service/service/2016-11-28/lex-runtime-service-2016-11-28.json rename to models/lex-runtime-service/service/2016-11-28/lex-runtime-service-2016-11-28.json diff --git a/lex-runtime-v2/service/2020-08-07/lex-runtime-v2-2020-08-07.json b/models/lex-runtime-v2/service/2020-08-07/lex-runtime-v2-2020-08-07.json similarity index 100% rename from lex-runtime-v2/service/2020-08-07/lex-runtime-v2-2020-08-07.json rename to models/lex-runtime-v2/service/2020-08-07/lex-runtime-v2-2020-08-07.json diff --git a/license-manager-linux-subscriptions/service/2018-05-10/license-manager-linux-subscriptions-2018-05-10.json b/models/license-manager-linux-subscriptions/service/2018-05-10/license-manager-linux-subscriptions-2018-05-10.json similarity index 100% rename from license-manager-linux-subscriptions/service/2018-05-10/license-manager-linux-subscriptions-2018-05-10.json rename to models/license-manager-linux-subscriptions/service/2018-05-10/license-manager-linux-subscriptions-2018-05-10.json diff --git a/license-manager-user-subscriptions/service/2018-05-10/license-manager-user-subscriptions-2018-05-10.json b/models/license-manager-user-subscriptions/service/2018-05-10/license-manager-user-subscriptions-2018-05-10.json similarity index 100% rename from license-manager-user-subscriptions/service/2018-05-10/license-manager-user-subscriptions-2018-05-10.json rename to models/license-manager-user-subscriptions/service/2018-05-10/license-manager-user-subscriptions-2018-05-10.json diff --git a/license-manager/service/2018-08-01/license-manager-2018-08-01.json b/models/license-manager/service/2018-08-01/license-manager-2018-08-01.json similarity index 100% rename from license-manager/service/2018-08-01/license-manager-2018-08-01.json rename to models/license-manager/service/2018-08-01/license-manager-2018-08-01.json diff --git a/lightsail/service/2016-11-28/lightsail-2016-11-28.json b/models/lightsail/service/2016-11-28/lightsail-2016-11-28.json similarity index 100% rename from lightsail/service/2016-11-28/lightsail-2016-11-28.json rename to models/lightsail/service/2016-11-28/lightsail-2016-11-28.json diff --git a/location/service/2020-11-19/location-2020-11-19.json b/models/location/service/2020-11-19/location-2020-11-19.json similarity index 100% rename from location/service/2020-11-19/location-2020-11-19.json rename to models/location/service/2020-11-19/location-2020-11-19.json diff --git a/lookoutequipment/service/2020-12-15/lookoutequipment-2020-12-15.json b/models/lookoutequipment/service/2020-12-15/lookoutequipment-2020-12-15.json similarity index 100% rename from lookoutequipment/service/2020-12-15/lookoutequipment-2020-12-15.json rename to models/lookoutequipment/service/2020-12-15/lookoutequipment-2020-12-15.json diff --git a/lookoutmetrics/service/2017-07-25/lookoutmetrics-2017-07-25.json b/models/lookoutmetrics/service/2017-07-25/lookoutmetrics-2017-07-25.json similarity index 100% rename from lookoutmetrics/service/2017-07-25/lookoutmetrics-2017-07-25.json rename to models/lookoutmetrics/service/2017-07-25/lookoutmetrics-2017-07-25.json diff --git a/lookoutvision/service/2020-11-20/lookoutvision-2020-11-20.json b/models/lookoutvision/service/2020-11-20/lookoutvision-2020-11-20.json similarity index 100% rename from lookoutvision/service/2020-11-20/lookoutvision-2020-11-20.json rename to models/lookoutvision/service/2020-11-20/lookoutvision-2020-11-20.json diff --git a/m2/service/2021-04-28/m2-2021-04-28.json b/models/m2/service/2021-04-28/m2-2021-04-28.json similarity index 100% rename from m2/service/2021-04-28/m2-2021-04-28.json rename to models/m2/service/2021-04-28/m2-2021-04-28.json diff --git a/machine-learning/service/2014-12-12/machine-learning-2014-12-12.json b/models/machine-learning/service/2014-12-12/machine-learning-2014-12-12.json similarity index 100% rename from machine-learning/service/2014-12-12/machine-learning-2014-12-12.json rename to models/machine-learning/service/2014-12-12/machine-learning-2014-12-12.json diff --git a/macie2/service/2020-01-01/macie2-2020-01-01.json b/models/macie2/service/2020-01-01/macie2-2020-01-01.json similarity index 100% rename from macie2/service/2020-01-01/macie2-2020-01-01.json rename to models/macie2/service/2020-01-01/macie2-2020-01-01.json diff --git a/mailmanager/service/2023-10-17/mailmanager-2023-10-17.json b/models/mailmanager/service/2023-10-17/mailmanager-2023-10-17.json similarity index 94% rename from mailmanager/service/2023-10-17/mailmanager-2023-10-17.json rename to models/mailmanager/service/2023-10-17/mailmanager-2023-10-17.json index f4a7f606..cf4ab955 100644 --- a/mailmanager/service/2023-10-17/mailmanager-2023-10-17.json +++ b/models/mailmanager/service/2023-10-17/mailmanager-2023-10-17.json @@ -54,7 +54,7 @@ "HeaderName": { "target": "com.amazonaws.mailmanager#HeaderName", "traits": { - "smithy.api#documentation": "The name of the header to add to an email. The header must be prefixed with\n \"X-\". Headers are added regardless of whether the header name pre-existed in\n the email.
", + "smithy.api#documentation": "The name of the header to add to an email. The header must be prefixed with \"X-\". Headers are added regardless of whether the header name pre-existed in the email.
", "smithy.api#required": {} } }, @@ -67,7 +67,7 @@ } }, "traits": { - "smithy.api#documentation": "The action to add a header to a message. When executed, this action will add the given\n header to the message.
" + "smithy.api#documentation": "The action to add a header to a message. When executed, this action will add the given header to the message.
" } }, "com.amazonaws.mailmanager#AddonInstance": { @@ -204,7 +204,7 @@ } }, "traits": { - "smithy.api#documentation": "A subscription for an Add On representing the acceptance of its terms of use and\n additional pricing.
" + "smithy.api#documentation": "A subscription for an Add On representing the acceptance of its terms of use and additional pricing.
" } }, "com.amazonaws.mailmanager#AddonSubscriptionArn": { @@ -445,7 +445,7 @@ } }, "traits": { - "smithy.api#documentation": "The result of an analysis can be used in conditions to trigger actions. Analyses can\n inspect the email content and report a certain aspect of the email.
" + "smithy.api#documentation": "The result of an analysis can be used in conditions to trigger actions. Analyses can inspect the email content and report a certain aspect of the email.
" } }, "com.amazonaws.mailmanager#AnalyzerArn": { @@ -474,7 +474,7 @@ "ArchiveState": { "target": "com.amazonaws.mailmanager#ArchiveState", "traits": { - "smithy.api#documentation": "The current state of the archive:
\n\n ACTIVE \u2013 The archive is ready and available for use.
\n PENDING_DELETION \u2013 The archive has been marked for deletion\n and will be permanently deleted in 30 days. No further modifications can be made\n in this state.
The current state of the archive:
ACTIVE \u2013 The archive is ready and available for use.
PENDING_DELETION \u2013 The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.
A policy that states what to do in the case of failure. The action will fail if there\n are configuration errors. For example, the specified archive has been deleted.
" + "smithy.api#documentation": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified archive has been deleted.
" } }, "TargetArchive": { @@ -725,7 +725,7 @@ } }, "traits": { - "smithy.api#documentation": "The retention policy for an email archive that specifies how long emails are kept\n before being automatically deleted.
" + "smithy.api#documentation": "The retention policy for an email archive that specifies how long emails are kept before being automatically deleted.
" } }, "com.amazonaws.mailmanager#ArchiveState": { @@ -885,7 +885,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Add On instance for the subscription indicated in the request. The\n resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.\n
", + "smithy.api#documentation": "Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.
", "smithy.api#idempotent": {} } }, @@ -895,14 +895,14 @@ "ClientToken": { "target": "com.amazonaws.mailmanager#IdempotencyToken", "traits": { - "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same\n request.
", + "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", "smithy.api#idempotencyToken": {} } }, "AddonSubscriptionId": { "target": "com.amazonaws.mailmanager#AddonSubscriptionId", "traits": { - "smithy.api#documentation": "The unique ID of a previously created subscription that an Add On instance is created\n for. You can only have one instance per subscription.
", + "smithy.api#documentation": "The unique ID of a previously created subscription that an Add On instance is created for. You can only have one instance per subscription.
", "smithy.api#required": {} } }, @@ -952,7 +952,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a subscription for an Add On representing the acceptance of its terms of use\n and additional pricing. The subscription can then be used to create an instance for use\n in rule sets or traffic policies.
", + "smithy.api#documentation": "Creates a subscription for an Add On representing the acceptance of its terms of use and additional pricing. The subscription can then be used to create an instance for use in rule sets or traffic policies.
", "smithy.api#idempotent": {} } }, @@ -962,14 +962,14 @@ "ClientToken": { "target": "com.amazonaws.mailmanager#IdempotencyToken", "traits": { - "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same\n request.
", + "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", "smithy.api#idempotencyToken": {} } }, "AddonName": { "target": "com.amazonaws.mailmanager#AddonName", "traits": { - "smithy.api#documentation": "The name of the Add On to subscribe to. You can only have one subscription for each\n Add On name.
", + "smithy.api#documentation": "The name of the Add On to subscribe to. You can only have one subscription for each Add On name.
", "smithy.api#required": {} } }, @@ -1062,7 +1062,7 @@ "ClientToken": { "target": "com.amazonaws.mailmanager#IdempotencyToken", "traits": { - "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same\n request.
", + "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", "smithy.api#idempotencyToken": {} } }, @@ -1120,7 +1120,7 @@ "ClientToken": { "target": "com.amazonaws.mailmanager#IdempotencyToken", "traits": { - "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same\n request.
", + "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", "smithy.api#idempotencyToken": {} } }, @@ -1336,7 +1336,7 @@ "ClientToken": { "target": "com.amazonaws.mailmanager#IdempotencyToken", "traits": { - "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same\n request.
", + "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", "smithy.api#idempotencyToken": {} } }, @@ -1357,27 +1357,27 @@ "RuleSetId": { "target": "com.amazonaws.mailmanager#RuleSetId", "traits": { - "smithy.api#documentation": "The identifier of an existing rule set that you attach to an ingress endpoint\n resource.
", + "smithy.api#documentation": "The identifier of an existing rule set that you attach to an ingress endpoint resource.
", "smithy.api#required": {} } }, "TrafficPolicyId": { "target": "com.amazonaws.mailmanager#TrafficPolicyId", "traits": { - "smithy.api#documentation": "The identifier of an existing traffic policy that you attach to an ingress endpoint\n resource.
", + "smithy.api#documentation": "The identifier of an existing traffic policy that you attach to an ingress endpoint resource.
", "smithy.api#required": {} } }, "IngressPointConfiguration": { "target": "com.amazonaws.mailmanager#IngressPointConfiguration", "traits": { - "smithy.api#documentation": "If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret\n ARN.
" + "smithy.api#documentation": "If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
" } }, "NetworkConfiguration": { "target": "com.amazonaws.mailmanager#NetworkConfiguration", "traits": { - "smithy.api#documentation": "Specifies the network configuration for the ingress point.\n This allows you to create an IPv4-only, Dual-Stack, or PrivateLink type of ingress point. If not specified, the default network type is IPv4-only.\n
" + "smithy.api#documentation": "Specifies the network configuration for the ingress point. This allows you to create an IPv4-only, Dual-Stack, or PrivateLink type of ingress point. If not specified, the default network type is IPv4-only.
" } }, "Tags": { @@ -1426,7 +1426,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a relay resource which can be used in rules to relay incoming emails to\n defined relay destinations.
", + "smithy.api#documentation": "Creates a relay resource which can be used in rules to relay incoming emails to defined relay destinations.
", "smithy.api#idempotent": {} } }, @@ -1436,7 +1436,7 @@ "ClientToken": { "target": "com.amazonaws.mailmanager#IdempotencyToken", "traits": { - "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same\n request.
", + "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", "smithy.api#idempotencyToken": {} } }, @@ -1464,7 +1464,7 @@ "Authentication": { "target": "com.amazonaws.mailmanager#RelayAuthentication", "traits": { - "smithy.api#documentation": "Authentication for the relay destination server\u2014specify the secretARN where\n the SMTP credentials are stored.
", + "smithy.api#documentation": "Authentication for the relay destination server\u2014specify the secretARN where the SMTP credentials are stored.
", "smithy.api#required": {} } }, @@ -1524,7 +1524,7 @@ "ClientToken": { "target": "com.amazonaws.mailmanager#IdempotencyToken", "traits": { - "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same\n request.
", + "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", "smithy.api#idempotencyToken": {} } }, @@ -1628,7 +1628,7 @@ "ClientToken": { "target": "com.amazonaws.mailmanager#IdempotencyToken", "traits": { - "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same\n request.
", + "smithy.api#documentation": "A unique token that Amazon SES uses to recognize subsequent retries of the same request.
", "smithy.api#idempotencyToken": {} } }, @@ -1656,7 +1656,7 @@ "MaxMessageSizeBytes": { "target": "com.amazonaws.mailmanager#MaxMessageSizeBytes", "traits": { - "smithy.api#documentation": "The maximum message size in bytes of email which is allowed in by this traffic\n policy\u2014anything larger will be blocked.
" + "smithy.api#documentation": "The maximum message size in bytes of email which is allowed in by this traffic policy\u2014anything larger will be blocked.
" } }, "Tags": { @@ -1840,7 +1840,7 @@ } ], "traits": { - "smithy.api#documentation": "Initiates deletion of an email archive. This changes the archive state to pending\n deletion. In this state, no new emails can be added, and existing archived emails become\n inaccessible (search, export, download). The archive and all of its contents will be\n permanently deleted 30 days after entering the pending deletion state, regardless of the\n configured retention period.
", + "smithy.api#documentation": "Initiates deletion of an email archive. This changes the archive state to pending deletion. In this state, no new emails can be added, and existing archived emails become inaccessible (search, export, download). The archive and all of its contents will be permanently deleted 30 days after entering the pending deletion state, regardless of the configured retention period.
", "smithy.api#idempotent": {} } }, @@ -1864,7 +1864,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "The response indicating if the archive deletion was successfully initiated.
\nOn success, returns an HTTP 200 status code. On failure, returns an error\n message.
", + "smithy.api#documentation": "The response indicating if the archive deletion was successfully initiated.
On success, returns an HTTP 200 status code. On failure, returns an error message.
", "smithy.api#output": {} } }, @@ -2073,7 +2073,7 @@ "ActionFailurePolicy": { "target": "com.amazonaws.mailmanager#ActionFailurePolicy", "traits": { - "smithy.api#documentation": "A policy that states what to do in the case of failure. The action will fail if there\n are configuration errors. For example, the mailbox ARN is no longer valid.
" + "smithy.api#documentation": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the mailbox ARN is no longer valid.
" } }, "MailboxArn": { @@ -2086,7 +2086,7 @@ "RoleArn": { "target": "com.amazonaws.mailmanager#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role to use to execute this action. The role must have access to\n the workmail:DeliverToMailbox API.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role to use to execute this action. The role must have access to the workmail:DeliverToMailbox API.
", "smithy.api#required": {} } } @@ -2101,27 +2101,27 @@ "ActionFailurePolicy": { "target": "com.amazonaws.mailmanager#ActionFailurePolicy", "traits": { - "smithy.api#documentation": "A policy that states what to do in the case of failure. The action will fail if there are\n configuration errors. For example, the specified application has been deleted or the role lacks\n necessary permissions to call the qbusiness:BatchPutDocument API.
" + "smithy.api#documentation": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the qbusiness:BatchPutDocument API.
The unique identifier of the Amazon Q Business application instance where the email\n content will be delivered.
", + "smithy.api#documentation": "The unique identifier of the Amazon Q Business application instance where the email content will be delivered.
", "smithy.api#required": {} } }, "IndexId": { "target": "com.amazonaws.mailmanager#QBusinessIndexId", "traits": { - "smithy.api#documentation": "The identifier of the knowledge base index within the Amazon Q Business application\n where the email content will be stored and indexed.
", + "smithy.api#documentation": "The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.
", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.mailmanager#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access\n to the qbusiness:BatchPutDocument API for the given application and index.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business. This role must have access to the qbusiness:BatchPutDocument API for the given application and index.
This action causes processing to stop and the email to be dropped. If the action\n applies only to certain recipients, only those recipients are dropped, and processing\n continues for other recipients.
" + "smithy.api#documentation": "This action causes processing to stop and the email to be dropped. If the action applies only to certain recipients, only those recipients are dropped, and processing continues for other recipients.
" } }, "com.amazonaws.mailmanager#EmailAddress": { @@ -2845,7 +2845,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a pre-signed URL that provides temporary download access to the specific email message stored in\n the archive.\n
", + "smithy.api#documentation": "Returns a pre-signed URL that provides temporary download access to the specific email message stored in the archive.
", "smithy.api#readonly": {} } }, @@ -2869,7 +2869,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the textual content of a specific email message stored in the archive. Attachments are not\n included.\n
" + "smithy.api#documentation": "Returns the textual content of a specific email message stored in the archive. Attachments are not included.
" } }, "com.amazonaws.mailmanager#GetArchiveMessageContentRequest": { @@ -2989,7 +2989,7 @@ "ArchiveState": { "target": "com.amazonaws.mailmanager#ArchiveState", "traits": { - "smithy.api#documentation": "The current state of the archive:
\n\n ACTIVE \u2013 The archive is ready and available for use.
\n PENDING_DELETION \u2013 The archive has been marked for deletion\n and will be permanently deleted in 30 days. No further modifications can be made\n in this state.
The current state of the archive:
ACTIVE \u2013 The archive is ready and available for use.
PENDING_DELETION \u2013 The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.
\n The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.\n
" + "smithy.api#documentation": "The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.
" } }, "RuleSetId": { @@ -3286,7 +3286,7 @@ "TrafficPolicyId": { "target": "com.amazonaws.mailmanager#TrafficPolicyId", "traits": { - "smithy.api#documentation": "The identifier of the traffic policy resource associated with the ingress\n endpoint.
" + "smithy.api#documentation": "The identifier of the traffic policy resource associated with the ingress endpoint.
" } }, "IngressPointAuthConfiguration": { @@ -3462,7 +3462,7 @@ "Authentication": { "target": "com.amazonaws.mailmanager#RelayAuthentication", "traits": { - "smithy.api#documentation": "The authentication attribute\u2014contains the secret ARN where the customer relay\n server credentials are stored.
" + "smithy.api#documentation": "The authentication attribute\u2014contains the secret ARN where the customer relay server credentials are stored.
" } }, "CreatedTimestamp": { @@ -3670,7 +3670,7 @@ "MaxMessageSizeBytes": { "target": "com.amazonaws.mailmanager#MaxMessageSizeBytes", "traits": { - "smithy.api#documentation": "The maximum message size in bytes of email which is allowed in by this traffic\n policy\u2014anything larger will be blocked.
" + "smithy.api#documentation": "The maximum message size in bytes of email which is allowed in by this traffic policy\u2014anything larger will be blocked.
" } }, "DefaultAction": { @@ -3759,7 +3759,7 @@ } }, "traits": { - "smithy.api#documentation": "The import data format contains the specifications of the input file that would be passed to the address list\n import job.
" + "smithy.api#documentation": "The import data format contains the specifications of the input file that would be passed to the address list import job.
" } }, "com.amazonaws.mailmanager#ImportDataType": { @@ -3950,7 +3950,7 @@ } }, "traits": { - "smithy.api#documentation": "The Add On ARN and its returned value that is evaluated in a policy statement's\n conditional expression to either deny or block the incoming email.
" + "smithy.api#documentation": "The Add On ARN and its returned value that is evaluated in a policy statement's conditional expression to either deny or block the incoming email.
" } }, "com.amazonaws.mailmanager#IngressBooleanExpression": { @@ -3998,7 +3998,7 @@ "Analysis": { "target": "com.amazonaws.mailmanager#IngressAnalysis", "traits": { - "smithy.api#documentation": "The structure type for a boolean condition stating the Add On ARN and its returned\n value.
" + "smithy.api#documentation": "The structure type for a boolean condition stating the Add On ARN and its returned value.
" } }, "IsInAddressList": { @@ -4009,7 +4009,7 @@ } }, "traits": { - "smithy.api#documentation": "The union type representing the allowed types of operands for a boolean\n condition.
" + "smithy.api#documentation": "The union type representing the allowed types of operands for a boolean condition.
" } }, "com.amazonaws.mailmanager#IngressIpOperator": { @@ -4080,7 +4080,7 @@ } }, "traits": { - "smithy.api#documentation": "The union type representing the allowed types for the left hand side of an IP\n condition.
" + "smithy.api#documentation": "The union type representing the allowed types for the left hand side of an IP condition.
" } }, "com.amazonaws.mailmanager#IngressIpv6Attribute": { @@ -4156,7 +4156,7 @@ } }, "traits": { - "smithy.api#documentation": "The address lists and the address list attribute value that is evaluated in a policy statement's\n conditional expression to either deny or block the incoming email.
" + "smithy.api#documentation": "The address lists and the address list attribute value that is evaluated in a policy statement's conditional expression to either deny or block the incoming email.
" } }, "com.amazonaws.mailmanager#IngressPoint": { @@ -4193,7 +4193,7 @@ "ARecord": { "target": "com.amazonaws.mailmanager#IngressPointARecord", "traits": { - "smithy.api#documentation": "\n The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.\n
" + "smithy.api#documentation": "The DNS A Record that identifies your ingress endpoint. Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.
" } } }, @@ -4222,7 +4222,7 @@ "SecretArn": { "target": "com.amazonaws.mailmanager#SecretArn", "traits": { - "smithy.api#documentation": "The ingress endpoint SecretsManager::Secret ARN configuration for the ingress endpoint\n resource.
" + "smithy.api#documentation": "The ingress endpoint SecretsManager::Secret ARN configuration for the ingress endpoint resource.
" } } }, @@ -4496,7 +4496,7 @@ } }, "traits": { - "smithy.api#documentation": "The union type representing the allowed types for the left hand side of a string\n condition.
" + "smithy.api#documentation": "The union type representing the allowed types for the left hand side of a string condition.
" } }, "com.amazonaws.mailmanager#IngressTlsAttribute": { @@ -4584,7 +4584,7 @@ } }, "traits": { - "smithy.api#documentation": "The union type representing the allowed types for the left hand side of a TLS\n condition.
" + "smithy.api#documentation": "The union type representing the allowed types for the left hand side of a TLS condition.
" } }, "com.amazonaws.mailmanager#IpType": { @@ -4706,7 +4706,7 @@ "PageSize": { "target": "com.amazonaws.mailmanager#PageSize", "traits": { - "smithy.api#documentation": "The maximum number of ingress endpoint resources that are returned per call. You can\n use NextToken to obtain further ingress endpoints.
" + "smithy.api#documentation": "The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.
" } } }, @@ -4770,7 +4770,7 @@ "PageSize": { "target": "com.amazonaws.mailmanager#PageSize", "traits": { - "smithy.api#documentation": "The maximum number of ingress endpoint resources that are returned per call. You can\n use NextToken to obtain further ingress endpoints.
" + "smithy.api#documentation": "The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.
" } } }, @@ -4921,7 +4921,7 @@ "PageSize": { "target": "com.amazonaws.mailmanager#PageSize", "traits": { - "smithy.api#documentation": "The maximum number of address list resources that are returned per call. You can use\n NextToken to retrieve the next page of address lists.
" + "smithy.api#documentation": "The maximum number of address list resources that are returned per call. You can use NextToken to retrieve the next page of address lists.
" } } }, @@ -4996,13 +4996,13 @@ "NextToken": { "target": "com.amazonaws.mailmanager#PaginationToken", "traits": { - "smithy.api#documentation": "If NextToken is returned, there are more results available. The value of NextToken is a unique pagination\n token for each page. Make the call again using the returned token to retrieve the next page.\n
" + "smithy.api#documentation": "If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" } }, "PageSize": { "target": "com.amazonaws.mailmanager#PageSize", "traits": { - "smithy.api#documentation": "The maximum number of archive export jobs that are returned per call. You can use NextToken to obtain\n further pages of archives.\n
" + "smithy.api#documentation": "The maximum number of archive export jobs that are returned per call. You can use NextToken to obtain further pages of archives.
" } } }, @@ -5078,13 +5078,13 @@ "NextToken": { "target": "com.amazonaws.mailmanager#PaginationToken", "traits": { - "smithy.api#documentation": "If NextToken is returned, there are more results available. The value of NextToken is a unique pagination\n token for each page. Make the call again using the returned token to retrieve the next page.\n
" + "smithy.api#documentation": "If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" } }, "PageSize": { "target": "com.amazonaws.mailmanager#PageSize", "traits": { - "smithy.api#documentation": "The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain\n further pages of archives.\n
" + "smithy.api#documentation": "The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives.
" } } }, @@ -5150,13 +5150,13 @@ "NextToken": { "target": "com.amazonaws.mailmanager#PaginationToken", "traits": { - "smithy.api#documentation": "If NextToken is returned, there are more results available. The value of NextToken is\n a unique pagination token for each page. Make the call again using the returned token to\n retrieve the next page.
" + "smithy.api#documentation": "If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
" } }, "PageSize": { "target": "com.amazonaws.mailmanager#PageSize", "traits": { - "smithy.api#documentation": "The maximum number of archives that are returned per call. You can use NextToken to\n obtain further pages of archives.
" + "smithy.api#documentation": "The maximum number of archives that are returned per call. You can use NextToken to obtain further pages of archives.
" } } }, @@ -5268,7 +5268,7 @@ "PageSize": { "target": "com.amazonaws.mailmanager#PageSize", "traits": { - "smithy.api#documentation": "The maximum number of ingress endpoint resources that are returned per call. You can\n use NextToken to obtain further ingress endpoints.
" + "smithy.api#documentation": "The maximum number of ingress endpoint resources that are returned per call. You can use NextToken to obtain further ingress endpoints.
" } }, "NextToken": { @@ -5360,7 +5360,7 @@ "PageSize": { "target": "com.amazonaws.mailmanager#AddressPageSize", "traits": { - "smithy.api#documentation": "The maximum number of address list members that are returned per call.\n You can use NextToken to retrieve the next page of members.
" + "smithy.api#documentation": "The maximum number of address list members that are returned per call. You can use NextToken to retrieve the next page of members.
" } } }, @@ -5490,7 +5490,7 @@ "PageSize": { "target": "com.amazonaws.mailmanager#PageSize", "traits": { - "smithy.api#documentation": "The maximum number of rule set resources that are returned per call. You can use\n NextToken to obtain further rule sets.
" + "smithy.api#documentation": "The maximum number of rule set resources that are returned per call. You can use NextToken to obtain further rule sets.
" } } }, @@ -5645,7 +5645,7 @@ "PageSize": { "target": "com.amazonaws.mailmanager#PageSize", "traits": { - "smithy.api#documentation": "The maximum number of traffic policy resources that are returned per call. You can use\n NextToken to obtain further traffic policies.
" + "smithy.api#documentation": "The maximum number of traffic policy resources that are returned per call. You can use NextToken to obtain further traffic policies.
" } }, "NextToken": { @@ -5808,7 +5808,7 @@ }, "aws.protocols#awsJson1_0": {}, "smithy.api#cors": {}, - "smithy.api#documentation": "The Amazon SES Mail Manager API contains operations and data types\n that comprise the Mail Manager feature of Amazon Simple Email Service (SES).
\nMail Manager is a set of Amazon SES email gateway features designed to help you strengthen\n your organization's email infrastructure, simplify email workflow management, and\n streamline email compliance control. To learn more, see the Mail Manager chapter in the Amazon SES Developer\n Guide.
", + "smithy.api#documentation": "The Amazon SES Mail Manager API contains operations and data types that comprise the Mail Manager feature of Amazon Simple Email Service (SES).
Mail Manager is a set of Amazon SES email gateway features designed to help you strengthen your organization's email infrastructure, simplify email workflow management, and streamline email compliance control. To learn more, see the Mail Manager chapter in the Amazon SES Developer Guide.
", "smithy.api#externalDocumentation": { "API Reference": "https://w.amazon.com/bin/view/AWS/Border" }, @@ -6573,25 +6573,25 @@ "SourceIdentity": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The identity name used to authorize the sending action when sent through a configuration set with\n archiving enabled.
" + "smithy.api#documentation": "The identity name used to authorize the sending action when sent through a configuration set with archiving enabled.
" } }, "SendingPool": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the dedicated IP pool used when sent through a configuration set with archiving\n enabled.
" + "smithy.api#documentation": "The name of the dedicated IP pool used when sent through a configuration set with archiving enabled.
" } }, "ConfigurationSet": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the configuration set used when sent through a configuration set with archiving\n enabled.
" + "smithy.api#documentation": "The name of the configuration set used when sent through a configuration set with archiving enabled.
" } }, "SourceArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a\n Configuration Set's Archive ARN.
" + "smithy.api#documentation": "Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN.
" } } }, @@ -6666,36 +6666,36 @@ "StringExpression": { "target": "com.amazonaws.mailmanager#IngressStringExpression", "traits": { - "smithy.api#documentation": "This represents a string based condition matching on the incoming mail. It performs\n the string operation configured in 'Operator' and evaluates the 'Protocol' object\n against the 'Value'.
" + "smithy.api#documentation": "This represents a string based condition matching on the incoming mail. It performs the string operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.
" } }, "IpExpression": { "target": "com.amazonaws.mailmanager#IngressIpv4Expression", "traits": { - "smithy.api#documentation": "This represents an IP based condition matching on the incoming mail. It performs the\n operation configured in 'Operator' and evaluates the 'Protocol' object against the\n 'Value'.
" + "smithy.api#documentation": "This represents an IP based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.
" } }, "Ipv6Expression": { "target": "com.amazonaws.mailmanager#IngressIpv6Expression", "traits": { - "smithy.api#documentation": "This represents an IPv6 based condition matching on the incoming mail. It performs the\n operation configured in 'Operator' and evaluates the 'Protocol' object against the\n 'Value'.
" + "smithy.api#documentation": "This represents an IPv6 based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.
" } }, "TlsExpression": { "target": "com.amazonaws.mailmanager#IngressTlsProtocolExpression", "traits": { - "smithy.api#documentation": "This represents a TLS based condition matching on the incoming mail. It performs the\n operation configured in 'Operator' and evaluates the 'Protocol' object against the\n 'Value'.
" + "smithy.api#documentation": "This represents a TLS based condition matching on the incoming mail. It performs the operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.
" } }, "BooleanExpression": { "target": "com.amazonaws.mailmanager#IngressBooleanExpression", "traits": { - "smithy.api#documentation": "This represents a boolean type condition matching on the incoming mail. It performs\n the boolean operation configured in 'Operator' and evaluates the 'Protocol' object\n against the 'Value'.
" + "smithy.api#documentation": "This represents a boolean type condition matching on the incoming mail. It performs the boolean operation configured in 'Operator' and evaluates the 'Protocol' object against the 'Value'.
" } } }, "traits": { - "smithy.api#documentation": "The email traffic filtering conditions which are contained in a traffic policy\n resource.
" + "smithy.api#documentation": "The email traffic filtering conditions which are contained in a traffic policy resource.
" } }, "com.amazonaws.mailmanager#PolicyConditions": { @@ -6715,14 +6715,14 @@ "Conditions": { "target": "com.amazonaws.mailmanager#PolicyConditions", "traits": { - "smithy.api#documentation": "The list of conditions to apply to incoming messages for filtering email\n traffic.
", + "smithy.api#documentation": "The list of conditions to apply to incoming messages for filtering email traffic.
", "smithy.api#required": {} } }, "Action": { "target": "com.amazonaws.mailmanager#AcceptAction", "traits": { - "smithy.api#documentation": "The action that informs a traffic policy resource to either allow or block the email\n if it matches a condition in the policy statement.
", + "smithy.api#documentation": "The action that informs a traffic policy resource to either allow or block the email if it matches a condition in the policy statement.
", "smithy.api#required": {} } } @@ -6889,7 +6889,7 @@ } }, "traits": { - "smithy.api#documentation": "The relay resource that can be used as a rule to relay receiving emails to the destination\n relay server.
" + "smithy.api#documentation": "The relay resource that can be used as a rule to relay receiving emails to the destination relay server.
" } }, "com.amazonaws.mailmanager#RelayAction": { @@ -6898,7 +6898,7 @@ "ActionFailurePolicy": { "target": "com.amazonaws.mailmanager#ActionFailurePolicy", "traits": { - "smithy.api#documentation": "A policy that states what to do in the case of failure. The action will fail if there\n are configuration errors. For example, the specified relay has been deleted.
" + "smithy.api#documentation": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified relay has been deleted.
" } }, "Relay": { @@ -6911,7 +6911,7 @@ "MailFrom": { "target": "com.amazonaws.mailmanager#MailFrom", "traits": { - "smithy.api#documentation": "This action specifies whether to preserve or replace original mail from address while\n relaying received emails to a destination server.
" + "smithy.api#documentation": "This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server.
" } } }, @@ -6942,7 +6942,7 @@ } }, "traits": { - "smithy.api#documentation": "Authentication for the relay destination server\u2014specify the secretARN where the SMTP credentials are stored,\n or specify an empty NoAuthentication structure if the relay destination server does not require SMTP credential authentication.
" + "smithy.api#documentation": "Authentication for the relay destination server\u2014specify the secretARN where the SMTP credentials are stored, or specify an empty NoAuthentication structure if the relay destination server does not require SMTP credential authentication.
" } }, "com.amazonaws.mailmanager#RelayId": { @@ -7055,7 +7055,7 @@ } }, "traits": { - "smithy.api#documentation": "This action replaces the email envelope recipients with the given list of recipients.\n If the condition of this action applies only to a subset of recipients, only those\n recipients are replaced with the recipients specified in the action. The message\n contents and headers are unaffected by this action, only the envelope recipients are\n updated.
" + "smithy.api#documentation": "This action replaces the email envelope recipients with the given list of recipients. If the condition of this action applies only to a subset of recipients, only those recipients are replaced with the recipients specified in the action. The message contents and headers are unaffected by this action, only the envelope recipients are updated.
" } }, "com.amazonaws.mailmanager#ResourceNotFoundException": { @@ -7284,7 +7284,7 @@ "SenderIpAddress": { "target": "com.amazonaws.mailmanager#SenderIpAddress", "traits": { - "smithy.api#documentation": "Mail archived with Mail Manager: The IP address of the client that connects to\n the ingress endpoint.
\nMail sent through a configuration set with the\n archiving option enabled: The IP address of the client that makes the SendEmail API call.
\nMail archived with Mail Manager: The IP address of the client that connects to the ingress endpoint.
Mail sent through a configuration set with the archiving option enabled: The IP address of the client that makes the SendEmail API call.
Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a\n Configuration Set's Archive ARN.
" + "smithy.api#documentation": "Specifies the archived email source, identified by either a Rule Set's ARN with an Archive action, or a Configuration Set's Archive ARN.
" } } }, @@ -7322,25 +7322,25 @@ "Conditions": { "target": "com.amazonaws.mailmanager#RuleConditions", "traits": { - "smithy.api#documentation": "The conditions of this rule. All conditions must match the email for the actions to be\n executed. An empty list of conditions means that all emails match, but are still subject\n to any \"unless conditions\"
" + "smithy.api#documentation": "The conditions of this rule. All conditions must match the email for the actions to be executed. An empty list of conditions means that all emails match, but are still subject to any \"unless conditions\"
" } }, "Unless": { "target": "com.amazonaws.mailmanager#RuleConditions", "traits": { - "smithy.api#documentation": "The \"unless conditions\" of this rule. None of the conditions can match the\n email for the actions to be executed. If any of these conditions do match the email,\n then the actions are not executed.
" + "smithy.api#documentation": "The \"unless conditions\" of this rule. None of the conditions can match the email for the actions to be executed. If any of these conditions do match the email, then the actions are not executed.
" } }, "Actions": { "target": "com.amazonaws.mailmanager#RuleActions", "traits": { - "smithy.api#documentation": "The list of actions to execute when the conditions match the incoming email, and none\n of the \"unless conditions\" match.
", + "smithy.api#documentation": "The list of actions to execute when the conditions match the incoming email, and none of the \"unless conditions\" match.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A rule contains conditions, \"unless conditions\" and actions. For each\n envelope recipient of an email, if all conditions match and none of the \"unless\n conditions\" match, then all of the actions are executed sequentially. If no\n conditions are provided, the rule always applies and the actions are implicitly\n executed. If only \"unless conditions\" are provided, the rule applies if the\n email does not match the evaluation of the \"unless conditions\".
" + "smithy.api#documentation": "A rule contains conditions, \"unless conditions\" and actions. For each envelope recipient of an email, if all conditions match and none of the \"unless conditions\" match, then all of the actions are executed sequentially. If no conditions are provided, the rule always applies and the actions are implicitly executed. If only \"unless conditions\" are provided, the rule applies if the email does not match the evaluation of the \"unless conditions\".
" } }, "com.amazonaws.mailmanager#RuleAction": { @@ -7361,7 +7361,7 @@ "Archive": { "target": "com.amazonaws.mailmanager#ArchiveAction", "traits": { - "smithy.api#documentation": "This action archives the email. This can be used to deliver an email to an\n archive.
" + "smithy.api#documentation": "This action archives the email. This can be used to deliver an email to an archive.
" } }, "WriteToS3": { @@ -7385,7 +7385,7 @@ "ReplaceRecipient": { "target": "com.amazonaws.mailmanager#ReplaceRecipientAction", "traits": { - "smithy.api#documentation": "The action replaces certain or all recipients with a different set of\n recipients.
" + "smithy.api#documentation": "The action replaces certain or all recipients with a different set of recipients.
" } }, "DeliverToMailbox": { @@ -7397,7 +7397,13 @@ "DeliverToQBusiness": { "target": "com.amazonaws.mailmanager#DeliverToQBusinessAction", "traits": { - "smithy.api#documentation": "This action delivers an email to an Amazon Q Business application for ingestion into\n its knowledge base.
" + "smithy.api#documentation": "This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base.
" + } + }, + "PublishToSns": { + "target": "com.amazonaws.mailmanager#SnsAction", + "traits": { + "smithy.api#documentation": "This action publishes the email content to an Amazon SNS topic.
" } } }, @@ -7556,7 +7562,7 @@ } }, "traits": { - "smithy.api#documentation": "The union type representing the allowed types of operands for a boolean\n condition.
" + "smithy.api#documentation": "The union type representing the allowed types of operands for a boolean condition.
" } }, "com.amazonaws.mailmanager#RuleCondition": { @@ -7600,7 +7606,7 @@ } }, "traits": { - "smithy.api#documentation": "The conditional expression used to evaluate an email for determining if a rule action\n should be taken.
" + "smithy.api#documentation": "The conditional expression used to evaluate an email for determining if a rule action should be taken.
" } }, "com.amazonaws.mailmanager#RuleConditions": { @@ -7628,13 +7634,13 @@ "Values": { "target": "com.amazonaws.mailmanager#RuleDmarcValueList", "traits": { - "smithy.api#documentation": "The values to use for the given DMARC policy operator. For the operator EQUALS, if\n multiple values are given, they are evaluated as an OR. That is, if any of the given\n values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple\n values are given, they are evaluated as an AND. That is, only if the email's DMARC\n policy is not equal to any of the given values, then the condition is deemed to\n match.
", + "smithy.api#documentation": "The values to use for the given DMARC policy operator. For the operator EQUALS, if multiple values are given, they are evaluated as an OR. That is, if any of the given values match, the condition is deemed to match. For the operator NOT_EQUALS, if multiple values are given, they are evaluated as an AND. That is, only if the email's DMARC policy is not equal to any of the given values, then the condition is deemed to match.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A DMARC policy expression. The condition matches if the given DMARC policy matches\n that of the incoming email.
" + "smithy.api#documentation": "A DMARC policy expression. The condition matches if the given DMARC policy matches that of the incoming email.
" } }, "com.amazonaws.mailmanager#RuleDmarcOperator": { @@ -7720,13 +7726,13 @@ "Values": { "target": "com.amazonaws.mailmanager#RuleIpValueList", "traits": { - "smithy.api#documentation": "The IP CIDR blocks in format \"x.y.z.w/n\" (eg 10.0.0.0/8) to match with the\n email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they\n are evaluated as an OR. That is, if the IP address is contained within any of the given\n CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR\n ranges are given, the condition is deemed to match if the IP address is not contained in\n any of the given CIDR ranges.
", + "smithy.api#documentation": "The IP CIDR blocks in format \"x.y.z.w/n\" (eg 10.0.0.0/8) to match with the email's IP address. For the operator CIDR_MATCHES, if multiple values are given, they are evaluated as an OR. That is, if the IP address is contained within any of the given CIDR ranges, the condition is deemed to match. For NOT_CIDR_MATCHES, if multiple CIDR ranges are given, the condition is deemed to match if the IP address is not contained in any of the given CIDR ranges.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "An IP address expression matching certain IP addresses within a given range of IP\n addresses.
" + "smithy.api#documentation": "An IP address expression matching certain IP addresses within a given range of IP addresses.
" } }, "com.amazonaws.mailmanager#RuleIpOperator": { @@ -7851,7 +7857,7 @@ } }, "traits": { - "smithy.api#documentation": "A number expression to match numeric conditions with integers from the incoming\n email.
" + "smithy.api#documentation": "A number expression to match numeric conditions with integers from the incoming email.
" } }, "com.amazonaws.mailmanager#RuleNumberOperator": { @@ -7932,7 +7938,7 @@ } }, "traits": { - "smithy.api#documentation": "A rule set contains a list of rules that are evaluated in order. Each rule is\n evaluated sequentially for each email.
" + "smithy.api#documentation": "A rule set contains a list of rules that are evaluated in order. Each rule is evaluated sequentially for each email.
" } }, "com.amazonaws.mailmanager#RuleSetArn": { @@ -8087,7 +8093,7 @@ "Values": { "target": "com.amazonaws.mailmanager#RuleStringList", "traits": { - "smithy.api#documentation": "The string(s) to be evaluated in a string condition expression. For all operators,\n except for NOT_EQUALS, if multiple values are given, the values are processed as an OR.\n That is, if any of the values match the email's string using the given operator, the\n condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to\n match if none of the given strings match the email's string.
", + "smithy.api#documentation": "The string(s) to be evaluated in a string condition expression. For all operators, except for NOT_EQUALS, if multiple values are given, the values are processed as an OR. That is, if any of the values match the email's string using the given operator, the condition is deemed to match. However, for NOT_EQUALS, the condition is only deemed to match if none of the given strings match the email's string.
", "smithy.api#required": {} } } @@ -8244,7 +8250,7 @@ "Values": { "target": "com.amazonaws.mailmanager#RuleVerdictValueList", "traits": { - "smithy.api#documentation": "The values to match with the email's verdict using the given operator. For the EQUALS\n operator, if multiple values are given, the condition is deemed to match if any of the\n given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values\n are given, the condition is deemed to match of none of the given verdicts match the\n verdict of the email.
", + "smithy.api#documentation": "The values to match with the email's verdict using the given operator. For the EQUALS operator, if multiple values are given, the condition is deemed to match if any of the given verdicts match that of the email. For the NOT_EQUALS operator, if multiple values are given, the condition is deemed to match of none of the given verdicts match the verdict of the email.
", "smithy.api#required": {} } } @@ -8282,7 +8288,7 @@ "Analysis": { "target": "com.amazonaws.mailmanager#Analysis", "traits": { - "smithy.api#documentation": "The Add On ARN and its returned value to evaluate in a verdict condition\n expression.
" + "smithy.api#documentation": "The Add On ARN and its returned value to evaluate in a verdict condition expression.
" } } }, @@ -8320,13 +8326,13 @@ "ActionFailurePolicy": { "target": "com.amazonaws.mailmanager#ActionFailurePolicy", "traits": { - "smithy.api#documentation": "A policy that states what to do in the case of failure. The action will fail if there\n are configuration errors. For example, the specified the bucket has been deleted.
" + "smithy.api#documentation": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the specified the bucket has been deleted.
" } }, "RoleArn": { "target": "com.amazonaws.mailmanager#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to\n the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Role to use while writing to S3. This role must have access to the s3:PutObject, kms:Encrypt, and kms:GenerateDataKey APIs for the given bucket.
", "smithy.api#required": {} } }, @@ -8551,13 +8557,13 @@ "ActionFailurePolicy": { "target": "com.amazonaws.mailmanager#ActionFailurePolicy", "traits": { - "smithy.api#documentation": "A policy that states what to do in the case of failure. The action will fail if there\n are configuration errors. For example, the caller does not have the permissions to call\n the sendRawEmail API.
" + "smithy.api#documentation": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, the caller does not have the permissions to call the sendRawEmail API.
" } }, "RoleArn": { "target": "com.amazonaws.mailmanager#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the\n ses:SendRawEmail API.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role to use for this action. This role must have access to the ses:SendRawEmail API.
", "smithy.api#required": {} } } @@ -8596,6 +8602,95 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.mailmanager#SnsAction": { + "type": "structure", + "members": { + "ActionFailurePolicy": { + "target": "com.amazonaws.mailmanager#ActionFailurePolicy", + "traits": { + "smithy.api#documentation": "A policy that states what to do in the case of failure. The action will fail if there are configuration errors. For example, specified SNS topic has been deleted or the role lacks necessary permissions to call the sns:Publish API.
The Amazon Resource Name (ARN) of the Amazon SNS Topic to which notification for the email received will be published.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.mailmanager#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Role to use while writing to Amazon SNS. This role must have access to the sns:Publish API for the given topic.
The encoding to use for the email within the Amazon SNS notification. The default value is UTF-8. Use BASE64 if you need to preserve all special characters, especially when the original message uses a different encoding format.
The expected payload type within the Amazon SNS notification. CONTENT attempts to publish the full email content with 20KB of headers content. HEADERS extracts up to 100KB of header content to include in the notification, email content will not be included to the notification. The default value is CONTENT.
The action to publish the email content to an Amazon SNS topic. When executed, this action will send the email as a notification to the specified SNS topic.
" + } + }, + "com.amazonaws.mailmanager#SnsNotificationEncoding": { + "type": "enum", + "members": { + "UTF_8": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UTF-8" + } + }, + "BASE64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASE64" + } + } + } + }, + "com.amazonaws.mailmanager#SnsNotificationPayloadType": { + "type": "enum", + "members": { + "HEADERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEADERS" + } + }, + "CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTENT" + } + } + } + }, + "com.amazonaws.mailmanager#SnsTopicArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::SNS::Topic" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):sns:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:[\\w\\-]{1,256}$" + } + }, "com.amazonaws.mailmanager#StartAddressListImportJob": { "type": "operation", "input": { @@ -8935,7 +9030,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "The response indicating if the request to stop the export job succeeded.
\nOn success, returns an HTTP 200 status code. On failure, returns an error message.
", + "smithy.api#documentation": "The response indicating if the request to stop the export job succeeded.
On success, returns an HTTP 200 status code. On failure, returns an error message.
", "smithy.api#output": {} } }, @@ -8983,7 +9078,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "The response indicating if the request to stop the search job succeeded.
\nOn success, returns an HTTP 200 status code. On failure, returns an error message.
", + "smithy.api#documentation": "The response indicating if the request to stop the search job succeeded.
On success, returns an HTTP 200 status code. On failure, returns an error message.
", "smithy.api#output": {} } }, @@ -9185,7 +9280,7 @@ } }, "traits": { - "smithy.api#documentation": "The structure of a traffic policy resource which is a container for policy\n statements.
" + "smithy.api#documentation": "The structure of a traffic policy resource which is a container for policy statements.
" } }, "com.amazonaws.mailmanager#TrafficPolicyArn": { @@ -9284,7 +9379,7 @@ "TagKeys": { "target": "com.amazonaws.mailmanager#TagKeyList", "traits": { - "smithy.api#documentation": "The keys of the key-value pairs for the tag or tags you want to remove from the\n specified resource.
", + "smithy.api#documentation": "The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.
", "smithy.api#required": {} } } @@ -9365,7 +9460,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "The response indicating if the archive update succeeded or failed.
\nOn success, returns an HTTP 200 status code. On failure, returns an error\n message.
", + "smithy.api#documentation": "The response indicating if the archive update succeeded or failed.
On success, returns an HTTP 200 status code. On failure, returns an error message.
", "smithy.api#output": {} } }, @@ -9457,19 +9552,19 @@ "RuleSetId": { "target": "com.amazonaws.mailmanager#RuleSetId", "traits": { - "smithy.api#documentation": "The identifier of an existing rule set that you attach to an ingress endpoint\n resource.
" + "smithy.api#documentation": "The identifier of an existing rule set that you attach to an ingress endpoint resource.
" } }, "TrafficPolicyId": { "target": "com.amazonaws.mailmanager#TrafficPolicyId", "traits": { - "smithy.api#documentation": "The identifier of an existing traffic policy that you attach to an ingress endpoint\n resource.
" + "smithy.api#documentation": "The identifier of an existing traffic policy that you attach to an ingress endpoint resource.
" } }, "IngressPointConfiguration": { "target": "com.amazonaws.mailmanager#IngressPointConfiguration", "traits": { - "smithy.api#documentation": "If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret\n ARN.
" + "smithy.api#documentation": "If you choose an Authenticated ingress endpoint, you must configure either an SMTP password or a secret ARN.
" } } }, @@ -9539,7 +9634,7 @@ "Authentication": { "target": "com.amazonaws.mailmanager#RelayAuthentication", "traits": { - "smithy.api#documentation": "Authentication for the relay destination server\u2014specify the secretARN where\n the SMTP credentials are stored.
" + "smithy.api#documentation": "Authentication for the relay destination server\u2014specify the secretARN where the SMTP credentials are stored.
" } } }, @@ -9597,7 +9692,7 @@ "Rules": { "target": "com.amazonaws.mailmanager#Rules", "traits": { - "smithy.api#documentation": "A new set of rules to replace the current rules of the rule set\u2014these rules will\n override all the rules of the rule set.
" + "smithy.api#documentation": "A new set of rules to replace the current rules of the rule set\u2014these rules will override all the rules of the rule set.
" } } }, @@ -9711,7 +9806,7 @@ "MaxMessageSizeBytes": { "target": "com.amazonaws.mailmanager#MaxMessageSizeBytes", "traits": { - "smithy.api#documentation": "The maximum message size in bytes of email which is allowed in by this traffic\n policy\u2014anything larger will be blocked.
" + "smithy.api#documentation": "The maximum message size in bytes of email which is allowed in by this traffic policy\u2014anything larger will be blocked.
" } } }, diff --git a/managedblockchain-query/service/2023-05-04/managedblockchain-query-2023-05-04.json b/models/managedblockchain-query/service/2023-05-04/managedblockchain-query-2023-05-04.json similarity index 100% rename from managedblockchain-query/service/2023-05-04/managedblockchain-query-2023-05-04.json rename to models/managedblockchain-query/service/2023-05-04/managedblockchain-query-2023-05-04.json diff --git a/managedblockchain/service/2018-09-24/managedblockchain-2018-09-24.json b/models/managedblockchain/service/2018-09-24/managedblockchain-2018-09-24.json similarity index 100% rename from managedblockchain/service/2018-09-24/managedblockchain-2018-09-24.json rename to models/managedblockchain/service/2018-09-24/managedblockchain-2018-09-24.json diff --git a/marketplace-agreement/service/2020-03-01/marketplace-agreement-2020-03-01.json b/models/marketplace-agreement/service/2020-03-01/marketplace-agreement-2020-03-01.json similarity index 100% rename from marketplace-agreement/service/2020-03-01/marketplace-agreement-2020-03-01.json rename to models/marketplace-agreement/service/2020-03-01/marketplace-agreement-2020-03-01.json diff --git a/marketplace-catalog/service/2018-09-17/marketplace-catalog-2018-09-17.json b/models/marketplace-catalog/service/2018-09-17/marketplace-catalog-2018-09-17.json similarity index 100% rename from marketplace-catalog/service/2018-09-17/marketplace-catalog-2018-09-17.json rename to models/marketplace-catalog/service/2018-09-17/marketplace-catalog-2018-09-17.json diff --git a/marketplace-commerce-analytics/service/2015-07-01/marketplace-commerce-analytics-2015-07-01.json b/models/marketplace-commerce-analytics/service/2015-07-01/marketplace-commerce-analytics-2015-07-01.json similarity index 100% rename from marketplace-commerce-analytics/service/2015-07-01/marketplace-commerce-analytics-2015-07-01.json rename to models/marketplace-commerce-analytics/service/2015-07-01/marketplace-commerce-analytics-2015-07-01.json diff --git a/marketplace-deployment/service/2023-01-25/marketplace-deployment-2023-01-25.json b/models/marketplace-deployment/service/2023-01-25/marketplace-deployment-2023-01-25.json similarity index 100% rename from marketplace-deployment/service/2023-01-25/marketplace-deployment-2023-01-25.json rename to models/marketplace-deployment/service/2023-01-25/marketplace-deployment-2023-01-25.json diff --git a/marketplace-entitlement-service/service/2017-01-11/marketplace-entitlement-service-2017-01-11.json b/models/marketplace-entitlement-service/service/2017-01-11/marketplace-entitlement-service-2017-01-11.json similarity index 100% rename from marketplace-entitlement-service/service/2017-01-11/marketplace-entitlement-service-2017-01-11.json rename to models/marketplace-entitlement-service/service/2017-01-11/marketplace-entitlement-service-2017-01-11.json diff --git a/marketplace-metering/service/2016-01-14/marketplace-metering-2016-01-14.json b/models/marketplace-metering/service/2016-01-14/marketplace-metering-2016-01-14.json similarity index 100% rename from marketplace-metering/service/2016-01-14/marketplace-metering-2016-01-14.json rename to models/marketplace-metering/service/2016-01-14/marketplace-metering-2016-01-14.json diff --git a/marketplace-reporting/service/2018-05-10/marketplace-reporting-2018-05-10.json b/models/marketplace-reporting/service/2018-05-10/marketplace-reporting-2018-05-10.json similarity index 100% rename from marketplace-reporting/service/2018-05-10/marketplace-reporting-2018-05-10.json rename to models/marketplace-reporting/service/2018-05-10/marketplace-reporting-2018-05-10.json diff --git a/mediaconnect/service/2018-11-14/mediaconnect-2018-11-14.json b/models/mediaconnect/service/2018-11-14/mediaconnect-2018-11-14.json similarity index 100% rename from mediaconnect/service/2018-11-14/mediaconnect-2018-11-14.json rename to models/mediaconnect/service/2018-11-14/mediaconnect-2018-11-14.json diff --git a/mediaconvert/service/2017-08-29/mediaconvert-2017-08-29.json b/models/mediaconvert/service/2017-08-29/mediaconvert-2017-08-29.json similarity index 98% rename from mediaconvert/service/2017-08-29/mediaconvert-2017-08-29.json rename to models/mediaconvert/service/2017-08-29/mediaconvert-2017-08-29.json index c7183413..49d16bd7 100644 --- a/mediaconvert/service/2017-08-29/mediaconvert-2017-08-29.json +++ b/models/mediaconvert/service/2017-08-29/mediaconvert-2017-08-29.json @@ -1700,7 +1700,7 @@ } }, "BitRate": { - "target": "com.amazonaws.mediaconvert#__integer", + "target": "com.amazonaws.mediaconvert#__long", "traits": { "smithy.api#documentation": "The bit rate of the audio track, in bits per second.", "smithy.api#jsonName": "bitRate" @@ -1872,6 +1872,12 @@ "traits": { "smithy.api#enumValue": "HLS_RENDITION_GROUP" } + }, + "ALL_PCM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_PCM" + } } }, "traits": { @@ -1954,7 +1960,7 @@ "MaxQualityLevel": { "target": "com.amazonaws.mediaconvert#__doubleMin1Max10", "traits": { - "smithy.api#documentation": "Optional. Specify the QVBR quality level to use for all renditions in your automated ABR stack. To have MediaConvert automatically determine the quality level: Leave blank. To manually specify a quality level: Enter an integer from 1 to 10. MediaConvert will use a quality level up to the value that you specify, depending on your source. For more information about QVBR quality levels, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/qvbr-guidelines.html", + "smithy.api#documentation": "Optional. Specify the QVBR quality level to use for all renditions in your automated ABR stack. To have MediaConvert automatically determine the quality level: Leave blank. To manually specify a quality level: Enter a value from 1 to 10. MediaConvert will use a quality level up to the value that you specify, depending on your source. For more information about QVBR quality levels, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/qvbr-guidelines.html", "smithy.api#jsonName": "maxQualityLevel" } }, @@ -2244,6 +2250,13 @@ "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" } }, + "PerFrameMetrics": { + "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", + "traits": { + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#jsonName": "perFrameMetrics" + } + }, "QvbrSettings": { "target": "com.amazonaws.mediaconvert#Av1QvbrSettings", "traits": { @@ -2506,6 +2519,13 @@ "smithy.api#jsonName": "interlaceMode" } }, + "PerFrameMetrics": { + "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", + "traits": { + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#jsonName": "perFrameMetrics" + } + }, "ScanTypeConversionMode": { "target": "com.amazonaws.mediaconvert#AvcIntraScanTypeConversionMode", "traits": { @@ -5733,7 +5753,7 @@ "BillingTagsSource": { "target": "com.amazonaws.mediaconvert#BillingTagsSource", "traits": { - "smithy.api#documentation": "Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.", + "smithy.api#documentation": "Optionally choose a Billing tags source that AWS Billing and Cost Management will use to display tags for individual output costs on any billing report that you set up. Leave blank to use the default value, Job.", "smithy.api#jsonName": "billingTagsSource" } }, @@ -8166,7 +8186,7 @@ } }, "traits": { - "smithy.api#documentation": "Use Dynamic audio selectors when you do not know the track layout of your source when you submit your job, but want to select multiple audio tracks. When you include an audio track in your output and specify this Dynamic audio selector as the Audio source, MediaConvert creates an output audio track for each dynamically selected track. Note that when you include a Dynamic audio selector for two or more inputs, each input must have the same number of audio tracks and audio channels." + "smithy.api#documentation": "Use Dynamic audio selectors when you do not know the track layout of your source when you submit your job, but want to select multiple audio tracks. When you include an audio track in your output and specify this Dynamic audio selector as the Audio source, MediaConvert creates an audio track within that output for each dynamically selected track. Note that when you include a Dynamic audio selector for two or more inputs, each input must have the same number of audio tracks and audio channels." } }, "com.amazonaws.mediaconvert#DynamicAudioSelectorType": { @@ -9685,6 +9705,50 @@ "smithy.api#documentation": "Required when you set Codec to the value FRAME_CAPTURE." } }, + "com.amazonaws.mediaconvert#FrameMetricType": { + "type": "enum", + "members": { + "PSNR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PSNR" + } + }, + "SSIM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSIM" + } + }, + "MS_SSIM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MS_SSIM" + } + }, + "PSNR_HVS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PSNR_HVS" + } + }, + "VMAF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VMAF" + } + }, + "QVBR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QVBR" + } + } + }, + "traits": { + "smithy.api#documentation": "* PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode." + } + }, "com.amazonaws.mediaconvert#FrameRate": { "type": "structure", "members": { @@ -10953,6 +11017,13 @@ "smithy.api#jsonName": "parNumerator" } }, + "PerFrameMetrics": { + "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", + "traits": { + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#jsonName": "perFrameMetrics" + } + }, "QualityTuningLevel": { "target": "com.amazonaws.mediaconvert#H264QualityTuningLevel", "traits": { @@ -12029,6 +12100,13 @@ "smithy.api#jsonName": "parNumerator" } }, + "PerFrameMetrics": { + "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", + "traits": { + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#jsonName": "perFrameMetrics" + } + }, "QualityTuningLevel": { "target": "com.amazonaws.mediaconvert#H265QualityTuningLevel", "traits": { @@ -14735,7 +14813,7 @@ "FollowSource": { "target": "com.amazonaws.mediaconvert#__integerMin1Max150", "traits": { - "smithy.api#documentation": "Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output settings for. Enabling this setting will disable \"Follow source\" for all other inputs. If MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs.", + "smithy.api#documentation": "Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output settings for. Enabling this setting will disable \"Follow source\" for all other inputs. If MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs.", "smithy.api#jsonName": "followSource" } }, @@ -15008,7 +15086,7 @@ "FollowSource": { "target": "com.amazonaws.mediaconvert#__integerMin1Max150", "traits": { - "smithy.api#documentation": "Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output settings for. Enabling this setting will disable \"Follow source\" for all other inputs. If MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs.", + "smithy.api#documentation": "Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output settings for. Enabling this setting will disable \"Follow source\" for all other inputs. If MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs.", "smithy.api#jsonName": "followSource" } }, @@ -20393,6 +20471,13 @@ "smithy.api#jsonName": "parNumerator" } }, + "PerFrameMetrics": { + "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", + "traits": { + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#jsonName": "perFrameMetrics" + } + }, "QualityTuningLevel": { "target": "com.amazonaws.mediaconvert#Mpeg2QualityTuningLevel", "traits": { @@ -21573,6 +21658,13 @@ "smithy.api#jsonName": "msSmoothGroupSettings" } }, + "PerFrameMetrics": { + "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", + "traits": { + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#jsonName": "perFrameMetrics" + } + }, "Type": { "target": "com.amazonaws.mediaconvert#OutputGroupType", "traits": { @@ -22368,6 +22460,13 @@ "smithy.api#jsonName": "parNumerator" } }, + "PerFrameMetrics": { + "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", + "traits": { + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#jsonName": "perFrameMetrics" + } + }, "ScanTypeConversionMode": { "target": "com.amazonaws.mediaconvert#ProresScanTypeConversionMode", "traits": { @@ -25940,7 +26039,7 @@ } }, "BitRate": { - "target": "com.amazonaws.mediaconvert#__integer", + "target": "com.amazonaws.mediaconvert#__long", "traits": { "smithy.api#documentation": "The bit rate of the video track, in bits per second.", "smithy.api#jsonName": "bitRate" @@ -27457,6 +27556,13 @@ "smithy.api#jsonName": "framerateNumerator" } }, + "PerFrameMetrics": { + "target": "com.amazonaws.mediaconvert#__listOfFrameMetricType", + "traits": { + "smithy.api#documentation": "Optionally choose one or more per frame metric reports to generate along with your output. You can use these metrics to analyze your video output according to one or more commonly used image quality metrics. You can specify per frame metrics for output groups or for individual outputs. When you do, MediaConvert writes a CSV (Comma-Separated Values) file to your S3 output destination, named after the video, video codec, and metric type. For example: video_h264_PSNR.csv Jobs that generate per frame metrics will take longer to complete, depending on the resolution and complexity of your output. For example, some 4K jobs might take up to twice as long to complete. Note that when analyzing the video quality of your output, or when comparing the video quality of multiple different outputs, we generally also recommend a detailed visual review in a controlled environment. You can choose from the following per frame metrics: * PSNR: Peak Signal-to-Noise Ratio * SSIM: Structural Similarity Index Measure * MS_SSIM: Multi-Scale Similarity Index Measure * PSNR_HVS: Peak Signal-to-Noise Ratio, Human Visual System * VMAF: Video Multi-Method Assessment Fusion * QVBR: Quality-Defined Variable Bitrate. This option is only available when your output uses the QVBR rate control mode.", + "smithy.api#jsonName": "perFrameMetrics" + } + }, "Profile": { "target": "com.amazonaws.mediaconvert#XavcProfile", "traits": { @@ -28612,6 +28718,12 @@ "target": "com.amazonaws.mediaconvert#ForceIncludeRenditionSize" } }, + "com.amazonaws.mediaconvert#__listOfFrameMetricType": { + "type": "list", + "member": { + "target": "com.amazonaws.mediaconvert#FrameMetricType" + } + }, "com.amazonaws.mediaconvert#__listOfHlsAdMarkers": { "type": "list", "member": { diff --git a/medialive/service/2017-10-14/medialive-2017-10-14.json b/models/medialive/service/2017-10-14/medialive-2017-10-14.json similarity index 100% rename from medialive/service/2017-10-14/medialive-2017-10-14.json rename to models/medialive/service/2017-10-14/medialive-2017-10-14.json diff --git a/mediapackage-vod/service/2018-11-07/mediapackage-vod-2018-11-07.json b/models/mediapackage-vod/service/2018-11-07/mediapackage-vod-2018-11-07.json similarity index 100% rename from mediapackage-vod/service/2018-11-07/mediapackage-vod-2018-11-07.json rename to models/mediapackage-vod/service/2018-11-07/mediapackage-vod-2018-11-07.json diff --git a/mediapackage/service/2017-10-12/mediapackage-2017-10-12.json b/models/mediapackage/service/2017-10-12/mediapackage-2017-10-12.json similarity index 100% rename from mediapackage/service/2017-10-12/mediapackage-2017-10-12.json rename to models/mediapackage/service/2017-10-12/mediapackage-2017-10-12.json diff --git a/mediapackagev2/service/2022-12-25/mediapackagev2-2022-12-25.json b/models/mediapackagev2/service/2022-12-25/mediapackagev2-2022-12-25.json similarity index 100% rename from mediapackagev2/service/2022-12-25/mediapackagev2-2022-12-25.json rename to models/mediapackagev2/service/2022-12-25/mediapackagev2-2022-12-25.json diff --git a/mediastore-data/service/2017-09-01/mediastore-data-2017-09-01.json b/models/mediastore-data/service/2017-09-01/mediastore-data-2017-09-01.json similarity index 100% rename from mediastore-data/service/2017-09-01/mediastore-data-2017-09-01.json rename to models/mediastore-data/service/2017-09-01/mediastore-data-2017-09-01.json diff --git a/mediastore/service/2017-09-01/mediastore-2017-09-01.json b/models/mediastore/service/2017-09-01/mediastore-2017-09-01.json similarity index 100% rename from mediastore/service/2017-09-01/mediastore-2017-09-01.json rename to models/mediastore/service/2017-09-01/mediastore-2017-09-01.json diff --git a/mediatailor/service/2018-04-23/mediatailor-2018-04-23.json b/models/mediatailor/service/2018-04-23/mediatailor-2018-04-23.json similarity index 100% rename from mediatailor/service/2018-04-23/mediatailor-2018-04-23.json rename to models/mediatailor/service/2018-04-23/mediatailor-2018-04-23.json diff --git a/medical-imaging/service/2023-07-19/medical-imaging-2023-07-19.json b/models/medical-imaging/service/2023-07-19/medical-imaging-2023-07-19.json similarity index 100% rename from medical-imaging/service/2023-07-19/medical-imaging-2023-07-19.json rename to models/medical-imaging/service/2023-07-19/medical-imaging-2023-07-19.json diff --git a/memorydb/service/2021-01-01/memorydb-2021-01-01.json b/models/memorydb/service/2021-01-01/memorydb-2021-01-01.json similarity index 100% rename from memorydb/service/2021-01-01/memorydb-2021-01-01.json rename to models/memorydb/service/2021-01-01/memorydb-2021-01-01.json diff --git a/mgn/service/2020-02-26/mgn-2020-02-26.json b/models/mgn/service/2020-02-26/mgn-2020-02-26.json similarity index 100% rename from mgn/service/2020-02-26/mgn-2020-02-26.json rename to models/mgn/service/2020-02-26/mgn-2020-02-26.json diff --git a/migration-hub-refactor-spaces/service/2021-10-26/migration-hub-refactor-spaces-2021-10-26.json b/models/migration-hub-refactor-spaces/service/2021-10-26/migration-hub-refactor-spaces-2021-10-26.json similarity index 100% rename from migration-hub-refactor-spaces/service/2021-10-26/migration-hub-refactor-spaces-2021-10-26.json rename to models/migration-hub-refactor-spaces/service/2021-10-26/migration-hub-refactor-spaces-2021-10-26.json diff --git a/migration-hub/service/2017-05-31/migration-hub-2017-05-31.json b/models/migration-hub/service/2017-05-31/migration-hub-2017-05-31.json similarity index 100% rename from migration-hub/service/2017-05-31/migration-hub-2017-05-31.json rename to models/migration-hub/service/2017-05-31/migration-hub-2017-05-31.json diff --git a/migrationhub-config/service/2019-06-30/migrationhub-config-2019-06-30.json b/models/migrationhub-config/service/2019-06-30/migrationhub-config-2019-06-30.json similarity index 100% rename from migrationhub-config/service/2019-06-30/migrationhub-config-2019-06-30.json rename to models/migrationhub-config/service/2019-06-30/migrationhub-config-2019-06-30.json diff --git a/migrationhuborchestrator/service/2021-08-28/migrationhuborchestrator-2021-08-28.json b/models/migrationhuborchestrator/service/2021-08-28/migrationhuborchestrator-2021-08-28.json similarity index 100% rename from migrationhuborchestrator/service/2021-08-28/migrationhuborchestrator-2021-08-28.json rename to models/migrationhuborchestrator/service/2021-08-28/migrationhuborchestrator-2021-08-28.json diff --git a/migrationhubstrategy/service/2020-02-19/migrationhubstrategy-2020-02-19.json b/models/migrationhubstrategy/service/2020-02-19/migrationhubstrategy-2020-02-19.json similarity index 100% rename from migrationhubstrategy/service/2020-02-19/migrationhubstrategy-2020-02-19.json rename to models/migrationhubstrategy/service/2020-02-19/migrationhubstrategy-2020-02-19.json diff --git a/mq/service/2017-11-27/mq-2017-11-27.json b/models/mq/service/2017-11-27/mq-2017-11-27.json similarity index 100% rename from mq/service/2017-11-27/mq-2017-11-27.json rename to models/mq/service/2017-11-27/mq-2017-11-27.json diff --git a/mturk/service/2017-01-17/mturk-2017-01-17.json b/models/mturk/service/2017-01-17/mturk-2017-01-17.json similarity index 100% rename from mturk/service/2017-01-17/mturk-2017-01-17.json rename to models/mturk/service/2017-01-17/mturk-2017-01-17.json diff --git a/mwaa/service/2020-07-01/mwaa-2020-07-01.json b/models/mwaa/service/2020-07-01/mwaa-2020-07-01.json similarity index 100% rename from mwaa/service/2020-07-01/mwaa-2020-07-01.json rename to models/mwaa/service/2020-07-01/mwaa-2020-07-01.json diff --git a/neptune-graph/service/2023-11-29/neptune-graph-2023-11-29.json b/models/neptune-graph/service/2023-11-29/neptune-graph-2023-11-29.json similarity index 100% rename from neptune-graph/service/2023-11-29/neptune-graph-2023-11-29.json rename to models/neptune-graph/service/2023-11-29/neptune-graph-2023-11-29.json diff --git a/neptune/service/2014-10-31/neptune-2014-10-31.json b/models/neptune/service/2014-10-31/neptune-2014-10-31.json similarity index 100% rename from neptune/service/2014-10-31/neptune-2014-10-31.json rename to models/neptune/service/2014-10-31/neptune-2014-10-31.json diff --git a/neptunedata/service/2023-08-01/neptunedata-2023-08-01.json b/models/neptunedata/service/2023-08-01/neptunedata-2023-08-01.json similarity index 100% rename from neptunedata/service/2023-08-01/neptunedata-2023-08-01.json rename to models/neptunedata/service/2023-08-01/neptunedata-2023-08-01.json diff --git a/network-firewall/service/2020-11-12/network-firewall-2020-11-12.json b/models/network-firewall/service/2020-11-12/network-firewall-2020-11-12.json similarity index 100% rename from network-firewall/service/2020-11-12/network-firewall-2020-11-12.json rename to models/network-firewall/service/2020-11-12/network-firewall-2020-11-12.json diff --git a/networkflowmonitor/service/2023-04-19/networkflowmonitor-2023-04-19.json b/models/networkflowmonitor/service/2023-04-19/networkflowmonitor-2023-04-19.json similarity index 100% rename from networkflowmonitor/service/2023-04-19/networkflowmonitor-2023-04-19.json rename to models/networkflowmonitor/service/2023-04-19/networkflowmonitor-2023-04-19.json diff --git a/networkmanager/service/2019-07-05/networkmanager-2019-07-05.json b/models/networkmanager/service/2019-07-05/networkmanager-2019-07-05.json similarity index 100% rename from networkmanager/service/2019-07-05/networkmanager-2019-07-05.json rename to models/networkmanager/service/2019-07-05/networkmanager-2019-07-05.json diff --git a/networkmonitor/service/2023-08-01/networkmonitor-2023-08-01.json b/models/networkmonitor/service/2023-08-01/networkmonitor-2023-08-01.json similarity index 100% rename from networkmonitor/service/2023-08-01/networkmonitor-2023-08-01.json rename to models/networkmonitor/service/2023-08-01/networkmonitor-2023-08-01.json diff --git a/notifications/service/2018-05-10/notifications-2018-05-10.json b/models/notifications/service/2018-05-10/notifications-2018-05-10.json similarity index 100% rename from notifications/service/2018-05-10/notifications-2018-05-10.json rename to models/notifications/service/2018-05-10/notifications-2018-05-10.json diff --git a/notificationscontacts/service/2018-05-10/notificationscontacts-2018-05-10.json b/models/notificationscontacts/service/2018-05-10/notificationscontacts-2018-05-10.json similarity index 100% rename from notificationscontacts/service/2018-05-10/notificationscontacts-2018-05-10.json rename to models/notificationscontacts/service/2018-05-10/notificationscontacts-2018-05-10.json diff --git a/oam/service/2022-06-10/oam-2022-06-10.json b/models/oam/service/2022-06-10/oam-2022-06-10.json similarity index 100% rename from oam/service/2022-06-10/oam-2022-06-10.json rename to models/oam/service/2022-06-10/oam-2022-06-10.json diff --git a/observabilityadmin/service/2018-05-10/observabilityadmin-2018-05-10.json b/models/observabilityadmin/service/2018-05-10/observabilityadmin-2018-05-10.json similarity index 100% rename from observabilityadmin/service/2018-05-10/observabilityadmin-2018-05-10.json rename to models/observabilityadmin/service/2018-05-10/observabilityadmin-2018-05-10.json diff --git a/omics/service/2022-11-28/omics-2022-11-28.json b/models/omics/service/2022-11-28/omics-2022-11-28.json similarity index 100% rename from omics/service/2022-11-28/omics-2022-11-28.json rename to models/omics/service/2022-11-28/omics-2022-11-28.json diff --git a/opensearch/service/2021-01-01/opensearch-2021-01-01.json b/models/opensearch/service/2021-01-01/opensearch-2021-01-01.json similarity index 100% rename from opensearch/service/2021-01-01/opensearch-2021-01-01.json rename to models/opensearch/service/2021-01-01/opensearch-2021-01-01.json diff --git a/opensearchserverless/service/2021-11-01/opensearchserverless-2021-11-01.json b/models/opensearchserverless/service/2021-11-01/opensearchserverless-2021-11-01.json similarity index 100% rename from opensearchserverless/service/2021-11-01/opensearchserverless-2021-11-01.json rename to models/opensearchserverless/service/2021-11-01/opensearchserverless-2021-11-01.json diff --git a/opsworks/service/2013-02-18/opsworks-2013-02-18.json b/models/opsworks/service/2013-02-18/opsworks-2013-02-18.json similarity index 100% rename from opsworks/service/2013-02-18/opsworks-2013-02-18.json rename to models/opsworks/service/2013-02-18/opsworks-2013-02-18.json diff --git a/opsworkscm/service/2016-11-01/opsworkscm-2016-11-01.json b/models/opsworkscm/service/2016-11-01/opsworkscm-2016-11-01.json similarity index 100% rename from opsworkscm/service/2016-11-01/opsworkscm-2016-11-01.json rename to models/opsworkscm/service/2016-11-01/opsworkscm-2016-11-01.json diff --git a/organizations/service/2016-11-28/organizations-2016-11-28.json b/models/organizations/service/2016-11-28/organizations-2016-11-28.json similarity index 100% rename from organizations/service/2016-11-28/organizations-2016-11-28.json rename to models/organizations/service/2016-11-28/organizations-2016-11-28.json diff --git a/osis/service/2022-01-01/osis-2022-01-01.json b/models/osis/service/2022-01-01/osis-2022-01-01.json similarity index 100% rename from osis/service/2022-01-01/osis-2022-01-01.json rename to models/osis/service/2022-01-01/osis-2022-01-01.json diff --git a/outposts/service/2019-12-03/outposts-2019-12-03.json b/models/outposts/service/2019-12-03/outposts-2019-12-03.json similarity index 100% rename from outposts/service/2019-12-03/outposts-2019-12-03.json rename to models/outposts/service/2019-12-03/outposts-2019-12-03.json diff --git a/panorama/service/2019-07-24/panorama-2019-07-24.json b/models/panorama/service/2019-07-24/panorama-2019-07-24.json similarity index 100% rename from panorama/service/2019-07-24/panorama-2019-07-24.json rename to models/panorama/service/2019-07-24/panorama-2019-07-24.json diff --git a/partnercentral-selling/service/2022-07-26/partnercentral-selling-2022-07-26.json b/models/partnercentral-selling/service/2022-07-26/partnercentral-selling-2022-07-26.json similarity index 100% rename from partnercentral-selling/service/2022-07-26/partnercentral-selling-2022-07-26.json rename to models/partnercentral-selling/service/2022-07-26/partnercentral-selling-2022-07-26.json diff --git a/payment-cryptography-data/service/2022-02-03/payment-cryptography-data-2022-02-03.json b/models/payment-cryptography-data/service/2022-02-03/payment-cryptography-data-2022-02-03.json similarity index 100% rename from payment-cryptography-data/service/2022-02-03/payment-cryptography-data-2022-02-03.json rename to models/payment-cryptography-data/service/2022-02-03/payment-cryptography-data-2022-02-03.json diff --git a/payment-cryptography/service/2021-09-14/payment-cryptography-2021-09-14.json b/models/payment-cryptography/service/2021-09-14/payment-cryptography-2021-09-14.json similarity index 100% rename from payment-cryptography/service/2021-09-14/payment-cryptography-2021-09-14.json rename to models/payment-cryptography/service/2021-09-14/payment-cryptography-2021-09-14.json diff --git a/pca-connector-ad/service/2018-05-10/pca-connector-ad-2018-05-10.json b/models/pca-connector-ad/service/2018-05-10/pca-connector-ad-2018-05-10.json similarity index 100% rename from pca-connector-ad/service/2018-05-10/pca-connector-ad-2018-05-10.json rename to models/pca-connector-ad/service/2018-05-10/pca-connector-ad-2018-05-10.json diff --git a/pca-connector-scep/service/2018-05-10/pca-connector-scep-2018-05-10.json b/models/pca-connector-scep/service/2018-05-10/pca-connector-scep-2018-05-10.json similarity index 100% rename from pca-connector-scep/service/2018-05-10/pca-connector-scep-2018-05-10.json rename to models/pca-connector-scep/service/2018-05-10/pca-connector-scep-2018-05-10.json diff --git a/pcs/service/2023-02-10/pcs-2023-02-10.json b/models/pcs/service/2023-02-10/pcs-2023-02-10.json similarity index 100% rename from pcs/service/2023-02-10/pcs-2023-02-10.json rename to models/pcs/service/2023-02-10/pcs-2023-02-10.json diff --git a/personalize-events/service/2018-03-22/personalize-events-2018-03-22.json b/models/personalize-events/service/2018-03-22/personalize-events-2018-03-22.json similarity index 100% rename from personalize-events/service/2018-03-22/personalize-events-2018-03-22.json rename to models/personalize-events/service/2018-03-22/personalize-events-2018-03-22.json diff --git a/personalize-runtime/service/2018-05-22/personalize-runtime-2018-05-22.json b/models/personalize-runtime/service/2018-05-22/personalize-runtime-2018-05-22.json similarity index 100% rename from personalize-runtime/service/2018-05-22/personalize-runtime-2018-05-22.json rename to models/personalize-runtime/service/2018-05-22/personalize-runtime-2018-05-22.json diff --git a/personalize/service/2018-05-22/personalize-2018-05-22.json b/models/personalize/service/2018-05-22/personalize-2018-05-22.json similarity index 100% rename from personalize/service/2018-05-22/personalize-2018-05-22.json rename to models/personalize/service/2018-05-22/personalize-2018-05-22.json diff --git a/pi/service/2018-02-27/pi-2018-02-27.json b/models/pi/service/2018-02-27/pi-2018-02-27.json similarity index 100% rename from pi/service/2018-02-27/pi-2018-02-27.json rename to models/pi/service/2018-02-27/pi-2018-02-27.json diff --git a/pinpoint-email/service/2018-07-26/pinpoint-email-2018-07-26.json b/models/pinpoint-email/service/2018-07-26/pinpoint-email-2018-07-26.json similarity index 100% rename from pinpoint-email/service/2018-07-26/pinpoint-email-2018-07-26.json rename to models/pinpoint-email/service/2018-07-26/pinpoint-email-2018-07-26.json diff --git a/pinpoint-sms-voice-v2/service/2022-03-31/pinpoint-sms-voice-v2-2022-03-31.json b/models/pinpoint-sms-voice-v2/service/2022-03-31/pinpoint-sms-voice-v2-2022-03-31.json similarity index 86% rename from pinpoint-sms-voice-v2/service/2022-03-31/pinpoint-sms-voice-v2-2022-03-31.json rename to models/pinpoint-sms-voice-v2/service/2022-03-31/pinpoint-sms-voice-v2-2022-03-31.json index a5cd6816..44a8587c 100644 --- a/pinpoint-sms-voice-v2/service/2022-03-31/pinpoint-sms-voice-v2-2022-03-31.json +++ b/models/pinpoint-sms-voice-v2/service/2022-03-31/pinpoint-sms-voice-v2-2022-03-31.json @@ -15,7 +15,7 @@ } }, "traits": { - "smithy.api#documentation": "The request was denied because you don't have sufficient permissions to access the\n resource.
", + "smithy.api#documentation": "The request was denied because you don't have sufficient permissions to access the resource.
", "smithy.api#error": "client" } }, @@ -195,7 +195,7 @@ } ], "traits": { - "smithy.api#documentation": "Associates the specified origination identity with a pool.
\nIf the origination identity is a phone number and is already associated with another\n pool, an error is returned. A sender ID can be associated with multiple pools.
\nIf the origination identity configuration doesn't match the pool's configuration, an\n error is returned.
" + "smithy.api#documentation": "Associates the specified origination identity with a pool.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
If the origination identity configuration doesn't match the pool's configuration, an error is returned.
" } }, "com.amazonaws.pinpointsmsvoicev2#AssociateOriginationIdentityRequest": { @@ -204,28 +204,28 @@ "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "The pool to update with the new Identity. This value can be either the PoolId or\n PoolArn, and you can find these values using DescribePools.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of\n the origination identity.
", + "smithy.api#documentation": "The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -240,7 +240,7 @@ "PoolArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pool that is now associated with the origination\n identity.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.
" } }, "PoolId": { @@ -264,7 +264,7 @@ "IsoCountryCode": { "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
" + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" } } }, @@ -301,7 +301,7 @@ } ], "traits": { - "smithy.api#documentation": "Associate a protect configuration with a configuration set. This replaces the\n configuration sets current protect configuration. A configuration set can\n only be associated with one protect configuration at a time. A protect configuration can\n be associated with multiple configuration sets.
" + "smithy.api#documentation": "Associate a protect configuration with a configuration set. This replaces the configuration sets current protect configuration. A configuration set can only be associated with one protect configuration at a time. A protect configuration can be associated with multiple configuration sets.
" } }, "com.amazonaws.pinpointsmsvoicev2#AssociateProtectConfigurationRequest": { @@ -431,7 +431,7 @@ "IamRoleArn": { "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management role\n that is able to write event data to an Amazon CloudWatch destination.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.
", "smithy.api#required": {} } }, @@ -444,7 +444,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the destination configuration to use when publishing message sending events.\n
" + "smithy.api#documentation": "Contains the destination configuration to use when publishing message sending events.
" } }, "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetFilter": { @@ -531,14 +531,14 @@ "EventDestinations": { "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationList", "traits": { - "smithy.api#documentation": "An array of EventDestination objects that describe any events to log and where to log\n them.
", + "smithy.api#documentation": "An array of EventDestination objects that describe any events to log and where to log them.
", "smithy.api#required": {} } }, "DefaultMessageType": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
" + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" } }, "DefaultSenderId": { @@ -568,7 +568,7 @@ } }, "traits": { - "smithy.api#documentation": "Information related to a given configuration set in your Amazon Web Services\n account.
" + "smithy.api#documentation": "Information related to a given configuration set in your Amazon Web Services account.
" } }, "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetInformationList": { @@ -634,7 +634,7 @@ } }, "traits": { - "smithy.api#documentation": "Your request has conflicting operations. This can occur if you're trying to perform\n more than one operation on the same resource at the same time or it could be that the\n requested action isn't valid for the current state or configuration of the\n resource.
", + "smithy.api#documentation": "Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
", "smithy.api#error": "client" } }, @@ -852,7 +852,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new configuration set. After you create the configuration set, you can add\n one or more event destinations to it.
\nA configuration set is a set of rules that you apply to the SMS and voice messages\n that you send.
\nWhen you send a message, you can optionally specify a single configuration set.
" + "smithy.api#documentation": "Creates a new configuration set. After you create the configuration set, you can add one or more event destinations to it.
A configuration set is a set of rules that you apply to the SMS and voice messages that you send.
When you send a message, you can optionally specify a single configuration set.
" } }, "com.amazonaws.pinpointsmsvoicev2#CreateConfigurationSetRequest": { @@ -874,7 +874,7 @@ "ClientToken": { "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -901,7 +901,7 @@ "Tags": { "target": "com.amazonaws.pinpointsmsvoicev2#TagList", "traits": { - "smithy.api#documentation": "An array of key and value pair tags that's associated with the configuration\n set.
" + "smithy.api#documentation": "An array of key and value pair tags that's associated with the configuration set.
" } }, "CreatedTimestamp": { @@ -947,7 +947,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new event destination in a configuration set.
\nAn event destination is a location where you send message events. The event options\n are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example,\n when a message is delivered successfully, you can send information about that event to\n an event destination, or send notifications to endpoints that are subscribed to an\n Amazon SNS topic.
\nEach configuration set can contain between 0 and 5 event destinations. Each event\n destination can contain a reference to a single destination, such as a CloudWatch\n or Firehose destination.
" + "smithy.api#documentation": "Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event options are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example, when a message is delivered successfully, you can send information about that event to an event destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
You can only create one event destination at a time. You must provide a value for a single event destination using either CloudWatchLogsDestination, KinesisFirehoseDestination or SnsDestination. If an event destination isn't provided then an exception is returned.
Each configuration set can contain between 0 and 5 event destinations. Each event destination can contain a reference to a single destination, such as a CloudWatch or Firehose destination.
" } }, "com.amazonaws.pinpointsmsvoicev2#CreateEventDestinationRequest": { @@ -956,7 +956,7 @@ "ConfigurationSetName": { "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "Either the name of the configuration set or the configuration set ARN to apply event\n logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
", + "smithy.api#documentation": "Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
", "smithy.api#required": {} } }, @@ -970,7 +970,7 @@ "MatchingEventTypes": { "target": "com.amazonaws.pinpointsmsvoicev2#EventTypeList", "traits": { - "smithy.api#documentation": "An array of event types that determine which events to log. If \"ALL\" is used, then\n AWS End User Messaging SMS and Voice logs every event type.
\nThe TEXT_SENT event type is not supported.
An array of event types that determine which events to log. If \"ALL\" is used, then AWS End User Messaging SMS and Voice logs every event type.
The TEXT_SENT event type is not supported.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -1059,7 +1059,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new opt-out list.
\nIf the opt-out list name already exists, an error is returned.
\nAn opt-out list is a list of phone numbers that are opted out, meaning you can't send\n SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for\n the phone number is added to the opt-out list. In addition to STOP, your recipients can\n use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported\n opt-out keywords, see \n SMS opt out in the AWS End User Messaging SMS User Guide.
" + "smithy.api#documentation": "Creates a new opt-out list.
If the opt-out list name already exists, an error is returned.
An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword \"STOP,\" an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the AWS End User Messaging SMS User Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#CreateOptOutListRequest": { @@ -1081,7 +1081,7 @@ "ClientToken": { "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -1154,7 +1154,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new pool and associates the specified origination identity to the pool. A\n pool can include one or more phone numbers and SenderIds that are associated with your\n Amazon Web Services account.
\nThe new pool inherits its configuration from the specified origination identity. This\n includes keywords, message type, opt-out list, two-way configuration, and self-managed\n opt-out configuration. Deletion protection isn't inherited from the origination identity\n and defaults to false.
\nIf the origination identity is a phone number and is already associated with another\n pool, an error is returned. A sender ID can be associated with multiple pools.
" + "smithy.api#documentation": "Creates a new pool and associates the specified origination identity to the pool. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn't inherited from the origination identity and defaults to false.
If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.
" } }, "com.amazonaws.pinpointsmsvoicev2#CreatePoolRequest": { @@ -1163,28 +1163,28 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrSenderIdOrArn", "traits": { - "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
\nAfter the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of\n the new pool.
", + "smithy.api#documentation": "The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
", "smithy.api#required": {} } }, "MessageType": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive. After the pool is created the MessageType can't be changed.
", + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. After the pool is created the MessageType can't be changed.
", "smithy.api#required": {} } }, "DeletionProtectionEnabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "By default this is set to false. When set to true the pool can't be deleted. You can\n change this value using the UpdatePool action.
" + "smithy.api#documentation": "By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.
" } }, "Tags": { @@ -1196,7 +1196,7 @@ "ClientToken": { "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -1223,7 +1223,7 @@ "Status": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolStatus", "traits": { - "smithy.api#documentation": "The current status of the pool.
\nCREATING: The pool is currently being created and isn't yet available for\n use.
\nACTIVE: The pool is active and available for use.
\nDELETING: The pool is being deleted.
\nThe current status of the pool.
CREATING: The pool is currently being created and isn't yet available for use.
ACTIVE: The pool is active and available for use.
DELETING: The pool is being deleted.
By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" } }, "TwoWayChannelArn": { @@ -1255,7 +1255,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" } }, "OptOutListName": { @@ -1275,7 +1275,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "When set to true deletion protection is enabled. By default this is set to false.\n
" + "smithy.api#documentation": "When set to true deletion protection is enabled. By default this is set to false.
" } }, "Tags": { @@ -1307,6 +1307,9 @@ { "target": "com.amazonaws.pinpointsmsvoicev2#AccessDeniedException" }, + { + "target": "com.amazonaws.pinpointsmsvoicev2#ConflictException" + }, { "target": "com.amazonaws.pinpointsmsvoicev2#InternalServerException" }, @@ -1330,14 +1333,14 @@ "ClientToken": { "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } }, "DeletionProtectionEnabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "When set to true deletion protection is enabled. By default this is set to false.\n
" + "smithy.api#documentation": "When set to true deletion protection is enabled. By default this is set to false.
" } }, "Tags": { @@ -1387,7 +1390,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "When set to true deletion protection is enabled. By default this is set to false.\n
", + "smithy.api#documentation": "When set to true deletion protection is enabled. By default this is set to false.
", "smithy.api#required": {} } }, @@ -1511,7 +1514,7 @@ "RegistrationType": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", "traits": { - "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "smithy.api#required": {} } }, @@ -1582,7 +1585,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a new registration attachment to use for uploading a file or a URL to a file.\n The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG. For\n example, many sender ID registrations require a signed \u201cletter of authorization\u201d (LOA)\n to be submitted.
\nUse either AttachmentUrl or AttachmentBody to upload your attachment. If both are specified then an exception is returned.
Create a new registration attachment to use for uploading a file or a URL to a file. The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG. For example, many sender ID registrations require a signed \u201cletter of authorization\u201d (LOA) to be submitted.
Use either AttachmentUrl or AttachmentBody to upload your attachment. If both are specified then an exception is returned.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -1638,7 +1641,7 @@ "AttachmentStatus": { "target": "com.amazonaws.pinpointsmsvoicev2#AttachmentStatus", "traits": { - "smithy.api#documentation": "The status of the registration attachment.
\n\n UPLOAD_IN_PROGRESS The attachment is being uploaded.
\n UPLOAD_COMPLETE The attachment has been uploaded.
\n UPLOAD_FAILED The attachment failed to uploaded.
\n DELETED The attachment has been deleted..
The status of the registration attachment.
UPLOAD_IN_PROGRESS The attachment is being uploaded.
UPLOAD_COMPLETE The attachment has been uploaded.
UPLOAD_FAILED The attachment failed to uploaded.
DELETED The attachment has been deleted..
The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#documentation": "The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "smithy.api#required": {} } }, @@ -1679,7 +1682,7 @@ "ClientToken": { "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -1708,14 +1711,14 @@ "RegistrationType": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", "traits": { - "smithy.api#documentation": "The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#documentation": "The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "smithy.api#required": {} } }, "RegistrationStatus": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationStatus", "traits": { - "smithy.api#documentation": "The status of the registration.
\n\n CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
\n CREATED: Your registration is created but not submitted.
\n COMPLETE: Your registration has been approved and your origination identity has been created.
\n DELETED: The registration has been deleted.
\n PROVISIONING: Your registration has been approved and your origination identity is being created.
\n REQUIRES_AUTHENTICATION: You need to complete email authentication.
\n REQUIRES_UPDATES: You must fix your registration and resubmit it.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n SUBMITTED: Your registration has been submitted and is awaiting review.
The status of the registration.
CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
CREATED: Your registration is created but not submitted.
COMPLETE: Your registration has been approved and your origination identity has been created.
DELETED: The registration has been deleted.
PROVISIONING: Your registration has been approved and your origination identity is being created.
REQUIRES_AUTHENTICATION: You need to complete email authentication.
REQUIRES_UPDATES: You must fix your registration and resubmit it.
REVIEWING: Your registration has been accepted and is being reviewed.
SUBMITTED: Your registration has been submitted and is awaiting review.
The status of the registration.
\n\n APPROVED: Your registration has been approved.
\n ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
\n DENIED: You must fix your registration and resubmit it.
\n DISCARDED: You've abandon this version of their registration to start over with a new version.
\n DRAFT: The initial status of a registration version after it\u2019s created.
\n REQUIRES_AUTHENTICATION: You need to complete email authentication.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n REVOKED: Your previously approved registration has been revoked.
\n SUBMITTED: Your registration has been submitted.
The status of the registration.
APPROVED: Your registration has been approved.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
DENIED: You must fix your registration and resubmit it.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DRAFT: The initial status of a registration version after it\u2019s created.
REQUIRES_AUTHENTICATION: You need to complete email authentication.
REVIEWING: Your registration has been accepted and is being reviewed.
REVOKED: Your previously approved registration has been revoked.
SUBMITTED: Your registration has been submitted.
You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination\n numbers.
" + "smithy.api#documentation": "You can only send messages to verified destination numbers when your account is in the sandbox. You can add up to 10 verified destination numbers.
" } }, "com.amazonaws.pinpointsmsvoicev2#CreateVerifiedDestinationNumberRequest": { @@ -1894,7 +1897,7 @@ "ClientToken": { "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -1930,7 +1933,7 @@ "Status": { "target": "com.amazonaws.pinpointsmsvoicev2#VerificationStatus", "traits": { - "smithy.api#documentation": "The status of the verified destination phone number.
\n\n PENDING: The phone number hasn't been verified yet.
\n VERIFIED: The phone number is verified and can receive messages.
The status of the verified destination phone number.
PENDING: The phone number hasn't been verified yet.
VERIFIED: The phone number is verified and can receive messages.
Deletes an existing configuration set.
\nA configuration set is a set of rules that you apply to voice and SMS messages that\n you send. In a configuration set, you can specify a destination for specific types of\n events related to voice and SMS messages.
" + "smithy.api#documentation": "Deletes an existing configuration set.
A configuration set is a set of rules that you apply to voice and SMS messages that you send. In a configuration set, you can specify a destination for specific types of events related to voice and SMS messages.
" } }, "com.amazonaws.pinpointsmsvoicev2#DeleteConfigurationSetRequest": { @@ -2045,7 +2048,7 @@ "ConfigurationSetName": { "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The name of the configuration set or the configuration set ARN that you want to\n delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
", + "smithy.api#documentation": "The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
", "smithy.api#required": {} } } @@ -2072,7 +2075,7 @@ "EventDestinations": { "target": "com.amazonaws.pinpointsmsvoicev2#EventDestinationList", "traits": { - "smithy.api#documentation": "An array of any EventDestination objects that were associated with the deleted\n configuration set.
" + "smithy.api#documentation": "An array of any EventDestination objects that were associated with the deleted configuration set.
" } }, "DefaultMessageType": { @@ -2130,7 +2133,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing default message type on a configuration set.
\nA message type is a type of messages that you plan to send. If you send\n account-related messages or time-sensitive messages such as one-time passcodes, choose\n Transactional. If you plan to send messages that\n contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services\n account.
" + "smithy.api#documentation": "Deletes an existing default message type on a configuration set.
A message type is a type of messages that you plan to send. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
" } }, "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultMessageTypeRequest": { @@ -2139,7 +2142,7 @@ "ConfigurationSetName": { "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN)\n to delete the default message type from. The ConfigurationSetName and\n ConfigurationSetArn can be found using the DescribeConfigurationSets\n action.
", + "smithy.api#documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default message type from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
", "smithy.api#required": {} } } @@ -2200,7 +2203,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing default sender ID on a configuration set.
\nA default sender ID is the identity that appears on recipients' devices when they\n receive SMS messages. Support for sender ID capabilities varies by country or\n region.
" + "smithy.api#documentation": "Deletes an existing default sender ID on a configuration set.
A default sender ID is the identity that appears on recipients' devices when they receive SMS messages. Support for sender ID capabilities varies by country or region.
" } }, "com.amazonaws.pinpointsmsvoicev2#DeleteDefaultSenderIdRequest": { @@ -2209,7 +2212,7 @@ "ConfigurationSetName": { "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN)\n to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn\n can be found using the DescribeConfigurationSets action.
", + "smithy.api#documentation": "The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
", "smithy.api#required": {} } } @@ -2270,7 +2273,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing event destination.
\nAn event destination is a location where you send response information about the\n messages that you send. For example, when a message is delivered successfully, you can\n send information about that event to an Amazon CloudWatch destination, or send\n notifications to endpoints that are subscribed to an Amazon SNS topic.
" + "smithy.api#documentation": "Deletes an existing event destination.
An event destination is a location where you send response information about the messages that you send. For example, when a message is delivered successfully, you can send information about that event to an Amazon CloudWatch destination, or send notifications to endpoints that are subscribed to an Amazon SNS topic.
" } }, "com.amazonaws.pinpointsmsvoicev2#DeleteEventDestinationRequest": { @@ -2279,7 +2282,7 @@ "ConfigurationSetName": { "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The name of the configuration set or the configuration set's Amazon Resource Name\n (ARN) to remove the event destination from. The ConfigurateSetName and\n ConfigurationSetArn can be found using the DescribeConfigurationSets\n action.
", + "smithy.api#documentation": "The name of the configuration set or the configuration set's Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
", "smithy.api#required": {} } }, @@ -2350,7 +2353,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing keyword from an origination phone number or pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable\n message.
\nKeywords \"HELP\" and \"STOP\" can't be deleted or modified.
" + "smithy.api#documentation": "Deletes an existing keyword from an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
Keywords \"HELP\" and \"STOP\" can't be deleted or modified.
" } }, "com.amazonaws.pinpointsmsvoicev2#DeleteKeywordRequest": { @@ -2359,7 +2362,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", "traits": { - "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or\n PoolArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn and DescribePools to find the values\n of PoolId and PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Deletes an account-level monthly spending limit override for sending multimedia messages (MMS).\n Deleting a spend limit override will set the EnforcedLimit to equal the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spend limits (quotas) see Quotas for Server Migration Service\n in the Server Migration Service User Guide.
Deletes an account-level monthly spending limit override for sending multimedia messages (MMS). Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Quotas for Server Migration Service in the Server Migration Service User Guide.
Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are\n deleted.
\nIf the specified opt-out list name doesn't exist or is in-use by an origination phone\n number or pool, an error is returned.
" + "smithy.api#documentation": "Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.
If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned.
" } }, "com.amazonaws.pinpointsmsvoicev2#DeleteOptOutListRequest": { @@ -2498,7 +2501,7 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Deletes an existing opted out destination phone number from the specified opt-out\n list.
\nEach destination phone number can only be deleted once every 30 days.
\nIf the specified destination phone number doesn't exist or if the opt-out list doesn't\n exist, an error is returned.
" + "smithy.api#documentation": "Deletes an existing opted out destination phone number from the specified opt-out list.
Each destination phone number can only be deleted once every 30 days.
If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.
" } }, "com.amazonaws.pinpointsmsvoicev2#DeleteOptedOutNumberRequest": { @@ -2571,7 +2574,7 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "The OptOutListName or OptOutListArn to remove the phone number from.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe OptOutListName or OptOutListArn to remove the phone number from.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
This is true if it was the end user who requested their phone number be removed.\n
" + "smithy.api#documentation": "This is true if it was the end user who requested their phone number be removed.
" } } }, @@ -2655,7 +2658,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing pool. Deleting a pool disassociates all origination identities\n from that pool.
\nIf the pool status isn't active or if deletion protection is enabled, an error is\n returned.
\nA pool is a collection of phone numbers and SenderIds. A pool can include one or more\n phone numbers and SenderIds that are associated with your Amazon Web Services\n account.
" + "smithy.api#documentation": "Deletes an existing pool. Deleting a pool disassociates all origination identities from that pool.
If the pool status isn't active or if deletion protection is enabled, an error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
" } }, "com.amazonaws.pinpointsmsvoicev2#DeletePoolRequest": { @@ -2664,7 +2667,7 @@ "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The current status of the pool.
\nCREATING: The pool is currently being created and isn't yet available for\n use.
\nACTIVE: The pool is active and available for use.
\nDELETING: The pool is being deleted.
\nThe current status of the pool.
CREATING: The pool is currently being created and isn't yet available for use.
ACTIVE: The pool is active and available for use.
DELETING: The pool is being deleted.
By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" } }, "TwoWayChannelArn": { @@ -2723,7 +2726,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" } }, "OptOutListName": { @@ -2833,7 +2836,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.\n
", + "smithy.api#documentation": "The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
", "smithy.api#required": {} } } @@ -3047,7 +3050,7 @@ "AttachmentStatus": { "target": "com.amazonaws.pinpointsmsvoicev2#AttachmentStatus", "traits": { - "smithy.api#documentation": "The status of the registration attachment.
\n\n UPLOAD_IN_PROGRESS The attachment is being uploaded.
\n UPLOAD_COMPLETE The attachment has been uploaded.
\n UPLOAD_FAILED The attachment failed to uploaded.
\n DELETED The attachment has been deleted..
The status of the registration attachment.
UPLOAD_IN_PROGRESS The attachment is being uploaded.
UPLOAD_COMPLETE The attachment has been uploaded.
UPLOAD_FAILED The attachment failed to uploaded.
DELETED The attachment has been deleted..
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "smithy.api#required": {} } }, "RegistrationStatus": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationStatus", "traits": { - "smithy.api#documentation": "The status of the registration.
\n\n CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
\n CREATED: Your registration is created but not submitted.
\n COMPLETE: Your registration has been approved and your origination identity has been created.
\n DELETED: The registration has been deleted.
\n PROVISIONING: Your registration has been approved and your origination identity is being created.
\n REQUIRES_AUTHENTICATION: You need to complete email authentication.
\n REQUIRES_UPDATES: You must fix your registration and resubmit it.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n SUBMITTED: Your registration has been submitted and is awaiting review.
The status of the registration.
CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
CREATED: Your registration is created but not submitted.
COMPLETE: Your registration has been approved and your origination identity has been created.
DELETED: The registration has been deleted.
PROVISIONING: Your registration has been approved and your origination identity is being created.
REQUIRES_AUTHENTICATION: You need to complete email authentication.
REQUIRES_UPDATES: You must fix your registration and resubmit it.
REVIEWING: Your registration has been accepted and is being reviewed.
SUBMITTED: Your registration has been submitted and is awaiting review.
Deletes an account-level monthly spending limit override for sending text messages.\n Deleting a spend limit override will set the EnforcedLimit to equal the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spend limits (quotas) see Quotas \n in the AWS End User Messaging SMS User Guide.
Deletes an account-level monthly spending limit override for sending text messages. Deleting a spend limit override will set the EnforcedLimit to equal the MaxLimit, which is controlled by Amazon Web Services. For more information on spend limits (quotas) see Quotas in the AWS End User Messaging SMS User Guide.
Deletes an account level monthly spend limit override for sending voice messages.\n Deleting a spend limit override sets the EnforcedLimit equal to the\n MaxLimit, which is controlled by Amazon Web Services. For more\n information on spending limits (quotas) see Quotas \n in the AWS End User Messaging SMS User Guide.
Deletes an account level monthly spend limit override for sending voice messages. Deleting a spend limit override sets the EnforcedLimit equal to the MaxLimit, which is controlled by Amazon Web Services. For more information on spending limits (quotas) see Quotas in the AWS End User Messaging SMS User Guide.
Describes attributes of your Amazon Web Services account. The supported account\n attributes include account tier, which indicates whether your account is in the sandbox\n or production environment. When you're ready to move your account out of the sandbox,\n create an Amazon Web Services Support case for a service limit increase request.
\nNew accounts are placed into an SMS or voice sandbox. The sandbox\n protects both Amazon Web Services end recipients and SMS or voice recipients from fraud\n and abuse.
", + "smithy.api#documentation": "Describes attributes of your Amazon Web Services account. The supported account attributes include account tier, which indicates whether your account is in the sandbox or production environment. When you're ready to move your account out of the sandbox, create an Amazon Web Services Support case for a service limit increase request.
New accounts are placed into an SMS or voice sandbox. The sandbox protects both Amazon Web Services end recipients and SMS or voice recipients from fraud and abuse.
", "smithy.api#paginated": { "items": "AccountAttributes" } @@ -3552,7 +3555,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -3578,7 +3581,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" } } }, @@ -3609,7 +3612,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the current AWS End User Messaging SMS and Voice SMS Voice V2 resource quotas for your\n account. The description for a quota includes the quota name, current usage toward that\n quota, and the quota's maximum value.
\nWhen you establish an Amazon Web Services account, the account has initial quotas on\n the maximum number of configuration sets, opt-out lists, phone numbers, and pools that\n you can create in a given Region. For more information see Quotas \n in the AWS End User Messaging SMS User Guide.
", + "smithy.api#documentation": "Describes the current AWS End User Messaging SMS and Voice SMS Voice V2 resource quotas for your account. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of configuration sets, opt-out lists, phone numbers, and pools that you can create in a given Region. For more information see Quotas in the AWS End User Messaging SMS User Guide.
", "smithy.api#paginated": { "items": "AccountLimits" } @@ -3621,7 +3624,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -3647,7 +3650,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" } } }, @@ -3681,7 +3684,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified configuration sets or all in your account.
\nIf you specify configuration set names, the output includes information for only the\n specified configuration sets. If you specify filters, the output includes information\n for only those configuration sets that meet the filter criteria. If you don't specify\n configuration set names or filters, the output includes information for all\n configuration sets.
\nIf you specify a configuration set name that isn't valid, an error is returned.
", + "smithy.api#documentation": "Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only the specified configuration sets. If you specify filters, the output includes information for only those configuration sets that meet the filter criteria. If you don't specify configuration set names or filters, the output includes information for all configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
", "smithy.api#paginated": { "items": "ConfigurationSets" } @@ -3693,7 +3696,7 @@ "ConfigurationSetNames": { "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameList", "traits": { - "smithy.api#documentation": "An array of strings. Each element can be either a ConfigurationSetName or\n ConfigurationSetArn.
" + "smithy.api#documentation": "An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.
" } }, "Filters": { @@ -3705,7 +3708,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -3731,7 +3734,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" } } }, @@ -3765,7 +3768,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified keywords or all keywords on your origination phone number or\n pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable\n message.
\nIf you specify a keyword that isn't valid, an error is returned.
", + "smithy.api#documentation": "Describes the specified keywords or all keywords on your origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
", "smithy.api#paginated": { "items": "Keywords" } @@ -3777,7 +3780,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", "traits": { - "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers to find the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -3834,7 +3837,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" } } }, @@ -3868,7 +3871,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified opt-out list or all opt-out lists in your account.
\nIf you specify opt-out list names, the output includes information for only the\n specified opt-out lists. Opt-out lists include only those that meet the filter criteria.\n If you don't specify opt-out list names or filters, the output includes information for\n all opt-out lists.
\nIf you specify an opt-out list name that isn't valid, an error is returned.
", + "smithy.api#documentation": "Describes the specified opt-out list or all opt-out lists in your account.
If you specify opt-out list names, the output includes information for only the specified opt-out lists. Opt-out lists include only those that meet the filter criteria. If you don't specify opt-out list names or filters, the output includes information for all opt-out lists.
If you specify an opt-out list name that isn't valid, an error is returned.
", "smithy.api#paginated": { "items": "OptOutLists" } @@ -3880,13 +3883,13 @@ "OptOutListNames": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameList", "traits": { - "smithy.api#documentation": "The OptOutLists to show the details of. This is an array of strings that can be either\n the OptOutListName or OptOutListArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -3912,13 +3915,13 @@ "OptOutLists": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListInformationList", "traits": { - "smithy.api#documentation": "An array of OptOutListInformation objects that contain the details for the requested\n OptOutLists.
" + "smithy.api#documentation": "An array of OptOutListInformation objects that contain the details for the requested OptOutLists.
" } }, "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" } } }, @@ -3952,7 +3955,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified opted out destination numbers or all opted out destination\n numbers in an opt-out list.
\nIf you specify opted out numbers, the output includes information for only the\n specified opted out numbers. If you specify filters, the output includes information for\n only those opted out numbers that meet the filter criteria. If you don't specify opted\n out numbers or filters, the output includes information for all opted out destination\n numbers in your opt-out list.
\nIf you specify an opted out number that isn't valid, an exception is returned.
", + "smithy.api#documentation": "Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.
If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.
If you specify an opted out number that isn't valid, an exception is returned.
", "smithy.api#paginated": { "items": "OptedOutNumbers" } @@ -3964,14 +3967,14 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and\n OptOutListArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
An array of phone numbers to search for in the OptOutList.
\nIf you specify an opted out number that isn't valid, an exception is returned.
" + "smithy.api#documentation": "An array of phone numbers to search for in the OptOutList.
If you specify an opted out number that isn't valid, an exception is returned.
" } }, "Filters": { @@ -3983,7 +3986,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -4015,13 +4018,13 @@ "OptedOutNumbers": { "target": "com.amazonaws.pinpointsmsvoicev2#OptedOutNumberInformationList", "traits": { - "smithy.api#documentation": "An array of OptedOutNumbersInformation objects that provide information about the\n requested OptedOutNumbers.
" + "smithy.api#documentation": "An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
" } }, "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" } } }, @@ -4055,7 +4058,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified origination phone number, or all the phone numbers in your\n account.
\nIf you specify phone number IDs, the output includes information for only the\n specified phone numbers. If you specify filters, the output includes information for\n only those phone numbers that meet the filter criteria. If you don't specify phone\n number IDs or filters, the output includes information for all phone numbers.
\nIf you specify a phone number ID that isn't valid, an error is returned.
", + "smithy.api#documentation": "Describes the specified origination phone number, or all the phone numbers in your account.
If you specify phone number IDs, the output includes information for only the specified phone numbers. If you specify filters, the output includes information for only those phone numbers that meet the filter criteria. If you don't specify phone number IDs or filters, the output includes information for all phone numbers.
If you specify a phone number ID that isn't valid, an error is returned.
", "smithy.api#paginated": { "items": "PhoneNumbers" } @@ -4067,7 +4070,7 @@ "PhoneNumberIds": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdList", "traits": { - "smithy.api#documentation": "The unique identifier of phone numbers to find information about. This is an array of\n strings that can be either the PhoneNumberId or PhoneNumberArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -4105,13 +4108,13 @@ "PhoneNumbers": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberInformationList", "traits": { - "smithy.api#documentation": "An array of PhoneNumberInformation objects that contain the details for the requested\n phone numbers.
" + "smithy.api#documentation": "An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.
" } }, "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" } } }, @@ -4145,7 +4148,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the specified pools or all pools associated with your Amazon Web Services\n account.
\nIf you specify pool IDs, the output includes information for only the specified pools.\n If you specify filters, the output includes information for only those pools that meet\n the filter criteria. If you don't specify pool IDs or filters, the output includes\n information for all pools.
\nIf you specify a pool ID that isn't valid, an error is returned.
\nA pool is a collection of phone numbers and SenderIds. A pool can include one or more\n phone numbers and SenderIds that are associated with your Amazon Web Services\n account.
", + "smithy.api#documentation": "Retrieves the specified pools or all pools associated with your Amazon Web Services account.
If you specify pool IDs, the output includes information for only the specified pools. If you specify filters, the output includes information for only those pools that meet the filter criteria. If you don't specify pool IDs or filters, the output includes information for all pools.
If you specify a pool ID that isn't valid, an error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.
", "smithy.api#paginated": { "items": "Pools" } @@ -4157,7 +4160,7 @@ "PoolIds": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdList", "traits": { - "smithy.api#documentation": "The unique identifier of pools to find. This is an array of strings that can be either\n the PoolId or PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -4201,7 +4204,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" } } }, @@ -4259,7 +4262,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -4285,7 +4288,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, @@ -4343,7 +4346,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -4370,7 +4373,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, @@ -4413,7 +4416,7 @@ "RegistrationType": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", "traits": { - "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "smithy.api#required": {} } }, @@ -4432,7 +4435,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -4452,7 +4455,7 @@ "RegistrationType": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", "traits": { - "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "smithy.api#required": {} } }, @@ -4466,7 +4469,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, @@ -4537,7 +4540,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -4585,7 +4588,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, @@ -4628,7 +4631,7 @@ "RegistrationType": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", "traits": { - "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "smithy.api#required": {} } }, @@ -4641,7 +4644,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -4661,21 +4664,21 @@ "RegistrationType": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", "traits": { - "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "smithy.api#required": {} } }, "RegistrationSectionDefinitions": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationSectionDefinitionList", "traits": { - "smithy.api#documentation": "An array of RegistrationSectionDefinition objects.
", + "smithy.api#documentation": "An array of RegistrationSectionDefinition objects.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, @@ -4718,7 +4721,7 @@ "RegistrationTypes": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeList", "traits": { - "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
" + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
" } }, "Filters": { @@ -4730,7 +4733,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -4750,14 +4753,14 @@ "RegistrationTypeDefinitions": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationTypeDefinitionList", "traits": { - "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, @@ -4822,7 +4825,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -4863,7 +4866,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, @@ -4921,7 +4924,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -4948,7 +4951,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, @@ -4982,7 +4985,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
\nIf you specify SenderIds, the output includes information for only the specified\n SenderIds. If you specify filters, the output includes information for only those\n SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the\n output includes information for all SenderIds.
\nf you specify a sender ID that isn't valid, an error is returned.
", + "smithy.api#documentation": "Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.
If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.
f you specify a sender ID that isn't valid, an error is returned.
", "smithy.api#paginated": { "items": "SenderIds" } @@ -4994,7 +4997,7 @@ "SenderIds": { "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdList", "traits": { - "smithy.api#documentation": "An array of SenderIdAndCountry objects to search for.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nAn array of SenderIdAndCountry objects to search for.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -5032,13 +5035,13 @@ "SenderIds": { "target": "com.amazonaws.pinpointsmsvoicev2#SenderIdInformationList", "traits": { - "smithy.api#documentation": "An array of SernderIdInformation objects that contain the details for the requested\n SenderIds.
" + "smithy.api#documentation": "An array of SernderIdInformation objects that contain the details for the requested SenderIds.
" } }, "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" } } }, @@ -5069,7 +5072,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the current monthly spend limits for sending voice and\n text messages.
\nWhen you establish an Amazon Web Services account, the account has initial monthly\n spend limit in a given Region. For more information on increasing your monthly spend\n limit, see \n Requesting increases to your monthly SMS, MMS, or Voice spending quota\n in the AWS End User Messaging SMS User Guide.
", + "smithy.api#documentation": "Describes the current monthly spend limits for sending voice and text messages.
When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS, MMS, or Voice spending quota in the AWS End User Messaging SMS User Guide.
", "smithy.api#paginated": { "items": "SpendLimits" } @@ -5081,7 +5084,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -5101,13 +5104,13 @@ "SpendLimits": { "target": "com.amazonaws.pinpointsmsvoicev2#SpendLimitList", "traits": { - "smithy.api#documentation": "An array of SpendLimit objects that contain the details for the requested spend\n limits.
" + "smithy.api#documentation": "An array of SpendLimit objects that contain the details for the requested spend limits.
" } }, "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" } } }, @@ -5171,7 +5174,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -5198,7 +5201,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, @@ -5285,7 +5288,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specified origination identity from an existing pool.
\nIf the origination identity isn't associated with the specified pool, an error is\n returned.
" + "smithy.api#documentation": "Removes the specified origination identity from an existing pool.
If the origination identity isn't associated with the specified pool, an error is returned.
" } }, "com.amazonaws.pinpointsmsvoicev2#DisassociateOriginationIdentityRequest": { @@ -5294,28 +5297,28 @@ "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "The unique identifier for the pool to disassociate with the origination identity. This\n value can be either the PoolId or PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers find the values for\n PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the\n values for SenderId and SenderIdArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -5354,7 +5357,7 @@ "IsoCountryCode": { "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or\n region.
" + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" } } }, @@ -5526,7 +5529,7 @@ "RegistrationVersionStatus": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus", "traits": { - "smithy.api#documentation": "The status of the registration version.
\n\n APPROVED: Your registration has been approved.
\n ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
\n DENIED: You must fix your registration and resubmit it.
\n DISCARDED: You've abandon this version of their registration to start over with a new version.
\n DRAFT: The initial status of a registration version after it\u2019s created.
\n REQUIRES_AUTHENTICATION: You need to complete email authentication.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n REVOKED: Your previously approved registration has been revoked.
\n SUBMITTED: Your registration has been submitted.
The status of the registration version.
APPROVED: Your registration has been approved.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
DENIED: You must fix your registration and resubmit it.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DRAFT: The initial status of a registration version after it\u2019s created.
REQUIRES_AUTHENTICATION: You need to complete email authentication.
REVIEWING: Your registration has been accepted and is being reviewed.
REVOKED: Your previously approved registration has been revoked.
SUBMITTED: Your registration has been submitted.
An array of event types that determine which events to log.
\nThe TEXT_SENT event type is not supported.
An array of event types that determine which events to log.
The TEXT_SENT event type is not supported.
An object that contains information about an event destination that sends logging\n events to Amazon CloudWatch logs.
" + "smithy.api#documentation": "An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
" } }, "KinesisFirehoseDestination": { @@ -5581,12 +5584,12 @@ "SnsDestination": { "target": "com.amazonaws.pinpointsmsvoicev2#SnsDestination", "traits": { - "smithy.api#documentation": "An object that contains information about an event destination that sends logging\n events to Amazon SNS.
" + "smithy.api#documentation": "An object that contains information about an event destination that sends logging events to Amazon SNS.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about an event destination.
\nEvent destinations are associated with configuration sets, which enable you to publish\n message sending events to CloudWatch, Firehose, or Amazon SNS.
" + "smithy.api#documentation": "Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Firehose, or Amazon SNS.
" } }, "com.amazonaws.pinpointsmsvoicev2#EventDestinationList": { @@ -5955,7 +5958,7 @@ "CountryRuleSet": { "target": "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationCountryRuleSet", "traits": { - "smithy.api#documentation": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the\n details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.
", + "smithy.api#documentation": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.
", "smithy.api#required": {} } } @@ -6058,7 +6061,7 @@ } }, "traits": { - "smithy.api#documentation": "The API encountered an unexpected error and couldn't complete the request. You might\n be able to successfully issue the request again in the future.
", + "smithy.api#documentation": "The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
", "smithy.api#error": "server", "smithy.api#retryable": {} } @@ -6208,7 +6211,7 @@ "IamRoleArn": { "target": "com.amazonaws.pinpointsmsvoicev2#IamRoleArn", "traits": { - "smithy.api#documentation": "The ARN of an Identity and Access Management role that is able to write\n event data to an Amazon Data Firehose destination.
", + "smithy.api#documentation": "The ARN of an Identity and Access Management role that is able to write event data to an Amazon Data Firehose destination.
", "smithy.api#required": {} } }, @@ -6221,7 +6224,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with a Firehose event\n destination.
\nEvent destinations, such as Firehose, are associated with configuration\n sets, which enable you to publish message sending events.
" + "smithy.api#documentation": "Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with a Firehose event destination.
Event destinations, such as Firehose, are associated with configuration sets, which enable you to publish message sending events.
" } }, "com.amazonaws.pinpointsmsvoicev2#LanguageCode": { @@ -6309,7 +6312,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all associated origination identities in your pool.
\nIf you specify filters, the output includes information for only those origination\n identities that meet the filter criteria.
", + "smithy.api#documentation": "Lists all associated origination identities in your pool.
If you specify filters, the output includes information for only those origination identities that meet the filter criteria.
", "smithy.api#paginated": { "items": "OriginationIdentities" } @@ -6321,7 +6324,7 @@ "PoolId": { "target": "com.amazonaws.pinpointsmsvoicev2#PoolIdOrArn", "traits": { - "smithy.api#documentation": "The unique identifier for the pool. This value can be either the PoolId or\n PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe unique identifier for the pool. This value can be either the PoolId or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -6372,7 +6375,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty\n then there are no more results.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. If this field is empty then there are no more results.
" } } }, @@ -6443,7 +6446,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -6483,7 +6486,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, @@ -6542,7 +6545,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } }, "MaxResults": { @@ -6576,7 +6579,7 @@ "RegistrationType": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationType", "traits": { - "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "smithy.api#required": {} } }, @@ -6590,7 +6593,7 @@ "NextToken": { "target": "com.amazonaws.pinpointsmsvoicev2#NextToken", "traits": { - "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a\n value for this field in the initial request.
" + "smithy.api#documentation": "The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
" } } }, @@ -7067,14 +7070,14 @@ "IsoCountryCode": { "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "smithy.api#required": {} } }, "NumberCapabilities": { "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", "traits": { - "smithy.api#documentation": "Describes if the origination identity can be used for text messages, voice calls or\n both.
", + "smithy.api#documentation": "Describes if the origination identity can be used for text messages, voice calls or both.
", "smithy.api#required": {} } }, @@ -7254,21 +7257,21 @@ "IsoCountryCode": { "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "smithy.api#required": {} } }, "MessageType": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", "smithy.api#required": {} } }, "NumberCapabilities": { "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", "traits": { - "smithy.api#documentation": "Describes if the origination identity can be used for text messages, voice calls or\n both.
", + "smithy.api#documentation": "Describes if the origination identity can be used for text messages, voice calls or both.
", "smithy.api#required": {} } }, @@ -7290,7 +7293,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients using the TwoWayChannelArn.
", + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
", "smithy.api#required": {} } }, @@ -7310,7 +7313,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "When set to false an end recipient sends a message that begins with HELP or STOP to\n one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a\n customizable message and adds the end recipient to the OptOutList. When set to true\n you're responsible for responding to HELP and STOP requests. You're also responsible for\n tracking and honoring opt-out request. For more information see Self-managed opt-outs\n
", + "smithy.api#documentation": "When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs
", "smithy.api#required": {} } }, @@ -7664,7 +7667,7 @@ "name": "sms-voice" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "Welcome to the AWS End User Messaging SMS and Voice, version 2 API Reference.\n This guide provides information about AWS End User Messaging SMS and Voice, version 2 API\n resources, including supported HTTP methods, parameters, and schemas.
\nAmazon Pinpoint is an Amazon Web Services service that you can use to engage with\n your recipients across multiple messaging channels. The AWS End User Messaging SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS\n and voice channels. AWS End User Messaging SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.
\nIf you're new to AWS End User Messaging SMS and Voice, it's also helpful to review the \n AWS End User Messaging SMS User Guide. The AWS End User Messaging SMS User Guide\n provides tutorials, code samples, and procedures that\n demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate\n functionality into mobile apps and other types of applications.\n The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with\n other Amazon Web Services services, and the quotas that apply to use of the\n service.
\n\n Regional availability\n
\nThe AWS End User Messaging SMS and Voice version 2 API Reference is\n available in several Amazon Web Services Regions and it provides an endpoint for each of\n these Regions. For a list of all the Regions and endpoints where the API is currently\n available, see Amazon Web Services Service Endpoints and Amazon Pinpoint\n endpoints and quotas in the Amazon Web Services General Reference. To\n learn more about Amazon Web Services Regions, see Managing\n Amazon Web Services Regions in the Amazon Web Services General\n Reference.
\nIn each Region, Amazon Web Services maintains multiple Availability Zones. These\n Availability Zones are physically isolated from each other, but are united by private,\n low-latency, high-throughput, and highly redundant network connections. These\n Availability Zones enable us to provide very high levels of availability and redundancy,\n while also minimizing latency. To learn more about the number of Availability Zones that\n are available in each Region, see Amazon Web Services\n Global Infrastructure.\n
", + "smithy.api#documentation": "Welcome to the AWS End User Messaging SMS and Voice, version 2 API Reference. This guide provides information about AWS End User Messaging SMS and Voice, version 2 API resources, including supported HTTP methods, parameters, and schemas.
Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The AWS End User Messaging SMS and Voice, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. AWS End User Messaging SMS and Voice, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.
If you're new to AWS End User Messaging SMS and Voice, it's also helpful to review the AWS End User Messaging SMS User Guide. The AWS End User Messaging SMS User Guide provides tutorials, code samples, and procedures that demonstrate how to use AWS End User Messaging SMS and Voice features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as AWS End User Messaging SMS and Voice integration with other Amazon Web Services services, and the quotas that apply to use of the service.
Regional availability
The AWS End User Messaging SMS and Voice version 2 API Reference is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Pinpoint endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -8551,7 +8554,7 @@ "MessageType": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", "smithy.api#required": {} } }, @@ -8559,7 +8562,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "When set to true you can receive incoming text messages from your end recipients using\n the TwoWayChannelArn.
", + "smithy.api#documentation": "When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
", "smithy.api#required": {} } }, @@ -8579,7 +8582,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "When set to false, an end recipient sends a message that begins with HELP or STOP to\n one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a\n customizable message and adds the end recipient to the OptOutList. When set to true\n you're responsible for responding to HELP and STOP requests. You're also responsible for\n tracking and honoring opt-out requests. For more information see Self-managed opt-outs\n
", + "smithy.api#documentation": "When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs
", "smithy.api#required": {} } }, @@ -8594,7 +8597,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Allows you to enable shared routes on your pool.
\nBy default, this is set to False. If you set this value to\n True, your messages are sent using phone numbers or sender IDs\n (depending on the country) that are shared with other users. In some\n countries, such as the United States, senders aren't allowed to use shared routes and\n must use a dedicated phone number or short code.
Allows you to enable shared routes on your pool.
By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.
Information about origination identities associated with a pool that meets a specified\n criteria.
" + "smithy.api#documentation": "Information about origination identities associated with a pool that meets a specified criteria.
" } }, "com.amazonaws.pinpointsmsvoicev2#PoolOriginationIdentitiesFilterList": { @@ -8846,7 +8849,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.\n
", + "smithy.api#documentation": "The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
", "smithy.api#required": {} } } @@ -8920,7 +8923,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides details on a RuleSetNumberOverride.
" + "smithy.api#documentation": "Provides details on phone number rule overrides for a protect configuration.
" } }, "com.amazonaws.pinpointsmsvoicev2#ProtectConfigurationRuleSetNumberOverrideFilterItem": { @@ -9003,6 +9006,14 @@ { "value": "BLOCK", "name": "BLOCK" + }, + { + "value": "MONITOR", + "name": "MONITOR" + }, + { + "value": "FILTER", + "name": "FILTER" } ] } @@ -9039,7 +9050,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a keyword configuration on an origination phone number or\n pool.
\nA keyword is a word that you can search for on a particular phone number or pool. It\n is also a specific word or phrase that an end user can send to your number to elicit a\n response, such as an informational message or a special offer. When your number receives\n a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable\n message.
\nIf you specify a keyword that isn't valid, an error is returned.
" + "smithy.api#documentation": "Creates or updates a keyword configuration on an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
If you specify a keyword that isn't valid, an error is returned.
" } }, "com.amazonaws.pinpointsmsvoicev2#PutKeywordRequest": { @@ -9048,7 +9059,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneOrPoolIdOrArn", "traits": { - "smithy.api#documentation": "The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or\n SenderIdArn. You can use DescribePhoneNumbers get the values for\n PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used\n to get the values for SenderId and SenderIdArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The action to perform for the new keyword when it is received.
\nAUTOMATIC_RESPONSE: A message is sent to the recipient.
\nOPT_OUT: Keeps the recipient from receiving future messages.
\nOPT_IN: The recipient wants to receive future messages.
\nThe action to perform for the new keyword when it is received.
AUTOMATIC_RESPONSE: A message is sent to the recipient.
OPT_OUT: Keeps the recipient from receiving future messages.
OPT_IN: The recipient wants to receive future messages.
Set the MessageFeedbackStatus as RECEIVED or FAILED for the\n passed in MessageId.
If you use message feedback then you must update message feedback record. When you receive a signal that a user has received the message you must use\n PutMessageFeedback to set the message feedback record as\n RECEIVED; Otherwise, an hour after the message feedback record is set\n to FAILED.
Set the MessageFeedbackStatus as RECEIVED or FAILED for the passed in MessageId.
If you use message feedback then you must update message feedback record. When you receive a signal that a user has received the message you must use PutMessageFeedback to set the message feedback record as RECEIVED; Otherwise, an hour after the message feedback record is set to FAILED.
Creates an opted out destination phone number in the opt-out list.
\nIf the destination phone number isn't valid or if the specified opt-out list doesn't\n exist, an error is returned.
" + "smithy.api#documentation": "Creates an opted out destination phone number in the opt-out list.
If the destination phone number isn't valid or if the specified opt-out list doesn't exist, an error is returned.
" } }, "com.amazonaws.pinpointsmsvoicev2#PutOptedOutNumberRequest": { @@ -9223,7 +9234,7 @@ "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "The OptOutListName or OptOutListArn to add the phone number to.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe OptOutListName or OptOutListArn to add the phone number to.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
This is true if it was the end user who requested their phone number be removed.\n
" + "smithy.api#documentation": "This is true if it was the end user who requested their phone number be removed.
" } } }, @@ -9307,7 +9318,7 @@ } ], "traits": { - "smithy.api#documentation": "Create or update a RuleSetNumberOverride and associate it with a protect configuration.
" + "smithy.api#documentation": "Create or update a phone number rule override and associate it with a protect configuration.
" } }, "com.amazonaws.pinpointsmsvoicev2#PutProtectConfigurationRuleSetNumberOverrideRequest": { @@ -9316,7 +9327,7 @@ "ClientToken": { "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } }, @@ -9559,7 +9570,7 @@ } ], "traits": { - "smithy.api#documentation": "Attaches a resource-based policy to a AWS End User Messaging SMS and Voice resource(phone number, sender Id, phone poll, or opt-out list) that is used for\n sharing the resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For more information about\n resource-based policies, see Working with shared resources in the AWS End User Messaging SMS User Guide.
" + "smithy.api#documentation": "Attaches a resource-based policy to a AWS End User Messaging SMS and Voice resource(phone number, sender Id, phone poll, or opt-out list) that is used for sharing the resource. A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For more information about resource-based policies, see Working with shared resources in the AWS End User Messaging SMS User Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#PutResourcePolicyRequest": { @@ -9809,7 +9820,7 @@ "AttachmentStatus": { "target": "com.amazonaws.pinpointsmsvoicev2#AttachmentStatus", "traits": { - "smithy.api#documentation": "The status of the registration attachment.
\n\n UPLOAD_IN_PROGRESS The attachment is being uploaded.
\n UPLOAD_COMPLETE The attachment has been uploaded.
\n UPLOAD_FAILED The attachment failed to uploaded.
\n DELETED The attachment has been deleted..
The status of the registration attachment.
UPLOAD_IN_PROGRESS The attachment is being uploaded.
UPLOAD_COMPLETE The attachment has been uploaded.
UPLOAD_FAILED The attachment failed to uploaded.
DELETED The attachment has been deleted..
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "smithy.api#required": {} } }, "RegistrationStatus": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationStatus", "traits": { - "smithy.api#documentation": "The status of the registration.
\n\n CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
\n CREATED: Your registration is created but not submitted.
\n COMPLETE: Your registration has been approved and your origination identity has been created.
\n DELETED: The registration has been deleted.
\n PROVISIONING: Your registration has been approved and your origination identity is being created.
\n REQUIRES_AUTHENTICATION: You need to complete email authentication.
\n REQUIRES_UPDATES: You must fix your registration and resubmit it.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n SUBMITTED: Your registration has been submitted and is awaiting review.
The status of the registration.
CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.
CREATED: Your registration is created but not submitted.
COMPLETE: Your registration has been approved and your origination identity has been created.
DELETED: The registration has been deleted.
PROVISIONING: Your registration has been approved and your origination identity is being created.
REQUIRES_AUTHENTICATION: You need to complete email authentication.
REQUIRES_UPDATES: You must fix your registration and resubmit it.
REVIEWING: Your registration has been accepted and is being reviewed.
SUBMITTED: Your registration has been submitted and is awaiting review.
The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions\n action.
", + "smithy.api#documentation": "The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
", "smithy.api#required": {} } }, @@ -10519,7 +10530,7 @@ "RegistrationVersionStatus": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus", "traits": { - "smithy.api#documentation": "The status of the registration.
\n\n APPROVED: Your registration has been approved.
\n ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
\n DENIED: You must fix your registration and resubmit it.
\n DISCARDED: You've abandon this version of their registration to start over with a new version.
\n DRAFT: The initial status of a registration version after it\u2019s created.
\n REQUIRES_AUTHENTICATION: You need to complete email authentication.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n REVOKED: Your previously approved registration has been revoked.
\n SUBMITTED: Your registration has been submitted.
The status of the registration.
APPROVED: Your registration has been approved.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
DENIED: You must fix your registration and resubmit it.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DRAFT: The initial status of a registration version after it\u2019s created.
REQUIRES_AUTHENTICATION: You need to complete email authentication.
REVIEWING: Your registration has been accepted and is being reviewed.
REVOKED: Your previously approved registration has been revoked.
SUBMITTED: Your registration has been submitted.
Releases an existing origination phone number in your account. Once released, a phone\n number is no longer available for sending messages.
\nIf the origination phone number has deletion protection enabled or is associated with\n a pool, an error is returned.
" + "smithy.api#documentation": "Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.
If the origination phone number has deletion protection enabled or is associated with a pool, an error is returned.
" } }, "com.amazonaws.pinpointsmsvoicev2#ReleasePhoneNumberRequest": { @@ -10711,7 +10722,7 @@ "PhoneNumberId": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn", "traits": { - "smithy.api#documentation": "The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and\n PhoneNumberArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The two-character code, in ISO 3166-1 alpha-2 format, for the country or\n region.
" + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" } }, "MessageType": { @@ -10781,7 +10792,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" } }, "TwoWayChannelArn": { @@ -10800,7 +10811,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" } }, "OptOutListName": { @@ -10907,7 +10918,7 @@ "MessageTypes": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", "smithy.api#required": {} } }, @@ -10969,7 +10980,7 @@ } ], "traits": { - "smithy.api#documentation": "Request an origination phone number for use in your account. For more information on\n phone number request see Request a phone number in the AWS End User Messaging SMS User Guide.
" + "smithy.api#documentation": "Request an origination phone number for use in your account. For more information on phone number request see Request a phone number in the AWS End User Messaging SMS User Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#RequestPhoneNumberRequest": { @@ -10978,14 +10989,14 @@ "IsoCountryCode": { "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "smithy.api#required": {} } }, "MessageType": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
The type of phone number to request.
", + "smithy.api#documentation": "The type of phone number to request.
When you request a SIMULATOR phone number, you must set MessageType as TRANSACTIONAL.
The name of the OptOutList to associate with the phone number. You can use the\n OptOutListName or OptOutListArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The pool to associated with the phone number. You can use the PoolId or PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe pool to associated with the phone number. You can use the PoolId or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Use this field to attach your phone number for an external registration\n process.
" + "smithy.api#documentation": "Use this field to attach your phone number for an external registration process.
" } }, "DeletionProtectionEnabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be\n deleted.
" + "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be deleted.
" } }, "Tags": { "target": "com.amazonaws.pinpointsmsvoicev2#TagList", "traits": { - "smithy.api#documentation": "An array of tags (key and value pairs) associate with the requested phone number.\n
" + "smithy.api#documentation": "An array of tags (key and value pairs) associate with the requested phone number.
" } }, "ClientToken": { "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -11075,19 +11086,19 @@ "IsoCountryCode": { "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
" + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" } }, "MessageType": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
" + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" } }, "NumberCapabilities": { "target": "com.amazonaws.pinpointsmsvoicev2#NumberCapabilityList", "traits": { - "smithy.api#documentation": "Indicates if the phone number will be used for text messages, voice messages or both.\n
" + "smithy.api#documentation": "Indicates if the phone number will be used for text messages, voice messages or both.
" } }, "NumberType": { @@ -11106,7 +11117,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" } }, "TwoWayChannelArn": { @@ -11125,7 +11136,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" } }, "OptOutListName": { @@ -11138,7 +11149,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be deleted.\n
" + "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be deleted.
" } }, "PoolId": { @@ -11222,7 +11233,7 @@ "MessageTypes": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
" + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" } }, "DeletionProtectionEnabled": { @@ -11240,7 +11251,7 @@ "ClientToken": { "target": "com.amazonaws.pinpointsmsvoicev2#ClientToken", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If you don't specify a client token, a randomly generated token is used for the\n request to ensure idempotency.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
", "smithy.api#idempotencyToken": {} } } @@ -11276,7 +11287,7 @@ "MessageTypes": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", "smithy.api#required": {} } }, @@ -11582,7 +11593,7 @@ } ], "traits": { - "smithy.api#documentation": "Before you can send test messages to a verified destination phone number you need to\n opt-in the verified destination phone number. Creates a new text message with a\n verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
" + "smithy.api#documentation": "Before you can send test messages to a verified destination phone number you need to opt-in the verified destination phone number. Creates a new text message with a verification code and send it to a verified destination phone number. Once you have the verification code use VerifyDestinationNumber to opt-in the verified destination phone number to receive messages.
" } }, "com.amazonaws.pinpointsmsvoicev2#SendDestinationNumberVerificationCodeRequest": { @@ -11611,25 +11622,25 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#VerificationMessageOriginationIdentity", "traits": { - "smithy.api#documentation": "The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
" + "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
" } }, "Context": { "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", "traits": { - "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event\n destination.
" + "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event destination.
" } }, "DestinationCountryParameters": { "target": "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameters", "traits": { - "smithy.api#documentation": "This field is used for any country-specific registration requirements. Currently, this\n setting is only used when you send messages to recipients in India using a sender ID.\n For more information see Special requirements for sending SMS messages to recipients in India.\n
" + "smithy.api#documentation": "This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
" } } }, @@ -11700,7 +11711,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#MediaMessageOriginationIdentity", "traits": { - "smithy.api#documentation": "The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
An array of URLs to each media file to send.
\nThe media files have to be stored in a publicly available S3 bucket. Supported media file formats\n are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing\n objects, see Creating a bucket and Uploading objects in the S3 user guide.
" + "smithy.api#documentation": "An array of URLs to each media file to send.
The media files have to be stored in an S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket, Uploading objects in the Amazon S3 User Guide, and Setting up an Amazon S3 bucket for MMS files in the Amazon Web Services End User Messaging SMS User Guide.
" } }, "ConfigurationSetName": { "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
" + "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
" } }, "MaxPrice": { @@ -11737,14 +11748,14 @@ "Context": { "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", "traits": { - "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event\n destination.
" + "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event destination.
" } }, "DryRun": { "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end\n recipient.
" + "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end recipient.
" } }, "ProtectConfigurationId": { @@ -11810,7 +11821,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new text message and sends it to a recipient's phone number. SendTextMessage only sends an SMS message to one recipient each time it is invoked.
\nSMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit\n depends on the destination country of your messages, as well as the type of phone number\n (origination number) that you use to send the message. For more information about MPS, see Message Parts per\n Second (MPS) limits in the AWS End User Messaging SMS User Guide.
" + "smithy.api#documentation": "Creates a new text message and sends it to a recipient's phone number. SendTextMessage only sends an SMS message to one recipient each time it is invoked.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS limit depends on the destination country of your messages, as well as the type of phone number (origination number) that you use to send the message. For more information about MPS, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#SendTextMessageRequest": { @@ -11826,7 +11837,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#TextMessageOriginationIdentity", "traits": { - "smithy.api#documentation": "The origination identity of the message. This can be either the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
The type of message. Valid values are \n for messages that are critical or time-sensitive and PROMOTIONAL for messages that\n aren't critical or time-sensitive.
" + "smithy.api#documentation": "The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" } }, "Keyword": { "target": "com.amazonaws.pinpointsmsvoicev2#Keyword", "traits": { - "smithy.api#documentation": "When you register a short code in the US, you must specify a program name. If you\n don\u2019t have a US short code, omit this attribute.
" + "smithy.api#documentation": "When you register a short code in the US, you must specify a program name. If you don\u2019t have a US short code, omit this attribute.
" } }, "ConfigurationSetName": { "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
" + "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
" } }, "MaxPrice": { @@ -11868,20 +11879,20 @@ "Context": { "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", "traits": { - "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event\n destination.
" + "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event destination.
" } }, "DestinationCountryParameters": { "target": "com.amazonaws.pinpointsmsvoicev2#DestinationCountryParameters", "traits": { - "smithy.api#documentation": "This field is used for any country-specific registration requirements. Currently, this\n setting is only used when you send messages to recipients in India using a sender ID.\n For more information see Special requirements for sending SMS messages to recipients in India.\n
\n\n IN_ENTITY_ID The entity ID or Principal\n Entity (PE) ID that you received after completing the sender ID\n registration process.
\n IN_TEMPLATE_ID The template ID that you\n received after completing the sender ID registration\n process.
Make sure that the Template ID that you specify matches\n your message template exactly. If your message doesn't match\n the template that you provided during the registration\n process, the mobile carriers might reject your\n message.
\nThis field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process.
IN_TEMPLATE_ID The template ID that you received after completing the sender ID registration process.
Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.
When set to true, the message is checked and validated, but isn't sent to the end\n recipient. You are not charged for using DryRun.
The Message Parts per Second (MPS) limit when using DryRun is five. If\n your origination identity has a lower MPS limit then the lower MPS limit is used. For\n more information about MPS limits, see Message Parts per\n Second (MPS) limits in the AWS End User Messaging SMS User Guide..
When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.
The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..
Allows you to send a request that sends a voice message.\n This operation uses Amazon Polly to\n convert a text script into a voice message.
" + "smithy.api#documentation": "Allows you to send a request that sends a voice message. This operation uses Amazon Polly to convert a text script into a voice message.
" } }, "com.amazonaws.pinpointsmsvoicev2#SendVoiceMessageRequest": { @@ -11963,7 +11974,7 @@ "OriginationIdentity": { "target": "com.amazonaws.pinpointsmsvoicev2#VoiceMessageOriginationIdentity", "traits": { - "smithy.api#documentation": "The origination identity to use for the voice call. This can be the PhoneNumber,\n PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
Specifies if the MessageBody field contains text or speech synthesis\n markup language (SSML).
\nTEXT: This is the default value. When used the maximum character limit is\n 3000.
\nSSML: When used the maximum character limit is 6000 including SSML\n tagging.
\nSpecifies if the MessageBody field contains text or speech synthesis markup language (SSML).
TEXT: This is the default value. When used the maximum character limit is 3000.
SSML: When used the maximum character limit is 6000 including SSML tagging.
The voice for the Amazon Polly\n service to use. By default this is set to \"MATTHEW\".
" + "smithy.api#documentation": "The voice for the Amazon Polly service to use. By default this is set to \"MATTHEW\".
" } }, "ConfigurationSetName": { "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
" + "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
" } }, "MaxPricePerMinute": { @@ -12006,14 +12017,14 @@ "Context": { "target": "com.amazonaws.pinpointsmsvoicev2#ContextMap", "traits": { - "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event\n destination.
" + "smithy.api#documentation": "You can specify custom data in this field. If you do, that data is logged to the event destination.
" } }, "DryRun": { "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end\n recipient.
" + "smithy.api#documentation": "When set to true, the message is checked and validated, but isn't sent to the end recipient.
" } }, "ProtectConfigurationId": { @@ -12070,13 +12081,13 @@ "IsoCountryCode": { "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The alphanumeric sender ID in a specific country that you want to describe. For more\n information on sender IDs see Requesting\n sender IDs in the AWS End User Messaging SMS User Guide.
" + "smithy.api#documentation": "The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs in the AWS End User Messaging SMS User Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#SenderIdFilter": { @@ -12159,14 +12170,14 @@ "IsoCountryCode": { "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
", + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
", "smithy.api#required": {} } }, "MessageTypes": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", "smithy.api#required": {} } }, @@ -12374,7 +12385,7 @@ } ], "traits": { - "smithy.api#documentation": "Set a protect configuration as your account default. You can only have one account\n default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.
" + "smithy.api#documentation": "Set a protect configuration as your account default. You can only have one account default protect configuration at a time. The current account default protect configuration is replaced with the provided protect configuration.
" } }, "com.amazonaws.pinpointsmsvoicev2#SetAccountDefaultProtectConfigurationRequest": { @@ -12449,7 +12460,7 @@ "ConfigurationSetName": { "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName\n or ConfigurationSetArn.
", + "smithy.api#documentation": "The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
", "smithy.api#required": {} } }, @@ -12517,7 +12528,7 @@ } ], "traits": { - "smithy.api#documentation": "Sets the default message type on a configuration set.
\nChoose the category of SMS messages that you plan to send from this account. If you\n send account-related messages or time-sensitive messages such as one-time passcodes,\n choose Transactional. If you plan to send messages that\n contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services\n account.
" + "smithy.api#documentation": "Sets the default message type on a configuration set.
Choose the category of SMS messages that you plan to send from this account. If you send account-related messages or time-sensitive messages such as one-time passcodes, choose Transactional. If you plan to send messages that contain marketing material or other promotional content, choose Promotional. This setting applies to your entire Amazon Web Services account.
" } }, "com.amazonaws.pinpointsmsvoicev2#SetDefaultMessageTypeRequest": { @@ -12526,14 +12537,14 @@ "ConfigurationSetName": { "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The configuration set to update with a new default message type. This field can be the\n ConsigurationSetName or ConfigurationSetArn.
", + "smithy.api#documentation": "The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.
", "smithy.api#required": {} } }, "MessageType": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", "smithy.api#required": {} } } @@ -12594,7 +12605,7 @@ } ], "traits": { - "smithy.api#documentation": "Sets default sender ID on a configuration set.
\nWhen sending a text message to a destination country that supports sender IDs, the\n default sender ID on the configuration set specified will be used if no dedicated\n origination phone numbers or registered sender IDs are available in your account.
" + "smithy.api#documentation": "Sets default sender ID on a configuration set.
When sending a text message to a destination country that supports sender IDs, the default sender ID on the configuration set specified will be used if no dedicated origination phone numbers or registered sender IDs are available in your account.
" } }, "com.amazonaws.pinpointsmsvoicev2#SetDefaultSenderIdRequest": { @@ -12603,14 +12614,14 @@ "ConfigurationSetName": { "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The configuration set to updated with a new default SenderId. This field can be the\n ConsigurationSetName or ConfigurationSetArn.
", + "smithy.api#documentation": "The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.
", "smithy.api#required": {} } }, "SenderId": { "target": "com.amazonaws.pinpointsmsvoicev2#SenderId", "traits": { - "smithy.api#documentation": "The current sender ID for the configuration set. When sending a text message to a\n destination country which supports SenderIds, the default sender ID on the configuration\n set specified on SendTextMessage will be used if no dedicated\n origination phone numbers or registered SenderIds are available in your account, instead\n of a generic sender ID, such as 'NOTICE'.
", + "smithy.api#documentation": "The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as 'NOTICE'.
", "smithy.api#required": {} } } @@ -12668,7 +12679,7 @@ } ], "traits": { - "smithy.api#documentation": "Sets an account level monthly spend limit override for sending MMS messages. The\n requested spend limit must be less than or equal to the MaxLimit, which is\n set by Amazon Web Services.
Sets an account level monthly spend limit override for sending MMS messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Sets an account level monthly spend limit override for sending text messages. The\n requested spend limit must be less than or equal to the MaxLimit, which is\n set by Amazon Web Services.
Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
Sets an account level monthly spend limit override for sending voice messages. The\n requested spend limit must be less than or equal to the MaxLimit, which is\n set by Amazon Web Services.
Sets an account level monthly spend limit override for sending voice messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.
The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to\n publish events to.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "An object that defines an Amazon SNS destination for events. You can use\n Amazon SNS to send notification when certain events occur.
" + "smithy.api#documentation": "An object that defines an Amazon SNS destination for events. You can use Amazon SNS to send notification when certain events occur.
" } }, "com.amazonaws.pinpointsmsvoicev2#SnsTopicArn": { @@ -12849,7 +12860,7 @@ "target": "smithy.api#PrimitiveLong", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The maximum amount of money, in US dollars, that you want to be able to spend sending\n messages each month. This value has to be less than or equal to the amount in\n MaxLimit. To use this custom limit, Overridden must be set\n to true.
The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month. This value has to be less than or equal to the amount in MaxLimit. To use this custom limit, Overridden must be set to true.
The maximum amount of money that you are able to spend to send messages each month,\n in US dollars.
", + "smithy.api#documentation": "The maximum amount of money that you are able to spend to send messages each month, in US dollars.
", "smithy.api#required": {} } }, @@ -12865,13 +12876,13 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "When set to True, the value that has been specified in the\n EnforcedLimit is used to determine the maximum amount in US dollars\n that can be spent to send messages each month, in US dollars.
When set to True, the value that has been specified in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.
Describes the current monthly spend limits for sending voice and\n text messages. For more information on increasing your monthly spend limit, see \n Requesting a spending quota increase\n in the AWS End User Messaging SMS User Guide.
" + "smithy.api#documentation": "Describes the current monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting a spending quota increase in the AWS End User Messaging SMS User Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#SpendLimitList": { @@ -12988,7 +12999,7 @@ "RegistrationVersionStatus": { "target": "com.amazonaws.pinpointsmsvoicev2#RegistrationVersionStatus", "traits": { - "smithy.api#documentation": "The status of the registration version.
\n\n APPROVED: Your registration has been approved.
\n ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
\n DENIED: You must fix your registration and resubmit it.
\n DISCARDED: You've abandon this version of their registration to start over with a new version.
\n DRAFT: The initial status of a registration version after it\u2019s created.
\n REQUIRES_AUTHENTICATION: You need to complete email authentication.
\n REVIEWING: Your registration has been accepted and is being reviewed.
\n REVOKED: Your previously approved registration has been revoked.
\n SUBMITTED: Your registration has been submitted.
The status of the registration version.
APPROVED: Your registration has been approved.
ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.
DENIED: You must fix your registration and resubmit it.
DISCARDED: You've abandon this version of their registration to start over with a new version.
DRAFT: The initial status of a registration version after it\u2019s created.
REQUIRES_AUTHENTICATION: You need to complete email authentication.
REVIEWING: Your registration has been accepted and is being reviewed.
REVOKED: Your previously approved registration has been revoked.
SUBMITTED: Your registration has been submitted.
The association behavior.
\n\n ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.
\n ASSOCIATE_ON_APPROVAL This applies to all short code registrations. The short code will be automatically provisioned once the registration is approved.
\n ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.
The association behavior.
ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.
ASSOCIATE_ON_APPROVAL This applies to all sender ID registrations. The sender ID will be automatically provisioned once the registration is approved.
ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.
The disassociation behavior.
\n\n DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed.
\n DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted.
\n DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.
The disassociation behavior.
DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed.
DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted.
DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.
Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is\n overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag\n consists of a key and an optional value. Tag keys must be unique per resource. For more\n information about tags, see Tags in the AWS End User Messaging SMS User Guide.
" + "smithy.api#documentation": "Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see Tags in the AWS End User Messaging SMS User Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#TagResourceRequest": { @@ -13236,7 +13247,7 @@ } }, "traits": { - "smithy.api#documentation": "An error that occurred because too many requests were sent during a certain amount of\n time.
", + "smithy.api#documentation": "An error that occurred because too many requests were sent during a certain amount of time.
", "smithy.api#error": "client", "smithy.api#retryable": { "throttling": true @@ -13288,7 +13299,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the association of the specified tags from a\n resource. For more information on tags see Tags in the AWS End User Messaging SMS User Guide.
" + "smithy.api#documentation": "Removes the association of the specified tags from a resource. For more information on tags see Tags in the AWS End User Messaging SMS User Guide.
" } }, "com.amazonaws.pinpointsmsvoicev2#UntagResourceRequest": { @@ -13349,7 +13360,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing event destination in a configuration set. You can update the\n IAM role ARN for CloudWatch Logs and Firehose. You can\n also enable or disable the event destination.
\nYou may want to update an event destination to change its matching event types or\n updating the destination resource ARN. You can't change an event destination's type\n between CloudWatch Logs, Firehose, and Amazon SNS.
" + "smithy.api#documentation": "Updates an existing event destination in a configuration set. You can update the IAM role ARN for CloudWatch Logs and Firehose. You can also enable or disable the event destination.
You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Firehose, and Amazon SNS.
" } }, "com.amazonaws.pinpointsmsvoicev2#UpdateEventDestinationRequest": { @@ -13358,7 +13369,7 @@ "ConfigurationSetName": { "target": "com.amazonaws.pinpointsmsvoicev2#ConfigurationSetNameOrArn", "traits": { - "smithy.api#documentation": "The configuration set to update with the new event destination. Valid values for this\n can be the ConfigurationSetName or ConfigurationSetArn.
", + "smithy.api#documentation": "The configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.
", "smithy.api#required": {} } }, @@ -13378,13 +13389,13 @@ "MatchingEventTypes": { "target": "com.amazonaws.pinpointsmsvoicev2#EventTypeList", "traits": { - "smithy.api#documentation": "An array of event types that determine which events to log.
\nThe TEXT_SENT event type is not supported.
An array of event types that determine which events to log.
The TEXT_SENT event type is not supported.
An object that contains information about an event destination that sends data to\n CloudWatch Logs.
" + "smithy.api#documentation": "An object that contains information about an event destination that sends data to CloudWatch Logs.
" } }, "KinesisFirehoseDestination": { @@ -13396,7 +13407,7 @@ "SnsDestination": { "target": "com.amazonaws.pinpointsmsvoicev2#SnsDestination", "traits": { - "smithy.api#documentation": "An object that contains information about an event destination that sends data to\n Amazon SNS.
" + "smithy.api#documentation": "An object that contains information about an event destination that sends data to Amazon SNS.
" } } }, @@ -13422,7 +13433,7 @@ "EventDestination": { "target": "com.amazonaws.pinpointsmsvoicev2#EventDestination", "traits": { - "smithy.api#documentation": "An EventDestination object containing the details of where events will be logged.\n
" + "smithy.api#documentation": "An EventDestination object containing the details of where events will be logged.
" } } }, @@ -13459,7 +13470,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the configuration of an existing origination phone number. You can update the\n opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable\n or disable self-managed opt-outs, and enable or disable deletion protection.
\nIf the origination phone number is associated with a pool, an error is\n returned.
" + "smithy.api#documentation": "Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
If the origination phone number is associated with a pool, an error is returned.
" } }, "com.amazonaws.pinpointsmsvoicev2#UpdatePhoneNumberRequest": { @@ -13468,14 +13479,14 @@ "PhoneNumberId": { "target": "com.amazonaws.pinpointsmsvoicev2#PhoneNumberIdOrArn", "traits": { - "smithy.api#documentation": "The unique identifier of the phone number. Valid values for this field can be either\n the PhoneNumberId or PhoneNumberArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" } }, "TwoWayChannelArn": { @@ -13493,19 +13504,19 @@ "SelfManagedOptOutsEnabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" } }, "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "The OptOutList to add the phone number to. Valid values for this field can be either\n the OutOutListName or OutOutListArn.
" + "smithy.api#documentation": "The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.
" } }, "DeletionProtectionEnabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be deleted.\n
" + "smithy.api#documentation": "By default this is set to false. When set to true the phone number can't be deleted.
" } } }, @@ -13543,13 +13554,13 @@ "IsoCountryCode": { "target": "com.amazonaws.pinpointsmsvoicev2#IsoCountryCode", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.\n
" + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
" } }, "MessageType": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageType", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
" + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
" } }, "NumberCapabilities": { @@ -13574,7 +13585,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" } }, "TwoWayChannelArn": { @@ -13655,7 +13666,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the configuration of an existing pool. You can update the opt-out list, enable\n or disable two-way messaging, change the TwoWayChannelArn, enable or\n disable self-managed opt-outs, enable or disable deletion protection, and enable or\n disable shared routes.
Updates the configuration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes.
The unique identifier of the pool to update. Valid values are either the PoolId or\n PoolArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" } }, "TwoWayChannelArn": { @@ -13689,13 +13700,13 @@ "SelfManagedOptOutsEnabled": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins\n with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically\n replies with a customizable message and adds the end recipient to the OptOutList. When\n set to true you're responsible for responding to HELP and STOP requests. You're also\n responsible for tracking and honoring opt-out requests.
" + "smithy.api#documentation": "By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" } }, "OptOutListName": { "target": "com.amazonaws.pinpointsmsvoicev2#OptOutListNameOrArn", "traits": { - "smithy.api#documentation": "The OptOutList to associate with the pool. Valid values are either OptOutListName or\n OptOutListArn.
\nIf you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
\nThe OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).
By default this is set to false. When set to true you can receive incoming text\n messages from your end recipients.
" + "smithy.api#documentation": "By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
" } }, "TwoWayChannelArn": { @@ -13765,7 +13776,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "When an end recipient sends a message that begins with HELP or STOP to one of your\n dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message\n and adds the end recipient to the OptOutList. When set to true you're responsible for\n responding to HELP and STOP requests. You're also responsible for tracking and honoring\n opt-out requests.
" + "smithy.api#documentation": "When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
" } }, "OptOutListName": { @@ -13854,7 +13865,7 @@ } ], "traits": { - "smithy.api#documentation": "Update a country rule set to ALLOW or BLOCK messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.
Update a country rule set to ALLOW, BLOCK, MONITOR, or FILTER messages to be sent to the specified destination counties. You can update one or multiple countries at a time. The updates are only applied to the specified NumberCapability type.
A map of ProtectConfigurationCountryRuleSetInformation objects that contain the\n details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.
", + "smithy.api#documentation": "A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide.
For example, to set the United States as allowed and Canada as blocked, the CountryRuleSetUpdates would be formatted as: \"CountryRuleSetUpdates\": { \"US\" : { \"ProtectStatus\": \"ALLOW\" } \"CA\" : { \"ProtectStatus\": \"BLOCK\" } }
When set to true deletion protection is enabled. By default this is set to false.\n
" + "smithy.api#documentation": "When set to true deletion protection is enabled. By default this is set to false.
" } } }, @@ -13979,7 +13990,7 @@ "target": "smithy.api#PrimitiveBoolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.\n
", + "smithy.api#documentation": "The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
", "smithy.api#required": {} } } @@ -14072,7 +14083,7 @@ "MessageTypes": { "target": "com.amazonaws.pinpointsmsvoicev2#MessageTypeList", "traits": { - "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or\n time-sensitive and PROMOTIONAL for messages that aren't critical or\n time-sensitive.
", + "smithy.api#documentation": "The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
", "smithy.api#required": {} } }, @@ -14147,7 +14158,7 @@ "Message": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The message associated with the validation exception with information to help\n determine its cause.
", + "smithy.api#documentation": "The message associated with the validation exception with information to help determine its cause.
", "smithy.api#required": {} } } @@ -14471,7 +14482,7 @@ "Status": { "target": "com.amazonaws.pinpointsmsvoicev2#VerificationStatus", "traits": { - "smithy.api#documentation": "The status of the verified destination phone number.
\n\n PENDING: The phone number hasn't been verified yet.
\n VERIFIED: The phone number is verified and can receive messages.
The status of the verified destination phone number.
PENDING: The phone number hasn't been verified yet.
VERIFIED: The phone number is verified and can receive messages.
The source reference for an existing attachment.
" } }, + "com.amazonaws.qbusiness#CreateAnonymousWebExperienceUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.qbusiness#CreateAnonymousWebExperienceUrlRequest" + }, + "output": { + "target": "com.amazonaws.qbusiness#CreateAnonymousWebExperienceUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qbusiness#AccessDeniedException" + }, + { + "target": "com.amazonaws.qbusiness#InternalServerException" + }, + { + "target": "com.amazonaws.qbusiness#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qbusiness#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qbusiness#ThrottlingException" + }, + { + "target": "com.amazonaws.qbusiness#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a unique URL for anonymous Amazon Q Business web experience. This URL can only be used once and must be used within 5 minutes after it's generated.
", + "smithy.api#http": { + "uri": "/applications/{applicationId}/experiences/{webExperienceId}/anonymous-url", + "method": "POST" + } + } + }, + "com.amazonaws.qbusiness#CreateAnonymousWebExperienceUrlRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.qbusiness#ApplicationId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Q Business application environment attached to the web experience.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "webExperienceId": { + "target": "com.amazonaws.qbusiness#WebExperienceId", + "traits": { + "smithy.api#documentation": "The identifier of the web experience.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sessionDurationInMinutes": { + "target": "com.amazonaws.qbusiness#SessionDurationInMinutes", + "traits": { + "smithy.api#documentation": "The duration of the session associated with the unique URL for the web experience.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qbusiness#CreateAnonymousWebExperienceUrlResponse": { + "type": "structure", + "members": { + "anonymousUrl": { + "target": "com.amazonaws.qbusiness#Url", + "traits": { + "smithy.api#documentation": "The unique URL for accessing the web experience.
This URL can only be used once and must be used within 5 minutes after it's generated.
Configuration information required to setup hallucination reduction. For more information, see hallucination reduction.
The hallucination reduction feature won't work if chat orchestration controls are enabled for your application.
Configuration information required to setup hallucination reduction. For more information, see hallucination reduction.
The hallucination reduction feature won't work if chat orchestration controls are enabled for your application.
An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.
" } }, + "com.amazonaws.sagemaker#AlarmDetails": { + "type": "structure", + "members": { + "AlarmName": { + "target": "com.amazonaws.sagemaker#AlarmName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the alarm.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the alarm to monitor during the AMI update.
" + } + }, "com.amazonaws.sagemaker#AlarmList": { "type": "list", "member": { @@ -1600,6 +1616,12 @@ "smithy.api#enumValue": "ml.p5.48xlarge" } }, + "ML_P5EN_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.p5en.48xlarge" + } + }, "ML_M6I_LARGE": { "target": "smithy.api#Unit", "traits": { @@ -4619,6 +4641,18 @@ } } }, + "com.amazonaws.sagemaker#AutoRollbackAlarms": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#AlarmDetails" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.sagemaker#AutoRollbackConfig": { "type": "structure", "members": { @@ -5567,6 +5601,30 @@ "smithy.api#documentation": "Specifies the type and size of the endpoint capacity to activate for a blue/green\n deployment, a rolling deployment, or a rollback strategy. You can specify your batches\n as either instance count or the overall percentage or your fleet.
\nFor a rollback strategy, if you don't specify the fields in this object, or if you set\n the Value to 100%, then SageMaker uses a blue/green rollback strategy and rolls\n all traffic back to the blue fleet.
Specifies whether SageMaker should process the update by amount or percentage of instances.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.sagemaker#NodeUnavailabilityValue", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the amount or percentage of instances SageMaker updates at a time.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of the size measurements of the AMI update. Using this\n configuration, you can specify whether SageMaker should update your instance group\n by an amount or percentage of instances.
" + } + }, "com.amazonaws.sagemaker#CapacitySizeType": { "type": "enum", "members": { @@ -6964,6 +7022,12 @@ "traits": { "smithy.api#documentation": "The customized Amazon VPC configuration at the instance group level that\n overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
" } + }, + "ScheduledUpdateConfig": { + "target": "com.amazonaws.sagemaker#ScheduledUpdateConfig", + "traits": { + "smithy.api#documentation": "The configuration object of the schedule that SageMaker follows when updating the AMI.
" + } } }, "traits": { @@ -7058,6 +7122,12 @@ "traits": { "smithy.api#documentation": "To configure multi-AZ deployments, customize the Amazon VPC configuration at the\n instance group level. You can specify different subnets and security groups across\n different AZs in the instance group specification to override a SageMaker HyperPod cluster's default\n Amazon VPC configuration. For more information about deploying a cluster in\n multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.
\nWhen your Amazon VPC and subnets support IPv6, network communications differ\n based on the cluster orchestration platform:
\nSlurm-orchestrated clusters automatically configure nodes with dual IPv6 and\n IPv4 addresses, allowing immediate IPv6 network communications.
\nIn Amazon EKS-orchestrated clusters, nodes receive dual-stack\n addressing, but pods can only use IPv6 when the Amazon EKS cluster is\n explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.
\nAdditional resources for IPv6 configuration:
\nFor information about adding IPv6 support to your VPC, see to IPv6\n Support for VPC.
\nFor information about creating a new IPv6-compatible VPC, see Amazon VPC Creation Guide.
\nTo configure SageMaker HyperPod with a custom Amazon VPC, see Custom Amazon VPC Setup for SageMaker HyperPod.
\nThe configuration object of the schedule that SageMaker uses to update the AMI.
" + } } }, "traits": { @@ -7955,6 +8025,12 @@ "smithy.api#documentation": "The time when the instance is launched.
" } }, + "LastSoftwareUpdateTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time of when the cluster was last updated.
" + } + }, "LifeCycleConfig": { "target": "com.amazonaws.sagemaker#ClusterLifeCycleConfig", "traits": { @@ -8088,6 +8164,12 @@ "smithy.api#required": {} } }, + "LastSoftwareUpdateTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "The time of when SageMaker last updated the software of the instances in the cluster.
" + } + }, "InstanceStatus": { "target": "com.amazonaws.sagemaker#ClusterInstanceStatusDetails", "traits": { @@ -12062,7 +12144,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version\n of a model by running many training jobs on your dataset using the algorithm you choose\n and values for hyperparameters within ranges that you specify. It then chooses the\n hyperparameter values that result in a model that performs the best, as measured by an\n objective metric that you choose.
\nA hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and\n trial components for each training job that it runs. You can view these entities in\n Amazon SageMaker Studio. For more information, see View\n Experiments, Trials, and Trial Components.
\nDo not include any security-sensitive information including account access IDs,\n secrets or tokens in any hyperparameter field. If the use of security-sensitive\n credentials are detected, SageMaker will reject your training job request and return an\n exception error.
\nStarts a hyperparameter tuning job. A hyperparameter tuning job finds the best version\n of a model by running many training jobs on your dataset using the algorithm you choose\n and values for hyperparameters within ranges that you specify. It then chooses the\n hyperparameter values that result in a model that performs the best, as measured by an\n objective metric that you choose.
\nA hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and\n trial components for each training job that it runs. You can view these entities in\n Amazon SageMaker Studio. For more information, see View\n Experiments, Trials, and Trial Components.
\nDo not include any security-sensitive information including account access IDs, secrets, \n or tokens in any hyperparameter fields. As part of the shared responsibility model, \n you are responsible for any potential exposure, unauthorized access, or \n compromise of your sensitive data if caused by any security-sensitive information included \n in the request hyperparameter variable or plain text fields..
\nThe environment variables to set in the Docker container. Up to 100 key and values\n entries in the map are supported.
" + "smithy.api#documentation": "The environment variables to set in the Docker container. Up to 100 key and values\n entries in the map are supported.
\nDo not include any security-sensitive information including account access IDs, secrets, \n or tokens in any environment fields. As part of the shared responsibility \n model, you are responsible for any potential exposure, unauthorized access, or compromise of \n your sensitive data if caused by security-sensitive information included in the \n request environment variable or plain text fields.
\n(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and\n Cost Management User Guide.
" + "smithy.api#documentation": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and\n Cost Management User Guide.
\nDo not include any security-sensitive information including account access IDs, secrets, \n or tokens in any tags. As part of the shared responsibility \n model, you are responsible for any potential exposure, unauthorized access, or compromise of \n your sensitive data if caused by security-sensitive information included in the \n request tag variable or plain text fields.
\nThe product ID and provisioning artifact ID to provision a service catalog. The provisioning \n artifact ID will default to the latest provisioning artifact ID of the product, if you don't \n provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service\n Catalog.
", - "smithy.api#required": {} + "smithy.api#documentation": "The product ID and provisioning artifact ID to provision a service catalog. The provisioning \n artifact ID will default to the latest provisioning artifact ID of the product, if you don't \n provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service\n Catalog.
" } }, "Tags": { @@ -14896,7 +14976,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a model training job. After training completes, SageMaker saves the resulting\n model artifacts to an Amazon S3 location that you specify.
\nIf you choose to host your model using SageMaker hosting services, you can use the\n resulting model artifacts as part of the model. You can also use the artifacts in a\n machine learning service other than SageMaker, provided that you know how to use them for\n inference. \n
\nIn the request body, you provide the following:
\n\n AlgorithmSpecification - Identifies the training algorithm to\n use.\n
\n HyperParameters - Specify these algorithm-specific parameters to\n enable the estimation of model parameters during training. Hyperparameters can\n be tuned to optimize this learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.
Do not include any security-sensitive information including account access\n IDs, secrets or tokens in any hyperparameter field. If the use of\n security-sensitive credentials are detected, SageMaker will reject your training\n job request and return an exception error.
\n\n InputDataConfig - Describes the input required by the training\n job and the Amazon S3, EFS, or FSx location where it is stored.
\n OutputDataConfig - Identifies the Amazon S3 bucket where you want\n SageMaker to save the results of model training.
\n ResourceConfig - Identifies the resources, ML compute\n instances, and ML storage volumes to deploy for model training. In distributed\n training, you specify more than one instance.
\n EnableManagedSpotTraining - Optimize the cost of training machine\n learning models by up to 80% by using Amazon EC2 Spot instances. For more\n information, see Managed Spot\n Training.
\n RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on\n your behalf during model training.\n \n You must grant this role the necessary permissions so that SageMaker can successfully\n complete model training.
\n StoppingCondition - To help cap training costs, use\n MaxRuntimeInSeconds to set a time limit for training. Use\n MaxWaitTimeInSeconds to specify how long a managed spot\n training job has to complete.
\n Environment - The environment variables to set in the Docker\n container.
\n RetryStrategy - The number of times to retry the job when the job\n fails due to an InternalServerError.
For more information about SageMaker, see How It Works.
" + "smithy.api#documentation": "Starts a model training job. After training completes, SageMaker saves the resulting\n model artifacts to an Amazon S3 location that you specify.
\nIf you choose to host your model using SageMaker hosting services, you can use the\n resulting model artifacts as part of the model. You can also use the artifacts in a\n machine learning service other than SageMaker, provided that you know how to use them for\n inference. \n
\nIn the request body, you provide the following:
\n\n AlgorithmSpecification - Identifies the training algorithm to\n use.\n
\n HyperParameters - Specify these algorithm-specific parameters to\n enable the estimation of model parameters during training. Hyperparameters can\n be tuned to optimize this learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.
Do not include any security-sensitive information including account access IDs, secrets, \n or tokens in any hyperparameter fields. As part of the shared responsibility \n model, you are responsible for any potential exposure, unauthorized access, or compromise of \n your sensitive data if caused by security-sensitive information included in the \n request hyperparameter variable or plain text fields.
\n\n InputDataConfig - Describes the input required by the training\n job and the Amazon S3, EFS, or FSx location where it is stored.
\n OutputDataConfig - Identifies the Amazon S3 bucket where you want\n SageMaker to save the results of model training.
\n ResourceConfig - Identifies the resources, ML compute\n instances, and ML storage volumes to deploy for model training. In distributed\n training, you specify more than one instance.
\n EnableManagedSpotTraining - Optimize the cost of training machine\n learning models by up to 80% by using Amazon EC2 Spot instances. For more\n information, see Managed Spot\n Training.
\n RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on\n your behalf during model training.\n \n You must grant this role the necessary permissions so that SageMaker can successfully\n complete model training.
\n StoppingCondition - To help cap training costs, use\n MaxRuntimeInSeconds to set a time limit for training. Use\n MaxWaitTimeInSeconds to specify how long a managed spot\n training job has to complete.
\n Environment - The environment variables to set in the Docker\n container.
Do not include any security-sensitive information including account access IDs, secrets, \n or tokens in any environment fields. As part of the shared responsibility model, you are \n responsible for any potential exposure, unauthorized access, or compromise of your sensitive\n data if caused by security-sensitive information included in the request environment variable \n or plain text fields.
\n\n RetryStrategy - The number of times to retry the job when the job\n fails due to an InternalServerError.
For more information about SageMaker, see How It Works.
" } }, "com.amazonaws.sagemaker#CreateTrainingJobRequest": { @@ -14913,7 +14993,7 @@ "HyperParameters": { "target": "com.amazonaws.sagemaker#HyperParameters", "traits": { - "smithy.api#documentation": "Algorithm-specific parameters that influence the quality of the model. You set\n hyperparameters before you start the learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.
\nYou can specify a maximum of 100 hyperparameters. Each hyperparameter is a\n key-value pair. Each key and value is limited to 256 characters, as specified by the\n Length Constraint.
Do not include any security-sensitive information including account access IDs,\n secrets or tokens in any hyperparameter field. If the use of security-sensitive\n credentials are detected, SageMaker will reject your training job request and return an\n exception error.
\nAlgorithm-specific parameters that influence the quality of the model. You set\n hyperparameters before you start the learning process. For a list of hyperparameters for\n each training algorithm provided by SageMaker, see Algorithms.
\nYou can specify a maximum of 100 hyperparameters. Each hyperparameter is a\n key-value pair. Each key and value is limited to 256 characters, as specified by the\n Length Constraint.
Do not include any security-sensitive information including account access IDs, secrets, \n or tokens in any hyperparameter fields. As part of the shared responsibility \n model, you are responsible for any potential exposure, unauthorized access, or compromise \n of your sensitive data if caused by any security-sensitive information included in the \n request hyperparameter variable or plain text fields.
\nAn array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
" + "smithy.api#documentation": "An array of key-value pairs. You can use tags to categorize your Amazon Web Services\n resources in different ways, for example, by purpose, owner, or environment. For more\n information, see Tagging Amazon Web Services Resources.
\nDo not include any security-sensitive information including account access IDs, secrets, \n or tokens in any tags. As part of the shared responsibility model, you are \n responsible for any potential exposure, unauthorized access, or compromise \n of your sensitive data if caused by any security-sensitive information included in the \n request tag variable or plain text fields.
\nThe environment variables to set in the Docker container.
" + "smithy.api#documentation": "The environment variables to set in the Docker container.
\nDo not include any security-sensitive information including account access IDs, \n secrets, or tokens in any environment fields. As part of the shared responsibility model, \n you are responsible for any potential exposure, unauthorized access, or compromise of your \n sensitive data if caused by security-sensitive information included in the request environment variable\n or plain text fields.
\nThe deployment configuration for an endpoint, which contains the desired deployment\n strategy and rollback configurations.
" } }, + "com.amazonaws.sagemaker#DeploymentConfiguration": { + "type": "structure", + "members": { + "RollingUpdatePolicy": { + "target": "com.amazonaws.sagemaker#RollingDeploymentPolicy", + "traits": { + "smithy.api#documentation": "The policy that SageMaker uses when updating the AMI versions of the cluster.
" + } + }, + "WaitIntervalInSeconds": { + "target": "com.amazonaws.sagemaker#WaitTimeIntervalInSeconds", + "traits": { + "smithy.api#documentation": "The duration in seconds that SageMaker waits before updating more instances in the cluster.
" + } + }, + "AutoRollbackConfiguration": { + "target": "com.amazonaws.sagemaker#AutoRollbackAlarms", + "traits": { + "smithy.api#documentation": "An array that contains the alarms that SageMaker monitors to know whether to roll back the AMI update.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration to use when updating the AMI versions.
" + } + }, "com.amazonaws.sagemaker#DeploymentRecommendation": { "type": "structure", "members": { @@ -26333,9 +26448,7 @@ "ServiceCatalogProvisioningDetails": { "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Information used to provision a service catalog product. For information, see What is Amazon Web Services Service\n Catalog.
", - "smithy.api#required": {} + "smithy.api#documentation": "Information used to provision a service catalog product. For information, see What is Amazon Web Services Service\n Catalog.
" } }, "ServiceCatalogProvisionedProductDetails": { @@ -26947,7 +27060,7 @@ "Environment": { "target": "com.amazonaws.sagemaker#TrainingEnvironmentMap", "traits": { - "smithy.api#documentation": "The environment variables to set in the Docker container.
" + "smithy.api#documentation": "The environment variables to set in the Docker container.
\nDo not include any security-sensitive information including account access IDs, secrets, \n or tokens in any environment fields. As part of the shared responsibility \n model, you are responsible for any potential exposure, unauthorized access, or compromise of \n your sensitive data if caused by security-sensitive information included in the \n request environment variable or plain text fields.
\nThe maximum amount of instances in the cluster that SageMaker can update at a time.
", + "smithy.api#required": {} + } + }, + "RollbackMaximumBatchSize": { + "target": "com.amazonaws.sagemaker#CapacitySizeConfig", + "traits": { + "smithy.api#documentation": "The maximum amount of instances in the cluster that SageMaker can roll back at a time.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configurations that SageMaker uses when updating the AMI versions.
" + } + }, "com.amazonaws.sagemaker#RollingUpdatePolicy": { "type": "structure", "members": { @@ -63905,6 +64065,28 @@ } } }, + "com.amazonaws.sagemaker#ScheduledUpdateConfig": { + "type": "structure", + "members": { + "ScheduleExpression": { + "target": "com.amazonaws.sagemaker#CronScheduleExpression", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A cron expression that specifies the schedule that SageMaker follows when updating the AMI.
", + "smithy.api#required": {} + } + }, + "DeploymentConfig": { + "target": "com.amazonaws.sagemaker#DeploymentConfiguration", + "traits": { + "smithy.api#documentation": "The configuration to use when updating the AMI versions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration object of the schedule that SageMaker follows when updating the AMI.
" + } + }, "com.amazonaws.sagemaker#SchedulerConfig": { "type": "structure", "members": { @@ -73017,6 +73199,34 @@ "smithy.api#documentation": "Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to\n use this API, see Update the SageMaker HyperPod platform software of a cluster.
\nThe UpgradeClusterSoftware API call may impact your SageMaker HyperPod cluster\n uptime and availability. Plan accordingly to mitigate potential disruptions to your\n workloads.
The name of the instance group to update.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration that describes specifications of the instance groups to update.
" + } + }, + "com.amazonaws.sagemaker#UpdateClusterSoftwareInstanceGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#UpdateClusterSoftwareInstanceGroupSpecification" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.sagemaker#UpdateClusterSoftwareRequest": { "type": "structure", "members": { @@ -73027,6 +73237,18 @@ "smithy.api#documentation": "Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security\n patching.
", "smithy.api#required": {} } + }, + "InstanceGroups": { + "target": "com.amazonaws.sagemaker#UpdateClusterSoftwareInstanceGroups", + "traits": { + "smithy.api#documentation": "The array of instance groups for which to update AMI versions.
" + } + }, + "DeploymentConfig": { + "target": "com.amazonaws.sagemaker#DeploymentConfiguration", + "traits": { + "smithy.api#documentation": "The configuration to use when updating the AMI versions.
" + } } }, "traits": { @@ -76507,6 +76729,15 @@ } } }, + "com.amazonaws.sagemaker#WaitTimeIntervalInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 3600 + } + } + }, "com.amazonaws.sagemaker#WarmPoolResourceStatus": { "type": "enum", "members": { diff --git a/savingsplans/service/2019-06-28/savingsplans-2019-06-28.json b/models/savingsplans/service/2019-06-28/savingsplans-2019-06-28.json similarity index 100% rename from savingsplans/service/2019-06-28/savingsplans-2019-06-28.json rename to models/savingsplans/service/2019-06-28/savingsplans-2019-06-28.json diff --git a/scheduler/service/2021-06-30/scheduler-2021-06-30.json b/models/scheduler/service/2021-06-30/scheduler-2021-06-30.json similarity index 100% rename from scheduler/service/2021-06-30/scheduler-2021-06-30.json rename to models/scheduler/service/2021-06-30/scheduler-2021-06-30.json diff --git a/schemas/service/2019-12-02/schemas-2019-12-02.json b/models/schemas/service/2019-12-02/schemas-2019-12-02.json similarity index 100% rename from schemas/service/2019-12-02/schemas-2019-12-02.json rename to models/schemas/service/2019-12-02/schemas-2019-12-02.json diff --git a/secrets-manager/service/2017-10-17/secrets-manager-2017-10-17.json b/models/secrets-manager/service/2017-10-17/secrets-manager-2017-10-17.json similarity index 100% rename from secrets-manager/service/2017-10-17/secrets-manager-2017-10-17.json rename to models/secrets-manager/service/2017-10-17/secrets-manager-2017-10-17.json diff --git a/security-ir/service/2018-05-10/security-ir-2018-05-10.json b/models/security-ir/service/2018-05-10/security-ir-2018-05-10.json similarity index 100% rename from security-ir/service/2018-05-10/security-ir-2018-05-10.json rename to models/security-ir/service/2018-05-10/security-ir-2018-05-10.json diff --git a/securityhub/service/2018-10-26/securityhub-2018-10-26.json b/models/securityhub/service/2018-10-26/securityhub-2018-10-26.json similarity index 100% rename from securityhub/service/2018-10-26/securityhub-2018-10-26.json rename to models/securityhub/service/2018-10-26/securityhub-2018-10-26.json diff --git a/securitylake/service/2018-05-10/securitylake-2018-05-10.json b/models/securitylake/service/2018-05-10/securitylake-2018-05-10.json similarity index 100% rename from securitylake/service/2018-05-10/securitylake-2018-05-10.json rename to models/securitylake/service/2018-05-10/securitylake-2018-05-10.json diff --git a/serverlessapplicationrepository/service/2017-09-08/serverlessapplicationrepository-2017-09-08.json b/models/serverlessapplicationrepository/service/2017-09-08/serverlessapplicationrepository-2017-09-08.json similarity index 100% rename from serverlessapplicationrepository/service/2017-09-08/serverlessapplicationrepository-2017-09-08.json rename to models/serverlessapplicationrepository/service/2017-09-08/serverlessapplicationrepository-2017-09-08.json diff --git a/service-catalog-appregistry/service/2020-06-24/service-catalog-appregistry-2020-06-24.json b/models/service-catalog-appregistry/service/2020-06-24/service-catalog-appregistry-2020-06-24.json similarity index 100% rename from service-catalog-appregistry/service/2020-06-24/service-catalog-appregistry-2020-06-24.json rename to models/service-catalog-appregistry/service/2020-06-24/service-catalog-appregistry-2020-06-24.json diff --git a/service-catalog/service/2015-12-10/service-catalog-2015-12-10.json b/models/service-catalog/service/2015-12-10/service-catalog-2015-12-10.json similarity index 100% rename from service-catalog/service/2015-12-10/service-catalog-2015-12-10.json rename to models/service-catalog/service/2015-12-10/service-catalog-2015-12-10.json diff --git a/service-quotas/service/2019-06-24/service-quotas-2019-06-24.json b/models/service-quotas/service/2019-06-24/service-quotas-2019-06-24.json similarity index 100% rename from service-quotas/service/2019-06-24/service-quotas-2019-06-24.json rename to models/service-quotas/service/2019-06-24/service-quotas-2019-06-24.json diff --git a/servicediscovery/service/2017-03-14/servicediscovery-2017-03-14.json b/models/servicediscovery/service/2017-03-14/servicediscovery-2017-03-14.json similarity index 100% rename from servicediscovery/service/2017-03-14/servicediscovery-2017-03-14.json rename to models/servicediscovery/service/2017-03-14/servicediscovery-2017-03-14.json diff --git a/ses/service/2010-12-01/ses-2010-12-01.json b/models/ses/service/2010-12-01/ses-2010-12-01.json similarity index 100% rename from ses/service/2010-12-01/ses-2010-12-01.json rename to models/ses/service/2010-12-01/ses-2010-12-01.json diff --git a/sesv2/service/2019-09-27/sesv2-2019-09-27.json b/models/sesv2/service/2019-09-27/sesv2-2019-09-27.json similarity index 100% rename from sesv2/service/2019-09-27/sesv2-2019-09-27.json rename to models/sesv2/service/2019-09-27/sesv2-2019-09-27.json diff --git a/sfn/service/2016-11-23/sfn-2016-11-23.json b/models/sfn/service/2016-11-23/sfn-2016-11-23.json similarity index 100% rename from sfn/service/2016-11-23/sfn-2016-11-23.json rename to models/sfn/service/2016-11-23/sfn-2016-11-23.json diff --git a/shield/service/2016-06-02/shield-2016-06-02.json b/models/shield/service/2016-06-02/shield-2016-06-02.json similarity index 100% rename from shield/service/2016-06-02/shield-2016-06-02.json rename to models/shield/service/2016-06-02/shield-2016-06-02.json diff --git a/signer/service/2017-08-25/signer-2017-08-25.json b/models/signer/service/2017-08-25/signer-2017-08-25.json similarity index 100% rename from signer/service/2017-08-25/signer-2017-08-25.json rename to models/signer/service/2017-08-25/signer-2017-08-25.json diff --git a/simspaceweaver/service/2022-10-28/simspaceweaver-2022-10-28.json b/models/simspaceweaver/service/2022-10-28/simspaceweaver-2022-10-28.json similarity index 100% rename from simspaceweaver/service/2022-10-28/simspaceweaver-2022-10-28.json rename to models/simspaceweaver/service/2022-10-28/simspaceweaver-2022-10-28.json diff --git a/sms/service/2016-10-24/sms-2016-10-24.json b/models/sms/service/2016-10-24/sms-2016-10-24.json similarity index 100% rename from sms/service/2016-10-24/sms-2016-10-24.json rename to models/sms/service/2016-10-24/sms-2016-10-24.json diff --git a/snow-device-management/service/2021-08-04/snow-device-management-2021-08-04.json b/models/snow-device-management/service/2021-08-04/snow-device-management-2021-08-04.json similarity index 100% rename from snow-device-management/service/2021-08-04/snow-device-management-2021-08-04.json rename to models/snow-device-management/service/2021-08-04/snow-device-management-2021-08-04.json diff --git a/snowball/service/2016-06-30/snowball-2016-06-30.json b/models/snowball/service/2016-06-30/snowball-2016-06-30.json similarity index 100% rename from snowball/service/2016-06-30/snowball-2016-06-30.json rename to models/snowball/service/2016-06-30/snowball-2016-06-30.json diff --git a/sns/service/2010-03-31/sns-2010-03-31.json b/models/sns/service/2010-03-31/sns-2010-03-31.json similarity index 100% rename from sns/service/2010-03-31/sns-2010-03-31.json rename to models/sns/service/2010-03-31/sns-2010-03-31.json diff --git a/socialmessaging/service/2024-01-01/socialmessaging-2024-01-01.json b/models/socialmessaging/service/2024-01-01/socialmessaging-2024-01-01.json similarity index 100% rename from socialmessaging/service/2024-01-01/socialmessaging-2024-01-01.json rename to models/socialmessaging/service/2024-01-01/socialmessaging-2024-01-01.json diff --git a/sqs/service/2012-11-05/sqs-2012-11-05.json b/models/sqs/service/2012-11-05/sqs-2012-11-05.json similarity index 100% rename from sqs/service/2012-11-05/sqs-2012-11-05.json rename to models/sqs/service/2012-11-05/sqs-2012-11-05.json diff --git a/ssm-contacts/service/2021-05-03/ssm-contacts-2021-05-03.json b/models/ssm-contacts/service/2021-05-03/ssm-contacts-2021-05-03.json similarity index 100% rename from ssm-contacts/service/2021-05-03/ssm-contacts-2021-05-03.json rename to models/ssm-contacts/service/2021-05-03/ssm-contacts-2021-05-03.json diff --git a/models/ssm-guiconnect/service/2021-05-01/ssm-guiconnect-2021-05-01.json b/models/ssm-guiconnect/service/2021-05-01/ssm-guiconnect-2021-05-01.json new file mode 100644 index 00000000..3a83189e --- /dev/null +++ b/models/ssm-guiconnect/service/2021-05-01/ssm-guiconnect-2021-05-01.json @@ -0,0 +1,1322 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.ssmguiconnect#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ssmguiconnect#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You do not have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.ssmguiconnect#AccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.ssmguiconnect#BucketName": { + "type": "string", + "traits": { + "smithy.api#pattern": "(?=^.{3,63}$)(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)" + } + }, + "com.amazonaws.ssmguiconnect#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.ssmguiconnect#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ssmguiconnect#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An error occurred due to a conflict.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.ssmguiconnect#Connection": { + "type": "resource", + "identifiers": { + "ConnectionArn": { + "target": "com.amazonaws.ssmguiconnect#ConnectionArn" + } + } + }, + "com.amazonaws.ssmguiconnect#ConnectionAccess": { + "type": "resource", + "identifiers": { + "ConnectionToken": { + "target": "com.amazonaws.ssmguiconnect#ConnectionToken" + } + } + }, + "com.amazonaws.ssmguiconnect#ConnectionArn": { + "type": "string" + }, + "com.amazonaws.ssmguiconnect#ConnectionPreferences": { + "type": "resource", + "identifiers": { + "AccountId": { + "target": "com.amazonaws.ssmguiconnect#AccountId" + } + } + }, + "com.amazonaws.ssmguiconnect#ConnectionRecordingPreferences": { + "type": "structure", + "members": { + "RecordingDestinations": { + "target": "com.amazonaws.ssmguiconnect#RecordingDestinations", + "traits": { + "smithy.api#documentation": "Determines where recordings of RDP connections are stored.
", + "smithy.api#required": {} + } + }, + "KMSKeyArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ARN of a KMS key that is used to encrypt data while it is being processed by the service. This key must exist in the same Amazon Web Services Region as the node you start an RDP connection to.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in.
" + } + }, + "com.amazonaws.ssmguiconnect#ConnectionToken": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}_[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$" + } + }, + "com.amazonaws.ssmguiconnect#ConnectionsCollection": { + "type": "resource", + "identifiers": { + "AccountId": { + "target": "com.amazonaws.ssmguiconnect#AccountId" + } + } + }, + "com.amazonaws.ssmguiconnect#DeleteConnectionRecordingPreferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmguiconnect#DeleteConnectionRecordingPreferencesRequest" + }, + "output": { + "target": "com.amazonaws.ssmguiconnect#DeleteConnectionRecordingPreferencesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssmguiconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmguiconnect#ConflictException" + }, + { + "target": "com.amazonaws.ssmguiconnect#InternalServerException" + }, + { + "target": "com.amazonaws.ssmguiconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmguiconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ssmguiconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmguiconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the preferences for recording RDP connections.
", + "smithy.api#examples": [ + { + "title": "Delete the connection recording preferences for the account", + "input": {}, + "output": { + "ClientToken": "sample_uuid" + } + } + ], + "smithy.api#http": { + "uri": "/DeleteConnectionRecordingPreferences", + "method": "POST" + }, + "smithy.api#idempotent": {}, + "smithy.test#smokeTests": [ + { + "id": "DeleteConnectionRecordingPreferencesSuccess", + "params": {}, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.ssmguiconnect#DeleteConnectionRecordingPreferencesRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ssmguiconnect#ClientToken", + "traits": { + "smithy.api#documentation": "User-provided idempotency token.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmguiconnect#DeleteConnectionRecordingPreferencesResponse": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ssmguiconnect#ClientToken", + "traits": { + "smithy.api#documentation": "Service-provided idempotency token.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmguiconnect#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.ssmguiconnect#GetConnectionRecordingPreferences": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.ssmguiconnect#GetConnectionRecordingPreferencesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssmguiconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmguiconnect#ConflictException" + }, + { + "target": "com.amazonaws.ssmguiconnect#InternalServerException" + }, + { + "target": "com.amazonaws.ssmguiconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmguiconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ssmguiconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmguiconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the preferences specified for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region.
", + "smithy.api#examples": [ + { + "title": "Retrieves the connection recording preferences for the account", + "output": { + "ConnectionRecordingPreferences": { + "RecordingDestinations": { + "S3Buckets": [ + { + "BucketOwner": "123456789012", + "BucketName": "sample-connection-recording-bucket" + } + ] + }, + "KMSKeyArn": "arn:aws:kms:region:account_id:key/sample_key_id" + }, + "ClientToken": "sample_uuid" + } + } + ], + "smithy.api#http": { + "uri": "/GetConnectionRecordingPreferences", + "method": "POST" + }, + "smithy.api#readonly": {}, + "smithy.test#smokeTests": [ + { + "id": "GetConnectionRecordingPreferencesSuccess", + "params": {}, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.ssmguiconnect#GetConnectionRecordingPreferencesResponse": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ssmguiconnect#ClientToken", + "traits": { + "smithy.api#documentation": "Service-provided idempotency token.
" + } + }, + "ConnectionRecordingPreferences": { + "target": "com.amazonaws.ssmguiconnect#ConnectionRecordingPreferences", + "traits": { + "smithy.api#documentation": "The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmguiconnect#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ssmguiconnect#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or failure.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.ssmguiconnect#ModifyConnectionPreferences": { + "type": "resource" + }, + "com.amazonaws.ssmguiconnect#ModifyRecordingPreferences": { + "type": "resource", + "read": { + "target": "com.amazonaws.ssmguiconnect#GetConnectionRecordingPreferences" + }, + "delete": { + "target": "com.amazonaws.ssmguiconnect#DeleteConnectionRecordingPreferences" + } + }, + "com.amazonaws.ssmguiconnect#RecordingDestinations": { + "type": "structure", + "members": { + "S3Buckets": { + "target": "com.amazonaws.ssmguiconnect#S3Buckets", + "traits": { + "smithy.api#documentation": "The S3 bucket where RDP connection recordings are stored.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Determines where recordings of RDP connections are stored.
" + } + }, + "com.amazonaws.ssmguiconnect#RecordingPreferences": { + "type": "resource", + "identifiers": { + "AccountId": { + "target": "com.amazonaws.ssmguiconnect#AccountId" + } + }, + "create": { + "target": "com.amazonaws.ssmguiconnect#UpdateConnectionRecordingPreferences" + } + }, + "com.amazonaws.ssmguiconnect#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ssmguiconnect#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The resource could not be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.ssmguiconnect#S3Bucket": { + "type": "structure", + "members": { + "BucketOwner": { + "target": "com.amazonaws.ssmguiconnect#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account number that owns the S3 bucket.
", + "smithy.api#required": {} + } + }, + "BucketName": { + "target": "com.amazonaws.ssmguiconnect#BucketName", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket where RDP connection recordings are stored.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The S3 bucket where RDP connection recordings are stored.
" + } + }, + "com.amazonaws.ssmguiconnect#S3Buckets": { + "type": "list", + "member": { + "target": "com.amazonaws.ssmguiconnect#S3Bucket" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.ssmguiconnect#SSMGuiConnect": { + "type": "service", + "version": "2021-05-01", + "resources": [ + { + "target": "com.amazonaws.ssmguiconnect#Connection" + }, + { + "target": "com.amazonaws.ssmguiconnect#ConnectionAccess" + }, + { + "target": "com.amazonaws.ssmguiconnect#ConnectionPreferences" + }, + { + "target": "com.amazonaws.ssmguiconnect#ConnectionsCollection" + }, + { + "target": "com.amazonaws.ssmguiconnect#ModifyConnectionPreferences" + }, + { + "target": "com.amazonaws.ssmguiconnect#ModifyRecordingPreferences" + }, + { + "target": "com.amazonaws.ssmguiconnect#RecordingPreferences" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "aws.api#service": { + "sdkId": "SSM GuiConnect", + "arnNamespace": "ssm-guiconnect" + }, + "aws.auth#sigv4": { + "name": "ssm-guiconnect" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "Systems Manager GUI Connect, a component of Fleet Manager, lets you connect to your Window\n Server-type Amazon Elastic Compute Cloud (Amazon EC2) instances using the Remote Desktop Protocol (RDP). GUI\n Connect, which is powered by Amazon DCV, provides you\n with secure connectivity to your Windows Server instances directly from the Systems Manager console.\n You can have up to four simultaneous connections in a single browser window. In the\n console, GUI Connect is also referred to as Fleet Manager Remote Desktop.
\nThis reference is intended to be used with the \n Amazon Web Services Systems Manager User\n Guide\n . To get started, see the following user guide topics:
\n\n Connect to a Windows Server managed instance using Remote Desktop\n
\nYour request exceeds a service quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.ssmguiconnect#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ssmguiconnect#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.ssmguiconnect#UpdateConnectionRecordingPreferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssmguiconnect#UpdateConnectionRecordingPreferencesRequest" + }, + "output": { + "target": "com.amazonaws.ssmguiconnect#UpdateConnectionRecordingPreferencesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssmguiconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssmguiconnect#ConflictException" + }, + { + "target": "com.amazonaws.ssmguiconnect#InternalServerException" + }, + { + "target": "com.amazonaws.ssmguiconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssmguiconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ssmguiconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.ssmguiconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the preferences for recording RDP connections.
", + "smithy.api#examples": [ + { + "title": "Updates the connection recording preferences for the account", + "input": { + "ConnectionRecordingPreferences": { + "RecordingDestinations": { + "S3Buckets": [ + { + "BucketOwner": "123456789012", + "BucketName": "sample-connection-recording-bucket" + } + ] + }, + "KMSKeyArn": "arn:aws:kms:region:account_id:key/sample_key_id" + } + }, + "output": { + "ConnectionRecordingPreferences": { + "RecordingDestinations": { + "S3Buckets": [ + { + "BucketOwner": "123456789012", + "BucketName": "sample-connection-recording-bucket" + } + ] + }, + "KMSKeyArn": "arn:aws:kms:region:account_id:key/sample_key_id" + }, + "ClientToken": "sample_uuid" + } + } + ], + "smithy.api#http": { + "uri": "/UpdateConnectionRecordingPreferences", + "method": "POST" + }, + "smithy.api#idempotent": {}, + "smithy.test#smokeTests": [ + { + "id": "UpdateConnectionRecordingPreferencesSuccess", + "params": { + "ConnectionRecordingPreferences": { + "RecordingDestinations": { + "S3Buckets": [ + { + "BucketOwner": "111122223333", + "BucketName": "test-bucket" + } + ] + }, + "KMSKeyArn": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + } + }, + "expect": { + "success": {} + }, + "vendorParamsShape": "aws.test#AwsVendorParams", + "vendorParams": { + "region": "us-east-1" + } + } + ] + } + }, + "com.amazonaws.ssmguiconnect#UpdateConnectionRecordingPreferencesRequest": { + "type": "structure", + "members": { + "ConnectionRecordingPreferences": { + "target": "com.amazonaws.ssmguiconnect#ConnectionRecordingPreferences", + "traits": { + "smithy.api#documentation": "The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.ssmguiconnect#ClientToken", + "traits": { + "smithy.api#documentation": "User-provided idempotency token.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssmguiconnect#UpdateConnectionRecordingPreferencesResponse": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.ssmguiconnect#ClientToken", + "traits": { + "smithy.api#documentation": "Service-provided idempotency token.
" + } + }, + "ConnectionRecordingPreferences": { + "target": "com.amazonaws.ssmguiconnect#ConnectionRecordingPreferences", + "traits": { + "smithy.api#documentation": "The set of preferences used for recording RDP connections in the requesting Amazon Web Services account and Amazon Web Services Region. This includes details such as which S3 bucket recordings are stored in.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.ssmguiconnect#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.ssmguiconnect#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an AWS service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} \ No newline at end of file diff --git a/ssm-incidents/service/2018-05-10/ssm-incidents-2018-05-10.json b/models/ssm-incidents/service/2018-05-10/ssm-incidents-2018-05-10.json similarity index 100% rename from ssm-incidents/service/2018-05-10/ssm-incidents-2018-05-10.json rename to models/ssm-incidents/service/2018-05-10/ssm-incidents-2018-05-10.json diff --git a/ssm-quicksetup/service/2018-05-10/ssm-quicksetup-2018-05-10.json b/models/ssm-quicksetup/service/2018-05-10/ssm-quicksetup-2018-05-10.json similarity index 100% rename from ssm-quicksetup/service/2018-05-10/ssm-quicksetup-2018-05-10.json rename to models/ssm-quicksetup/service/2018-05-10/ssm-quicksetup-2018-05-10.json diff --git a/ssm-sap/service/2018-05-10/ssm-sap-2018-05-10.json b/models/ssm-sap/service/2018-05-10/ssm-sap-2018-05-10.json similarity index 100% rename from ssm-sap/service/2018-05-10/ssm-sap-2018-05-10.json rename to models/ssm-sap/service/2018-05-10/ssm-sap-2018-05-10.json diff --git a/ssm/service/2014-11-06/ssm-2014-11-06.json b/models/ssm/service/2014-11-06/ssm-2014-11-06.json similarity index 99% rename from ssm/service/2014-11-06/ssm-2014-11-06.json rename to models/ssm/service/2014-11-06/ssm-2014-11-06.json index 3fcbc460..9686f61d 100644 --- a/ssm/service/2014-11-06/ssm-2014-11-06.json +++ b/models/ssm/service/2014-11-06/ssm-2014-11-06.json @@ -29,6 +29,74 @@ ] }, "shapes": { + "com.amazonaws.ssm#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The requester doesn't have permissions to perform the requested operation.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.ssm#AccessKeyIdType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\w{16,128}$" + } + }, + "com.amazonaws.ssm#AccessKeySecretType": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ssm#AccessRequestId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(oi)-[0-9a-f]{12}$" + } + }, + "com.amazonaws.ssm#AccessRequestStatus": { + "type": "enum", + "members": { + "APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Approved" + } + }, + "REJECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Rejected" + } + }, + "REVOKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Revoked" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Expired" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + } + } + }, "com.amazonaws.ssm#Account": { "type": "string" }, @@ -602,6 +670,9 @@ { "target": "com.amazonaws.ssm#DisassociateOpsItemRelatedItem" }, + { + "target": "com.amazonaws.ssm#GetAccessToken" + }, { "target": "com.amazonaws.ssm#GetAutomationExecution" }, @@ -779,6 +850,9 @@ { "target": "com.amazonaws.ssm#SendCommand" }, + { + "target": "com.amazonaws.ssm#StartAccessRequest" + }, { "target": "com.amazonaws.ssm#StartAssociationsOnce" }, @@ -4219,6 +4293,12 @@ "traits": { "smithy.api#enumValue": "ChangeRequest" } + }, + "AccessRequest": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessRequest" + } } } }, @@ -6931,6 +7011,42 @@ "com.amazonaws.ssm#CreatedDate": { "type": "timestamp" }, + "com.amazonaws.ssm#Credentials": { + "type": "structure", + "members": { + "AccessKeyId": { + "target": "com.amazonaws.ssm#AccessKeyIdType", + "traits": { + "smithy.api#documentation": "The access key ID that identifies the temporary security credentials.
", + "smithy.api#required": {} + } + }, + "SecretAccessKey": { + "target": "com.amazonaws.ssm#AccessKeySecretType", + "traits": { + "smithy.api#documentation": "The secret access key that can be used to sign requests.
", + "smithy.api#required": {} + } + }, + "SessionToken": { + "target": "com.amazonaws.ssm#SessionTokenType", + "traits": { + "smithy.api#documentation": "The token that users must pass to the service API to use the temporary credentials.
", + "smithy.api#required": {} + } + }, + "ExpirationTime": { + "target": "com.amazonaws.ssm#DateTime", + "traits": { + "smithy.api#documentation": "The datetime on which the current credentials expire.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
" + } + }, "com.amazonaws.ssm#CustomSchemaCountLimitExceededException": { "type": "structure", "members": { @@ -11698,6 +11814,18 @@ "traits": { "smithy.api#enumValue": "QuickSetup" } + }, + "ManualApprovalPolicy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManualApprovalPolicy" + } + }, + "AutoApprovalPolicy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoApprovalPolicy" + } } } }, @@ -12167,6 +12295,70 @@ "smithy.api#error": "client" } }, + "com.amazonaws.ssm#GetAccessToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssm#GetAccessTokenRequest" + }, + "output": { + "target": "com.amazonaws.ssm#GetAccessTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssm#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssm#InternalServerError" + }, + { + "target": "com.amazonaws.ssm#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssm#ThrottlingException" + }, + { + "target": "com.amazonaws.ssm#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a credentials set to be used with just-in-time node access.
" + } + }, + "com.amazonaws.ssm#GetAccessTokenRequest": { + "type": "structure", + "members": { + "AccessRequestId": { + "target": "com.amazonaws.ssm#AccessRequestId", + "traits": { + "smithy.api#documentation": "The ID of a just-in-time node access request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssm#GetAccessTokenResponse": { + "type": "structure", + "members": { + "Credentials": { + "target": "com.amazonaws.ssm#Credentials", + "traits": { + "smithy.api#documentation": "The temporary security credentials which can be used to start just-in-time node access sessions.
" + } + }, + "AccessRequestStatus": { + "target": "com.amazonaws.ssm#AccessRequestStatus", + "traits": { + "smithy.api#documentation": "The status of the access request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ssm#GetAutomationExecution": { "type": "operation", "input": { @@ -22412,6 +22604,60 @@ "smithy.api#enumValue": "OpsItemType" } }, + "ACCESS_REQUEST_REQUESTER_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessRequestByRequesterArn" + } + }, + "ACCESS_REQUEST_REQUESTER_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessRequestByRequesterId" + } + }, + "ACCESS_REQUEST_APPROVER_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessRequestByApproverArn" + } + }, + "ACCESS_REQUEST_APPROVER_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessRequestByApproverId" + } + }, + "ACCESS_REQUEST_SOURCE_ACCOUNT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessRequestBySourceAccountId" + } + }, + "ACCESS_REQUEST_SOURCE_OPS_ITEM_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessRequestBySourceOpsItemId" + } + }, + "ACCESS_REQUEST_SOURCE_REGION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessRequestBySourceRegion" + } + }, + "ACCESS_REQUEST_IS_REPLICA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessRequestByIsReplica" + } + }, + "ACCESS_REQUEST_TARGET_RESOURCE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessRequestByTargetResourceId" + } + }, "CHANGE_REQUEST_REQUESTER_ARN": { "target": "smithy.api#Unit", "traits": { @@ -22972,6 +23218,12 @@ "smithy.api#enumValue": "Approved" } }, + "REVOKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Revoked" + } + }, "REJECTED": { "target": "smithy.api#Unit", "traits": { @@ -27981,6 +28233,47 @@ "smithy.api#output": {} } }, + "com.amazonaws.ssm#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "The unique ID of the resource referenced in the failed request.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "The resource type of the resource referenced in the failed request.
" + } + }, + "QuotaCode": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "The quota code recognized by the Amazon Web Services Service Quotas service.
", + "smithy.api#required": {} + } + }, + "ServiceCode": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "The code for the Amazon Web Services service that owns the quota.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request exceeds the service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.ssm#ServiceRole": { "type": "string" }, @@ -28410,6 +28703,12 @@ } } }, + "com.amazonaws.ssm#SessionTokenType": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.ssm#SeveritySummary": { "type": "structure", "members": { @@ -28503,6 +28802,12 @@ "traits": { "smithy.api#enumValue": "Resume" } + }, + "REVOKE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Revoke" + } } } }, @@ -28570,6 +28875,80 @@ } } }, + "com.amazonaws.ssm#StartAccessRequest": { + "type": "operation", + "input": { + "target": "com.amazonaws.ssm#StartAccessRequestRequest" + }, + "output": { + "target": "com.amazonaws.ssm#StartAccessRequestResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ssm#AccessDeniedException" + }, + { + "target": "com.amazonaws.ssm#InternalServerError" + }, + { + "target": "com.amazonaws.ssm#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ssm#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ssm#ThrottlingException" + }, + { + "target": "com.amazonaws.ssm#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts the workflow for just-in-time node access sessions.
" + } + }, + "com.amazonaws.ssm#StartAccessRequestRequest": { + "type": "structure", + "members": { + "Reason": { + "target": "com.amazonaws.ssm#String1to256", + "traits": { + "smithy.api#documentation": "A brief description explaining why you are requesting access to the node.
", + "smithy.api#required": {} + } + }, + "Targets": { + "target": "com.amazonaws.ssm#Targets", + "traits": { + "smithy.api#documentation": "The node you are requesting access to.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.ssm#TagList", + "traits": { + "smithy.api#documentation": "Key-value pairs of metadata you want to assign to the access request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ssm#StartAccessRequestResponse": { + "type": "structure", + "members": { + "AccessRequestId": { + "target": "com.amazonaws.ssm#AccessRequestId", + "traits": { + "smithy.api#documentation": "The ID of the access request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ssm#StartAssociationsOnce": { "type": "operation", "input": { @@ -29436,6 +29815,15 @@ "com.amazonaws.ssm#String": { "type": "string" }, + "com.amazonaws.ssm#String1to256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.ssm#StringDateTime": { "type": "string", "traits": { @@ -29855,6 +30243,33 @@ "smithy.api#output": {} } }, + "com.amazonaws.ssm#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#required": {} + } + }, + "QuotaCode": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "The quota code recognized by the Amazon Web Services Service Quotas service.
" + } + }, + "ServiceCode": { + "target": "com.amazonaws.ssm#String", + "traits": { + "smithy.api#documentation": "The code for the Amazon Web Services service that owns the quota.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request or operation couldn't be performed because the service is throttling requests.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.ssm#TimeoutSeconds": { "type": "integer", "traits": { diff --git a/sso-admin/service/2020-07-20/sso-admin-2020-07-20.json b/models/sso-admin/service/2020-07-20/sso-admin-2020-07-20.json similarity index 100% rename from sso-admin/service/2020-07-20/sso-admin-2020-07-20.json rename to models/sso-admin/service/2020-07-20/sso-admin-2020-07-20.json diff --git a/sso-oidc/service/2019-06-10/sso-oidc-2019-06-10.json b/models/sso-oidc/service/2019-06-10/sso-oidc-2019-06-10.json similarity index 100% rename from sso-oidc/service/2019-06-10/sso-oidc-2019-06-10.json rename to models/sso-oidc/service/2019-06-10/sso-oidc-2019-06-10.json diff --git a/sso/service/2019-06-10/sso-2019-06-10.json b/models/sso/service/2019-06-10/sso-2019-06-10.json similarity index 100% rename from sso/service/2019-06-10/sso-2019-06-10.json rename to models/sso/service/2019-06-10/sso-2019-06-10.json diff --git a/storage-gateway/service/2013-06-30/storage-gateway-2013-06-30.json b/models/storage-gateway/service/2013-06-30/storage-gateway-2013-06-30.json similarity index 100% rename from storage-gateway/service/2013-06-30/storage-gateway-2013-06-30.json rename to models/storage-gateway/service/2013-06-30/storage-gateway-2013-06-30.json diff --git a/sts/service/2011-06-15/sts-2011-06-15.json b/models/sts/service/2011-06-15/sts-2011-06-15.json similarity index 100% rename from sts/service/2011-06-15/sts-2011-06-15.json rename to models/sts/service/2011-06-15/sts-2011-06-15.json diff --git a/supplychain/service/2024-01-01/supplychain-2024-01-01.json b/models/supplychain/service/2024-01-01/supplychain-2024-01-01.json similarity index 100% rename from supplychain/service/2024-01-01/supplychain-2024-01-01.json rename to models/supplychain/service/2024-01-01/supplychain-2024-01-01.json diff --git a/support-app/service/2021-08-20/support-app-2021-08-20.json b/models/support-app/service/2021-08-20/support-app-2021-08-20.json similarity index 100% rename from support-app/service/2021-08-20/support-app-2021-08-20.json rename to models/support-app/service/2021-08-20/support-app-2021-08-20.json diff --git a/support/service/2013-04-15/support-2013-04-15.json b/models/support/service/2013-04-15/support-2013-04-15.json similarity index 100% rename from support/service/2013-04-15/support-2013-04-15.json rename to models/support/service/2013-04-15/support-2013-04-15.json diff --git a/swf/service/2012-01-25/swf-2012-01-25.json b/models/swf/service/2012-01-25/swf-2012-01-25.json similarity index 100% rename from swf/service/2012-01-25/swf-2012-01-25.json rename to models/swf/service/2012-01-25/swf-2012-01-25.json diff --git a/synthetics/service/2017-10-11/synthetics-2017-10-11.json b/models/synthetics/service/2017-10-11/synthetics-2017-10-11.json similarity index 100% rename from synthetics/service/2017-10-11/synthetics-2017-10-11.json rename to models/synthetics/service/2017-10-11/synthetics-2017-10-11.json diff --git a/taxsettings/service/2018-05-10/taxsettings-2018-05-10.json b/models/taxsettings/service/2018-05-10/taxsettings-2018-05-10.json similarity index 100% rename from taxsettings/service/2018-05-10/taxsettings-2018-05-10.json rename to models/taxsettings/service/2018-05-10/taxsettings-2018-05-10.json diff --git a/textract/service/2018-06-27/textract-2018-06-27.json b/models/textract/service/2018-06-27/textract-2018-06-27.json similarity index 100% rename from textract/service/2018-06-27/textract-2018-06-27.json rename to models/textract/service/2018-06-27/textract-2018-06-27.json diff --git a/timestream-influxdb/service/2023-01-27/timestream-influxdb-2023-01-27.json b/models/timestream-influxdb/service/2023-01-27/timestream-influxdb-2023-01-27.json similarity index 100% rename from timestream-influxdb/service/2023-01-27/timestream-influxdb-2023-01-27.json rename to models/timestream-influxdb/service/2023-01-27/timestream-influxdb-2023-01-27.json diff --git a/timestream-query/service/2018-11-01/timestream-query-2018-11-01.json b/models/timestream-query/service/2018-11-01/timestream-query-2018-11-01.json similarity index 100% rename from timestream-query/service/2018-11-01/timestream-query-2018-11-01.json rename to models/timestream-query/service/2018-11-01/timestream-query-2018-11-01.json diff --git a/timestream-write/service/2018-11-01/timestream-write-2018-11-01.json b/models/timestream-write/service/2018-11-01/timestream-write-2018-11-01.json similarity index 100% rename from timestream-write/service/2018-11-01/timestream-write-2018-11-01.json rename to models/timestream-write/service/2018-11-01/timestream-write-2018-11-01.json diff --git a/tnb/service/2008-10-21/tnb-2008-10-21.json b/models/tnb/service/2008-10-21/tnb-2008-10-21.json similarity index 100% rename from tnb/service/2008-10-21/tnb-2008-10-21.json rename to models/tnb/service/2008-10-21/tnb-2008-10-21.json diff --git a/transcribe-streaming/service/2017-10-26/transcribe-streaming-2017-10-26.json b/models/transcribe-streaming/service/2017-10-26/transcribe-streaming-2017-10-26.json similarity index 100% rename from transcribe-streaming/service/2017-10-26/transcribe-streaming-2017-10-26.json rename to models/transcribe-streaming/service/2017-10-26/transcribe-streaming-2017-10-26.json diff --git a/transcribe/service/2017-10-26/transcribe-2017-10-26.json b/models/transcribe/service/2017-10-26/transcribe-2017-10-26.json similarity index 100% rename from transcribe/service/2017-10-26/transcribe-2017-10-26.json rename to models/transcribe/service/2017-10-26/transcribe-2017-10-26.json diff --git a/transfer/service/2018-11-05/transfer-2018-11-05.json b/models/transfer/service/2018-11-05/transfer-2018-11-05.json similarity index 100% rename from transfer/service/2018-11-05/transfer-2018-11-05.json rename to models/transfer/service/2018-11-05/transfer-2018-11-05.json diff --git a/translate/service/2017-07-01/translate-2017-07-01.json b/models/translate/service/2017-07-01/translate-2017-07-01.json similarity index 100% rename from translate/service/2017-07-01/translate-2017-07-01.json rename to models/translate/service/2017-07-01/translate-2017-07-01.json diff --git a/trustedadvisor/service/2022-09-15/trustedadvisor-2022-09-15.json b/models/trustedadvisor/service/2022-09-15/trustedadvisor-2022-09-15.json similarity index 100% rename from trustedadvisor/service/2022-09-15/trustedadvisor-2022-09-15.json rename to models/trustedadvisor/service/2022-09-15/trustedadvisor-2022-09-15.json diff --git a/verifiedpermissions/service/2021-12-01/verifiedpermissions-2021-12-01.json b/models/verifiedpermissions/service/2021-12-01/verifiedpermissions-2021-12-01.json similarity index 71% rename from verifiedpermissions/service/2021-12-01/verifiedpermissions-2021-12-01.json rename to models/verifiedpermissions/service/2021-12-01/verifiedpermissions-2021-12-01.json index 78a719d6..e154690d 100644 --- a/verifiedpermissions/service/2021-12-01/verifiedpermissions-2021-12-01.json +++ b/models/verifiedpermissions/service/2021-12-01/verifiedpermissions-2021-12-01.json @@ -47,7 +47,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information about an action for a request for which an authorization decision\n is made.
\nThis data type is used as a request parameter to the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken\n operations.
\nExample: { \"actionId\": \"<action name>\", \"actionType\": \"Action\"\n }\n
Contains information about an action for a request for which an authorization decision is made.
This data type is used as a request parameter to the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.
Example: { \"actionId\": \"<action name>\", \"actionType\": \"Action\" }
An attribute value of Boolean\n type.
\nExample: {\"boolean\": true}\n
An attribute value of Boolean type.
Example: {\"boolean\": true}
An attribute value of type EntityIdentifier.
\nExample: \"entityIdentifier\": { \"entityId\": \"<id>\", \"entityType\":\n \"<entity type>\"}\n
An attribute value of type EntityIdentifier.
Example: \"entityIdentifier\": { \"entityId\": \"<id>\", \"entityType\": \"<entity type>\"}
An attribute value of Long type.
\nExample: {\"long\": 0}\n
An attribute value of Long type.
Example: {\"long\": 0}
An attribute value of String\n type.
\nExample: {\"string\": \"abc\"}\n
An attribute value of String type.
Example: {\"string\": \"abc\"}
An attribute value of Set type.
\nExample: {\"set\": [ {} ] }\n
An attribute value of Set type.
Example: {\"set\": [ {} ] }
An attribute value of Record\n type.
\nExample: {\"record\": { \"keyName\": {} } }\n
An attribute value of Record type.
Example: {\"record\": { \"keyName\": {} } }
An attribute value of ipaddr\n type.
\nExample: {\"ip\": \"192.168.1.100\"}\n
An attribute value of ipaddr type.
Example: {\"ip\": \"192.168.1.100\"}
An attribute value of decimal type.
\nExample: {\"decimal\": \"1.1\"}\n
An attribute value of decimal type.
Example: {\"decimal\": \"1.1\"}
The value of an attribute.
\nContains information about the runtime context for a request for which an\n authorization decision is made.
\nThis data type is used as a member of the ContextDefinition structure\n which is uses as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken\n operations.
" + "smithy.api#documentation": "The value of an attribute.
Contains information about the runtime context for a request for which an authorization decision is made.
This data type is used as a member of the ContextDefinition structure which is uses as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.
" } }, "com.amazonaws.verifiedpermissions#Audience": { @@ -154,10 +164,9 @@ }, "traits": { "aws.iam#iamAction": { - "documentation": "Grants permission to return a list of a requested policies stored in the specified policy stores", "name": "GetPolicy" }, - "smithy.api#documentation": "Retrieves information about a group (batch) of policies.
\nThe BatchGetPolicy operation doesn't have its own IAM\n permission. To authorize this operation for Amazon Web Services principals, include the permission\n verifiedpermissions:GetPolicy in their IAM policies.
Retrieves information about a group (batch) of policies.
The BatchGetPolicy operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission verifiedpermissions:GetPolicy in their IAM policies.
Contains the information about an error resulting from a BatchGetPolicy\n API call.
Contains the information about an error resulting from a BatchGetPolicy API call.
The identifier of the policy store where the policy you want information about is\n stored.
", + "smithy.api#documentation": "The identifier of the policy store where the policy you want information about is stored.
", "smithy.api#required": {} } }, @@ -320,7 +329,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about a policy that you include in a BatchGetPolicy API\n request.
Information about a policy that you include in a BatchGetPolicy API request.
The identifier of the policy store where the policy you want information about is\n stored.
", + "smithy.api#documentation": "The identifier of the policy store where the policy you want information about is stored.
", "smithy.api#required": {} } }, @@ -385,7 +394,7 @@ "policyType": { "target": "com.amazonaws.verifiedpermissions#PolicyType", "traits": { - "smithy.api#documentation": "The type of the policy. This is one of the following values:
\n\n STATIC\n
\n TEMPLATE_LINKED\n
The type of the policy. This is one of the following values:
STATIC
TEMPLATE_LINKED
Contains information about a policy returned from a BatchGetPolicy API\n request.
Contains information about a policy returned from a BatchGetPolicy API request.
Makes a series of decisions about multiple authorization requests for one principal or\n resource. Each request contains the equivalent content of an IsAuthorized\n request: principal, action, resource, and context. Either the principal or\n the resource parameter must be identical across all requests. For example,\n Verified Permissions won't evaluate a pair of requests where bob views\n photo1 and alice views photo2. Authorization\n of bob to view photo1 and photo2, or\n bob and alice to view photo1, are valid\n batches.
The request is evaluated against all policies in the specified policy store that match the\n entities that you declare. The result of the decisions is a series of Allow\n or Deny responses, along with the IDs of the policies that produced each\n decision.
The entities of a BatchIsAuthorized API request can contain\n up to 100 principals and up to 100 resources. The requests of a\n BatchIsAuthorized API request can contain up to 30 requests.
The BatchIsAuthorized operation doesn't have its own IAM\n permission. To authorize this operation for Amazon Web Services principals, include the permission\n verifiedpermissions:IsAuthorized in their IAM policies.
Makes a series of decisions about multiple authorization requests for one principal or resource. Each request contains the equivalent content of an IsAuthorized request: principal, action, resource, and context. Either the principal or the resource parameter must be identical across all requests. For example, Verified Permissions won't evaluate a pair of requests where bob views photo1 and alice views photo2. Authorization of bob to view photo1 and photo2, or bob and alice to view photo1, are valid batches.
The request is evaluated against all policies in the specified policy store that match the entities that you declare. The result of the decisions is a series of Allow or Deny responses, along with the IDs of the policies that produced each decision.
The entities of a BatchIsAuthorized API request can contain up to 100 principals and up to 100 resources. The requests of a BatchIsAuthorized API request can contain up to 30 requests.
The BatchIsAuthorized operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission verifiedpermissions:IsAuthorized in their IAM policies.
Specifies the ID of the policy store. Policies in this policy store will be used to make the\n authorization decisions for the input.
", + "smithy.api#documentation": "Specifies the ID of the policy store. Policies in this policy store will be used to make the authorization decisions for the input.
", "smithy.api#required": {} } }, "entities": { "target": "com.amazonaws.verifiedpermissions#EntitiesDefinition", "traits": { - "smithy.api#documentation": "Specifies the list of resources and principals and their associated attributes that\n Verified Permissions can examine when evaluating the policies.
\nYou can include only principal and resource entities in this parameter; you can't\n include actions. You must specify actions in the schema.
\n(Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.
You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.
Specifies the requested action to be authorized. For example,\n PhotoFlash::ReadPhoto.
Specifies the requested action to be authorized. For example, PhotoFlash::ReadPhoto.
Specifies the resource that you want an authorization decision for. For example,\n PhotoFlash::Photo.
Specifies the resource that you want an authorization decision for. For example, PhotoFlash::Photo.
Specifies additional context that can be used to make more granular authorization\n decisions.
" + "smithy.api#documentation": "Specifies additional context that can be used to make more granular authorization decisions.
" } } }, "traits": { - "smithy.api#documentation": "An authorization request that you include in a BatchIsAuthorized API\n request.
An authorization request that you include in a BatchIsAuthorized API request.
A series of Allow or Deny decisions for each request, and\n the policies that produced them. These results are returned in the order they were requested.
A series of Allow or Deny decisions for each request, and the policies that produced them. These results are returned in the order they were requested.
An authorization decision that indicates if the authorization request should be\n allowed or denied.
", + "smithy.api#documentation": "An authorization decision that indicates if the authorization request should be allowed or denied.
", "smithy.api#required": {} } }, "determiningPolicies": { "target": "com.amazonaws.verifiedpermissions#DeterminingPolicyList", "traits": { - "smithy.api#documentation": "The list of determining policies used to make the authorization decision. For example,\n if there are two matching policies, where one is a forbid and the other is a permit,\n then the forbid policy will be the determining policy. In the case of multiple matching\n permit policies then there would be multiple determining policies. In the case that no\n policies match, and hence the response is DENY, there would be no determining\n policies.
", + "smithy.api#documentation": "The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.
", "smithy.api#required": {} } }, "errors": { "target": "com.amazonaws.verifiedpermissions#EvaluationErrorList", "traits": { - "smithy.api#documentation": "Errors that occurred while making an authorization decision. For example, a policy\n might reference an entity or attribute that doesn't exist in the request.
", + "smithy.api#documentation": "Errors that occurred while making an authorization decision. For example, a policy might reference an entity or attribute that doesn't exist in the request.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The decision, based on policy evaluation, from an individual authorization request in\n a BatchIsAuthorized API request.
The decision, based on policy evaluation, from an individual authorization request in a BatchIsAuthorized API request.
Makes a series of decisions about multiple authorization requests for one token. The\n principal in this request comes from an external identity source in the form of an identity or\n access token, formatted as a JSON\n web token (JWT). The information in the parameters can also define\n additional context that Verified Permissions can include in the evaluations.
\nThe request is evaluated against all policies in the specified policy store that match the\n entities that you provide in the entities declaration and in the token. The result of\n the decisions is a series of Allow or Deny responses, along\n with the IDs of the policies that produced each decision.
The entities of a BatchIsAuthorizedWithToken API request can\n contain up to 100 resources and up to 99 user groups. The requests of a\n BatchIsAuthorizedWithToken API request can contain up to 30\n requests.
The BatchIsAuthorizedWithToken operation doesn't have its own\n IAM permission. To authorize this operation for Amazon Web Services principals, include the\n permission verifiedpermissions:IsAuthorizedWithToken in their IAM\n policies.
Makes a series of decisions about multiple authorization requests for one token. The principal in this request comes from an external identity source in the form of an identity or access token, formatted as a JSON web token (JWT). The information in the parameters can also define additional context that Verified Permissions can include in the evaluations.
The request is evaluated against all policies in the specified policy store that match the entities that you provide in the entities declaration and in the token. The result of the decisions is a series of Allow or Deny responses, along with the IDs of the policies that produced each decision.
The entities of a BatchIsAuthorizedWithToken API request can contain up to 100 resources and up to 99 user groups. The requests of a BatchIsAuthorizedWithToken API request can contain up to 30 requests.
The BatchIsAuthorizedWithToken operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission verifiedpermissions:IsAuthorizedWithToken in their IAM policies.
Specifies the ID of the policy store. Policies in this policy store will be used to make an\n authorization decision for the input.
", + "smithy.api#documentation": "Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.
", "smithy.api#required": {} } }, "identityToken": { "target": "com.amazonaws.verifiedpermissions#Token", "traits": { - "smithy.api#documentation": "Specifies an identity (ID) token for the principal that you want to authorize in each\n request. This token is provided to you by the identity provider (IdP) associated with\n the specified identity source. You must specify either an accessToken, an\n identityToken, or both.
Must be an ID token. Verified Permissions returns an error if the token_use claim in the\n submitted token isn't id.
Specifies an identity (ID) token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.
Must be an ID token. Verified Permissions returns an error if the token_use claim in the submitted token isn't id.
Specifies an access token for the principal that you want to authorize in each\n request. This token is provided to you by the identity provider (IdP) associated with\n the specified identity source. You must specify either an accessToken, an\n identityToken, or both.
Must be an access token. Verified Permissions returns an error if the token_use claim in\n the submitted token isn't access.
Specifies an access token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.
Must be an access token. Verified Permissions returns an error if the token_use claim in the submitted token isn't access.
Specifies the list of resources and their associated attributes that Verified Permissions can examine\n when evaluating the policies.
\nYou can't include principals in this parameter, only resource and action entities.\n This parameter can't include any entities of a type that matches the user or group\n entity types that you defined in your identity source.
\nThe BatchIsAuthorizedWithToken operation takes principal\n attributes from \n only\n \n the identityToken or accessToken passed to the\n operation.
For action entities, you can include only their Identifier\n and EntityType.
(Optional) Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.
You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.
The BatchIsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.
For action entities, you can include only their Identifier and EntityType.
Specifies the requested action to be authorized. For example,\n PhotoFlash::ReadPhoto.
Specifies the requested action to be authorized. For example, PhotoFlash::ReadPhoto.
Specifies the resource that you want an authorization decision for. For example,\n PhotoFlash::Photo.
Specifies the resource that you want an authorization decision for. For example, PhotoFlash::Photo.
Specifies additional context that can be used to make more granular authorization\n decisions.
" + "smithy.api#documentation": "Specifies additional context that can be used to make more granular authorization decisions.
" } } }, "traits": { - "smithy.api#documentation": "An authorization request that you include in a BatchIsAuthorizedWithToken\n API request.
An authorization request that you include in a BatchIsAuthorizedWithToken API request.
A series of Allow or Deny decisions for each request, and\n the policies that produced them. These results are returned in the order they were requested.
A series of Allow or Deny decisions for each request, and the policies that produced them. These results are returned in the order they were requested.
An authorization decision that indicates if the authorization request should be\n allowed or denied.
", + "smithy.api#documentation": "An authorization decision that indicates if the authorization request should be allowed or denied.
", "smithy.api#required": {} } }, "determiningPolicies": { "target": "com.amazonaws.verifiedpermissions#DeterminingPolicyList", "traits": { - "smithy.api#documentation": "The list of determining policies used to make the authorization decision. For example,\n if there are two matching policies, where one is a forbid and the other is a permit,\n then the forbid policy will be the determining policy. In the case of multiple matching\n permit policies then there would be multiple determining policies. In the case that no\n policies match, and hence the response is DENY, there would be no determining\n policies.
", + "smithy.api#documentation": "The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.
", "smithy.api#required": {} } }, "errors": { "target": "com.amazonaws.verifiedpermissions#EvaluationErrorList", "traits": { - "smithy.api#documentation": "Errors that occurred while making an authorization decision. For example, a policy\n might reference an entity or attribute that doesn't exist in the request.
", + "smithy.api#documentation": "Errors that occurred while making an authorization decision. For example, a policy might reference an entity or attribute that doesn't exist in the request.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The decision, based on policy evaluation, from an individual authorization request in\n a BatchIsAuthorizedWithToken API request.
The decision, based on policy evaluation, from an individual authorization request in a BatchIsAuthorizedWithToken API request.
The name of the schema entity type that's mapped to the user pool group. Defaults\n to AWS::CognitoGroup.
The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.
The type of entity that a policy store maps to groups from an Amazon Cognito user\n pool identity source.
\nThis data type is part of a CognitoUserPoolConfiguration structure and is a request parameter in CreateIdentitySource.
" + "smithy.api#documentation": "The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
This data type is part of a CognitoUserPoolConfiguration structure and is a request parameter in CreateIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#CognitoGroupConfigurationDetail": { @@ -1086,12 +1112,12 @@ "groupEntityType": { "target": "com.amazonaws.verifiedpermissions#GroupEntityType", "traits": { - "smithy.api#documentation": "The name of the schema entity type that's mapped to the user pool group. Defaults\n to AWS::CognitoGroup.
The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.
The type of entity that a policy store maps to groups from an Amazon Cognito user\n pool identity source.
\nThis data type is part of an CognitoUserPoolConfigurationDetail structure and is a response parameter to\n GetIdentitySource.
" + "smithy.api#documentation": "The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
This data type is part of an CognitoUserPoolConfigurationDetail structure and is a response parameter to GetIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#CognitoGroupConfigurationItem": { @@ -1100,12 +1126,12 @@ "groupEntityType": { "target": "com.amazonaws.verifiedpermissions#GroupEntityType", "traits": { - "smithy.api#documentation": "The name of the schema entity type that's mapped to the user pool group. Defaults\n to AWS::CognitoGroup.
The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.
The type of entity that a policy store maps to groups from an Amazon Cognito user\n pool identity source.
\nThis data type is part of an CognitoUserPoolConfigurationItem structure and is a response parameter to\n ListIdentitySources.
" + "smithy.api#documentation": "The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
This data type is part of an CognitoUserPoolConfigurationItem structure and is a response parameter to ListIdentitySources.
" } }, "com.amazonaws.verifiedpermissions#CognitoUserPoolConfiguration": { @@ -1114,25 +1140,25 @@ "userPoolArn": { "target": "com.amazonaws.verifiedpermissions#UserPoolArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be\n authorized.
\nExample: \"UserPoolArn\":\n \"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\"\n
The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.
Example: \"UserPoolArn\": \"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\"
The unique application client IDs that are associated with the specified Amazon Cognito user\n pool.
\nExample: \"ClientIds\": [\"&ExampleCogClientId;\"]\n
The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example: \"ClientIds\": [\"&ExampleCogClientId;\"]
The type of entity that a policy store maps to groups from an Amazon Cognito user\n pool identity source.
" + "smithy.api#documentation": "The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
" } } }, "traits": { - "smithy.api#documentation": "The configuration for an identity source that represents a connection to an Amazon Cognito user pool used\n as an identity provider for Verified Permissions.
\nThis data type part of a Configuration structure that is\n used as a parameter to CreateIdentitySource.
\nExample:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\":\n \"MyCorp::Group\"}}\n
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type part of a Configuration structure that is used as a parameter to CreateIdentitySource.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}
The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be\n authorized.
\nExample: \"userPoolArn\":\n \"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\"\n
The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.
Example: \"userPoolArn\": \"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\"
The unique application client IDs that are associated with the specified Amazon Cognito user\n pool.
\nExample: \"clientIds\": [\"&ExampleCogClientId;\"]\n
The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example: \"clientIds\": [\"&ExampleCogClientId;\"]
The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that contains\n the identities to be authorized.
Example: \"issuer\":\n \"https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5\"\n
The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that contains the identities to be authorized.
Example: \"issuer\": \"https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5\"
The type of entity that a policy store maps to groups from an Amazon Cognito user\n pool identity source.
" + "smithy.api#documentation": "The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
" } } }, "traits": { - "smithy.api#documentation": "The configuration for an identity source that represents a connection to an Amazon Cognito user pool used\n as an identity provider for Verified Permissions.
\nThis data type is used as a field that is part of an ConfigurationDetail\n structure that is part of the response to GetIdentitySource.
\nExample:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\":\n \"MyCorp::Group\"}}\n
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of an ConfigurationDetail structure that is part of the response to GetIdentitySource.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}
The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be\n authorized.
\nExample: \"userPoolArn\":\n \"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\"\n
The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.
Example: \"userPoolArn\": \"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\"
The unique application client IDs that are associated with the specified Amazon Cognito user\n pool.
\nExample: \"clientIds\": [\"&ExampleCogClientId;\"]\n
The unique application client IDs that are associated with the specified Amazon Cognito user pool.
Example: \"clientIds\": [\"&ExampleCogClientId;\"]
The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that contains\n the identities to be authorized.
Example: \"issuer\":\n \"https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5\"\n
The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that contains the identities to be authorized.
Example: \"issuer\": \"https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5\"
The type of entity that a policy store maps to groups from an Amazon Cognito user\n pool identity source.
" + "smithy.api#documentation": "The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.
" } } }, "traits": { - "smithy.api#documentation": "The configuration for an identity source that represents a connection to an Amazon Cognito user pool used\n as an identity provider for Verified Permissions.
\nThis data type is used as a field that is part of the ConfigurationItem structure\n that is part of the response to ListIdentitySources.
\nExample:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\":\n \"MyCorp::Group\"}}\n
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used as an identity provider for Verified Permissions.
This data type is used as a field that is part of the ConfigurationItem structure that is part of the response to ListIdentitySources.
Example:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of\n authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool\n and one or more application client IDs.
\nExample:\n \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\":\n \"MyCorp::Group\"}}}\n
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}}
Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.
\nExample:\"configuration\":{\"openIdConnectConfiguration\":{\"issuer\":\"https://auth.example.com\",\"tokenSelection\":{\"accessTokenOnly\":{\"audiences\":[\"https://myapp.example.com\",\"https://myapp2.example.com\"],\"principalIdClaim\":\"sub\"}},\"entityIdPrefix\":\"MyOIDCProvider\",\"groupConfiguration\":{\"groupClaim\":\"groups\",\"groupEntityType\":\"MyCorp::UserGroup\"}}}\n
Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.
Example:\"configuration\":{\"openIdConnectConfiguration\":{\"issuer\":\"https://auth.example.com\",\"tokenSelection\":{\"accessTokenOnly\":{\"audiences\":[\"https://myapp.example.com\",\"https://myapp2.example.com\"],\"principalIdClaim\":\"sub\"}},\"entityIdPrefix\":\"MyOIDCProvider\",\"groupConfiguration\":{\"groupClaim\":\"groups\",\"groupEntityType\":\"MyCorp::UserGroup\"}}}
Contains configuration information used when creating a new identity source.
\nThis data type is used as a request parameter for the CreateIdentitySource\n operation.
" + "smithy.api#documentation": "Contains configuration information used when creating a new identity source.
This data type is used as a request parameter for the CreateIdentitySource operation.
" } }, "com.amazonaws.verifiedpermissions#ConfigurationDetail": { @@ -1231,18 +1257,18 @@ "cognitoUserPoolConfiguration": { "target": "com.amazonaws.verifiedpermissions#CognitoUserPoolConfigurationDetail", "traits": { - "smithy.api#documentation": "Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of\n authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool,\n the policy store entity that you want to assign to user groups, and one or more\n application client IDs.
\nExample:\n \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\":\n \"MyCorp::Group\"}}}\n
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}}
Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.
\nExample:\"configuration\":{\"openIdConnectConfiguration\":{\"issuer\":\"https://auth.example.com\",\"tokenSelection\":{\"accessTokenOnly\":{\"audiences\":[\"https://myapp.example.com\",\"https://myapp2.example.com\"],\"principalIdClaim\":\"sub\"}},\"entityIdPrefix\":\"MyOIDCProvider\",\"groupConfiguration\":{\"groupClaim\":\"groups\",\"groupEntityType\":\"MyCorp::UserGroup\"}}}\n
Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.
Example:\"configuration\":{\"openIdConnectConfiguration\":{\"issuer\":\"https://auth.example.com\",\"tokenSelection\":{\"accessTokenOnly\":{\"audiences\":[\"https://myapp.example.com\",\"https://myapp2.example.com\"],\"principalIdClaim\":\"sub\"}},\"entityIdPrefix\":\"MyOIDCProvider\",\"groupConfiguration\":{\"groupClaim\":\"groups\",\"groupEntityType\":\"MyCorp::UserGroup\"}}}
Contains configuration information about an identity source.
\nThis data type is a response parameter to the GetIdentitySource\n operation.
" + "smithy.api#documentation": "Contains configuration information about an identity source.
This data type is a response parameter to the GetIdentitySource operation.
" } }, "com.amazonaws.verifiedpermissions#ConfigurationItem": { @@ -1251,18 +1277,18 @@ "cognitoUserPoolConfiguration": { "target": "com.amazonaws.verifiedpermissions#CognitoUserPoolConfigurationItem", "traits": { - "smithy.api#documentation": "Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of\n authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool,\n the policy store entity that you want to assign to user groups, and one or more\n application client IDs.
\nExample:\n \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\":\n \"MyCorp::Group\"}}}\n
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool, the policy store entity that you want to assign to user groups, and one or more application client IDs.
Example: \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\": [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"],\"groupConfiguration\": {\"groupEntityType\": \"MyCorp::Group\"}}}
Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.
\nExample:\"configuration\":{\"openIdConnectConfiguration\":{\"issuer\":\"https://auth.example.com\",\"tokenSelection\":{\"accessTokenOnly\":{\"audiences\":[\"https://myapp.example.com\",\"https://myapp2.example.com\"],\"principalIdClaim\":\"sub\"}},\"entityIdPrefix\":\"MyOIDCProvider\",\"groupConfiguration\":{\"groupClaim\":\"groups\",\"groupEntityType\":\"MyCorp::UserGroup\"}}}\n
Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.
Example:\"configuration\":{\"openIdConnectConfiguration\":{\"issuer\":\"https://auth.example.com\",\"tokenSelection\":{\"accessTokenOnly\":{\"audiences\":[\"https://myapp.example.com\",\"https://myapp2.example.com\"],\"principalIdClaim\":\"sub\"}},\"entityIdPrefix\":\"MyOIDCProvider\",\"groupConfiguration\":{\"groupClaim\":\"groups\",\"groupEntityType\":\"MyCorp::UserGroup\"}}}
Contains configuration information about an identity source.
\nThis data type is a response parameter to the ListIdentitySources\n operation.
" + "smithy.api#documentation": "Contains configuration information about an identity source.
This data type is a response parameter to the ListIdentitySources operation.
" } }, "com.amazonaws.verifiedpermissions#ConflictException": { @@ -1283,7 +1309,7 @@ } }, "traits": { - "smithy.api#documentation": "The request failed because another request to modify a resource occurred at the\n same.
", + "smithy.api#documentation": "The request failed because another request to modify a resource occurred at the same.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1294,18 +1320,18 @@ "contextMap": { "target": "com.amazonaws.verifiedpermissions#ContextMap", "traits": { - "smithy.api#documentation": "An list of attributes that are needed to successfully evaluate an authorization\n request. Each attribute in this array must include a map of a data type and its\n value.
\nExample:\n \"contextMap\":{\"<KeyName1>\":{\"boolean\":true},\"<KeyName2>\":{\"long\":1234}}\n
An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.
Example: \"contextMap\":{\"<KeyName1>\":{\"boolean\":true},\"<KeyName2>\":{\"long\":1234}}
A Cedar JSON string representation of the context needed to successfully evaluate an authorization\n request.
\nExample:\n {\"cedarJson\":\"{\\\"<KeyName1>\\\": true, \\\"<KeyName2>\\\": 1234}\" }\n
A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.
Example: {\"cedarJson\":\"{\\\"<KeyName1>\\\": true, \\\"<KeyName2>\\\": 1234}\" }
Contains additional details about the context of the request. Verified Permissions evaluates this\n information in an authorization request as part of the when and\n unless clauses in a policy.
This data type is used as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken\n operations.
\nIf you're passing context as part of the request, exactly one instance of \n context must be passed. If you don't want to pass context, omit the\n context parameter from your request rather than sending context\n {}.
Example:\n \"context\":{\"contextMap\":{\"<KeyName1>\":{\"boolean\":true},\"<KeyName2>\":{\"long\":1234}}}\n
Contains additional details about the context of the request. Verified Permissions evaluates this information in an authorization request as part of the when and unless clauses in a policy.
This data type is used as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.
If you're passing context as part of the request, exactly one instance of context must be passed. If you don't want to pass context, omit the context parameter from your request rather than sending context {}.
Example: \"context\":{\"contextMap\":{\"<KeyName1>\":{\"boolean\":true},\"<KeyName2>\":{\"long\":1234}}}
Adds an identity source to a policy store\u2013an Amazon Cognito user pool or OpenID Connect\n (OIDC) identity provider (IdP).\n
\nAfter you create an identity source, you can use the identities provided by the IdP as proxies\n for the principal in authorization queries that use the IsAuthorizedWithToken or\n BatchIsAuthorizedWithToken API operations. These identities take the form\n of tokens that contain claims about the user, such as IDs, attributes and group\n memberships. Identity sources provide identity (ID) tokens and access tokens. Verified Permissions\n derives information about your user and session from token claims. Access tokens provide\n action context to your policies, and ID tokens provide principal\n Attributes.
Tokens from an identity source user continue to be usable until they expire. \n Token revocation and resource deletion have no effect on the validity of a token in your policy store
\nTo reference a user from this identity source in your Cedar policies, refer to the\n following syntax examples.
\nAmazon Cognito user pool: Namespace::[Entity type]::[User pool ID]|[user\n principal attribute], for example\n MyCorp::User::us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
OpenID Connect (OIDC) provider: Namespace::[Entity\n type]::[entityIdPrefix]|[user principal attribute], for example\n MyCorp::User::MyOIDCProvider|a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nAdds an identity source to a policy store\u2013an Amazon Cognito user pool or OpenID Connect (OIDC) identity provider (IdP).
After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the IsAuthorizedWithToken or BatchIsAuthorizedWithToken API operations. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Identity sources provide identity (ID) tokens and access tokens. Verified Permissions derives information about your user and session from token claims. Access tokens provide action context to your policies, and ID tokens provide principal Attributes.
Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store
To reference a user from this identity source in your Cedar policies, refer to the following syntax examples.
Amazon Cognito user pool: Namespace::[Entity type]::[User pool ID]|[user principal attribute], for example MyCorp::User::us-east-1_EXAMPLE|a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
OpenID Connect (OIDC) provider: Namespace::[Entity type]::[entityIdPrefix]|[user principal attribute], for example MyCorp::User::MyOIDCProvider|a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an ConflictException\n error.
Verified Permissions recognizes a ClientToken for eight hours. After eight hours,\n the next request with the same parameters performs the operation again regardless of \n the value of ClientToken.
Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.
Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.
Specifies the ID of the policy store in which you want to store this identity source. Only policies and\n requests made using this policy store can reference identities from the identity provider\n configured in the new identity source.
", + "smithy.api#documentation": "Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.
", "smithy.api#required": {} } }, "configuration": { "target": "com.amazonaws.verifiedpermissions#Configuration", "traits": { - "smithy.api#documentation": "Specifies the details required to communicate with the identity provider (IdP)\n associated with this identity source.
", + "smithy.api#documentation": "Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.
", "smithy.api#required": {} } }, "principalEntityType": { "target": "com.amazonaws.verifiedpermissions#PrincipalEntityType", "traits": { - "smithy.api#documentation": "Specifies the namespace and data type of the principals generated for identities\n authenticated by the new identity source.
" + "smithy.api#documentation": "Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.
" } } }, @@ -1466,7 +1492,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to create a Cedar policy and save it in the specified policy store" }, - "smithy.api#documentation": "Creates a Cedar policy and saves it in the specified policy store. You can create either a\n static policy or a policy linked to a policy template.
\nTo create a static policy, provide the Cedar policy text in the\n StaticPolicy section of the\n PolicyDefinition.
To create a policy that is dynamically linked to a policy template, specify the policy template ID\n and the principal and resource to associate with this policy in the\n templateLinked section of the PolicyDefinition. If the\n policy template is ever updated, any policies linked to the policy template automatically use the\n updated template.
Creating a policy causes it to be validated against the schema in the policy store. If the\n policy doesn't pass validation, the operation fails and the policy isn't\n stored.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nCreates a Cedar policy and saves it in the specified policy store. You can create either a static policy or a policy linked to a policy template.
To create a static policy, provide the Cedar policy text in the StaticPolicy section of the PolicyDefinition.
To create a policy that is dynamically linked to a policy template, specify the policy template ID and the principal and resource to associate with this policy in the templateLinked section of the PolicyDefinition. If the policy template is ever updated, any policies linked to the policy template automatically use the updated template.
Creating a policy causes it to be validated against the schema in the policy store. If the policy doesn't pass validation, the operation fails and the policy isn't stored.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an ConflictException\n error.
Verified Permissions recognizes a ClientToken for eight hours. After eight hours,\n the next request with the same parameters performs the operation again regardless of \n the value of ClientToken.
Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.
Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.
Specifies the PolicyStoreId of the policy store you want to store the policy\n in.
Specifies the PolicyStoreId of the policy store you want to store the policy in.
A structure that specifies the policy type and content to use for the new policy. You\n must include either a static or a templateLinked element. The policy content must be written\n in the Cedar policy language.
", + "smithy.api#documentation": "A structure that specifies the policy type and content to use for the new policy. You must include either a static or a templateLinked element. The policy content must be written in the Cedar policy language.
", "smithy.api#required": {} } } @@ -1618,19 +1644,19 @@ "principal": { "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", "traits": { - "smithy.api#documentation": "The principal specified in the new policy's scope. This response element isn't present\n when principal isn't specified in the policy content.
The principal specified in the new policy's scope. This response element isn't present when principal isn't specified in the policy content.
The resource specified in the new policy's scope. This response element isn't present\n when the resource isn't specified in the policy content.
The resource specified in the new policy's scope. This response element isn't present when the resource isn't specified in the policy content.
The action that a policy permits or forbids. For example, \n{\"actions\": [{\"actionId\": \"ViewPhoto\", \"actionType\": \"PhotoFlash::Action\"}, {\"entityID\": \"SharePhoto\", \n\"entityType\": \"PhotoFlash::Action\"}]}.
The action that a policy permits or forbids. For example, {\"actions\": [{\"actionId\": \"ViewPhoto\", \"actionType\": \"PhotoFlash::Action\"}, {\"entityID\": \"SharePhoto\", \"entityType\": \"PhotoFlash::Action\"}]}.
The effect of the decision that a policy returns to an authorization \nrequest. For example, \"effect\": \"Permit\".
The effect of the decision that a policy returns to an authorization request. For example, \"effect\": \"Permit\".
Creates a policy store. A policy store is a container for policy resources.
\nAlthough Cedar supports multiple namespaces, Verified Permissions currently supports only one\n namespace per policy store.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nCreates a policy store. A policy store is a container for policy resources.
Although Cedar supports multiple namespaces, Verified Permissions currently supports only one namespace per policy store.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an ConflictException\n error.
Verified Permissions recognizes a ClientToken for eight hours. After eight hours,\n the next request with the same parameters performs the operation again regardless of \n the value of ClientToken.
Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.
Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.
Specifies the validation setting for this policy store.
\nCurrently, the only valid and required value is Mode.
We recommend that you turn on STRICT mode only after you define a\n schema. If a schema doesn't exist, then STRICT mode causes any policy\n to fail validation, and Verified Permissions rejects the policy. You can turn off validation by\n using the UpdatePolicyStore. Then, when you have a schema defined, use UpdatePolicyStore again to turn validation back on.
Specifies the validation setting for this policy store.
Currently, the only valid and required value is Mode.
We recommend that you turn on STRICT mode only after you define a schema. If a schema doesn't exist, then STRICT mode causes any policy to fail validation, and Verified Permissions rejects the policy. You can turn off validation by using the UpdatePolicyStore. Then, when you have a schema defined, use UpdatePolicyStore again to turn validation back on.
Descriptive text that you can provide to help with identification \n of the current policy store.
" + "smithy.api#documentation": "Descriptive text that you can provide to help with identification of the current policy store.
" } }, "deletionProtection": { "target": "com.amazonaws.verifiedpermissions#DeletionProtection", "traits": { - "smithy.api#documentation": "Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.
\nThe default state is DISABLED.
Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.
The default state is DISABLED.
The list of key-value pairs to associate with the policy store.
" } } }, @@ -1793,7 +1825,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to create a policy template" }, - "smithy.api#documentation": "Creates a policy template. A template can use placeholders for the principal and resource. A\n template must be instantiated into a policy by associating it with specific principals\n and resources to use for the placeholders. That instantiated policy can then be\n considered in authorization decisions. The instantiated policy works identically to any\n other policy, except that it is dynamically linked to the template. If the template\n changes, then any policies that are linked to that template are immediately updated as\n well.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nCreates a policy template. A template can use placeholders for the principal and resource. A template must be instantiated into a policy by associating it with specific principals and resources to use for the placeholders. That instantiated policy can then be considered in authorization decisions. The instantiated policy works identically to any other policy, except that it is dynamically linked to the template. If the template changes, then any policies that are linked to that template are immediately updated as well.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an ConflictException\n error.
Verified Permissions recognizes a ClientToken for eight hours. After eight hours,\n the next request with the same parameters performs the operation again regardless of \n the value of ClientToken.
Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.
Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.
Specifies the content that you want to use for the new policy template, written in the Cedar\n policy language.
", + "smithy.api#documentation": "Specifies the content that you want to use for the new policy template, written in the Cedar policy language.
", "smithy.api#required": {} } } @@ -1934,7 +1966,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to delete an identity source that references an identity provider (IdP) such as Amazon Cognito" }, - "smithy.api#documentation": "Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito. After\n you delete the identity source, you can no longer use tokens for identities from that identity source to\n represent principals in authorization queries made using IsAuthorizedWithToken.\n operations.
", + "smithy.api#documentation": "Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito. After you delete the identity source, you can no longer use tokens for identities from that identity source to represent principals in authorization queries made using IsAuthorizedWithToken. operations.
", "smithy.api#examples": [ { "title": "To delete an identity source", @@ -1998,7 +2030,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to delete the specified policy from the policy store" }, - "smithy.api#documentation": "Deletes the specified policy from the policy store.
\nThis operation is idempotent; if you specify a policy that doesn't \n exist, the request response returns a successful HTTP 200 status code.
Deletes the specified policy from the policy store.
This operation is idempotent; if you specify a policy that doesn't exist, the request response returns a successful HTTP 200 status code.
Deletes the specified policy store.
\nThis operation is idempotent. If you specify a policy store that does not exist, the request\n response will still return a successful HTTP 200 status code.
", + "smithy.api#documentation": "Deletes the specified policy store.
This operation is idempotent. If you specify a policy store that does not exist, the request response will still return a successful HTTP 200 status code.
", "smithy.api#examples": [ { "title": "To delete a policy store", @@ -2115,7 +2147,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to delete the specified policy template from the policy store" }, - "smithy.api#documentation": "Deletes the specified policy template from the policy store.
\nThis operation also deletes any policies that were created from the specified\n policy template. Those policies are immediately removed from all future API responses, and are\n asynchronously deleted from the policy store.
\nDeletes the specified policy template from the policy store.
This operation also deletes any policies that were created from the specified policy template. Those policies are immediately removed from all future API responses, and are asynchronously deleted from the policy store.
The Id of a policy that determined to an authorization decision.
\nExample: \"policyId\":\"SPEXAMPLEabcdefg111111\"\n
The Id of a policy that determined to an authorization decision.
Example: \"policyId\":\"SPEXAMPLEabcdefg111111\"
Contains information about one of the policies that determined an authorization\n decision.
\nThis data type is used as an element in a response parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken\n operations.
\nExample: \"determiningPolicies\":[{\"policyId\":\"SPEXAMPLEabcdefg111111\"}]\n
Contains information about one of the policies that determined an authorization decision.
This data type is used as an element in a response parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.
Example: \"determiningPolicies\":[{\"policyId\":\"SPEXAMPLEabcdefg111111\"}]
An array of entities that are needed to successfully evaluate an authorization\n request. Each entity in this array must include an identifier for the entity, the\n attributes of the entity, and a list of any parent entities.
\nIf you include multiple entities with the same identifier, only the\n last one is processed in the request.
An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.
If you include multiple entities with the same identifier, only the last one is processed in the request.
A Cedar JSON string representation of the entities needed to successfully evaluate an authorization\n request.
\nExample:\n {\"cedarJson\": \"[{\\\"uid\\\":{\\\"type\\\":\\\"Photo\\\",\\\"id\\\":\\\"VacationPhoto94.jpg\\\"},\\\"attrs\\\":{\\\"accessLevel\\\":\\\"public\\\"},\\\"parents\\\":[]}]\"}\n
A Cedar JSON string representation of the entities needed to successfully evaluate an authorization request.
Example: {\"cedarJson\": \"[{\\\"uid\\\":{\\\"type\\\":\\\"Photo\\\",\\\"id\\\":\\\"VacationPhoto94.jpg\\\"},\\\"attrs\\\":{\\\"accessLevel\\\":\\\"public\\\"},\\\"parents\\\":[]}]\"}
Contains the list of entities to be considered during an authorization request. This\n includes all principals, resources, and actions required to successfully evaluate the\n request.
\nThis data type is used as a field in the response parameter for the IsAuthorized\n and IsAuthorizedWithToken operations.
" + "smithy.api#documentation": "Contains the list of entities to be considered during an authorization request. This includes all principals, resources, and actions required to successfully evaluate the request.
This data type is used as a field in the response parameter for the IsAuthorized and IsAuthorizedWithToken operations.
" } }, "com.amazonaws.verifiedpermissions#EntityAttributes": { @@ -2266,20 +2298,20 @@ "entityType": { "target": "com.amazonaws.verifiedpermissions#EntityType", "traits": { - "smithy.api#documentation": "The type of an entity.
\nExample: \"entityType\":\"typeName\"\n
The type of an entity.
Example: \"entityType\":\"typeName\"
The identifier of an entity.
\n\n \"entityId\":\"identifier\"\n
The identifier of an entity.
\"entityId\":\"identifier\"
Contains the identifier of an entity, including its ID and type.
\nThis data type is used as a request parameter for IsAuthorized operation, and as a\n response parameter for the CreatePolicy, GetPolicy, and\n UpdatePolicy operations.
\nExample:\n {\"entityId\":\"string\",\"entityType\":\"string\"}\n
Contains the identifier of an entity, including its ID and type.
This data type is used as a request parameter for IsAuthorized operation, and as a response parameter for the CreatePolicy, GetPolicy, and UpdatePolicy operations.
Example: {\"entityId\":\"string\",\"entityType\":\"string\"}
The parent entities in the hierarchy that contains the entity. A principal or resource\n entity can be defined with at most 99 transitive parents per\n authorization request.
\nA transitive parent is an entity in the hierarchy of entities including all direct\n parents, and parents of parents. For example, a user can be a member of 91 groups if one\n of those groups is a member of eight groups, for a total of 100: one entity, 91 entity\n parents, and eight parents of parents.
" + "smithy.api#documentation": "The parent entities in the hierarchy that contains the entity. A principal or resource entity can be defined with at most 99 transitive parents per authorization request.
A transitive parent is an entity in the hierarchy of entities including all direct parents, and parents of parents. For example, a user can be a member of 91 groups if one of those groups is a member of eight groups, for a total of 100: one entity, 91 entity parents, and eight parents of parents.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about an entity that can be referenced in a Cedar\n policy.
\nThis data type is used as one of the fields in the EntitiesDefinition\n structure.
\n\n { \"identifier\": { \"entityType\": \"Photo\", \"entityId\": \"VacationPhoto94.jpg\" },\n \"attributes\": {}, \"parents\": [ { \"entityType\": \"Album\", \"entityId\": \"alice_folder\" }\n ] }\n
Contains information about an entity that can be referenced in a Cedar policy.
This data type is used as one of the fields in the EntitiesDefinition structure.
{ \"identifier\": { \"entityType\": \"Photo\", \"entityId\": \"VacationPhoto94.jpg\" }, \"attributes\": {}, \"parents\": [ { \"entityType\": \"Album\", \"entityId\": \"alice_folder\" } ] }
Used to indicate that a principal or resource is not specified. This can be used to\n search for policies that are not associated with a specific principal or\n resource.
" + "smithy.api#documentation": "Used to indicate that a principal or resource is not specified. This can be used to search for policies that are not associated with a specific principal or resource.
" } }, "identifier": { "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", "traits": { - "smithy.api#documentation": "The identifier of the entity. It can consist of either an EntityType and EntityId, a\n principal, or a resource.
" + "smithy.api#documentation": "The identifier of the entity. It can consist of either an EntityType and EntityId, a principal, or a resource.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about a principal or resource that can be referenced in a Cedar\n policy.
\nThis data type is used as part of the PolicyFilter structure that is\n used as a request parameter for the ListPolicies operation..
" + "smithy.api#documentation": "Contains information about a principal or resource that can be referenced in a Cedar policy.
This data type is used as part of the PolicyFilter structure that is used as a request parameter for the ListPolicies operation..
" } }, "com.amazonaws.verifiedpermissions#EntityType": { @@ -2358,7 +2390,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains a description of an evaluation error.
\nThis data type is a response parameter of the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.
", + "smithy.api#documentation": "Contains a description of an evaluation error.
This data type is a response parameter of the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.
", "smithy.api#sensitive": {} } }, @@ -2484,7 +2516,7 @@ "principalEntityType": { "target": "com.amazonaws.verifiedpermissions#PrincipalEntityType", "traits": { - "smithy.api#documentation": "The data type of principals generated for identities authenticated by this\n identity source.
", + "smithy.api#documentation": "The data type of principals generated for identities authenticated by this identity source.
", "smithy.api#required": {} } }, @@ -2554,7 +2586,7 @@ "policyStoreId": { "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", "traits": { - "smithy.api#documentation": "Specifies the ID of the policy store that contains the policy that you want information\n about.
", + "smithy.api#documentation": "Specifies the ID of the policy store that contains the policy that you want information about.
", "smithy.api#required": {} } }, @@ -2598,21 +2630,21 @@ "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The principal specified in the policy's scope. This element isn't included in the\n response when Principal isn't present in the policy content.
The principal specified in the policy's scope. This element isn't included in the response when Principal isn't present in the policy content.
The resource specified in the policy's scope. This element isn't included in the\n response when Resource isn't present in the policy content.
The resource specified in the policy's scope. This element isn't included in the response when Resource isn't present in the policy content.
The action that a policy permits or forbids. For example, \n{\"actions\": [{\"actionId\": \"ViewPhoto\", \"actionType\": \"PhotoFlash::Action\"}, {\"entityID\": \"SharePhoto\", \n\"entityType\": \"PhotoFlash::Action\"}]}.
The action that a policy permits or forbids. For example, {\"actions\": [{\"actionId\": \"ViewPhoto\", \"actionType\": \"PhotoFlash::Action\"}, {\"entityID\": \"SharePhoto\", \"entityType\": \"PhotoFlash::Action\"}]}.
The effect of the decision that a policy returns to an authorization \nrequest. For example, \"effect\": \"Permit\".
The effect of the decision that a policy returns to an authorization request. For example, \"effect\": \"Permit\".
Specifies the ID of the policy store that you want information about.
", "smithy.api#required": {} } + }, + "tags": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether to return the tags that are attached to the policy store. If this parameter is included in the API call, the tags are returned, otherwise they are not returned.
If this parameter is included in the API call but there are no tags attached to the policy store, the tags response parameter is omitted from the response.
Descriptive text that you can provide to help with identification \n of the current policy store.
" + "smithy.api#documentation": "Descriptive text that you can provide to help with identification of the current policy store.
" } }, "deletionProtection": { "target": "com.amazonaws.verifiedpermissions#DeletionProtection", "traits": { - "smithy.api#documentation": "Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.
\nThe default state is DISABLED.
Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.
The default state is DISABLED.
The version of the Cedar language used with policies, policy templates, and schemas in this policy store. For more information, see Amazon Verified Permissions upgrade to Cedar v4 FAQ.
" + } + }, + "tags": { + "target": "com.amazonaws.verifiedpermissions#TagMap", + "traits": { + "smithy.api#documentation": "The list of tags associated with the policy store.
" } } }, @@ -2807,7 +2858,7 @@ "policyStoreId": { "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", "traits": { - "smithy.api#documentation": "Specifies the ID of the policy store that contains the policy template that you want information\n about.
", + "smithy.api#documentation": "Specifies the ID of the policy store that contains the policy template that you want information about.
", "smithy.api#required": {} } }, @@ -3027,7 +3078,7 @@ "smithy.api#deprecated": { "message": "This attribute has been replaced by configuration.cognitoUserPoolConfiguration.clientIds" }, - "smithy.api#documentation": "The application client IDs associated with the specified Amazon Cognito user pool that are\n enabled for this identity source.
" + "smithy.api#documentation": "The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.
" } }, "userPoolArn": { @@ -3036,7 +3087,7 @@ "smithy.api#deprecated": { "message": "This attribute has been replaced by configuration.cognitoUserPoolConfiguration.userPoolArn" }, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool whose identities are accessible to this Verified Permissions\n policy store.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.
" } }, "discoveryUrl": { @@ -3045,7 +3096,7 @@ "smithy.api#deprecated": { "message": "This attribute has been replaced by configuration.cognitoUserPoolConfiguration.issuer" }, - "smithy.api#documentation": "The well-known URL that points to this user pool's OIDC discovery endpoint. This is a\n URL string in the following format. This URL replaces the placeholders for both the\n Amazon Web Services Region and the user pool identifier with those appropriate for this user\n pool.
\n\n https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration\n
The well-known URL that points to this user pool's OIDC discovery endpoint. This is a URL string in the following format. This URL replaces the placeholders for both the Amazon Web Services Region and the user pool identifier with those appropriate for this user pool.
https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration
A string that identifies the type of OIDC service represented by this identity source.
\nAt this time, the only valid value is cognito.
A string that identifies the type of OIDC service represented by this identity source.
At this time, the only valid value is cognito.
A structure that contains configuration of the identity source.
\nThis data type was a response parameter for the GetIdentitySource operation.\n Replaced by ConfigurationDetail.
" + "smithy.api#documentation": "A structure that contains configuration of the identity source.
This data type was a response parameter for the GetIdentitySource operation. Replaced by ConfigurationDetail.
" } }, "com.amazonaws.verifiedpermissions#IdentitySourceFilter": { @@ -3071,12 +3122,12 @@ "principalEntityType": { "target": "com.amazonaws.verifiedpermissions#PrincipalEntityType", "traits": { - "smithy.api#documentation": "The Cedar entity type of the principals returned by the identity provider (IdP)\n associated with this identity source.
" + "smithy.api#documentation": "The Cedar entity type of the principals returned by the identity provider (IdP) associated with this identity source.
" } } }, "traits": { - "smithy.api#documentation": "A structure that defines characteristics of an identity source that you can use to\n filter.
\nThis data type is a request parameter for the ListIdentityStores\n operation.
" + "smithy.api#documentation": "A structure that defines characteristics of an identity source that you can use to filter.
This data type is a request parameter for the ListIdentityStores operation.
" } }, "com.amazonaws.verifiedpermissions#IdentitySourceFilters": { @@ -3118,7 +3169,7 @@ "smithy.api#deprecated": { "message": "This attribute has been replaced by configuration.cognitoUserPoolConfiguration" }, - "smithy.api#documentation": "A structure that contains the details of the associated identity provider\n (IdP).
" + "smithy.api#documentation": "A structure that contains the details of the associated identity provider (IdP).
" } }, "identitySourceId": { @@ -3145,7 +3196,7 @@ "principalEntityType": { "target": "com.amazonaws.verifiedpermissions#PrincipalEntityType", "traits": { - "smithy.api#documentation": "The Cedar entity type of the principals returned from the IdP associated with this\n identity source.
", + "smithy.api#documentation": "The Cedar entity type of the principals returned from the IdP associated with this identity source.
", "smithy.api#required": {} } }, @@ -3157,7 +3208,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure that defines an identity source.
\nThis data type is a response parameter to the ListIdentitySources\n operation.
" + "smithy.api#documentation": "A structure that defines an identity source.
This data type is a response parameter to the ListIdentitySources operation.
" } }, "com.amazonaws.verifiedpermissions#IdentitySourceItemDetails": { @@ -3169,7 +3220,7 @@ "smithy.api#deprecated": { "message": "This attribute has been replaced by configuration.cognitoUserPoolConfiguration.clientIds" }, - "smithy.api#documentation": "The application client IDs associated with the specified Amazon Cognito user pool that are\n enabled for this identity source.
" + "smithy.api#documentation": "The application client IDs associated with the specified Amazon Cognito user pool that are enabled for this identity source.
" } }, "userPoolArn": { @@ -3187,7 +3238,7 @@ "smithy.api#deprecated": { "message": "This attribute has been replaced by configuration.cognitoUserPoolConfiguration.issuer" }, - "smithy.api#documentation": "The well-known URL that points to this user pool's OIDC discovery endpoint. This is a\n URL string in the following format. This URL replaces the placeholders for both the\n Amazon Web Services Region and the user pool identifier with those appropriate for this user\n pool.
\n\n https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration\n
The well-known URL that points to this user pool's OIDC discovery endpoint. This is a URL string in the following format. This URL replaces the placeholders for both the Amazon Web Services Region and the user pool identifier with those appropriate for this user pool.
https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration
A string that identifies the type of OIDC service represented by this identity source.
\nAt this time, the only valid value is cognito.
A string that identifies the type of OIDC service represented by this identity source.
At this time, the only valid value is cognito.
A structure that contains configuration of the identity source.
\nThis data type was a response parameter for the ListIdentitySources\n operation. Replaced by ConfigurationItem.
" + "smithy.api#documentation": "A structure that contains configuration of the identity source.
This data type was a response parameter for the ListIdentitySources operation. Replaced by ConfigurationItem.
" } }, "com.amazonaws.verifiedpermissions#IdentitySources": { @@ -3274,7 +3325,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to make an authorization decision about a service request described in the parameters" }, - "smithy.api#documentation": "Makes an authorization decision about a service request described in the parameters.\n The information in the parameters can also define additional context that Verified Permissions can\n include in the evaluation. The request is evaluated against all matching policies in the\n specified policy store. The result of the decision is either Allow or\n Deny, along with a list of the policies that resulted in the\n decision.
Makes an authorization decision about a service request described in the parameters. The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either Allow or Deny, along with a list of the policies that resulted in the decision.
Specifies the ID of the policy store. Policies in this policy store will be used to make an\n authorization decision for the input.
", + "smithy.api#documentation": "Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.
", "smithy.api#required": {} } }, @@ -3351,7 +3402,7 @@ "action": { "target": "com.amazonaws.verifiedpermissions#ActionIdentifier", "traits": { - "smithy.api#documentation": "Specifies the requested action to be authorized. For example, is the principal\n authorized to perform this action on the resource?
" + "smithy.api#documentation": "Specifies the requested action to be authorized. For example, is the principal authorized to perform this action on the resource?
" } }, "resource": { @@ -3363,13 +3414,13 @@ "context": { "target": "com.amazonaws.verifiedpermissions#ContextDefinition", "traits": { - "smithy.api#documentation": "Specifies additional context that can be used to make more granular authorization\n decisions.
" + "smithy.api#documentation": "Specifies additional context that can be used to make more granular authorization decisions.
" } }, "entities": { "target": "com.amazonaws.verifiedpermissions#EntitiesDefinition", "traits": { - "smithy.api#documentation": "Specifies the list of resources and principals and their associated attributes that\n Verified Permissions can examine when evaluating the policies.
\nYou can include only principal and resource entities in this parameter; you can't\n include actions. You must specify actions in the schema.
\n(Optional) Specifies the list of resources and principals and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.
You can include only principal and resource entities in this parameter; you can't include actions. You must specify actions in the schema.
An authorization decision that indicates if the authorization request should be\n allowed or denied.
", + "smithy.api#documentation": "An authorization decision that indicates if the authorization request should be allowed or denied.
", "smithy.api#required": {} } }, "determiningPolicies": { "target": "com.amazonaws.verifiedpermissions#DeterminingPolicyList", "traits": { - "smithy.api#documentation": "The list of determining policies used to make the authorization decision. For example,\n if there are two matching policies, where one is a forbid and the other is a permit,\n then the forbid policy will be the determining policy. In the case of multiple matching\n permit policies then there would be multiple determining policies. In the case that no\n policies match, and hence the response is DENY, there would be no determining\n policies.
", + "smithy.api#documentation": "The list of determining policies used to make the authorization decision. For example, if there are two matching policies, where one is a forbid and the other is a permit, then the forbid policy will be the determining policy. In the case of multiple matching permit policies then there would be multiple determining policies. In the case that no policies match, and hence the response is DENY, there would be no determining policies.
", "smithy.api#required": {} } }, "errors": { "target": "com.amazonaws.verifiedpermissions#EvaluationErrorList", "traits": { - "smithy.api#documentation": "Errors that occurred while making an authorization decision, for example, a policy\n references an Entity or entity Attribute that does not exist in the slice.
", + "smithy.api#documentation": "Errors that occurred while making an authorization decision, for example, a policy references an Entity or entity Attribute that does not exist in the slice.
", "smithy.api#required": {} } } @@ -3423,7 +3474,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to make an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source" }, - "smithy.api#documentation": "Makes an authorization decision about a service request described in the parameters.\n The principal in this request comes from an external identity source in the form of an identity\n token formatted as a JSON web\n token (JWT). The information in the parameters can also define additional\n context that Verified Permissions can include in the evaluation. The request is evaluated against all\n matching policies in the specified policy store. The result of the decision is either\n Allow or Deny, along with a list of the policies that\n resulted in the decision.
Verified Permissions validates each token that is specified in a request by checking its expiration\n date and its signature.
\nTokens from an identity source user continue to be usable until they expire. \n Token revocation and resource deletion have no effect on the validity of a token in your policy store
\nMakes an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source in the form of an identity token formatted as a JSON web token (JWT). The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either Allow or Deny, along with a list of the policies that resulted in the decision.
Verified Permissions validates each token that is specified in a request by checking its expiration date and its signature.
Tokens from an identity source user continue to be usable until they expire. Token revocation and resource deletion have no effect on the validity of a token in your policy store
Specifies the ID of the policy store. Policies in this policy store will be used to make an\n authorization decision for the input.
", + "smithy.api#documentation": "Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.
", "smithy.api#required": {} } }, "identityToken": { "target": "com.amazonaws.verifiedpermissions#Token", "traits": { - "smithy.api#documentation": "Specifies an identity token for the principal to be authorized. This token is provided\n to you by the identity provider (IdP) associated with the specified identity source. You must\n specify either an accessToken, an identityToken, or\n both.
Must be an ID token. Verified Permissions returns an error if the token_use claim in the\n submitted token isn't id.
Specifies an identity token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.
Must be an ID token. Verified Permissions returns an error if the token_use claim in the submitted token isn't id.
Specifies an access token for the principal to be authorized. This token is provided\n to you by the identity provider (IdP) associated with the specified identity source. You must\n specify either an accessToken, an identityToken, or\n both.
Must be an access token. Verified Permissions returns an error if the token_use claim in\n the submitted token isn't access.
Specifies an access token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.
Must be an access token. Verified Permissions returns an error if the token_use claim in the submitted token isn't access.
Specifies the requested action to be authorized. Is the specified principal authorized\n to perform this action on the specified resource.
" + "smithy.api#documentation": "Specifies the requested action to be authorized. Is the specified principal authorized to perform this action on the specified resource.
" } }, "resource": { "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", "traits": { - "smithy.api#documentation": "Specifies the resource for which the authorization decision is made. For example, is\n the principal allowed to perform the action on the resource?
" + "smithy.api#documentation": "Specifies the resource for which the authorization decision is made. For example, is the principal allowed to perform the action on the resource?
" } }, "context": { "target": "com.amazonaws.verifiedpermissions#ContextDefinition", "traits": { - "smithy.api#documentation": "Specifies additional context that can be used to make more granular authorization\n decisions.
" + "smithy.api#documentation": "Specifies additional context that can be used to make more granular authorization decisions.
" } }, "entities": { "target": "com.amazonaws.verifiedpermissions#EntitiesDefinition", "traits": { - "smithy.api#documentation": "Specifies the list of resources and their associated attributes that Verified Permissions can examine\n when evaluating the policies.
\nYou can't include principals in this parameter, only resource and action entities.\n This parameter can't include any entities of a type that matches the user or group\n entity types that you defined in your identity source.
\nThe IsAuthorizedWithToken operation takes principal\n attributes from \n only\n \n the identityToken or accessToken passed to the\n operation.
For action entities, you can include only their Identifier\n and EntityType.
(Optional) Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.
You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.
The IsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.
For action entities, you can include only their Identifier and EntityType.
An authorization decision that indicates if the authorization request should be\n allowed or denied.
", + "smithy.api#documentation": "An authorization decision that indicates if the authorization request should be allowed or denied.
", "smithy.api#required": {} } }, "determiningPolicies": { "target": "com.amazonaws.verifiedpermissions#DeterminingPolicyList", "traits": { - "smithy.api#documentation": "The list of determining policies used to make the authorization decision. For example,\n if there are multiple matching policies, where at least one is a forbid policy, then\n because forbid always overrides permit the forbid policies are the determining policies.\n If all matching policies are permit policies, then those policies are the determining\n policies. When no policies match and the response is the default DENY, there are no\n determining policies.
", + "smithy.api#documentation": "The list of determining policies used to make the authorization decision. For example, if there are multiple matching policies, where at least one is a forbid policy, then because forbid always overrides permit the forbid policies are the determining policies. If all matching policies are permit policies, then those policies are the determining policies. When no policies match and the response is the default DENY, there are no determining policies.
", "smithy.api#required": {} } }, "errors": { "target": "com.amazonaws.verifiedpermissions#EvaluationErrorList", "traits": { - "smithy.api#documentation": "Errors that occurred while making an authorization decision. For example, a policy\n references an entity or entity attribute that does not exist in the slice.
", + "smithy.api#documentation": "Errors that occurred while making an authorization decision. For example, a policy references an entity or entity attribute that does not exist in the slice.
", "smithy.api#required": {} } }, @@ -3618,19 +3669,19 @@ "nextToken": { "target": "com.amazonaws.verifiedpermissions#NextToken", "traits": { - "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.
If you do not specify this parameter, the operation defaults to 10 identity sources per response.\n You can specify a maximum of 50 identity sources per response.
" + "smithy.api#documentation": "Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If you do not specify this parameter, the operation defaults to 10 identity sources per response. You can specify a maximum of 50 identity sources per response.
" } }, "filters": { "target": "com.amazonaws.verifiedpermissions#IdentitySourceFilters", "traits": { - "smithy.api#documentation": "Specifies characteristics of an identity source that you can use to limit the output to matching\n identity sources.
" + "smithy.api#documentation": "Specifies characteristics of an identity source that you can use to limit the output to matching identity sources.
" } } }, @@ -3652,7 +3703,7 @@ "nextToken": { "target": "com.amazonaws.verifiedpermissions#NextToken", "traits": { - "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.
Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.
If you do not specify this parameter, the operation defaults to 10 policies per\n response. You can specify a maximum of 50 policies per response.
" + "smithy.api#documentation": "Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If you do not specify this parameter, the operation defaults to 10 policies per response. You can specify a maximum of 50 policies per response.
" } }, "filter": { "target": "com.amazonaws.verifiedpermissions#PolicyFilter", "traits": { - "smithy.api#documentation": "Specifies a filter that limits the response to only policies that match the specified\n criteria. For example, you list only the policies that reference a specified\n principal.
" + "smithy.api#documentation": "Specifies a filter that limits the response to only policies that match the specified criteria. For example, you list only the policies that reference a specified principal.
" } } }, @@ -3881,7 +3932,7 @@ "nextToken": { "target": "com.amazonaws.verifiedpermissions#NextToken", "traits": { - "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.
Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.
If you do not specify this parameter, the operation defaults to 10 policy stores per response.\n You can specify a maximum of 50 policy stores per response.
" + "smithy.api#documentation": "Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If you do not specify this parameter, the operation defaults to 10 policy stores per response. You can specify a maximum of 50 policy stores per response.
" } } }, @@ -3964,7 +4015,7 @@ "nextToken": { "target": "com.amazonaws.verifiedpermissions#NextToken", "traits": { - "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.
Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.
Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.
If you do not specify this parameter, the operation defaults to 10 policy templates per response.\n You can specify a maximum of 50 policy templates per response.
" + "smithy.api#documentation": "Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
If you do not specify this parameter, the operation defaults to 10 policy templates per response. You can specify a maximum of 50 policy templates per response.
" } } }, @@ -4066,7 +4117,7 @@ "nextToken": { "target": "com.amazonaws.verifiedpermissions#NextToken", "traits": { - "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.
Returns the tags associated with the specified Amazon Verified Permissions resource. In Verified Permissions, policy stores can be tagged.
", + "smithy.api#examples": [ + { + "title": "ListTagsForResource", + "documentation": "The following example lists all the tags for the resource named in the API call.", + "input": { + "resourceArn": "C7v5xMplfFH3i3e4Jrzb1a" + }, + "output": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + ], + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#ListTagsForResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.verifiedpermissions#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the resource for which you want to view tags.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.verifiedpermissions#PolicyStore", + "ids": { + "policyStoreId": "resourceArn" + } + } + ] + } + }, + "com.amazonaws.verifiedpermissions#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.verifiedpermissions#TagMap", + "traits": { + "smithy.api#documentation": "The list of tags associated with the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.verifiedpermissions#LongAttribute": { "type": "long", "traits": { @@ -4128,18 +4261,18 @@ "target": "com.amazonaws.verifiedpermissions#Claim", "traits": { "smithy.api#default": "sub", - "smithy.api#documentation": "The claim that determines the principal in OIDC access tokens. For example,\n sub.
The claim that determines the principal in OIDC access tokens. For example, sub.
The access token aud claim values that you want to accept in your policy\n store. For example, https://myapp.example.com, https://myapp2.example.com.
The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.
The configuration of an OpenID Connect (OIDC) identity source for handling access token\n claims. Contains the claim that you want to identify as the principal in an authorization\n request, and the values of the aud claim, or audiences, that you want to\n accept.
This data type is part of a OpenIdConnectTokenSelection structure, which is a parameter of CreateIdentitySource.
" + "smithy.api#documentation": "The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.
This data type is part of a OpenIdConnectTokenSelection structure, which is a parameter of CreateIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#OpenIdConnectAccessTokenConfigurationDetail": { @@ -4149,18 +4282,18 @@ "target": "com.amazonaws.verifiedpermissions#Claim", "traits": { "smithy.api#default": "sub", - "smithy.api#documentation": "The claim that determines the principal in OIDC access tokens. For example,\n sub.
The claim that determines the principal in OIDC access tokens. For example, sub.
The access token aud claim values that you want to accept in your policy\n store. For example, https://myapp.example.com, https://myapp2.example.com.
The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.
The configuration of an OpenID Connect (OIDC) identity source for handling access token\n claims. Contains the claim that you want to identify as the principal in an authorization\n request, and the values of the aud claim, or audiences, that you want to\n accept.
This data type is part of a OpenIdConnectTokenSelectionDetail structure, which is a parameter of GetIdentitySource.
" + "smithy.api#documentation": "The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.
This data type is part of a OpenIdConnectTokenSelectionDetail structure, which is a parameter of GetIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#OpenIdConnectAccessTokenConfigurationItem": { @@ -4170,18 +4303,18 @@ "target": "com.amazonaws.verifiedpermissions#Claim", "traits": { "smithy.api#default": "sub", - "smithy.api#documentation": "The claim that determines the principal in OIDC access tokens. For example,\n sub.
The claim that determines the principal in OIDC access tokens. For example, sub.
The access token aud claim values that you want to accept in your policy\n store. For example, https://myapp.example.com, https://myapp2.example.com.
The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.
The configuration of an OpenID Connect (OIDC) identity source for handling access token\n claims. Contains the claim that you want to identify as the principal in an authorization\n request, and the values of the aud claim, or audiences, that you want to\n accept.
This data type is part of a OpenIdConnectTokenSelectionItem structure, which is a parameter of ListIdentitySources.
" + "smithy.api#documentation": "The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.
This data type is part of a OpenIdConnectTokenSelectionItem structure, which is a parameter of ListIdentitySources.
" } }, "com.amazonaws.verifiedpermissions#OpenIdConnectConfiguration": { @@ -4190,32 +4323,32 @@ "issuer": { "target": "com.amazonaws.verifiedpermissions#Issuer", "traits": { - "smithy.api#documentation": "The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery\n endpoint at the path .well-known/openid-configuration.
The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.
A descriptive string that you want to prefix to user entities from your OIDC identity\n provider. For example, if you set an entityIdPrefix of\n MyOIDCProvider, you can reference principals in your policies in the format\n MyCorp::User::MyOIDCProvider|Carlos.
A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.
The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.
The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.
The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.
", + "smithy.api#documentation": "The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.
\nThis data type is part of a Configuration structure, which\n is a parameter to CreateIdentitySource.
" + "smithy.api#documentation": "Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.
This data type is part of a Configuration structure, which is a parameter to CreateIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#OpenIdConnectConfigurationDetail": { @@ -4224,32 +4357,32 @@ "issuer": { "target": "com.amazonaws.verifiedpermissions#Issuer", "traits": { - "smithy.api#documentation": "The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery\n endpoint at the path .well-known/openid-configuration.
The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.
A descriptive string that you want to prefix to user entities from your OIDC identity\n provider. For example, if you set an entityIdPrefix of\n MyOIDCProvider, you can reference principals in your policies in the format\n MyCorp::User::MyOIDCProvider|Carlos.
A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.
The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.
The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.
The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.
", + "smithy.api#documentation": "The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.
\nThis data type is part of a ConfigurationDetail\n structure, which is a parameter to GetIdentitySource.
" + "smithy.api#documentation": "Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.
This data type is part of a ConfigurationDetail structure, which is a parameter to GetIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#OpenIdConnectConfigurationItem": { @@ -4258,32 +4391,32 @@ "issuer": { "target": "com.amazonaws.verifiedpermissions#Issuer", "traits": { - "smithy.api#documentation": "The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery\n endpoint at the path .well-known/openid-configuration.
The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.
A descriptive string that you want to prefix to user entities from your OIDC identity\n provider. For example, if you set an entityIdPrefix of\n MyOIDCProvider, you can reference principals in your policies in the format\n MyCorp::User::MyOIDCProvider|Carlos.
A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.
The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.
The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.
The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.
", + "smithy.api#documentation": "The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.
\nThis data type is part of a ConfigurationItem\n structure, which is a parameter to ListIdentitySources.
" + "smithy.api#documentation": "Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.
This data type is part of a ConfigurationItem structure, which is a parameter to ListIdentitySources.
" } }, "com.amazonaws.verifiedpermissions#OpenIdConnectGroupConfiguration": { @@ -4292,20 +4425,20 @@ "groupClaim": { "target": "com.amazonaws.verifiedpermissions#Claim", "traits": { - "smithy.api#documentation": "The token claim that you want Verified Permissions to interpret as group membership. For example,\n groups.
The token claim that you want Verified Permissions to interpret as group membership. For example, groups.
The policy store entity type that you want to map your users' group claim to. For example,\n MyCorp::UserGroup. A group entity type is an entity that can have a user\n entity type as a member.
The policy store entity type that you want to map your users' group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.
The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.
This data type is part of a OpenIdConnectConfiguration structure, which is a parameter of CreateIdentitySource.
" + "smithy.api#documentation": "The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.
This data type is part of a OpenIdConnectConfiguration structure, which is a parameter of CreateIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#OpenIdConnectGroupConfigurationDetail": { @@ -4314,20 +4447,20 @@ "groupClaim": { "target": "com.amazonaws.verifiedpermissions#Claim", "traits": { - "smithy.api#documentation": "The token claim that you want Verified Permissions to interpret as group membership. For example,\n groups.
The token claim that you want Verified Permissions to interpret as group membership. For example, groups.
The policy store entity type that you want to map your users' group claim to. For example,\n MyCorp::UserGroup. A group entity type is an entity that can have a user\n entity type as a member.
The policy store entity type that you want to map your users' group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.
The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.
This data type is part of a OpenIdConnectConfigurationDetail structure, which is a parameter of GetIdentitySource.
" + "smithy.api#documentation": "The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.
This data type is part of a OpenIdConnectConfigurationDetail structure, which is a parameter of GetIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#OpenIdConnectGroupConfigurationItem": { @@ -4336,20 +4469,20 @@ "groupClaim": { "target": "com.amazonaws.verifiedpermissions#Claim", "traits": { - "smithy.api#documentation": "The token claim that you want Verified Permissions to interpret as group membership. For example,\n groups.
The token claim that you want Verified Permissions to interpret as group membership. For example, groups.
The policy store entity type that you want to map your users' group claim to. For example,\n MyCorp::UserGroup. A group entity type is an entity that can have a user\n entity type as a member.
The policy store entity type that you want to map your users' group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.
The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.
This data type is part of a OpenIdConnectConfigurationItem structure, which is a parameter of ListIdentitySourcea.
" + "smithy.api#documentation": "The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.
This data type is part of a OpenIdConnectConfigurationItem structure, which is a parameter of ListIdentitySourcea.
" } }, "com.amazonaws.verifiedpermissions#OpenIdConnectIdentityTokenConfiguration": { @@ -4359,18 +4492,18 @@ "target": "com.amazonaws.verifiedpermissions#Claim", "traits": { "smithy.api#default": "sub", - "smithy.api#documentation": "The claim that determines the principal in OIDC access tokens. For example,\n sub.
The claim that determines the principal in OIDC access tokens. For example, sub.
The ID token audience, or client ID, claim values that you want to accept in your policy\n store from an OIDC identity provider. For example, 1example23456789,\n 2example10111213.
The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.
The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID)\n token claims. Contains the claim that you want to identify as the principal in an\n authorization request, and the values of the aud claim, or audiences, that\n you want to accept.
This data type is part of a OpenIdConnectTokenSelection structure, which is a parameter of CreateIdentitySource.
" + "smithy.api#documentation": "The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.
This data type is part of a OpenIdConnectTokenSelection structure, which is a parameter of CreateIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#OpenIdConnectIdentityTokenConfigurationDetail": { @@ -4380,18 +4513,18 @@ "target": "com.amazonaws.verifiedpermissions#Claim", "traits": { "smithy.api#default": "sub", - "smithy.api#documentation": "The claim that determines the principal in OIDC access tokens. For example,\n sub.
The claim that determines the principal in OIDC access tokens. For example, sub.
The ID token audience, or client ID, claim values that you want to accept in your policy\n store from an OIDC identity provider. For example, 1example23456789,\n 2example10111213.
The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.
The configuration of an OpenID Connect (OIDC) identity source for handling identity\n (ID) token claims. Contains the claim that you want to identify as the principal in an\n authorization request, and the values of the aud claim, or audiences, that\n you want to accept.
This data type is part of a OpenIdConnectTokenSelectionDetail structure, which is a parameter of GetIdentitySource.
" + "smithy.api#documentation": "The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.
This data type is part of a OpenIdConnectTokenSelectionDetail structure, which is a parameter of GetIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#OpenIdConnectIdentityTokenConfigurationItem": { @@ -4401,18 +4534,18 @@ "target": "com.amazonaws.verifiedpermissions#Claim", "traits": { "smithy.api#default": "sub", - "smithy.api#documentation": "The claim that determines the principal in OIDC access tokens. For example,\n sub.
The claim that determines the principal in OIDC access tokens. For example, sub.
The ID token audience, or client ID, claim values that you want to accept in your policy\n store from an OIDC identity provider. For example, 1example23456789,\n 2example10111213.
The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.
The configuration of an OpenID Connect (OIDC) identity source for handling identity\n (ID) token claims. Contains the claim that you want to identify as the principal in an\n authorization request, and the values of the aud claim, or audiences, that\n you want to accept.
This data type is part of a OpenIdConnectTokenSelectionItem structure, which is a parameter of ListIdentitySources.
" + "smithy.api#documentation": "The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.
This data type is part of a OpenIdConnectTokenSelectionItem structure, which is a parameter of ListIdentitySources.
" } }, "com.amazonaws.verifiedpermissions#OpenIdConnectTokenSelection": { @@ -4421,18 +4554,18 @@ "accessTokenOnly": { "target": "com.amazonaws.verifiedpermissions#OpenIdConnectAccessTokenConfiguration", "traits": { - "smithy.api#documentation": "The OIDC configuration for processing access tokens. Contains allowed audience claims,\n for example https://auth.example.com, and the claim that you want to map to the\n principal, for example sub.
The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.
The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID\n claims, for example 1example23456789, and the claim that you want to map to\n the principal, for example sub.
The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.
The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.
\nThis data type is part of a OpenIdConnectConfiguration structure, which is a parameter of CreateIdentitySource.
" + "smithy.api#documentation": "The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.
This data type is part of a OpenIdConnectConfiguration structure, which is a parameter of CreateIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#OpenIdConnectTokenSelectionDetail": { @@ -4441,18 +4574,18 @@ "accessTokenOnly": { "target": "com.amazonaws.verifiedpermissions#OpenIdConnectAccessTokenConfigurationDetail", "traits": { - "smithy.api#documentation": "The OIDC configuration for processing access tokens. Contains allowed audience claims,\n for example https://auth.example.com, and the claim that you want to map to the\n principal, for example sub.
The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.
The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID\n claims, for example 1example23456789, and the claim that you want to map to\n the principal, for example sub.
The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.
The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.
\nThis data type is part of a OpenIdConnectConfigurationDetail structure, which is a parameter of GetIdentitySource.
" + "smithy.api#documentation": "The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.
This data type is part of a OpenIdConnectConfigurationDetail structure, which is a parameter of GetIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#OpenIdConnectTokenSelectionItem": { @@ -4461,18 +4594,18 @@ "accessTokenOnly": { "target": "com.amazonaws.verifiedpermissions#OpenIdConnectAccessTokenConfigurationItem", "traits": { - "smithy.api#documentation": "The OIDC configuration for processing access tokens. Contains allowed audience claims,\n for example https://auth.example.com, and the claim that you want to map to the\n principal, for example sub.
The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.
The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID\n claims, for example 1example23456789, and the claim that you want to map to\n the principal, for example sub.
The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.
The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.
\nThis data type is part of a OpenIdConnectConfigurationItem structure, which is a parameter of ListIdentitySources.
" + "smithy.api#documentation": "The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.
This data type is part of a OpenIdConnectConfigurationItem structure, which is a parameter of ListIdentitySources.
" } }, "com.amazonaws.verifiedpermissions#OpenIdIssuer": { @@ -4531,18 +4664,18 @@ "static": { "target": "com.amazonaws.verifiedpermissions#StaticPolicyDefinition", "traits": { - "smithy.api#documentation": "A structure that describes a static policy. An static policy doesn't use a template or allow\n placeholders for entities.
" + "smithy.api#documentation": "A structure that describes a static policy. An static policy doesn't use a template or allow placeholders for entities.
" } }, "templateLinked": { "target": "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinition", "traits": { - "smithy.api#documentation": "A structure that describes a policy that was instantiated from a template. The\n template can specify placeholders for principal and resource.\n When you use CreatePolicy to create a policy from a template, you specify the exact\n principal and resource to use for the instantiated policy.
A structure that describes a policy that was instantiated from a template. The template can specify placeholders for principal and resource. When you use CreatePolicy to create a policy from a template, you specify the exact principal and resource to use for the instantiated policy.
A structure that contains the details for a Cedar policy definition. It includes the\n policy type, a description, and a policy body. This is a top level data type used to\n create a policy.
\nThis data type is used as a request parameter for the CreatePolicy operation. This\n structure must always have either an static or a templateLinked\n element.
A structure that contains the details for a Cedar policy definition. It includes the policy type, a description, and a policy body. This is a top level data type used to create a policy.
This data type is used as a request parameter for the CreatePolicy operation. This structure must always have either an static or a templateLinked element.
A structure that describes a policy definition. It must always have either an\n static or a templateLinked element.
This data type is used as a response parameter for the GetPolicy operation.
" + "smithy.api#documentation": "A structure that describes a policy definition. It must always have either an static or a templateLinked element.
This data type is used as a response parameter for the GetPolicy operation.
" } }, "com.amazonaws.verifiedpermissions#PolicyDefinitionItem": { @@ -4582,7 +4715,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure that describes a PolicyDefinintion. It will\n always have either an StaticPolicy or a TemplateLinkedPolicy\n element.
This data type is used as a response parameter for the CreatePolicy and ListPolicies\n operations.
" + "smithy.api#documentation": "A structure that describes a PolicyDefinintion. It will always have either an StaticPolicy or a TemplateLinkedPolicy element.
This data type is used as a response parameter for the CreatePolicy and ListPolicies operations.
" } }, "com.amazonaws.verifiedpermissions#PolicyEffect": { @@ -4626,12 +4759,12 @@ "policyTemplateId": { "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", "traits": { - "smithy.api#documentation": "Filters the output to only template-linked policies that were instantiated from the specified\n policy template.
" + "smithy.api#documentation": "Filters the output to only template-linked policies that were instantiated from the specified policy template.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about a filter to refine policies returned in a query.
\nThis data type is used as a response parameter for the ListPolicies operation.
" + "smithy.api#documentation": "Contains information about a filter to refine policies returned in a query.
This data type is used as a response parameter for the ListPolicies operation.
" } }, "com.amazonaws.verifiedpermissions#PolicyId": { @@ -4650,7 +4783,7 @@ "policyStoreId": { "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", "traits": { - "smithy.api#documentation": "The identifier of the policy store where the policy you want information about is\n stored.
", + "smithy.api#documentation": "The identifier of the policy store where the policy you want information about is stored.
", "smithy.api#required": {} } }, @@ -4664,7 +4797,7 @@ "policyType": { "target": "com.amazonaws.verifiedpermissions#PolicyType", "traits": { - "smithy.api#documentation": "The type of the policy. This is one of the following values:
\n\n STATIC\n
\n TEMPLATE_LINKED\n
The type of the policy. This is one of the following values:
STATIC
TEMPLATE_LINKED
The action that a policy permits or forbids. For example, \n{\"actions\": [{\"actionId\": \"ViewPhoto\", \"actionType\": \"PhotoFlash::Action\"}, {\"entityID\": \"SharePhoto\", \n\"entityType\": \"PhotoFlash::Action\"}]}.
The action that a policy permits or forbids. For example, {\"actions\": [{\"actionId\": \"ViewPhoto\", \"actionType\": \"PhotoFlash::Action\"}, {\"entityID\": \"SharePhoto\", \"entityType\": \"PhotoFlash::Action\"}]}.
The effect of the decision that a policy returns to an authorization \nrequest. For example, \"effect\": \"Permit\".
The effect of the decision that a policy returns to an authorization request. For example, \"effect\": \"Permit\".
Contains information about a policy.
\nThis data type is used as a response parameter for the ListPolicies operation.
" + "smithy.api#documentation": "Contains information about a policy.
This data type is used as a response parameter for the ListPolicies operation.
" } }, "com.amazonaws.verifiedpermissions#PolicyList": { @@ -4798,6 +4931,9 @@ "noRegion": true }, "aws.cloudformation#cfnResource": {}, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ], "aws.iam#disableConditionKeyInference": {}, "aws.iam#iamResource": { "name": "policy-store" @@ -4822,7 +4958,7 @@ "min": 1, "max": 200 }, - "smithy.api#pattern": "^[a-zA-Z0-9-]*$" + "smithy.api#pattern": "^[a-zA-Z0-9-/_]*$" } }, "com.amazonaws.verifiedpermissions#PolicyStoreItem": { @@ -4858,12 +4994,12 @@ "description": { "target": "com.amazonaws.verifiedpermissions#PolicyStoreDescription", "traits": { - "smithy.api#documentation": "Descriptive text that you can provide to help with identification \n of the current policy store.
" + "smithy.api#documentation": "Descriptive text that you can provide to help with identification of the current policy store.
" } } }, "traits": { - "smithy.api#documentation": "Contains information about a policy store.
\nThis data type is used as a response parameter for the ListPolicyStores\n operation.
" + "smithy.api#documentation": "Contains information about a policy store.
This data type is used as a response parameter for the ListPolicyStores operation.
" } }, "com.amazonaws.verifiedpermissions#PolicyStoreList": { @@ -4919,7 +5055,7 @@ "min": 1, "max": 200 }, - "smithy.api#pattern": "^[a-zA-Z0-9-]*$" + "smithy.api#pattern": "^[a-zA-Z0-9-/_]*$" } }, "com.amazonaws.verifiedpermissions#PolicyTemplateItem": { @@ -4961,7 +5097,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains details about a policy template
\nThis data type is used as a response parameter for the ListPolicyTemplates\n operation.
" + "smithy.api#documentation": "Contains details about a policy template
This data type is used as a response parameter for the ListPolicyTemplates operation.
" } }, "com.amazonaws.verifiedpermissions#PolicyTemplatesList": { @@ -5021,7 +5157,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to create or update the policy schema in the specified policy store" }, - "smithy.api#documentation": "Creates or updates the policy schema in the specified policy store. The schema is used to\n validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema\n validate only policies and templates submitted after the schema change. Existing\n policies and templates are not re-evaluated against the changed schema. If you later\n update a policy, then it is evaluated against the new schema at that time.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nCreates or updates the policy schema in the specified policy store. The schema is used to validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema validate only policies and templates submitted after the schema change. Existing policies and templates are not re-evaluated against the changed schema. If you later update a policy, then it is evaluated against the new schema at that time.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
Specifies the definition of the schema to be stored. The schema definition must be\n written in Cedar schema JSON.
", + "smithy.api#documentation": "Specifies the definition of the schema to be stored. The schema definition must be written in Cedar schema JSON.
", "smithy.api#required": {} } } @@ -5221,12 +5357,12 @@ "cedarJson": { "target": "com.amazonaws.verifiedpermissions#SchemaJson", "traits": { - "smithy.api#documentation": "A JSON string representation of the schema supported by applications that use this\n policy store. To delete the schema, run PutSchema with {} for\n this parameter. For more information, see Policy store schema in the\n Amazon Verified Permissions User Guide.
A JSON string representation of the schema supported by applications that use this policy store. To delete the schema, run PutSchema with {} for this parameter. For more information, see Policy store schema in the Amazon Verified Permissions User Guide.
Contains a list of principal types, resource types, and actions that can be specified\n in policies stored in the same policy store. If the validation mode for the policy store is set to\n STRICT, then policies that can't be validated by this schema are\n rejected by Verified Permissions and can't be stored in the policy store.
Contains a list of principal types, resource types, and actions that can be specified in policies stored in the same policy store. If the validation mode for the policy store is set to STRICT, then policies that can't be validated by this schema are rejected by Verified Permissions and can't be stored in the policy store.
Contains information about a static policy.
\nThis data type is used as a field that is part of the PolicyDefinitionDetail\n type.
" + "smithy.api#documentation": "Contains information about a static policy.
This data type is used as a field that is part of the PolicyDefinitionDetail type.
" } }, "com.amazonaws.verifiedpermissions#StaticPolicyDefinitionDetail": { @@ -5324,7 +5460,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure that contains details about a static policy. It includes the description and\n policy body.
\nThis data type is used within a PolicyDefinition structure as\n part of a request parameter for the CreatePolicy operation.
" + "smithy.api#documentation": "A structure that contains details about a static policy. It includes the description and policy body.
This data type is used within a PolicyDefinition structure as part of a request parameter for the CreatePolicy operation.
" } }, "com.amazonaws.verifiedpermissions#StaticPolicyDefinitionItem": { @@ -5338,7 +5474,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure that contains details about a static policy. It includes the description and\n policy statement.
\nThis data type is used within a PolicyDefinition structure as\n part of a request parameter for the CreatePolicy operation.
" + "smithy.api#documentation": "A structure that contains details about a static policy. It includes the description and policy statement.
This data type is used within a PolicyDefinition structure as part of a request parameter for the CreatePolicy operation.
" } }, "com.amazonaws.verifiedpermissions#StaticPolicyDescription": { @@ -5357,6 +5493,135 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.verifiedpermissions#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.verifiedpermissions#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.verifiedpermissions#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.verifiedpermissions#TagKey" + }, + "value": { + "target": "com.amazonaws.verifiedpermissions#TagValue" + }, + "traits": { + "smithy.api#length": { + "max": 200 + } + } + }, + "com.amazonaws.verifiedpermissions#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#AccessDeniedException" + }, + { + "target": "com.amazonaws.verifiedpermissions#InternalServerException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ThrottlingException" + }, + { + "target": "com.amazonaws.verifiedpermissions#TooManyTagsException" + } + ], + "traits": { + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}", + "aws:RequestTag/${TagKey}", + "aws:TagKeys" + ], + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified Amazon Verified Permissions resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Verified Permissions, policy stores can be tagged.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
", + "smithy.api#examples": [ + { + "title": "TagResource", + "documentation": "The following example tags the resource.", + "input": { + "resourceArn": "C7v5xMplfFH3i3e4Jrzb1a", + "tags": { + "key1": "value1", + "key2": "value2" + } + }, + "output": {} + } + ] + } + }, + "com.amazonaws.verifiedpermissions#TagResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.verifiedpermissions#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the resource that you're adding tags to.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.verifiedpermissions#TagMap", + "traits": { + "smithy.api#documentation": "The list of key-value pairs to associate with the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.verifiedpermissions#PolicyStore", + "ids": { + "policyStoreId": "resourceArn" + } + } + ] + } + }, + "com.amazonaws.verifiedpermissions#TagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinition": { "type": "structure", "members": { @@ -5370,13 +5635,13 @@ "principal": { "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", "traits": { - "smithy.api#documentation": "The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the\n ?principal placeholder in the policy template when it evaluates an authorization\n request.
The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the ?principal placeholder in the policy template when it evaluates an authorization request.
The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the\n ?resource placeholder in the policy template when it evaluates an authorization\n request.
The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the ?resource placeholder in the policy template when it evaluates an authorization request.
The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the\n ?principal placeholder in the policy template when it evaluates an authorization\n request.
The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the ?principal placeholder in the policy template when it evaluates an authorization request.
The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the\n ?resource placeholder in the policy template when it evaluates an authorization\n request.
The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the ?resource placeholder in the policy template when it evaluates an authorization request.
Contains information about a policy that was created by instantiating a policy\n template.
" + "smithy.api#documentation": "Contains information about a policy that was created by instantiating a policy template.
" } }, "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinitionItem": { @@ -5424,18 +5689,18 @@ "principal": { "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", "traits": { - "smithy.api#documentation": "The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the\n ?principal placeholder in the policy template when it evaluates an authorization\n request.
The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the ?principal placeholder in the policy template when it evaluates an authorization request.
The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the\n ?resource placeholder in the policy template when it evaluates an authorization\n request.
The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the ?resource placeholder in the policy template when it evaluates an authorization request.
Contains information about a policy created by instantiating a policy template.
\nThis
" + "smithy.api#documentation": "Contains information about a policy created by instantiating a policy template.
This
" } }, "com.amazonaws.verifiedpermissions#ThrottlingException": { @@ -5486,13 +5751,111 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.verifiedpermissions#TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + }, + "resourceName": { + "target": "com.amazonaws.verifiedpermissions#AmazonResourceName" + } + }, + "traits": { + "smithy.api#documentation": "No more tags be added because the limit (50) has been reached. To add new tags, use UntagResource to remove existing tags.
Removes one or more tags from the specified Amazon Verified Permissions resource. In Verified Permissions, policy stores can be tagged.
", + "smithy.api#examples": [ + { + "title": "UntagResource", + "documentation": "The following example removes the listed tags from the resource.", + "input": { + "resourceArn": "C7v5xMplfFH3i3e4Jrzb1a", + "tagKeys": [ + "key1", + "key2" + ] + }, + "output": {} + } + ] + } + }, + "com.amazonaws.verifiedpermissions#UntagResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.verifiedpermissions#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The ARN of the resource from which you are removing tags.
", + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.verifiedpermissions#TagKeyList", + "traits": { + "aws.iam#conditionKeyValue": "aws:TagKeys", + "smithy.api#documentation": "The list of tag keys to remove from the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.verifiedpermissions#PolicyStore", + "ids": { + "policyStoreId": "resourceArn" + } + } + ] + } + }, + "com.amazonaws.verifiedpermissions#UntagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.verifiedpermissions#UpdateCognitoGroupConfiguration": { "type": "structure", "members": { "groupEntityType": { "target": "com.amazonaws.verifiedpermissions#GroupEntityType", "traits": { - "smithy.api#documentation": "The name of the schema entity type that's mapped to the user pool group. Defaults\n to AWS::CognitoGroup.
The name of the schema entity type that's mapped to the user pool group. Defaults to AWS::CognitoGroup.
The client ID of an app client that is configured for the specified Amazon Cognito user\n pool.
" + "smithy.api#documentation": "The client ID of an app client that is configured for the specified Amazon Cognito user pool.
" } }, "groupConfiguration": { "target": "com.amazonaws.verifiedpermissions#UpdateCognitoGroupConfiguration", "traits": { - "smithy.api#documentation": "The configuration of the user groups from an Amazon Cognito user pool identity\n source.
" + "smithy.api#documentation": "The configuration of the user groups from an Amazon Cognito user pool identity source.
" } } }, @@ -5540,7 +5903,7 @@ "openIdConnectConfiguration": { "target": "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectConfiguration", "traits": { - "smithy.api#documentation": "Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.
" + "smithy.api#documentation": "Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.
" } } }, @@ -5568,7 +5931,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to update the specified identity source to use a new identity provider (IdP) source, or to change the mapping of identities from the IdP to a different principal entity type" }, - "smithy.api#documentation": "Updates the specified identity source to use a new identity provider (IdP), or to change\n the mapping of identities from the IdP to a different principal entity type.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nUpdates the specified identity source to use a new identity provider (IdP), or to change the mapping of identities from the IdP to a different principal entity type.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
Specifies the details required to communicate with the identity provider (IdP)\n associated with this identity source.
", + "smithy.api#documentation": "Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.
", "smithy.api#required": {} } }, "principalEntityType": { "target": "com.amazonaws.verifiedpermissions#PrincipalEntityType", "traits": { - "smithy.api#documentation": "Specifies the data type of principals generated for identities authenticated by the\n identity source.
" + "smithy.api#documentation": "Specifies the data type of principals generated for identities authenticated by the identity source.
" } } }, @@ -5675,18 +6038,18 @@ "target": "com.amazonaws.verifiedpermissions#Claim", "traits": { "smithy.api#default": "sub", - "smithy.api#documentation": "The claim that determines the principal in OIDC access tokens. For example,\n sub.
The claim that determines the principal in OIDC access tokens. For example, sub.
The access token aud claim values that you want to accept in your policy\n store. For example, https://myapp.example.com, https://myapp2.example.com.
The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.
The configuration of an OpenID Connect (OIDC) identity source for handling access token\n claims. Contains the claim that you want to identify as the principal in an authorization\n request, and the values of the aud claim, or audiences, that you want to\n accept.
This data type is part of a UpdateOpenIdConnectTokenSelection structure, which is a parameter to UpdateIdentitySource.
" + "smithy.api#documentation": "The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.
This data type is part of a UpdateOpenIdConnectTokenSelection structure, which is a parameter to UpdateIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectConfiguration": { @@ -5695,32 +6058,32 @@ "issuer": { "target": "com.amazonaws.verifiedpermissions#Issuer", "traits": { - "smithy.api#documentation": "The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery\n endpoint at the path .well-known/openid-configuration.
The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.
A descriptive string that you want to prefix to user entities from your OIDC identity\n provider. For example, if you set an entityIdPrefix of\n MyOIDCProvider, you can reference principals in your policies in the format\n MyCorp::User::MyOIDCProvider|Carlos.
A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.
The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.
The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.
The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.
", + "smithy.api#documentation": "The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains configuration details of an OpenID Connect (OIDC) identity provider, or\n identity source, that Verified Permissions can use to generate entities from authenticated identities. It\n specifies the issuer URL, token type that you want to use, and policy store entity\n details.
\nThis data type is part of a UpdateConfiguration\n structure, which is a parameter to UpdateIdentitySource.
" + "smithy.api#documentation": "Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.
This data type is part of a UpdateConfiguration structure, which is a parameter to UpdateIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectGroupConfiguration": { @@ -5729,20 +6092,20 @@ "groupClaim": { "target": "com.amazonaws.verifiedpermissions#Claim", "traits": { - "smithy.api#documentation": "The token claim that you want Verified Permissions to interpret as group membership. For example,\n groups.
The token claim that you want Verified Permissions to interpret as group membership. For example, groups.
The policy store entity type that you want to map your users' group claim to. For example,\n MyCorp::UserGroup. A group entity type is an entity that can have a user\n entity type as a member.
The policy store entity type that you want to map your users' group claim to. For example, MyCorp::UserGroup. A group entity type is an entity that can have a user entity type as a member.
The claim in OIDC identity provider tokens that indicates a user's group membership, and\n the entity type that you want to map it to. For example, this object can map the contents\n of a groups claim to MyCorp::UserGroup.
This data type is part of a UpdateOpenIdConnectConfiguration structure, which is a parameter to UpdateIdentitySource.
" + "smithy.api#documentation": "The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.
This data type is part of a UpdateOpenIdConnectConfiguration structure, which is a parameter to UpdateIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectIdentityTokenConfiguration": { @@ -5752,18 +6115,18 @@ "target": "com.amazonaws.verifiedpermissions#Claim", "traits": { "smithy.api#default": "sub", - "smithy.api#documentation": "The claim that determines the principal in OIDC access tokens. For example,\n sub.
The claim that determines the principal in OIDC access tokens. For example, sub.
The ID token audience, or client ID, claim values that you want to accept in your policy\n store from an OIDC identity provider. For example, 1example23456789,\n 2example10111213.
The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider. For example, 1example23456789, 2example10111213.
The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID)\n token claims. Contains the claim that you want to identify as the principal in an\n authorization request, and the values of the aud claim, or audiences, that\n you want to accept.
This data type is part of a UpdateOpenIdConnectTokenSelection structure, which is a parameter to UpdateIdentitySource.
" + "smithy.api#documentation": "The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.
This data type is part of a UpdateOpenIdConnectTokenSelection structure, which is a parameter to UpdateIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectTokenSelection": { @@ -5772,18 +6135,18 @@ "accessTokenOnly": { "target": "com.amazonaws.verifiedpermissions#UpdateOpenIdConnectAccessTokenConfiguration", "traits": { - "smithy.api#documentation": "The OIDC configuration for processing access tokens. Contains allowed audience claims,\n for example https://auth.example.com, and the claim that you want to map to the\n principal, for example sub.
The OIDC configuration for processing access tokens. Contains allowed audience claims, for example https://auth.example.com, and the claim that you want to map to the principal, for example sub.
The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID\n claims, for example 1example23456789, and the claim that you want to map to\n the principal, for example sub.
The OIDC configuration for processing identity (ID) tokens. Contains allowed client ID claims, for example 1example23456789, and the claim that you want to map to the principal, for example sub.
The token type that you want to process from your OIDC identity provider. Your policy\n store can process either identity (ID) or access tokens from a given OIDC identity\n source.
\nThis data type is part of a UpdateOpenIdConnectConfiguration structure, which is a parameter to UpdateIdentitySource.
" + "smithy.api#documentation": "The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.
This data type is part of a UpdateOpenIdConnectConfiguration structure, which is a parameter to UpdateIdentitySource.
" } }, "com.amazonaws.verifiedpermissions#UpdatePolicy": { @@ -5809,7 +6172,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to modify the specified Cedar static policy in the specified policy store" }, - "smithy.api#documentation": "Modifies a Cedar static policy in the specified policy store. You can change only certain elements of\n the UpdatePolicyDefinition parameter. You can directly update only static policies. To\n change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate.
\nIf policy validation is enabled in the policy store, then updating a static policy causes\n Verified Permissions to validate the policy against the schema in the policy store. If the updated\n static policy doesn't pass validation, the operation fails and the update isn't\n stored.
\nWhen you edit a static policy, you can change only certain elements of a static\n policy:
\nThe action referenced by the policy.
\nA condition clause, such as when and unless.
\nYou can't change these elements of a static policy:
\nChanging a policy from a static policy to a template-linked\n policy.
\nChanging the effect of a static policy from permit or forbid.\n
\nThe principal referenced by a static policy.
\nThe resource referenced by a static policy.
\nTo update a template-linked policy, you must update the template instead.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nModifies a Cedar static policy in the specified policy store. You can change only certain elements of the UpdatePolicyDefinition parameter. You can directly update only static policies. To change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate.
If policy validation is enabled in the policy store, then updating a static policy causes Verified Permissions to validate the policy against the schema in the policy store. If the updated static policy doesn't pass validation, the operation fails and the update isn't stored.
When you edit a static policy, you can change only certain elements of a static policy:
The action referenced by the policy.
A condition clause, such as when and unless.
You can't change these elements of a static policy:
Changing a policy from a static policy to a template-linked policy.
Changing the effect of a static policy from permit or forbid.
The principal referenced by a static policy.
The resource referenced by a static policy.
To update a template-linked policy, you must update the template instead.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
Contains information about updates to be applied to a policy.
\nThis data type is used as a request parameter in the UpdatePolicy operation.
" + "smithy.api#documentation": "Contains information about updates to be applied to a policy.
This data type is used as a request parameter in the UpdatePolicy operation.
" } }, "com.amazonaws.verifiedpermissions#UpdatePolicyInput": { @@ -5866,7 +6229,7 @@ "policyId": { "target": "com.amazonaws.verifiedpermissions#PolicyId", "traits": { - "smithy.api#documentation": "Specifies the ID of the policy that you want to update. To find this value, you can\n use ListPolicies.
", + "smithy.api#documentation": "Specifies the ID of the policy that you want to update. To find this value, you can use ListPolicies.
", "smithy.api#required": {} } }, @@ -5874,7 +6237,7 @@ "target": "com.amazonaws.verifiedpermissions#UpdatePolicyDefinition", "traits": { "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "Specifies the updated policy content that you want to replace on the specified policy.\n The content must be valid Cedar policy language text.
\nYou can change only the following elements from the policy definition:
\nThe action referenced by the policy.
Any conditional clauses, such as when or unless\n clauses.
You can't change the following elements:
\nChanging from static to templateLinked.
Changing the effect of the policy from permit or\n forbid.
The principal referenced by the policy.
The resource referenced by the policy.
Specifies the updated policy content that you want to replace on the specified policy. The content must be valid Cedar policy language text.
You can change only the following elements from the policy definition:
The action referenced by the policy.
Any conditional clauses, such as when or unless clauses.
You can't change the following elements:
Changing from static to templateLinked.
Changing the effect of the policy from permit or forbid.
The principal referenced by the policy.
The resource referenced by the policy.
The principal specified in the policy's scope. This element isn't included in the\n response when Principal isn't present in the policy content.
The principal specified in the policy's scope. This element isn't included in the response when Principal isn't present in the policy content.
The resource specified in the policy's scope. This element isn't included in the\n response when Resource isn't present in the policy content.
The resource specified in the policy's scope. This element isn't included in the response when Resource isn't present in the policy content.
The action that a policy permits or forbids. For example, \n{\"actions\": [{\"actionId\": \"ViewPhoto\", \"actionType\": \"PhotoFlash::Action\"}, {\"entityID\": \"SharePhoto\", \n\"entityType\": \"PhotoFlash::Action\"}]}.
The action that a policy permits or forbids. For example, {\"actions\": [{\"actionId\": \"ViewPhoto\", \"actionType\": \"PhotoFlash::Action\"}, {\"entityID\": \"SharePhoto\", \"entityType\": \"PhotoFlash::Action\"}]}.
The effect of the decision that a policy returns to an authorization \nrequest. For example, \"effect\": \"Permit\".
The effect of the decision that a policy returns to an authorization request. For example, \"effect\": \"Permit\".
Modifies the validation setting for a policy store.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nModifies the validation setting for a policy store.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
A structure that defines the validation settings that want to enable for the\n policy store.
", + "smithy.api#documentation": "A structure that defines the validation settings that want to enable for the policy store.
", "smithy.api#required": {} } }, "deletionProtection": { "target": "com.amazonaws.verifiedpermissions#DeletionProtection", "traits": { - "smithy.api#documentation": "Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.
\nWhen you call UpdatePolicyStore, this parameter is unchanged unless explicitly included in the call.
Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted.
When you call UpdatePolicyStore, this parameter is unchanged unless explicitly included in the call.
Descriptive text that you can provide to help with identification \n of the current policy store.
" + "smithy.api#documentation": "Descriptive text that you can provide to help with identification of the current policy store.
" } } }, @@ -6082,7 +6445,7 @@ "aws.iam#iamAction": { "documentation": "Grants permission to update the specified policy template" }, - "smithy.api#documentation": "Updates the specified policy template. You can update only the description and the some elements\n of the policyBody.
\nChanges you make to the policy template content are immediately (within the constraints of\n eventual consistency) reflected in authorization decisions that involve all template-linked policies\n instantiated from this template.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nUpdates the specified policy template. You can update only the description and the some elements of the policyBody.
Changes you make to the policy template content are immediately (within the constraints of eventual consistency) reflected in authorization decisions that involve all template-linked policies instantiated from this template.
Verified Permissions is eventually consistent . It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations.
Specifies new statement content written in Cedar policy language to replace the\n current body of the policy template.
\nYou can change only the following elements of the policy body:
\nThe action referenced by the policy template.
Any conditional clauses, such as when or unless\n clauses.
You can't change the following elements:
\nThe effect (permit or forbid) of the policy template.
The principal referenced by the policy template.
The resource referenced by the policy template.
Specifies new statement content written in Cedar policy language to replace the current body of the policy template.
You can change only the following elements of the policy body:
The action referenced by the policy template.
Any conditional clauses, such as when or unless clauses.
You can't change the following elements:
The effect (permit or forbid) of the policy template.
The principal referenced by the policy template.
The resource referenced by the policy template.
Specifies the Cedar policy language text to be added to or replaced on the static policy.
\nYou can change only the following elements from the original content:
\nThe action referenced by the policy.
Any conditional clauses, such as when or unless\n clauses.
You can't change the following elements:
\nChanging from StaticPolicy to\n TemplateLinkedPolicy.
The effect (permit or forbid) of the\n policy.
The principal referenced by the policy.
The resource referenced by the policy.
Specifies the Cedar policy language text to be added to or replaced on the static policy.
You can change only the following elements from the original content:
The action referenced by the policy.
Any conditional clauses, such as when or unless clauses.
You can't change the following elements:
Changing from StaticPolicy to TemplateLinkedPolicy.
The effect (permit or forbid) of the policy.
The principal referenced by the policy.
The resource referenced by the policy.
The request failed because one or more input parameters don't satisfy their constraint\n requirements. The output is provided as a list of fields and a reason for each field that\n isn't valid.
\nThe possible reasons include the following:
\n\n UnrecognizedEntityType\n
\nThe policy includes an entity type that isn't found in the schema.
\n\n UnrecognizedActionId\n
\nThe policy includes an action id that isn't found in the schema.
\n\n InvalidActionApplication\n
\nThe policy includes an action that, according to the schema, doesn't support\n the specified principal and resource.
\n\n UnexpectedType\n
\nThe policy included an operand that isn't a valid type for the specified\n operation.
\n\n IncompatibleTypes\n
\nThe types of elements included in a set, or the types of\n expressions used in an if...then...else clause aren't compatible in\n this context.
\n MissingAttribute\n
\nThe policy attempts to access a record or entity attribute that isn't\n specified in the schema. Test for the existence of the attribute first before\n attempting to access its value. For more information, see the has (presence of attribute test) operator in the\n Cedar Policy Language Guide.
\n\n UnsafeOptionalAttributeAccess\n
\nThe policy attempts to access a record or entity attribute that is optional\n and isn't guaranteed to be present. Test for the existence of the attribute\n first before attempting to access its value. For more information, see the\n has (presence of attribute test) operator in the\n Cedar Policy Language Guide.
\n\n ImpossiblePolicy\n
\nCedar has determined that a policy condition always evaluates to false. If\n the policy is always false, it can never apply to any query, and so it can never\n affect an authorization decision.
\n\n WrongNumberArguments\n
\nThe policy references an extension type with the wrong number of\n arguments.
\n\n FunctionArgumentValidationError\n
\nCedar couldn't parse the argument passed to an extension type. For example,\n a string that is to be parsed as an IPv4 address can contain only digits and the\n period character.
\nThe request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.
The possible reasons include the following:
UnrecognizedEntityType
The policy includes an entity type that isn't found in the schema.
UnrecognizedActionId
The policy includes an action id that isn't found in the schema.
InvalidActionApplication
The policy includes an action that, according to the schema, doesn't support the specified principal and resource.
UnexpectedType
The policy included an operand that isn't a valid type for the specified operation.
IncompatibleTypes
The types of elements included in a set, or the types of expressions used in an if...then...else clause aren't compatible in this context.
MissingAttribute
The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.
UnsafeOptionalAttributeAccess
The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the has (presence of attribute test) operator in the Cedar Policy Language Guide.
ImpossiblePolicy
Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.
WrongNumberArguments
The policy references an extension type with the wrong number of arguments.
FunctionArgumentValidationError
Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.
The validation mode currently configured for this policy store. The valid values are:
\n\n OFF \u2013 Neither Verified Permissions nor Cedar\n perform any validation on policies. No validation errors are reported by either\n service.
\n\n STRICT \u2013 Requires a schema to be\n present in the policy store. Cedar performs validation on all submitted new or updated\n static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store\n them in the policy store.
\nIf Mode=STRICT and the policy store doesn't contain a schema, Verified Permissions rejects\n all static policies and policy templates because there is no schema to validate against.
To submit a static policy or policy template without a schema, you must turn off validation.
\nThe validation mode currently configured for this policy store. The valid values are:
OFF \u2013 Neither Verified Permissions nor Cedar perform any validation on policies. No validation errors are reported by either service.
STRICT \u2013 Requires a schema to be present in the policy store. Cedar performs validation on all submitted new or updated static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store them in the policy store.
If Mode=STRICT and the policy store doesn't contain a schema, Verified Permissions rejects all static policies and policy templates because there is no schema to validate against.
To submit a static policy or policy template without a schema, you must turn off validation.
A structure that contains Cedar policy validation settings for the policy store. The\n validation mode determines which validation failures that Cedar considers serious\n enough to block acceptance of a new or edited static policy or policy template.
\nThis data type is used as a request parameter in the CreatePolicyStore and UpdatePolicyStore operations.
" + "smithy.api#documentation": "A structure that contains Cedar policy validation settings for the policy store. The validation mode determines which validation failures that Cedar considers serious enough to block acceptance of a new or edited static policy or policy template.
This data type is used as a request parameter in the CreatePolicyStore and UpdatePolicyStore operations.
" } }, "com.amazonaws.verifiedpermissions#VerifiedPermissions": { "type": "service", "version": "2021-12-01", + "operations": [ + { + "target": "com.amazonaws.verifiedpermissions#ListTagsForResource" + }, + { + "target": "com.amazonaws.verifiedpermissions#TagResource" + }, + { + "target": "com.amazonaws.verifiedpermissions#UntagResource" + } + ], "resources": [ { "target": "com.amazonaws.verifiedpermissions#PolicyStore" @@ -6305,9 +6679,6 @@ { "target": "com.amazonaws.verifiedpermissions#ThrottlingException" }, - { - "target": "com.amazonaws.verifiedpermissions#ThrottlingException" - }, { "target": "com.amazonaws.verifiedpermissions#ValidationException" } @@ -6321,6 +6692,23 @@ "aws.auth#sigv4": { "name": "verifiedpermissions" }, + "aws.iam#defineConditionKeys": { + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by a tag key and value pair of a resource", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by a tag key and value pair that is allowed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" + }, + "aws:TagKeys": { + "type": "ArrayOfString", + "documentation": "Filters access by a list of tag keys that are allowed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" + } + }, "aws.iam#supportedPrincipalTypes": [ "Root", "IAMUser", @@ -6328,7 +6716,7 @@ "FederatedUser" ], "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "Amazon Verified Permissions is a permissions management service from Amazon Web Services. You can use Verified Permissions to manage\n permissions for your application, and authorize user access based on those permissions.\n Using Verified Permissions, application developers can grant access based on information about the\n users, resources, and requested actions. You can also evaluate additional information\n like group membership, attributes of the resources, and session context, such as time of\n request and IP addresses. Verified Permissions manages these permissions by letting you create and\n store authorization policies for your applications, such as consumer-facing web sites\n and enterprise business systems.
\nVerified Permissions uses Cedar as the policy language to express your permission requirements.\n Cedar supports both role-based access control (RBAC) and attribute-based access\n control (ABAC) authorization models.
\nFor more information about configuring, administering, and using Amazon Verified Permissions in your\n applications, see the Amazon Verified Permissions User Guide.
\nFor more information about the Cedar policy language, see the Cedar Policy Language Guide.
\nWhen you write Cedar policies that reference principals, resources and actions,\n you can define the unique identifiers used for each of those elements. We strongly\n recommend that you follow these best practices:
\n\n Use values like universally unique identifiers\n (UUIDs) for all principal and resource identifiers.\n
\nFor example, if user jane leaves the company, and you later\n let someone else use the name jane, then that new user\n automatically gets access to everything granted by policies that still\n reference User::\"jane\". Cedar can\u2019t distinguish between the\n new user and the old. This applies to both principal and resource\n identifiers. Always use identifiers that are guaranteed unique and never\n reused to ensure that you don\u2019t unintentionally grant access because of the\n presence of an old identifier in a policy.
Where you use a UUID for an entity, we recommend that you follow it with\n the // comment specifier and the \u2018friendly\u2019 name of your entity. This helps\n to make your policies easier to understand. For example: principal ==\n User::\"a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111\", // alice
\n\n Do not include personally identifying, confidential,\n or sensitive information as part of the unique identifier for your\n principals or resources. These identifiers are included in\n log entries shared in CloudTrail trails.
\nSeveral operations return structures that appear similar, but have different purposes.\n As new functionality is added to the product, the structure used in a parameter of one\n operation might need to change in a way that wouldn't make sense for the same parameter\n in a different operation. To help you understand the purpose of each, the following\n naming convention is used for the structures:
\nParameter type structures that end in Detail are used in\n Get operations.
Parameter type structures that end in Item are used in\n List operations.
Parameter type structures that use neither suffix are used in the mutating\n (create and update) operations.
\nAmazon Verified Permissions is a permissions management service from Amazon Web Services. You can use Verified Permissions to manage permissions for your application, and authorize user access based on those permissions. Using Verified Permissions, application developers can grant access based on information about the users, resources, and requested actions. You can also evaluate additional information like group membership, attributes of the resources, and session context, such as time of request and IP addresses. Verified Permissions manages these permissions by letting you create and store authorization policies for your applications, such as consumer-facing web sites and enterprise business systems.
Verified Permissions uses Cedar as the policy language to express your permission requirements. Cedar supports both role-based access control (RBAC) and attribute-based access control (ABAC) authorization models.
For more information about configuring, administering, and using Amazon Verified Permissions in your applications, see the Amazon Verified Permissions User Guide.
For more information about the Cedar policy language, see the Cedar Policy Language Guide.
When you write Cedar policies that reference principals, resources and actions, you can define the unique identifiers used for each of those elements. We strongly recommend that you follow these best practices:
Use values like universally unique identifiers (UUIDs) for all principal and resource identifiers.
For example, if user jane leaves the company, and you later let someone else use the name jane, then that new user automatically gets access to everything granted by policies that still reference User::\"jane\". Cedar can\u2019t distinguish between the new user and the old. This applies to both principal and resource identifiers. Always use identifiers that are guaranteed unique and never reused to ensure that you don\u2019t unintentionally grant access because of the presence of an old identifier in a policy.
Where you use a UUID for an entity, we recommend that you follow it with the // comment specifier and the \u2018friendly\u2019 name of your entity. This helps to make your policies easier to understand. For example: principal == User::\"a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111\", // alice
Do not include personally identifying, confidential, or sensitive information as part of the unique identifier for your principals or resources. These identifiers are included in log entries shared in CloudTrail trails.
Several operations return structures that appear similar, but have different purposes. As new functionality is added to the product, the structure used in a parameter of one operation might need to change in a way that wouldn't make sense for the same parameter in a different operation. To help you understand the purpose of each, the following naming convention is used for the structures:
Parameter type structures that end in Detail are used in Get operations.
Parameter type structures that end in Item are used in List operations.
Parameter type structures that use neither suffix are used in the mutating (create and update) operations.