Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action.
Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.
Before you can delete a CA that you have created and activated, you must disable it. To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.
Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into ACM Private CA (that is, the status of the CA is PENDING_CERTIFICATE).
When you successfully call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the restoration window of a private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority action.
Revokes permissions on a private CA granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com).
These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically.
Permissions can be granted with the CreatePermission action and listed with the ListPermissions action.
About Permissions
If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.
For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.
If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.
Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful.
If you delete a policy that was applied through AWS Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.
The AWS Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy.
The current policy can be shown with GetPolicy and updated with PutPolicy.
About Policies
A policy grants access on a private CA to an AWS customer account, to AWS Organizations, or to an AWS Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.
A policy permits a user of AWS Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.
Updates made in AWS Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.
Lists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:
CREATING - ACM Private CA is creating your private certificate authority.
PENDING_CERTIFICATE - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.
ACTIVE - Your private CA is active.
DISABLED - Your private CA has been disabled.
EXPIRED - Your private CA certificate has expired.
FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.
DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.
Lists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:
CREATING - ACM Private CA is creating your private certificate authority.
PENDING_CERTIFICATE - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.
ACTIVE - Your private CA is active.
DISABLED - Your private CA has been disabled.
EXPIRED - Your private CA certificate has expired.
FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or back-end AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.
DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.
Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action.
", "GetCertificate": "Retrieves a certificate from your private CA or one that has been shared with you. The ARN of the certificate is returned when you call the IssueCertificate action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the certificates issued and revoked by your private CA.
", "GetCertificateAuthorityCertificate": "Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you. Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.
", "GetCertificateAuthorityCsr": "Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into ACM Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string.
", "GetPolicy": "Retrieves the resource-based policy attached to a private CA. If either the private CA resource or the policy cannot be found, this action returns a ResourceNotFoundException.
The policy can be attached or updated with PutPolicy and removed with DeletePolicy.
About Policies
A policy grants access on a private CA to an AWS customer account, to AWS Organizations, or to an AWS Organizations unit. Policies are under the control of a CA administrator. For more information, see Using a Resource Based Policy with ACM Private CA.
A policy permits a user of AWS Certificate Manager (ACM) to issue ACM certificates signed by a CA in another account.
For ACM to manage automatic renewal of these certificates, the ACM user must configure a Service Linked Role (SLR). The SLR allows the ACM service to assume the identity of the user, subject to confirmation against the ACM Private CA policy. For more information, see Using a Service Linked Role with ACM.
Updates made in AWS Resource Manager (RAM) are reflected in policies. For more information, see Attach a Policy for Cross-Account Access.
Imports a signed private CA certificate into ACM Private CA. This action is used when you are using a chain of trust whose root is located outside ACM Private CA. Before you can call this action, the following preparations must in place:
In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that that you plan to back with the imported certificate.
Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).
Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA.
Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.
ACM Private CA supports three scenarios for installing a CA certificate:
Installing a certificate for a root CA hosted by ACM Private CA.
Installing a subordinate CA certificate whose parent authority is hosted by ACM Private CA.
Installing a subordinate CA certificate whose parent authority is externally hosted.
The following addtitional requirements apply when you import a CA certificate.
Only a self-signed certificate can be imported as a root CA.
A self-signed certificate cannot be imported as a subordinate CA.
Your certificate chain must not include the private CA certificate that you are importing.
Your root CA must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.
The chain must be PEM-encoded.
The maximum allowed size of a certificate is 32 KB.
The maximum allowed size of a certificate chain is 2 MB.
Enforcement of Critical Constraints
ACM Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.
Basic constraints (must be marked critical)
Subject alternative names
Key usage
Extended key usage
Authority key identifier
Subject key identifier
Issuer alternative name
Subject directory attributes
Subject information access
Certificate policies
Policy mappings
Inhibit anyPolicy
ACM Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.
Name constraints
Policy constraints
CRL distribution points
Authority information access
Freshest CRL
Any other extension
Imports a signed private CA certificate into ACM Private CA. This action is used when you are using a chain of trust whose root is located outside ACM Private CA. Before you can call this action, the following preparations must in place:
In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that you plan to back with the imported certificate.
Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).
Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA.
Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.
ACM Private CA supports three scenarios for installing a CA certificate:
Installing a certificate for a root CA hosted by ACM Private CA.
Installing a subordinate CA certificate whose parent authority is hosted by ACM Private CA.
Installing a subordinate CA certificate whose parent authority is externally hosted.
The following additional requirements apply when you import a CA certificate.
Only a self-signed certificate can be imported as a root CA.
A self-signed certificate cannot be imported as a subordinate CA.
Your certificate chain must not include the private CA certificate that you are importing.
Your root CA must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.
The chain must be PEM-encoded.
The maximum allowed size of a certificate is 32 KB.
The maximum allowed size of a certificate chain is 2 MB.
Enforcement of Critical Constraints
ACM Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.
Basic constraints (must be marked critical)
Subject alternative names
Key usage
Extended key usage
Authority key identifier
Subject key identifier
Issuer alternative name
Subject directory attributes
Subject information access
Certificate policies
Policy mappings
Inhibit anyPolicy
ACM Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.
Name constraints
Policy constraints
CRL distribution points
Authority information access
Freshest CRL
Any other extension
Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN.
You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using ACM Private CA.
Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.
", "ListPermissions": "List all permissions on a private CA, if any, granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com).
These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA.
Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.
About Permissions
If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.
For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.
If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.
Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each entity, but your private CA can issue more than one certificate with the same DN to the same entity.
", + "base": "Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.
Structure that contains X.500 distinguished name information for your private CA.
", "GeneralName$DirectoryName": null } @@ -46,7 +47,7 @@ "refs": { "GetPolicyResponse$Policy": "The policy attached to the private CA as a JSON document.
", "Permission$Policy": "The name of the policy that is associated with the permission.
", - "PutPolicyRequest$Policy": "The path and filename of a JSON-formatted IAM policy to attach to the specified private CA resource. If this policy does not contain all required statements or if it includes any statement that is not allowed, the PutPolicy action returns an InvalidPolicyException. For information about IAM policy and statement structure, see Overview of JSON Policies.
The path and file name of a JSON-formatted IAM policy to attach to the specified private CA resource. If this policy does not contain all required statements or if it includes any statement that is not allowed, the PutPolicy action returns an InvalidPolicyException. For information about IAM policy and statement structure, see Overview of JSON Policies.
Contains X.509 certificate information to be placed in an issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored.
If conflicting or duplicate certificate information is supplied from other sources, ACM Private CA applies order of operation rules to determine what information is used.
", + "refs": { + "IssueCertificateRequest$ApiPassthrough": "Specifies X.509 certificate information to be included in the issued certificate. An APIPassthrough or APICSRPassthrough template variant must be selected, or else this parameter is ignored. For more information about using these templates, see Understanding Certificate Templates.
If conflicting or duplicate certificate information is supplied during certificate issuance, ACM Private CA applies order of operation rules to determine what information is used.
" + } + }, "Arn": { "base": null, "refs": { @@ -114,7 +121,7 @@ "GetPolicyRequest$ResourceArn": "The Amazon Resource Number (ARN) of the private CA that will have its policy retrieved. You can find the CA's ARN by calling the ListCertificateAuthorities action.
", "ImportCertificateAuthorityCertificateRequest$CertificateAuthorityArn": "The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.
Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.
The following service-owned TemplateArn values are supported by ACM Private CA:
arn:aws:acm-pca:::template/CodeSigningCertificate/V1
arn:aws:acm-pca:::template/CodeSigningCertificate_CSRPassthrough/V1
arn:aws:acm-pca:::template/EndEntityCertificate/V1
arn:aws:acm-pca:::template/EndEntityCertificate_CSRPassthrough/V1
arn:aws:acm-pca:::template/EndEntityClientAuthCertificate/V1
arn:aws:acm-pca:::template/EndEntityClientAuthCertificate_CSRPassthrough/V1
arn:aws:acm-pca:::template/EndEntityServerAuthCertificate/V1
arn:aws:acm-pca:::template/EndEntityServerAuthCertificate_CSRPassthrough/V1
arn:aws:acm-pca:::template/OCSPSigningCertificate/V1
arn:aws:acm-pca:::template/OCSPSigningCertificate_CSRPassthrough/V1
arn:aws:acm-pca:::template/RootCACertificate/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1
For more information, see Using Templates.
", + "IssueCertificateRequest$TemplateArn": "Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.
Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.
For a list of TemplateArn values supported by ACM Private CA, see Understanding Certificate Templates.
The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private CA's ARN by running the ListCertificateAuthorities action.
The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. For more information, see NIST's definition of Object Identifier (OID).
In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate.
" + } + }, "ConcurrentModificationException": { "base": "A previous update to your private CA is still ongoing.
", "refs": { @@ -271,7 +284,7 @@ "CsrBlob": { "base": null, "refs": { - "IssueCertificateRequest$Csr": "The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.
openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.
openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.
" + "IssueCertificateRequest$Csr": "The certificate signing request (CSR) for the certificate you want to issue. As an example, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.
openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
If you have a configuration file, you can then use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.
openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
Note: A CSR must provide either a subject name or a subject alternative name or the request will be rejected.
" } }, "CsrBody": { @@ -290,8 +303,10 @@ "base": null, "refs": { "AccessMethod$CustomObjectIdentifier": "An object identifier (OID) specifying the AccessMethod. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of Object Identifier (OID).
Specifies a custom ExtendedKeyUsage with an object identifier (OID).
Represents GeneralName as an object identifier (OID).
Specifies an OID.
" + "OtherName$TypeId": "Specifies an OID.
", + "PolicyInformation$CertPolicyId": "Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. For more information, see NIST's definition of Object Identifier (OID).
" } }, "DeleteCertificateAuthorityRequest": { @@ -335,6 +350,30 @@ "GeneralName$EdiPartyName": "Represents GeneralName as an EdiPartyName object.
Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.
Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.
Specifies a standard ExtendedKeyUsage as defined as in RFC 5280.
Contains X.509 extension information for a certificate.
", + "refs": { + "ApiPassthrough$Extensions": "Specifies X.509 extension information for a certificate.
" + } + }, "FailureReason": { "base": null, "refs": { @@ -342,9 +381,16 @@ } }, "GeneralName": { - "base": "Describes an ASN.1 X.400 GeneralName as defined in RFC 5280. Only one of the following naming options should be providied. Providing more than one option results in an InvalidArgsException error.
Describes an ASN.1 X.400 GeneralName as defined in RFC 5280. Only one of the following naming options should be provided. Providing more than one option results in an InvalidArgsException error.
The location of AccessDescription information.
The location of AccessDescription information.
The subject alternative name extension allows identities to be bound to the subject of the certificate. These identities may be included in addition to or in place of the identity in the subject field of the certificate.
" } }, "GetCertificateAuthorityCertificateRequest": { @@ -390,8 +436,8 @@ "IdempotencyToken": { "base": null, "refs": { - "CreateCertificateAuthorityRequest$IdempotencyToken": "Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. For a given token, ACM Private CA creates exactly one CA. If you issue a subsequent call using the same token, ACM Private CA returns the ARN of the existing CA and takes no further action. If you change the idempotency token across multiple calls, ACM Private CA creates a unique CA for each unique token.
", - "IssueCertificateRequest$IdempotencyToken": "Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.
" + "CreateCertificateAuthorityRequest$IdempotencyToken": "Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action. Idempotency tokens for CreateCertificateAuthority time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within five minutes, ACM Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificate authorities.
", + "IssueCertificateRequest$IdempotencyToken": "Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after one minute. Therefore, if you call IssueCertificate multiple times with the same idempotency token within one minute, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.
" } }, "ImportCertificateAuthorityCertificateRequest": { @@ -459,7 +505,8 @@ "KeyUsage": { "base": "Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.
", "refs": { - "CsrExtensions$KeyUsage": "Indicates the purpose of the certificate and of the key contained in the certificate.
" + "CsrExtensions$KeyUsage": "Indicates the purpose of the certificate and of the key contained in the certificate.
", + "Extensions$KeyUsage": null } }, "LimitExceededException": { @@ -560,6 +607,30 @@ "ListPermissionsResponse$Permissions": "Summary information about each permission assigned by the specified private CA, including the action enabled, the policy provided, and the time of creation.
" } }, + "PolicyInformation": { + "base": "Defines the X.509 CertificatePolicies extension.
Identifies the qualifier modifying a CertPolicyId.
Modifies the CertPolicyId of a PolicyInformation object with a qualifier. ACM Private CA supports the certification practice statement (CPS) qualifier.
Modifies the given CertPolicyId with a qualifier. ACM Private CA supports the certification practice statement (CPS) qualifier.
Defines a PolicyInformation qualifier. ACM Private CA supports the certification practice statement (CPS) qualifier defined in RFC 5280.
Defines the qualifier type. ACM Private CA supports the use of a URI for a CPS qualifier in this field.
" + } + }, "RequestAlreadyProcessedException": { "base": "Your request has already been completed.
", "refs": { @@ -647,7 +724,7 @@ "base": null, "refs": { "CertificateAuthorityConfiguration$SigningAlgorithm": "Name of the algorithm your private CA uses to sign certificate requests.
This parameter should not be confused with the SigningAlgorithm parameter used to sign certificates when they are issued.
The name of the algorithm that will be used to sign the certificate to be issued.
This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR.
The name of the algorithm that will be used to sign the certificate to be issued.
This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR in the CreateCertificateAuthority action.
Specifies the party name.
", "EdiPartyName$NameAssigner": "Specifies the name assigner.
", "GeneralName$Rfc822Name": "Represents GeneralName as an RFC 822 email address.
Specifies an OID value.
" + "OtherName$Value": "Specifies an OID value.
", + "Qualifier$CpsUri": "Contains a pointer to a certification practice statement (CPS) published by the CA.
" } }, "String3": { @@ -734,7 +812,7 @@ "String5": { "base": null, "refs": { - "ASN1Subject$Initials": "Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the SurName.
" + "ASN1Subject$Initials": "Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the Surname.
" } }, "String64": { @@ -806,15 +884,16 @@ } }, "Validity": { - "base": "Validity specifies the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.
You can issue a certificate by calling the IssueCertificate action.
", + "base": "Validity specifies the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the validity of a certificate starts or expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.
ACM Private CA API consumes the Validity data type differently in two distinct parameters of the IssueCertificate action. The required parameter IssueCertificate:Validity specifies the end of a certificate's validity period. The optional parameter IssueCertificate:ValidityNotBefore specifies a customized starting time for the validity period.
Information describing the validity period of the certificate.
When issuing a certificate, ACM Private CA sets the \"Not Before\" date in the validity field to date and time minus 60 minutes. This is intended to compensate for time inconsistencies across systems of 60 minutes or less.
The validity period configured on a certificate must not exceed the limit set by its parents in the CA hierarchy.
" + "IssueCertificateRequest$Validity": "Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.
Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.
This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.
The end of the validity period configured on a certificate must not exceed the limit set on its parents in the CA hierarchy.
", + "IssueCertificateRequest$ValidityNotBefore": "Information describing the start of the validity period of the certificate. This parameter sets the “Not Before\" date for the certificate.
By default, when issuing a certificate, ACM Private CA sets the \"Not Before\" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ValidityNotBefore parameter can be used to customize the “Not Before” value.
Unlike the Validity parameter, the ValidityNotBefore parameter is optional.
The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE. For more information, see Validity in this API reference and Validity in RFC 5280.
Determines how ACM Private CA interprets the Value parameter, an integer. Supported validity types include those listed below. Type definitions with values include a sample input value and the resulting output.
END_DATE: The specific date and time when the certificate will expire, expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is greater than or equal to 50, the year is interpreted as 19YY. If the year field is less than 50, the year is interpreted as 20YY.
Sample input value: 491231235959 (UTCTime format)
Output expiration date/time: 12/31/2049 23:59:59
ABSOLUTE: The specific date and time when the certificate will expire, expressed in seconds since the Unix Epoch.
Sample input value: 2524608000
Output expiration date/time: 01/01/2050 00:00:00
DAYS, MONTHS, YEARS: The relative time from the moment of issuance until the certificate will expire, expressed in days, months, or years.
Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:
Sample input value: 90
Output expiration date: 01/10/2020 12:34:54 UTC
The minimum validity duration for a certificate using relative time (DAYS) is one day. The minimum validity for a certificate using absolute time (ABSOLUTE or END_DATE) is one second.
Determines how ACM Private CA interprets the Value parameter, an integer. Supported validity types include those listed below. Type definitions with values include a sample input value and the resulting output.
END_DATE: The specific date and time when the certificate will expire, expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime (YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is greater than or equal to 50, the year is interpreted as 19YY. If the year field is less than 50, the year is interpreted as 20YY.
Sample input value: 491231235959 (UTCTime format)
Output expiration date/time: 12/31/2049 23:59:59
ABSOLUTE: The specific date and time when the validity of a certificate will start or expire, expressed in seconds since the Unix Epoch.
Sample input value: 2524608000
Output expiration date/time: 01/01/2050 00:00:00
DAYS, MONTHS, YEARS: The relative time from the moment of issuance until the certificate will expire, expressed in days, months, or years.
Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:
Sample input value: 90
Output expiration date: 01/10/2020 12:34:54 UTC
The minimum validity duration for a certificate using relative time (DAYS) is one day. The minimum validity for a certificate using absolute time (ABSOLUTE or END_DATE) is one second.
The Amazon Chime API (application programming interface) is designed for developers to perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes. It also includes some server-side API actions to use with the Amazon Chime SDK. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.
You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.
Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.
If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports Signature Version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.
When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.
Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.
", + "service": "The Amazon Chime API (application programming interface) is designed for developers to perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes. It also includes some server-side API actions to use with the Amazon Chime SDK. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.
You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.
Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.
If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.
When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.
Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.
", "operations": { "AssociatePhoneNumberWithUser": "Associates a phone number with the specified Amazon Chime user.
", "AssociatePhoneNumbersWithVoiceConnector": "Associates phone numbers with the specified Amazon Chime Voice Connector.
", "AssociatePhoneNumbersWithVoiceConnectorGroup": "Associates phone numbers with the specified Amazon Chime Voice Connector group.
", "AssociateSigninDelegateGroupsWithAccount": "Associates the specified sign-in delegate groups with the specified Amazon Chime account.
", - "BatchCreateAttendee": "Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", - "BatchCreateRoomMembership": "Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be either users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
", - "BatchDeletePhoneNumber": "Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.
Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
", - "BatchSuspendUser": "Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Users suspended from a Team account are disassociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.
Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.
To sign out users without suspending them, use the LogoutUser action.
", - "BatchUnsuspendUser": "Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.
Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update either the product type or the calling name.
For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
", - "BatchUpdateUser": "Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.
Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", + "BatchCreateRoomMembership": "Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
", + "BatchDeletePhoneNumber": "Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.
Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
", + "BatchSuspendUser": "Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Users suspended from a Team account are disassociated from the account,but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.
Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.
To sign out users without suspending them, use the LogoutUser action.
", + "BatchUnsuspendUser": "Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.
Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem . For example, you can update either the product type or the calling name.
For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
", + "BatchUpdateUser": " Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.
Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Creates an Amazon Chime Messaging SDK AppInstance under an AWS Account. Only Messaging SDK customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.
Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.
ChannelModerator actions across all channels in the app instance.
DeleteChannelMessage actions.
Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.
Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.
Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.
ChannelModerator actions across all channels in the AppInstance.
DeleteChannelMessage actions.
Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.
Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.
Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", + "CreateAttendee": "Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", "CreateBot": "Creates a bot for an Amazon Chime Enterprise account.
", - "CreateChannel": "Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
", - "CreateChannelBan": "Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.
If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
", - "CreateChannelMembership": "Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:
List messages
Send messages
Receive messages
Edit their own messages
Leave the channel
Privacy settings impact this action as follows:
Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
Private Channels: You must be a member to list or send messages.
Creates a new ChannelModerator. A channel moderator can:
Add and remove other members of the channel.
Add and remove other moderators of the channel.
Add and remove user bans for the channel.
Redact messages in the channel.
List messages in the channel.
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", - "CreateMeetingDialOut": "Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and joins them into Chime meeting. Also ensures that the From number belongs to the customer.
To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall API with the corresponding SIP media application ID.
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", + "CreateChannel": "Creates a channel to which you can add users and send messages.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.
If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:
List messages
Send messages
Receive messages
Edit their own messages
Leave the channel
Privacy settings impact this action as follows:
Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
Private Channels: You must be a member to list or send messages.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Creates a new ChannelModerator. A channel moderator can:
Add and remove other members of the channel.
Add and remove other moderators of the channel.
Add and remove user bans for the channel.
Redact messages in the channel.
List messages in the channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
", + "CreateMeetingDialOut": "Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.
To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action with the corresponding SIP media application ID.
Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
", "CreatePhoneNumberOrder": "Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
", "CreateProxySession": "Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.
", "CreateRoom": "Creates a chat room for the specified Amazon Chime Enterprise account.
", @@ -34,22 +34,22 @@ "CreateSipMediaApplicationCall": "Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.
Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.
", "CreateUser": "Creates a user under the specified Amazon Chime account.
", - "CreateVoiceConnector": "Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.
Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.
", + "CreateVoiceConnector": "Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.
Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.
", "CreateVoiceConnectorGroup": "Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request.
You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.
", - "DeleteAccount": "Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so.
For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.
Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account from your Disabled accounts list, you must contact AWS Support.
After 90 days, deleted accounts are permanently removed from your Disabled accounts list.
Deletes the specified Amazon Chime account. You must suspend all users before deleting Team account. You can use the BatchSuspendUser action to dodo.
For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.
Deleted accounts appear in your Disabled accounts list for 90 days. To restore deleted account from your Disabled accounts list, you must contact AWS Support.
After 90 days, deleted accounts are permanently removed from your Disabled accounts list.
Deletes an AppInstance and all associated data asynchronously.
Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.
Deletes the streaming configurations of an app instance.
", + "DeleteAppInstanceStreamingConfigurations": "Deletes the streaming configurations of an AppInstance.
Deletes an AppInstanceUser.
Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
", - "DeleteChannelBan": "Removes a user from a channel's ban list.
", - "DeleteChannelMembership": "Removes a member from a channel.
", - "DeleteChannelMessage": "Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.
Deletes a channel moderator.
", + "DeleteAttendee": " Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken . Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Removes a user from a channel's ban list.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Removes a member from a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Deletes a channel moderator.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Deletes the events configuration that allows a bot to receive outgoing events.
", - "DeleteMeeting": "Deletes the specified Amazon Chime SDK meeting. When a meeting is deleted, its attendees are also deleted and clients can no longer join it. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", - "DeletePhoneNumber": "Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.
Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
", + "DeleteMeeting": "Deletes the specified Amazon Chime SDK meeting. When a meeting is deleted, its attendees are also deleted, clients connected to the meeting are disconnected, and clients can no longer join the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", + "DeletePhoneNumber": "Moves the specified phone number into the Deletionqueue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.
Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
", "DeleteProxySession": "Deletes the specified proxy session from the specified Amazon Chime Voice Connector.
", "DeleteRoom": "Deletes a chat room in an Amazon Chime Enterprise account.
", "DeleteRoomMembership": "Removes a member from a chat room in an Amazon Chime Enterprise account.
", @@ -57,7 +57,7 @@ "DeleteSipRule": "Deletes a SIP rule. You must disable a SIP rule before you can delete it.
", "DeleteVoiceConnector": "Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.
", "DeleteVoiceConnectorEmergencyCallingConfiguration": "Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.
", - "DeleteVoiceConnectorGroup": "Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.
Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.
Deletes the origination settings for the specified Amazon Chime Voice Connector.
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.
Deletes the proxy configuration from the specified Amazon Chime Voice Connector.
", "DeleteVoiceConnectorStreamingConfiguration": "Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
", @@ -65,65 +65,65 @@ "DeleteVoiceConnectorTerminationCredentials": "Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
", "DescribeAppInstance": "Returns the full details of an AppInstance.
Returns the full details of an AppInstanceAdmin.
Returns the full details of an AppInstanceUser.
Returns the full details of a channel in an Amazon Chime app instance.
", - "DescribeChannelBan": "Returns the full details of a channel ban.
", - "DescribeChannelMembership": "Returns the full details of a user's channel membership.
", - "DescribeChannelMembershipForAppInstanceUser": "Returns the details of a channel based on the membership of the AppInstanceUser specified.
Returns the full details of a channel moderated by the specified AppInstanceUser.
Returns the full details of a single ChannelModerator.
", + "DescribeAppInstanceUser": " Returns the full details of an AppInstanceUser .
Returns the full details of a channel in an Amazon Chime AppInstance.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Returns the full details of a channel ban.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Returns the full details of a user's channel membership.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Returns the details of a channel based on the membership of the specified AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Returns the full details of a channel moderated by the specified AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Returns the full details of a single ChannelModerator.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Disassociates the primary provisioned phone number from the specified Amazon Chime user.
", "DisassociatePhoneNumbersFromVoiceConnector": "Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
", "DisassociatePhoneNumbersFromVoiceConnectorGroup": "Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
", "DisassociateSigninDelegateGroupsFromAccount": "Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.
", "GetAccount": "Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
", - "GetAccountSettings": "Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
", - "GetAppInstanceRetentionSettings": "Gets the retention settings for an app instance.
", - "GetAppInstanceStreamingConfigurations": "Gets the streaming settings for an app instance.
", - "GetAttendee": "Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", + "GetAccountSettings": "Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
", + "GetAppInstanceRetentionSettings": "Gets the retention settings for an AppInstance.
Gets the streaming settings for an AppInstance.
Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
", "GetBot": "Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
", - "GetChannelMessage": "Gets the full details of a channel message.
", - "GetEventsConfiguration": "Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
", + "GetChannelMessage": "Gets the full details of a channel message.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
", "GetGlobalSettings": "Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
", - "GetMeeting": "Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", - "GetMessagingSessionEndpoint": "The endpoint for the messaging session.
", + "GetMeeting": "Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
", + "GetMessagingSessionEndpoint": "The details of the endpoint for the messaging session.
", "GetPhoneNumber": "Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
", - "GetPhoneNumberOrder": "Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status.
", + "GetPhoneNumberOrder": "Retrieves details for the specified phone number order, such as the order creation timestamp, phone numbers in E.164 format, product type, and order status.
", "GetPhoneNumberSettings": "Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
", "GetProxySession": "Gets the specified proxy session details for the specified Amazon Chime Voice Connector.
", - "GetRetentionSettings": "Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
", + "GetRetentionSettings": "Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide .
", "GetRoom": "Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
", "GetSipMediaApplication": "Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.
", "GetSipMediaApplicationLoggingConfiguration": "Returns the logging configuration for the specified SIP media application.
", "GetSipRule": "Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.
", - "GetUser": "Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN.
To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.
", + "GetUser": "Retrieves details for the specified user ID, such as primary email address, license type,and personal meeting PIN.
To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.
", "GetUserSettings": "Retrieves settings for the specified user ID, such as any associated phone number settings.
", - "GetVoiceConnector": "Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.
", + "GetVoiceConnector": "Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps,name, outbound host, and encryption requirements.
", "GetVoiceConnectorEmergencyCallingConfiguration": "Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.
", - "GetVoiceConnectorGroup": "Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, and associated VoiceConnectorItems.
Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch.
", + "GetVoiceConnectorGroup": " Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps,name, and associated VoiceConnectorItems .
Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
", "GetVoiceConnectorOrigination": "Retrieves origination setting details for the specified Amazon Chime Voice Connector.
", "GetVoiceConnectorProxy": "Gets the proxy configuration details for the specified Amazon Chime Voice Connector.
", "GetVoiceConnectorStreamingConfiguration": "Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.
", "GetVoiceConnectorTermination": "Retrieves termination setting details for the specified Amazon Chime Voice Connector.
", "GetVoiceConnectorTerminationHealth": "Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.
Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.
Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.
", - "ListAppInstanceAdmins": "Returns a list of the administrators in the app instance.
", - "ListAppInstanceUsers": "List all AppInstanceUsers created under a single app instance.
Lists all Amazon Chime app instances created under a single AWS account.
", + "InviteUsers": "Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.
Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, toucan filter by the user's email address, which returns one account result.
", + "ListAppInstanceAdmins": "Returns a list of the administrators in the AppInstance.
List all AppInstanceUsers created under a single AppInstance.
Lists all Amazon Chime AppInstances created under a single AWS account.
Lists the tags applied to an Amazon Chime SDK attendee resource.
", - "ListAttendees": "Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", + "ListAttendees": "Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
", "ListBots": "Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
", - "ListChannelBans": "Lists all the users banned from a particular channel.
", - "ListChannelMemberships": "Lists all channel memberships in a channel.
", - "ListChannelMembershipsForAppInstanceUser": "Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.
List all the messages in a channel. Returns a paginated list of ChannelMessages. Sorted in descending order by default, based on the creation timestamp.
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Lists all the moderators for a channel.
", - "ListChannels": "Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy = PUBLIC to retrieve all public channels in the account
Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.
A list of the channels moderated by an app instance user.
", + "ListChannelBans": "Lists all the users banned from a particular channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Lists all channel memberships in a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order .
Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.
Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Lists all the moderators for a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.
Functionality & restrictions
Use privacy = PUBLIC to retrieve all public channels in the account
Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
A list of the channels moderated by an AppInstanceUser.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Lists the tags applied to an Amazon Chime SDK meeting resource.
", - "ListMeetings": "Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
", + "ListMeetings": "Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .
", "ListPhoneNumberOrders": "Lists the phone number orders for the administrator's Amazon Chime account.
", "ListPhoneNumbers": "Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
", "ListProxySessions": "Lists the proxy sessions for the specified Amazon Chime Voice Connector.
", @@ -137,26 +137,26 @@ "ListVoiceConnectorTerminationCredentials": "Lists the SIP credentials for the specified Amazon Chime Voice Connector.
", "ListVoiceConnectors": "Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
", "LogoutUser": "Logs out the specified user from all of the devices they are currently logged into.
", - "PutAppInstanceRetentionSettings": "Sets the amount of time in days that a given app instance retains data.
", - "PutAppInstanceStreamingConfigurations": "The data streaming configurations of an app instance.
", + "PutAppInstanceRetentionSettings": "Sets the amount of time in days that a given AppInstance retains data.
The data streaming configurations of an AppInstance.
Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.
", - "PutRetentionSettings": "Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.
To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.
", + "PutRetentionSettings": "Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide .
To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide .
", "PutSipMediaApplicationLoggingConfiguration": "Updates the logging configuration for the specified SIP media application.
", "PutVoiceConnectorEmergencyCallingConfiguration": "Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.
", "PutVoiceConnectorLoggingConfiguration": "Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
", "PutVoiceConnectorOrigination": "Adds origination settings for the specified Amazon Chime Voice Connector.
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.
Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.
", - "PutVoiceConnectorStreamingConfiguration": "Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Amazon Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.
", + "PutVoiceConnectorStreamingConfiguration": "Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Indonesians. It also sets the retention period, in hours, for the Amazon Kinesis data.
", "PutVoiceConnectorTermination": "Adds termination settings for the specified Amazon Chime Voice Connector.
If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.
Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
", - "RedactChannelMessage": "Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
", + "RedactChannelMessage": "Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Redacts the specified message from the specified Amazon Chime conversation.
", "RedactRoomMessage": "Redacts the specified message from the specified Amazon Chime channel.
", "RegenerateSecurityToken": "Regenerates the security token for a bot.
", "ResetPersonalPIN": "Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
", "RestorePhoneNumber": "Moves a phone number from the Deletion queue back into the phone number Inventory.
", "SearchAvailablePhoneNumbers": "Searches phone numbers that can be ordered.
", - "SendChannelMessage": "Sends a message to a particular channel that the member is a part of.
STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.
Sends a message to a particular channel that the member is a part of.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.
Applies the specified tags to the specified Amazon Chime SDK attendee.
", "TagMeeting": "Applies the specified tags to the specified Amazon Chime SDK meeting.
", "TagResource": "Applies the specified tags to the specified Amazon Chime SDK meeting resource.
", @@ -166,23 +166,23 @@ "UpdateAccount": "Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
", "UpdateAccountSettings": "Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
", "UpdateAppInstance": "Updates AppInstance metadata.
Updates the details for an AppInstanceUser. You can update names and metadata.
Updates the details of an AppInstanceUser. You can update names and metadata.
Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
", - "UpdateChannel": "Update a channel's attributes.
Restriction: You can't change a channel's privacy.
", - "UpdateChannelMessage": "Updates the content of a message.
", - "UpdateChannelReadMarker": "Sets the timestamp to the point when a user last read messages in a channel.
", + "UpdateChannel": "Update a channel's attributes.
Restriction: You can't change a channel's privacy.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Updates the content of a message.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
The details of the time when a user last read messages in a channel.
The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
", "UpdatePhoneNumber": "Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.
For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
", "UpdatePhoneNumberSettings": "Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.
", "UpdateProxySession": "Updates the specified proxy session details, such as voice or SMS capabilities.
", "UpdateRoom": "Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
", "UpdateRoomMembership": "Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.
", - "UpdateSipMediaApplication": "Updates the details for the specified SIP media application.
", - "UpdateSipRule": "Updates the details for the specified SIP rule.
", - "UpdateUser": "Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
Updates the details of the specified SIP media application.
", + "UpdateSipRule": "Updates the details of the specified SIP rule.
", + "UpdateUser": " Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
Updates the settings for the specified user, such as phone number settings.
", "UpdateVoiceConnector": "Updates details for the specified Amazon Chime Voice Connector.
", - "UpdateVoiceConnectorGroup": "Updates details for the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
" + "UpdateVoiceConnectorGroup": "Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
" }, "shapes": { "AccessDeniedException": { @@ -194,15 +194,15 @@ "base": "The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.
", "refs": { "AccountList$member": null, - "CreateAccountResponse$Account": null, - "GetAccountResponse$Account": null, - "UpdateAccountResponse$Account": null + "CreateAccountResponse$Account": "The Amazon Chime account details.
", + "GetAccountResponse$Account": "The Amazon Chime account details.
", + "UpdateAccountResponse$Account": "The updated Amazon Chime account details.
" } }, "AccountList": { "base": null, "refs": { - "ListAccountsResponse$Accounts": "The list of accounts.
" + "ListAccountsResponse$Accounts": "List of Amazon Chime accounts and account details.
" } }, "AccountName": { @@ -241,15 +241,15 @@ } }, "AppInstance": { - "base": "An instance of a Chime messaging application.
", + "base": "The details of an AppInstance, an instance of an Amazon Chime SDK messaging application.
The ARN, metadata, created and last-updated timestamps, and the name of the app instance. All timestamps use epoch milliseconds.
" + "DescribeAppInstanceResponse$AppInstance": "The ARN, metadata, created and last-updated timestamps, and the name of the AppInstance. All timestamps use epoch milliseconds.
Promotes a user to the administrator role for the duration of an app instance.
", + "base": "The details of an AppInstanceAdmin.
The ARN and name of the app instance user, the ARN of the app instance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.
" + "DescribeAppInstanceAdminResponse$AppInstanceAdmin": "The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.
The identity and metadata of an administrator.
", + "base": "Summary of the details of an AppInstanceAdmin.
The data type of the app instance.
" + "AppInstanceStreamingConfiguration$AppInstanceDataType": "The type of data to be streamed.
" } }, "AppInstanceList": { "base": null, "refs": { - "ListAppInstancesResponse$AppInstances": "The information for each app instance.
" + "ListAppInstancesResponse$AppInstances": "The information for each AppInstance.
The length of time in days to retain messages.
", + "base": "The details of the data-retention settings for an AppInstance.
The retention settings for the app instance.
", + "GetAppInstanceRetentionSettingsResponse$AppInstanceRetentionSettings": "The retention settings for the AppInstance.
The time in days to retain data. Data type: number.
", "PutAppInstanceRetentionSettingsResponse$AppInstanceRetentionSettings": "The time in days to retain data. Data type: number.
" } }, "AppInstanceStreamingConfiguration": { - "base": "The streaming configuration of an app instance.
", + "base": "The details of the streaming configuration of an AppInstance.
The streaming settings.
", - "PutAppInstanceStreamingConfigurationsRequest$AppInstanceStreamingConfigurations": "The streaming configurations set for an app instance.
", - "PutAppInstanceStreamingConfigurationsResponse$AppInstanceStreamingConfigurations": "The streaming configurations of an app instance.
" + "PutAppInstanceStreamingConfigurationsRequest$AppInstanceStreamingConfigurations": "The streaming configurations set for an AppInstance.
The streaming configurations of an AppInstance.
The summary data for an app instance.
", + "base": "Summary of the data for an AppInstance.
The app instance user.
", + "base": "The details of an AppInstanceUser.
The name of the app instance user.
" + "DescribeAppInstanceUserResponse$AppInstanceUser": "The name of the AppInstanceUser.
The information for each of the requested app instance users.
" + "ListAppInstanceUsersResponse$AppInstanceUsers": "The information for each requested AppInstanceUser.
Lists the channels to which app instance users belong.
", + "base": "Summary of the membership details of an AppInstanceUser.
Returns the channel membership data for an app instance.
" + "ChannelMembershipForAppInstanceUserSummary$AppInstanceUserMembershipSummary": "Returns the channel membership data for an AppInstance.
The app instance user summary data .
", + "base": "Summary of the details of an AppInstanceUser.
An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken. The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.
We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.
An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.
We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.
The attendee information, including attendee ID and join token.
", @@ -509,7 +509,7 @@ "Proxy$Disabled": "When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
", "PutVoiceConnectorProxyRequest$Disabled": "When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
", "SipMediaApplicationLoggingConfiguration$EnableSipMediaApplicationMessageLogs": "Enables application message logs for the SIP media application.
", - "SipRule$Disabled": "Indicates if the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
", + "SipRule$Disabled": "Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.
", "StreamingConfiguration$Disabled": "When true, media streaming to Amazon Kinesis is turned off.
", "TelephonySettings$InboundCalling": "Allows or denies inbound calling.
", "TelephonySettings$OutboundCalling": "Allows or denies outbound calling.
", @@ -591,19 +591,19 @@ } }, "Channel": { - "base": "Creates a channel.
", + "base": "The details of a channel.
", "refs": { "DescribeChannelResponse$Channel": "The channel details.
" } }, "ChannelBan": { - "base": "Bans a user from a channel.
", + "base": "The details of a channel ban.
", "refs": { "DescribeChannelBanResponse$ChannelBan": "The the details of the ban.
" } }, "ChannelBanSummary": { - "base": "The summary data for the channel ban.
", + "base": "Summary of the details of a ChannelBan.
Creates a channel member.
", + "base": "The details of a channel member.
", "refs": { "DescribeChannelMembershipResponse$ChannelMembership": "The details of the membership.
" } }, "ChannelMembershipForAppInstanceUserSummary": { - "base": "Returns the channel membership summary data for an app instance.
", + "base": "Summary of the channel membership details of an AppInstanceUser.
The channel to which a user belongs.
" @@ -634,7 +634,7 @@ } }, "ChannelMembershipSummary": { - "base": "The summary data of a channel membership.
", + "base": "Summary of the details of a ChannelMembership.
The type of channel summary,
", + "AppInstanceUserMembershipSummary$Type": "The type of ChannelMembership.
The membership type set for the channel member.
", "CreateChannelMembershipRequest$Type": "The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.
The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned.
Creates a message in a channel.
", + "base": "The details of a message in a channel.
", "refs": { "GetChannelMessageResponse$ChannelMessage": "The details of and content in the message.
" } @@ -663,12 +663,12 @@ "ChannelMessagePersistenceType": { "base": null, "refs": { - "ChannelMessage$Persistence": null, + "ChannelMessage$Persistence": "The persistence setting for a channel message.
", "SendChannelMessageRequest$Persistence": "Boolean that controls whether the message is persisted on the back end. Required.
" } }, "ChannelMessageSummary": { - "base": "A summary of the messages in a channel.
", + "base": "Summary of the messages in a Channel.
The information about and content of each requested message.
" + "ListChannelMessagesResponse$ChannelMessages": "The information about, and content of, each requested message.
" } }, "ChannelMessageType": { "base": null, "refs": { "ChannelMessage$Type": "The message type.
", - "ChannelMessageSummary$Type": "The type of message summary.
", + "ChannelMessageSummary$Type": "The type of message.
", "SendChannelMessageRequest$Type": "The type of message, STANDARD or CONTROL.
The mode of the channel.
", - "ChannelSummary$Mode": "The summary mode of the channel.
", + "ChannelSummary$Mode": "The mode of the channel.
", "CreateChannelRequest$Mode": "The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.
The mode of the update request.
" } }, "ChannelModeratedByAppInstanceUserSummary": { - "base": "Returns the summary data for a moderated channel.
", + "base": "Summary of the details of a moderated channel.
", "refs": { "ChannelModeratedByAppInstanceUserSummaryList$member": null, "DescribeChannelModeratedByAppInstanceUserResponse$Channel": "The moderated channel.
" @@ -710,13 +710,13 @@ } }, "ChannelModerator": { - "base": "Creates a moderator on a channel.
", + "base": "The details of a channel moderator.
", "refs": { "DescribeChannelModeratorResponse$ChannelModerator": "The details of the channel moderator.
" } }, "ChannelModeratorSummary": { - "base": "Summary data of the moderators in a channel.
", + "base": "Summary of the details of a ChannelModerator.
The channel's privacy setting, PUBLIC or HIDDEN.
The privacy setting of the channel being summarized, PUBLIC or HIDDEN.
The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the app instance.
The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an app instance administrator can retrieve private channels.
The channel's privacy setting.
", + "ChannelSummary$Privacy": "The privacy setting of the channel.
", + "CreateChannelRequest$Privacy": "The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.
The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.
The retention settings for a channel.
", + "base": "The details of the retention settings for a channel.
", "refs": { - "AppInstanceRetentionSettings$ChannelRetentionSettings": "The length of time in days to retain a channel.
" + "AppInstanceRetentionSettings$ChannelRetentionSettings": "The length of time in days to retain the messages in a channel.
" } }, "ChannelSummary": { - "base": "The summary data for a channel.
", + "base": "Summary of the details of a Channel.
The ARN of the messaging instance.
", - "AppInstanceAdmin$AppInstanceArn": "The ARN of the app instance administrator.
", - "AppInstanceSummary$AppInstanceArn": "The app instance ARN.
", - "AppInstanceUser$AppInstanceUserArn": "The ARN of the app instance user.
", - "AppInstanceUserSummary$AppInstanceUserArn": "The ARN of the app instance user.
", + "AppInstance$AppInstanceArn": "The ARN of the messaging instance.
", + "AppInstanceAdmin$AppInstanceArn": "The ARN of the AppInstance for which the user is an administrator.
The AppInstance ARN.
The ARN of the AppInstanceUser.
The ARN of the AppInstanceUser.
The ARN of the channel.
", "ChannelBan$ChannelArn": "The ARN of the channel from which a member is being banned.
", "ChannelMembership$ChannelArn": "The ARN of the member's channel.
", "ChannelMessage$ChannelArn": "The ARN of the channel.
", "ChannelModerator$ChannelArn": "The ARN of the moderator's channel.
", - "ChannelSummary$ChannelArn": "The ARN of the channel summary.
", - "CreateAppInstanceAdminRequest$AppInstanceAdminArn": "The ARN of the administrator of the current app instance.
", - "CreateAppInstanceAdminRequest$AppInstanceArn": "The ARN of the app instance.
", - "CreateAppInstanceAdminResponse$AppInstanceArn": "The ARN of the of the admin for the app instance.
", - "CreateAppInstanceResponse$AppInstanceArn": "The Amazon Resource Number (ARN) of the app instance.
", - "CreateAppInstanceUserRequest$AppInstanceArn": "The ARN of the app instance request.
", + "ChannelSummary$ChannelArn": "The ARN of the channel.
", + "CreateAppInstanceAdminRequest$AppInstanceAdminArn": "The ARN of the administrator of the current AppInstance.
The ARN of the AppInstance.
The ARN of the of the admin for the AppInstance.
The Amazon Resource Number (ARN) of the AppInstance.
The ARN of the AppInstance request.
The user's ARN.
", "CreateChannelBanRequest$ChannelArn": "The ARN of the ban request.
", "CreateChannelBanRequest$MemberArn": "The ARN of the member being banned.
", + "CreateChannelBanRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the response to the ban request.
", "CreateChannelMembershipRequest$ChannelArn": "The ARN of the channel to which you're adding users.
", "CreateChannelMembershipRequest$MemberArn": "The ARN of the member you want to add to the channel.
", + "CreateChannelMembershipRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "CreateChannelModeratorRequest$ChannelArn": "The ARN of the channel.
", "CreateChannelModeratorRequest$ChannelModeratorArn": "The ARN of the moderator.
", + "CreateChannelModeratorRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "CreateChannelRequest$AppInstanceArn": "The ARN of the channel request.
", + "CreateChannelRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", - "DeleteAppInstanceAdminRequest$AppInstanceAdminArn": "The ARN of the app instance's administrator.
", - "DeleteAppInstanceAdminRequest$AppInstanceArn": "The ARN of the app instance.
", - "DeleteAppInstanceRequest$AppInstanceArn": "The ARN of the app instance.
", + "DeleteAppInstanceAdminRequest$AppInstanceAdminArn": "The ARN of the AppInstance's administrator.
The ARN of the AppInstance.
The ARN of the AppInstance.
The ARN of the streaming configurations being deleted.
", "DeleteAppInstanceUserRequest$AppInstanceUserArn": "The ARN of the user request being deleted.
", - "DeleteChannelBanRequest$ChannelArn": "The ARN of the channel from which the app instance user was banned.
", - "DeleteChannelBanRequest$MemberArn": "The ARN of the app instance user that you want to reinstate.
", + "DeleteChannelBanRequest$ChannelArn": "The ARN of the channel from which the AppInstanceUser was banned.
The ARN of the AppInstanceUser that you want to reinstate.
The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel from which you want to remove the user.
", "DeleteChannelMembershipRequest$MemberArn": "The ARN of the member that you're removing from the channel.
", + "DeleteChannelMembershipRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", + "DeleteChannelMessageRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "DeleteChannelModeratorRequest$ChannelModeratorArn": "The ARN of the moderator being deleted.
", + "DeleteChannelModeratorRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel being deleted.
", - "DescribeAppInstanceAdminRequest$AppInstanceAdminArn": "The ARN of the app instance administrator.
", - "DescribeAppInstanceAdminRequest$AppInstanceArn": "The ARN of the app instance.
", - "DescribeAppInstanceRequest$AppInstanceArn": "The ARN of the app instance.
", - "DescribeAppInstanceUserRequest$AppInstanceUserArn": "The ARN of the app instance user.
", + "DeleteChannelRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the AppInstanceAdmin.
The ARN of the AppInstance.
The ARN of the AppInstance.
The ARN of the AppInstanceUser.
The ARN of the channel from which the user is banned.
", "DescribeChannelBanRequest$MemberArn": "The ARN of the member being banned.
", + "DescribeChannelBanRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel to which the user belongs.
", "DescribeChannelMembershipForAppInstanceUserRequest$AppInstanceUserArn": "The ARN of the user in a channel.
", + "DescribeChannelMembershipForAppInstanceUserRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "DescribeChannelMembershipRequest$MemberArn": "The ARN of the member.
", + "DescribeChannelMembershipRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the moderated channel.
", - "DescribeChannelModeratedByAppInstanceUserRequest$AppInstanceUserArn": "The ARN of the app instance user in the moderated channel.
", + "DescribeChannelModeratedByAppInstanceUserRequest$AppInstanceUserArn": "The ARN of the AppInstanceUser in the moderated channel.
The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "DescribeChannelModeratorRequest$ChannelModeratorArn": "The ARN of the channel moderator.
", + "DescribeChannelModeratorRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", - "GetAppInstanceRetentionSettingsRequest$AppInstanceArn": "The ARN of the app instance.
", - "GetAppInstanceStreamingConfigurationsRequest$AppInstanceArn": "The ARN of the app instance.
", + "DescribeChannelRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the AppInstance.
The ARN of the AppInstance.
The ARN of the channel.
", + "GetChannelMessageRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN in an Identity.
", - "ListAppInstanceAdminsRequest$AppInstanceArn": "The ARN of the app instance.
", - "ListAppInstanceAdminsResponse$AppInstanceArn": "The ARN of the app instance.
", - "ListAppInstanceUsersRequest$AppInstanceArn": "The ARN of the app instance.
", - "ListAppInstanceUsersResponse$AppInstanceArn": "The ARN of the app instance.
", + "ListAppInstanceAdminsRequest$AppInstanceArn": "The ARN of the AppInstance.
The ARN of the AppInstance.
The ARN of the AppInstance.
The ARN of the AppInstance.
The ARN of the channel.
", + "ListChannelBansRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", - "ListChannelMembershipsForAppInstanceUserRequest$AppInstanceUserArn": "The ARN of the app instance users
", + "ListChannelMembershipsForAppInstanceUserRequest$AppInstanceUserArn": "The ARN of the AppInstanceUsers
The AppInstanceUserArn of the user that makes the API call.
The maximum number of channel memberships that you want returned.
", + "ListChannelMembershipsRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "ListChannelMessagesRequest$ChannelArn": "The ARN of the channel.
", + "ListChannelMessagesRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel containing the requested messages.
", "ListChannelModeratorsRequest$ChannelArn": "The ARN of the channel.
", + "ListChannelModeratorsRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "ListChannelsModeratedByAppInstanceUserRequest$AppInstanceUserArn": "The ARN of the user in the moderated channel.
", - "ListChannelsRequest$AppInstanceArn": "The ARN of the app instance.
", - "PutAppInstanceRetentionSettingsRequest$AppInstanceArn": "The ARN of the app instance.
", - "PutAppInstanceStreamingConfigurationsRequest$AppInstanceArn": "The ARN of the app instance.
", + "ListChannelsModeratedByAppInstanceUserRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the AppInstance.
The AppInstanceUserArn of the user that makes the API call.
The ARN of the AppInstance.
The ARN of the AppInstance.
The ARN of the channel containing the messages that you want to redact.
", + "RedactChannelMessageRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel containing the messages that you want to redact.
", "SendChannelMessageRequest$ChannelArn": "The ARN of the channel.
", + "SendChannelMessageRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", - "UpdateAppInstanceRequest$AppInstanceArn": "The ARN of the app instance.
", - "UpdateAppInstanceResponse$AppInstanceArn": "The ARN of the app instance.
", - "UpdateAppInstanceUserRequest$AppInstanceUserArn": "The ARN of the app instance user.
", - "UpdateAppInstanceUserResponse$AppInstanceUserArn": "The ARN of the app instance user.
", + "UpdateAppInstanceRequest$AppInstanceArn": "The ARN of the AppInstance.
The ARN of the AppInstance.
The ARN of the AppInstanceUser.
The ARN of the AppInstanceUser.
The ARN of the channel.
", + "UpdateChannelMessageRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "UpdateChannelReadMarkerRequest$ChannelArn": "The ARN of the channel.
", + "UpdateChannelReadMarkerRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
", "UpdateChannelRequest$ChannelArn": "The ARN of the channel.
", + "UpdateChannelRequest$ChimeBearer": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
" } }, "ClientRequestToken": { "base": null, "refs": { - "CreateAppInstanceRequest$ClientRequestToken": "The ClientRequestToken of the app instance.
The token assigned to the user requesting an app instance.
", + "CreateAppInstanceRequest$ClientRequestToken": "The ClientRequestToken of the AppInstance.
The token assigned to the user requesting an AppInstance.
The client token for the request. An Idempotency token.
The unique identifier for the client request. Use a different token for different meetings.
", "CreateMeetingWithAttendeesRequest$ClientRequestToken": "The unique identifier for the client request. Use a different token for different meetings.
", @@ -873,12 +901,12 @@ "base": null, "refs": { "ChannelMessage$Content": "The message content.
", - "ChannelMessageSummary$Content": "The content of the message summary.
", + "ChannelMessageSummary$Content": "The content of the message.
", "UpdateChannelMessageRequest$Content": "The content of the message being updated.
" } }, "ConversationRetentionSettings": { - "base": "The retention settings that determine how long to retain chat conversation messages for an Amazon Chime Enterprise account.
", + "base": "The retention settings that determine how long to retain conversation messages for an Amazon Chime Enterprise account.
", "refs": { "RetentionSettings$ConversationRetentionSettings": "The chat conversation retention settings.
" } @@ -1464,7 +1492,7 @@ "CreateMeetingDialOutRequest$FromPhoneNumber": "Phone number used as the caller ID when the remote party receives a call.
", "CreateMeetingDialOutRequest$ToPhoneNumber": "Phone number called when inviting someone to a meeting.
", "CreateSipMediaApplicationCallRequest$FromPhoneNumber": "The phone number that a user calls from.
", - "CreateSipMediaApplicationCallRequest$ToPhoneNumber": "The phone number that the user dials in order to connect to a meeting
", + "CreateSipMediaApplicationCallRequest$ToPhoneNumber": "The phone number that the user dials in order to connect to a meeting.
", "DNISEmergencyCallingConfiguration$EmergencyPhoneNumber": "The DNIS phone number to route emergency calls to, in E.164 format.
", "DNISEmergencyCallingConfiguration$TestPhoneNumber": "The DNIS phone number to route test emergency calls to, in E.164 format.
", "E164PhoneNumberList$member": null, @@ -1551,10 +1579,10 @@ "ExternalUserIdType": { "base": null, "refs": { - "Attendee$ExternalUserId": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application. If you create an attendee with the same external user id, the service returns the existing record.
", - "CreateAttendeeError$ExternalUserId": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application. If you create an attendee with the same external user id, the service returns the existing record.
", - "CreateAttendeeRequest$ExternalUserId": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application. If you create an attendee with the same external user id, the service returns the existing record.
", - "CreateAttendeeRequestItem$ExternalUserId": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application. If you create an attendee with the same external user id, the service returns the existing record.
The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.
", + "Attendee$ExternalUserId": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
", + "CreateAttendeeError$ExternalUserId": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
", + "CreateAttendeeRequest$ExternalUserId": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
", + "CreateAttendeeRequestItem$ExternalUserId": "The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
", "CreateMeetingRequest$MeetingHostId": "Reserved.
", "CreateMeetingWithAttendeesRequest$MeetingHostId": "Reserved.
" } @@ -1567,7 +1595,7 @@ "FunctionArn": { "base": null, "refs": { - "SipMediaApplicationEndpoint$LambdaArn": "Valid Amazon Resource Name (ARN) of the Lambda function of the same AWS Region where the SIP media application is created.
" + "SipMediaApplicationEndpoint$LambdaArn": "Valid Amazon Resource Name (ARN) of the Lambda function. The function must be created in the same AWS Region as the SIP media application.
" } }, "GeoMatchLevel": { @@ -1890,7 +1918,7 @@ "Attendee$AttendeeId": "The Amazon Chime SDK attendee ID.
", "BatchCreateAttendeeRequest$MeetingId": "The Amazon Chime SDK meeting ID.
", "CreateAttendeeRequest$MeetingId": "The Amazon Chime SDK meeting ID.
", - "CreateMeetingDialOutRequest$MeetingId": "The Amazon Chime SDK meeting ID.
Type: String
Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}
Required: No
", + "CreateMeetingDialOutRequest$MeetingId": "The Amazon Chime SDK meeting ID.
", "CreateMeetingDialOutResponse$TransactionId": "Unique ID that tracks API calls.
", "DeleteAttendeeRequest$MeetingId": "The Amazon Chime SDK meeting ID.
", "DeleteAttendeeRequest$AttendeeId": "The Amazon Chime SDK attendee ID.
", @@ -1915,23 +1943,23 @@ } }, "Identity": { - "base": "The ARN and name of a user.
", + "base": "The details of a user.
", "refs": { - "AppInstanceAdmin$Admin": "The name and metadata of the app instance administrator.
", - "AppInstanceAdminSummary$Admin": "The name and metadata of the app instance administrator.
", - "Channel$CreatedBy": "The administrator who created the channel.
", + "AppInstanceAdmin$Admin": "The AppInstanceAdmin data.
The details of the AppInstanceAdmin.
The AppInstanceUser who created the channel.
The member being banned from the channel.
", - "ChannelBan$CreatedBy": "The parameter of the action.
", + "ChannelBan$CreatedBy": "The AppInstanceUser who created the ban.
The member being banned from a channel.
", - "ChannelMembership$InvitedBy": "The identifier of the member who invited another member. Taken from the message header.
", + "ChannelMembership$InvitedBy": "The identifier of the member who invited another member.
", "ChannelMembership$Member": "The data of the channel member.
", "ChannelMembershipSummary$Member": "A member's summary data.
", "ChannelMessage$Sender": "The message sender.
", - "ChannelMessageSummary$Sender": "The sender of the message summary.
", + "ChannelMessageSummary$Sender": "The message sender.
", "ChannelModerator$Moderator": "The moderator's data.
", - "ChannelModerator$CreatedBy": "The member who created the moderator.
", + "ChannelModerator$CreatedBy": "The AppInstanceUser who created the moderator.
The data for a moderator.
", - "CreateAppInstanceAdminResponse$AppInstanceAdmin": "The name and ARN of the admin for the app instance.
", + "CreateAppInstanceAdminResponse$AppInstanceAdmin": "The name and ARN of the admin for the AppInstance.
The ChannelArn and BannedIdentity of the member in the ban response.
The ARN and metadata of the member being added.
", "CreateChannelModeratorResponse$ChannelModerator": "The ARNs of the channel and the moderator.
" @@ -1985,33 +2013,33 @@ "PhoneNumber$UpdatedTimestamp": "The updated phone number timestamp, in ISO 8601 format.
", "PhoneNumber$DeletionTimestamp": "The deleted phone number timestamp, in ISO 8601 format.
", "PhoneNumberAssociation$AssociatedTimestamp": "The timestamp of the phone number association, in ISO 8601 format.
", - "PhoneNumberOrder$CreatedTimestamp": "The phone number order creation timestamp, in ISO 8601 format.
", - "PhoneNumberOrder$UpdatedTimestamp": "The updated phone number order timestamp, in ISO 8601 format.
", - "ProxySession$CreatedTimestamp": "The created timestamp, in ISO 8601 format.
", - "ProxySession$UpdatedTimestamp": "The updated timestamp, in ISO 8601 format.
", - "ProxySession$EndedTimestamp": "The ended timestamp, in ISO 8601 format.
", + "PhoneNumberOrder$CreatedTimestamp": "The phone number order creation time stamp, in ISO 8601 format.
", + "PhoneNumberOrder$UpdatedTimestamp": "The updated phone number order time stamp, in ISO 8601 format.
", + "ProxySession$CreatedTimestamp": "The created time stamp, in ISO 8601 format.
", + "ProxySession$UpdatedTimestamp": "The updated time stamp, in ISO 8601 format.
", + "ProxySession$EndedTimestamp": "The ended time stamp, in ISO 8601 format.
", "PutRetentionSettingsResponse$InitiateDeletionTimestamp": "The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.
", "Room$CreatedTimestamp": "The room creation timestamp, in ISO 8601 format.
", "Room$UpdatedTimestamp": "The room update timestamp, in ISO 8601 format.
", "RoomMembership$UpdatedTimestamp": "The room membership update timestamp, in ISO 8601 format.
", "SipMediaApplication$CreatedTimestamp": "The SIP media application creation timestamp, in ISO 8601 format.
", "SipMediaApplication$UpdatedTimestamp": "The SIP media application updated timestamp, in ISO 8601 format.
", - "SipRule$CreatedTimestamp": "The SIP rule created timestamp, in ISO 8601 format.
", - "SipRule$UpdatedTimestamp": "The SIP rule updated timestamp, in ISO 8601 format.
", + "SipRule$CreatedTimestamp": "The time at which the SIP rule was created, in ISO 8601 format.
", + "SipRule$UpdatedTimestamp": "The time at which the SIP rule was last updated, in ISO 8601 format.
", "TerminationHealth$Timestamp": "The timestamp, in ISO 8601 format.
", "User$RegisteredOn": "Date and time when the user is registered, in ISO 8601 format.
", "User$InvitedOn": "Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
", "VoiceConnector$CreatedTimestamp": "The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
", "VoiceConnector$UpdatedTimestamp": "The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
", - "VoiceConnectorGroup$CreatedTimestamp": "The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format.
", - "VoiceConnectorGroup$UpdatedTimestamp": "The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format.
" + "VoiceConnectorGroup$CreatedTimestamp": "The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
", + "VoiceConnectorGroup$UpdatedTimestamp": "The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
" } }, "JoinTokenString": { "base": null, "refs": { "Attendee$JoinToken": "The join token used by the Amazon Chime SDK attendee.
", - "CreateMeetingDialOutRequest$JoinToken": "Token used by the Amazon Chime SDK attendee. Call the CreateAttendee API to get a join token.
" + "CreateMeetingDialOutRequest$JoinToken": "Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.
" } }, "License": { @@ -2333,9 +2361,9 @@ "refs": { "ListAppInstanceAdminsRequest$MaxResults": "The maximum number of administrators that you want to return.
", "ListAppInstanceUsersRequest$MaxResults": "The maximum number of requests that you want returned.
", - "ListAppInstancesRequest$MaxResults": "The maximum number of app instances that you want to return.
", + "ListAppInstancesRequest$MaxResults": "The maximum number of AppInstances that you want to return.
The maximum number of bans that you want returned.
", - "ListChannelMembershipsForAppInstanceUserRequest$MaxResults": "The maximum number of users that you want returned.
", + "ListChannelMembershipsForAppInstanceUserRequest$MaxResults": "The maximum number of users that you want returned.
", "ListChannelMembershipsRequest$MaxResults": "The maximum number of channel memberships that you want returned.
", "ListChannelMessagesRequest$MaxResults": "The maximum number of messages that you want returned.
", "ListChannelModeratorsRequest$MaxResults": "The maximum number of moderators that you want returned.
", @@ -2352,7 +2380,7 @@ "Meeting": { "base": "A meeting created using the Amazon Chime SDK.
", "refs": { - "CreateMeetingResponse$Meeting": "The meeting information, including the meeting ID and MediaPlacement.
The meeting information, including the meeting ID and MediaPlacement .
The Amazon Chime SDK meeting information.
", "MeetingList$member": null @@ -2365,7 +2393,7 @@ } }, "MeetingNotificationConfiguration": { - "base": "The configuration for resource targets to receive notifications when Amazon Chime SDK meeting and attendee events occur. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (us-east-1).
The resource target configurations for receiving Amazon Chime SDK meeting and attendee event notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (us-east-1).
The configuration for resource targets to receive notifications when meeting and attendee events occur.
", "CreateMeetingWithAttendeesRequest$NotificationsConfiguration": null @@ -2425,18 +2453,18 @@ "base": null, "refs": { "ChannelMessage$MessageId": "The ID of a message.
", - "ChannelMessageSummary$MessageId": "The ID of the message summary.
", + "ChannelMessageSummary$MessageId": "The ID of the message.
", "DeleteChannelMessageRequest$MessageId": "The ID of the message being deleted.
", "GetChannelMessageRequest$MessageId": "The ID of the message.
", "RedactChannelMessageRequest$MessageId": "The ID of the message being redacted.
", "RedactChannelMessageResponse$MessageId": "The ID of the message being redacted.
", - "SendChannelMessageResponse$MessageId": "The ID string assigned to each message.
", + "SendChannelMessageResponse$MessageId": "The ID string assigned to each message.
", "UpdateChannelMessageRequest$MessageId": "The ID string of the message being updated.
", "UpdateChannelMessageResponse$MessageId": "The ID string of the message being updated.
" } }, "MessagingSessionEndpoint": { - "base": "The endpoint of a meeting session.
", + "base": "The websocket endpoint used to connect to Amazon Chime SDK messaging.
", "refs": { "GetMessagingSessionEndpointResponse$Endpoint": "The endpoint returned in the response.
" } @@ -2444,22 +2472,22 @@ "Metadata": { "base": null, "refs": { - "AppInstance$Metadata": "The metadata of an app instance.
", - "AppInstanceSummary$Metadata": "The metadata of the app instance summary.
", - "AppInstanceUser$Metadata": "The metadata of the app instance user.
", - "AppInstanceUserSummary$Metadata": "The metadata in an app instance user summary.
", - "Channel$Metadata": "The metadata of the channel.
", + "AppInstance$Metadata": "The metadata of an AppInstance.
The metadata of the AppInstance.
The metadata of the AppInstanceUser.
The metadata of the AppInstanceUser.
The channel's metadata.
", "ChannelMessage$Metadata": "The message metadata.
", - "ChannelMessageSummary$Metadata": "The metadata of the message summary.
", - "ChannelSummary$Metadata": "The metadata of the channel summary.
", - "CreateAppInstanceRequest$Metadata": "The metadata of the app instance. Limited to a 1KB string in UTF-8.
", + "ChannelMessageSummary$Metadata": "The metadata of the message.
", + "ChannelSummary$Metadata": "The metadata of the channel.
", + "CreateAppInstanceRequest$Metadata": "The metadata of the AppInstance. Limited to a 1KB string in UTF-8.
The request's metadata. Limited to a 1KB string in UTF-8.
", "CreateChannelRequest$Metadata": "The metadata of the creation request. Limited to 1KB and UTF-8.
", - "SendChannelMessageRequest$Metadata": "The optional metadata for each message.
", + "SendChannelMessageRequest$Metadata": "The optional metadata for each message.
", "UpdateAppInstanceRequest$Metadata": "The metadata that you want to change.
", - "UpdateAppInstanceUserRequest$Metadata": "The metadata of the app instance user.
", + "UpdateAppInstanceUserRequest$Metadata": "The metadata of the AppInstanceUser.
The metadata of the message being updated.
", - "UpdateChannelRequest$Metadata": "The metadata of the channel.
" + "UpdateChannelRequest$Metadata": "The metadata for the update request.
" } }, "NextToken": { @@ -2469,13 +2497,13 @@ "ListAppInstanceAdminsResponse$NextToken": "The token returned from previous API requests until the number of administrators is reached.
", "ListAppInstanceUsersRequest$NextToken": "The token passed by previous API calls until all requested users are returned.
", "ListAppInstanceUsersResponse$NextToken": "The token passed by previous API calls until all requested users are returned.
", - "ListAppInstancesRequest$NextToken": "The token passed by previous API requests until you reach the maximum number of app instances.
", - "ListAppInstancesResponse$NextToken": "The token passed by previous API requests until the maximum number of app instances is reached.
", + "ListAppInstancesRequest$NextToken": "The token passed by previous API requests until you reach the maximum number of AppInstances.
The token passed by previous API requests until the maximum number of AppInstances is reached.
The token passed by previous API calls until all requested bans are returned.
", "ListChannelBansResponse$NextToken": "The token passed by previous API calls until all requested bans are returned.
", "ListChannelMembershipsForAppInstanceUserRequest$NextToken": "The token returned from previous API requests until the number of channel memberships is reached.
", "ListChannelMembershipsForAppInstanceUserResponse$NextToken": "The token passed by previous API calls until all requested users are returned.
", - "ListChannelMembershipsRequest$NextToken": "The token passed by previous API calls until all requested channel memberships are returned..
", + "ListChannelMembershipsRequest$NextToken": "The token passed by previous API calls until all requested channel memberships are returned.
", "ListChannelMembershipsResponse$NextToken": "The token passed by previous API calls until all requested channel memberships are returned.
", "ListChannelMessagesRequest$NextToken": "The token passed by previous API calls until all requested messages are returned.
", "ListChannelMessagesResponse$NextToken": "The token passed by previous API calls until all requested messages are returned.
", @@ -2507,11 +2535,11 @@ "NonEmptyResourceName": { "base": null, "refs": { - "AppInstance$Name": "The name of an app instance.
", - "AppInstanceSummary$Name": "The name of the app instance summary.
", + "AppInstance$Name": "The name of an AppInstance.
The name of the AppInstance.
The name of the channel.
", - "ChannelSummary$Name": "The parameter of the action.
", - "CreateAppInstanceRequest$Name": "The name of the app instance.
", + "ChannelSummary$Name": "The name of the channel.
", + "CreateAppInstanceRequest$Name": "The name of the AppInstance.
The name of the channel.
", "UpdateAppInstanceRequest$Name": "The name that you want to change.
", "UpdateChannelRequest$Name": "The name of the channel.
" @@ -2535,7 +2563,7 @@ "CreateRoomMembershipRequest$MemberId": "The Amazon Chime member ID (user ID or bot ID).
", "CreateRoomRequest$AccountId": "The Amazon Chime account ID.
", "CreateSipMediaApplicationCallRequest$SipMediaApplicationId": "The ID of the SIP media application.
", - "CreateSipRuleRequest$TriggerValue": "If TriggerType is RequestUriHostname then the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber then the value can be a customer-owned phone number in E164 format. SipRule is triggered if the SIP application requests a host name, or a If TriggerType is RequestUriHostname, then the value can be the outbound hostname of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered if the SIP application requests a host name, or a ToPhoneNumber value matches the incoming SIP request.
If TriggerType is RequestUriHostname, the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.
The Amazon Chime account ID.
", "DeleteAccountRequest$AccountId": "The Amazon Chime account ID.
", "DeleteEventsConfigurationRequest$AccountId": "The Amazon Chime account ID.
", @@ -2566,7 +2594,7 @@ "GetRetentionSettingsRequest$AccountId": "The Amazon Chime account ID.
", "GetRoomRequest$AccountId": "The Amazon Chime account ID.
", "GetRoomRequest$RoomId": "The room ID.
", - "GetSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationId": "The ID of the SIP media application.
", + "GetSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationId": "The SIP media application ID.
", "GetSipMediaApplicationRequest$SipMediaApplicationId": "The SIP media application ID.
", "GetSipRuleRequest$SipRuleId": "The SIP rule ID.
", "GetUserRequest$AccountId": "The Amazon Chime account ID.
", @@ -2597,7 +2625,7 @@ "PutEventsConfigurationRequest$AccountId": "The Amazon Chime account ID.
", "PutEventsConfigurationRequest$BotId": "The bot ID.
", "PutRetentionSettingsRequest$AccountId": "The Amazon Chime account ID.
", - "PutSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationId": "The ID of the specified SIP media application
", + "PutSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationId": "The SIP media application ID.
", "PutVoiceConnectorEmergencyCallingConfigurationRequest$VoiceConnectorId": "The Amazon Chime Voice Connector ID.
", "PutVoiceConnectorLoggingConfigurationRequest$VoiceConnectorId": "The Amazon Chime Voice Connector ID.
", "PutVoiceConnectorOriginationRequest$VoiceConnectorId": "The Amazon Chime Voice Connector ID.
", @@ -2677,8 +2705,8 @@ "NonNullableBoolean": { "base": null, "refs": { - "ChannelMessage$Redacted": "Hides the content of a message. The message still exists on the back end, but this action only returns metadata.
", - "ChannelMessageSummary$Redacted": "Redacts the content of a message summary.
" + "ChannelMessage$Redacted": "Hides the content of a message.
", + "ChannelMessageSummary$Redacted": "Indicates whether a message was redacted.
" } }, "NotFoundException": { @@ -2769,7 +2797,7 @@ "OriginationRouteWeight": { "base": null, "refs": { - "OriginationRoute$Weight": "The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.
" + "OriginationRoute$Weight": "The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.
" } }, "Participant": { @@ -3165,13 +3193,13 @@ "RetentionDays": { "base": null, "refs": { - "ChannelRetentionSettings$RetentionDays": "The time in days to retain a channel.
", - "ConversationRetentionSettings$RetentionDays": "The number of days for which to retain chat conversation messages.
", - "RoomRetentionSettings$RetentionDays": "The number of days for which to retain chat room messages.
" + "ChannelRetentionSettings$RetentionDays": "The time in days to retain the messages in a channel.
", + "ConversationRetentionSettings$RetentionDays": "The number of days for which to retain conversation messages.
", + "RoomRetentionSettings$RetentionDays": "The number of days for which to retain chat-room messages.
" } }, "RetentionSettings": { - "base": "The retention settings for an Amazon Chime Enterprise account that determine how long to retain items such as chat room messages and chat conversation messages.
", + "base": "The retention settings for an Amazon Chime Enterprise account that determine how long to retain items such as chat-room messages and chat-conversation messages.
", "refs": { "GetRetentionSettingsResponse$RetentionSettings": "The retention settings.
", "PutRetentionSettingsRequest$RetentionSettings": "The retention settings.
", @@ -3217,7 +3245,7 @@ } }, "RoomRetentionSettings": { - "base": "The retention settings that determine how long to retain chat room messages for an Amazon Chime Enterprise account.
", + "base": "The retention settings that determine how long to retain chat-room messages for an Amazon Chime Enterprise account.
", "refs": { "RetentionSettings$RoomRetentionSettings": "The chat room retention settings.
" } @@ -3303,9 +3331,9 @@ } }, "SipMediaApplication": { - "base": "The SIP media application details, including name and endpoints. An AWS account can have multiple SIP media applications.
", + "base": "The details of the SIP media application, including name and endpoints. An AWS account can have multiple SIP media applications.
", "refs": { - "CreateSipMediaApplicationResponse$SipMediaApplication": "The Sip media application details.
", + "CreateSipMediaApplicationResponse$SipMediaApplication": "The SIP media application details.
", "GetSipMediaApplicationResponse$SipMediaApplication": "The SIP media application details.
", "SipMediaApplicationList$member": null, "UpdateSipMediaApplicationResponse$SipMediaApplication": "The updated SIP media application details.
" @@ -3318,7 +3346,7 @@ } }, "SipMediaApplicationEndpoint": { - "base": "Endpoints to specify as part of a SIP media application.
", + "base": "The endpoint assigned to the SIP media application.
", "refs": { "SipMediaApplicationEndpointList$member": null } @@ -3342,7 +3370,7 @@ "refs": { "GetSipMediaApplicationLoggingConfigurationResponse$SipMediaApplicationLoggingConfiguration": "The actual logging configuration.
", "PutSipMediaApplicationLoggingConfigurationRequest$SipMediaApplicationLoggingConfiguration": "The actual logging configuration.
", - "PutSipMediaApplicationLoggingConfigurationResponse$SipMediaApplicationLoggingConfiguration": "The actual logging configuration.
" + "PutSipMediaApplicationLoggingConfigurationResponse$SipMediaApplicationLoggingConfiguration": null } }, "SipMediaApplicationName": { @@ -3377,7 +3405,7 @@ } }, "SipRuleTargetApplication": { - "base": "Target SIP media application along with other details like priority and AWS Region to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
", + "base": "Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
", "refs": { "SipRuleTargetApplicationList$member": null } @@ -3386,15 +3414,15 @@ "base": null, "refs": { "CreateSipRuleRequest$TargetApplications": "List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.
", - "SipRule$TargetApplications": "List of SIP media applications with priority and AWS Region. You can only use one SIP application per AWS Region and priority combination.
", + "SipRule$TargetApplications": "Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.
", "UpdateSipRuleRequest$TargetApplications": "The new value of the list of target applications.
" } }, "SipRuleTriggerType": { "base": null, "refs": { - "CreateSipRuleRequest$TriggerType": "The type of trigger whose value is assigned to the SIP rule in TriggerValue. Allowed trigger values are RequestUriHostname and ToPhoneNumber.
The type of trigger whose value is assigned to the SIP rule in TriggerValue.
The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.
The error code.
", "CreateAttendeeError$ErrorMessage": "The error message.
", - "CreateMeetingRequest$MediaRegion": "The Region in which to create the meeting. Default: us-east-1.
Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.
The Region in which to create the meeting. Default: us-east-1.
Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.
AWS Region assigned to the SIP media application.
", + "CreateMeetingRequest$MediaRegion": " The Region in which to create the meeting. Default: us-east-1.
Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .
The Region in which to create the meeting. Default: us-east-1 .
Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .
The AWS Region assigned to the SIP media application.
", "CreateUserRequest$Username": "The user name.
", "DeletePhoneNumberRequest$PhoneNumberId": "The phone number ID.
", "DisassociatePhoneNumberFromUserRequest$AccountId": "The Amazon Chime account ID.
", @@ -3453,7 +3481,7 @@ "GetUserSettingsRequest$UserId": "The user ID.
", "Invite$InviteId": "The invite ID.
", "ListAccountsRequest$NextToken": "The token to use to retrieve the next page of results.
", - "ListAccountsResponse$NextToken": "The account's user token.
", + "ListAccountsResponse$NextToken": "The token to use to retrieve the next page of results.
", "ListAttendeesRequest$NextToken": "The token to use to retrieve the next page of results.
", "ListAttendeesResponse$NextToken": "The token to use to retrieve the next page of results.
", "ListBotsRequest$NextToken": "The token to use to retrieve the next page of results.
", @@ -3476,7 +3504,7 @@ "ListVoiceConnectorGroupsResponse$NextToken": "The token to use to retrieve the next page of results.
", "ListVoiceConnectorsRequest$NextToken": "The token to use to retrieve the next page of results.
", "ListVoiceConnectorsResponse$NextToken": "The token to use to retrieve the next page of results.
", - "Meeting$MediaRegion": "The Region in which to create the meeting. Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.
The Region in which you create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .
The error message.
", "NonEmptyStringList$member": null, "NotFoundException$Message": null, @@ -3493,7 +3521,7 @@ "ServiceFailureException$Message": null, "ServiceUnavailableException$Message": null, "SipMediaApplication$AwsRegion": "The AWS Region in which the SIP media application is created.
", - "SipRuleTargetApplication$AwsRegion": "AWS Region of target application.
", + "SipRuleTargetApplication$AwsRegion": "The AWS Region of the target application.
", "StringList$member": null, "TerminationHealth$Source": "The source IP address.
", "ThrottledClientException$Message": null, @@ -3554,7 +3582,9 @@ "TagList": { "base": null, "refs": { - "CreateChannelRequest$Tags": null, + "CreateAppInstanceRequest$Tags": "Tags assigned to the AppInstanceUser.
Tags assigned to the AppInstanceUser.
The tags for the creation request.
", "ListAttendeeTagsResponse$Tags": "A list of tag key-value pairs.
", "ListMeetingTagsResponse$Tags": "A list of tag key-value pairs.
", "ListTagsForResourceResponse$Tags": "A list of tag-key value pairs.
", @@ -3605,28 +3635,28 @@ "Timestamp": { "base": null, "refs": { - "AppInstance$CreatedTimestamp": "The time at which an app instance was created. In epoch milliseconds.
", - "AppInstance$LastUpdatedTimestamp": "The time an app instance was last updated. In epoch milliseconds.
", + "AppInstance$CreatedTimestamp": "The time at which an AppInstance was created. In epoch milliseconds.
The time an AppInstance was last updated. In epoch milliseconds.
The time at which an administrator was created.
", - "AppInstanceUser$CreatedTimestamp": "The time at which the app instance user was created.
", - "AppInstanceUser$LastUpdatedTimestamp": "The time at which the app instance user was last updated.
", - "AppInstanceUserMembershipSummary$ReadMarkerTimestamp": "The time at which a summary was last read.
", - "Channel$CreatedTimestamp": "The time at which the administrator created the channel.
", - "Channel$LastMessageTimestamp": "The time at which a member sent the last message in a session.
", + "AppInstanceUser$CreatedTimestamp": "The time at which the AppInstanceUser was created.
The time at which the AppInstanceUser was last updated.
The time at which a message was last read.
", + "Channel$CreatedTimestamp": "The time at which the AppInstanceUser created the channel.
The time at which a member sent the last message in the channel.
", "Channel$LastUpdatedTimestamp": "The time at which a channel was last updated.
", "ChannelBan$CreatedTimestamp": "The time at which the ban was created.
", - "ChannelMembership$CreatedTimestamp": "The time at which the channel membership was created.
", + "ChannelMembership$CreatedTimestamp": "The time at which the channel membership was created.
", "ChannelMembership$LastUpdatedTimestamp": "The time at which a channel membership was last updated.
", "ChannelMessage$CreatedTimestamp": "The time at which the message was created.
", "ChannelMessage$LastEditedTimestamp": "The time at which a message was edited.
", "ChannelMessage$LastUpdatedTimestamp": "The time at which a message was updated.
", "ChannelMessageSummary$CreatedTimestamp": "The time at which the message summary was created.
", - "ChannelMessageSummary$LastUpdatedTimestamp": null, - "ChannelMessageSummary$LastEditedTimestamp": null, + "ChannelMessageSummary$LastUpdatedTimestamp": "The time at which a message was last updated.
", + "ChannelMessageSummary$LastEditedTimestamp": "The time at which a message was last edited.
", "ChannelModerator$CreatedTimestamp": "The time at which the moderator was created.
", "ChannelSummary$LastMessageTimestamp": "The time at which the last message in a channel was sent.
", "GetAppInstanceRetentionSettingsResponse$InitiateDeletionTimestamp": "The timestamp representing the time at which the specified items are retained, in Epoch Seconds.
", - "ListChannelMessagesRequest$NotBefore": "The initial or starting time stamp for your requested messages.
", + "ListChannelMessagesRequest$NotBefore": "The initial or starting time stamp for your requested messages.
", "ListChannelMessagesRequest$NotAfter": "The final or ending time stamp for your requested messages.
", "PutAppInstanceRetentionSettingsResponse$InitiateDeletionTimestamp": "The time at which the API deletes data.
" } @@ -3753,7 +3783,7 @@ } }, "UpdatePhoneNumberRequestItem": { - "base": "The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.
", + "base": "The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.
", "refs": { "UpdatePhoneNumberRequestItemList$member": null } @@ -3830,7 +3860,7 @@ } }, "UpdateUserRequestItem": { - "base": "The user ID and user fields to update, used with the BatchUpdateUser action.
", + "base": "The user ID and user fields to update, used with the BatchUpdateUser action.
", "refs": { "UpdateUserRequestItemList$member": null } @@ -3886,7 +3916,7 @@ "UrlType": { "base": null, "refs": { - "MessagingSessionEndpoint$Url": "The URL of a meeting session endpoint.
" + "MessagingSessionEndpoint$Url": "The endpoint to which you establish a websocket connection.
" } }, "User": { @@ -3922,7 +3952,7 @@ "UserId": { "base": null, "refs": { - "CreateAppInstanceUserRequest$AppInstanceUserId": "The user ID of the app instance.
" + "CreateAppInstanceUserRequest$AppInstanceUserId": "The user ID of the AppInstance.
The name of the app instance user.
", - "AppInstanceUserSummary$Name": "The name in an app instance user summary.
", + "AppInstanceUser$Name": "The name of the AppInstanceUser.
The name of an AppInstanceUser.
The user's name.
", - "UpdateAppInstanceUserRequest$Name": "The name of the app instance user.
" + "UpdateAppInstanceUserRequest$Name": "The name of the AppInstanceUser.
The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1.
The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.
The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1 .
The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.
The Amazon Chime Voice Connectors to route inbound calls to.
", - "UpdateVoiceConnectorGroupRequest$VoiceConnectorItems": "The VoiceConnectorItems to associate with the group.
The VoiceConnectorItems to associate with the group.
The Amazon Chime Voice Connectors to which to route inbound calls.
" } }, "VoiceConnectorItemPriority": { "base": null, "refs": { - "VoiceConnectorItem$Priority": "The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
" + "VoiceConnectorItem$Priority": "The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
" } }, "VoiceConnectorList": { diff --git a/models/apis/ecs/2014-11-13/api-2.json b/models/apis/ecs/2014-11-13/api-2.json index b87d21ff1b8..3766114763c 100644 --- a/models/apis/ecs/2014-11-13/api-2.json +++ b/models/apis/ecs/2014-11-13/api-2.json @@ -2958,7 +2958,10 @@ "inferenceAccelerators":{"shape":"InferenceAccelerators"}, "pidMode":{"shape":"PidMode"}, "ipcMode":{"shape":"IpcMode"}, - "proxyConfiguration":{"shape":"ProxyConfiguration"} + "proxyConfiguration":{"shape":"ProxyConfiguration"}, + "registeredAt":{"shape":"Timestamp"}, + "deregisteredAt":{"shape":"Timestamp"}, + "registeredBy":{"shape":"String"} } }, "TaskDefinitionFamilyStatus":{ diff --git a/models/apis/ecs/2014-11-13/docs-2.json b/models/apis/ecs/2014-11-13/docs-2.json index 4c7433b9660..2000f5a28f3 100644 --- a/models/apis/ecs/2014-11-13/docs-2.json +++ b/models/apis/ecs/2014-11-13/docs-2.json @@ -139,7 +139,7 @@ "AutoScalingGroupProviderUpdate": { "base": "The details of the Auto Scaling group capacity provider to update.
", "refs": { - "UpdateCapacityProviderRequest$autoScalingGroupProvider": "The name of the capacity provider to update.
" + "UpdateCapacityProviderRequest$autoScalingGroupProvider": "An object representing the parameters to update for the Auto Scaling group capacity provider.
" } }, "AwsVpcConfiguration": { @@ -831,7 +831,7 @@ "EnvironmentFiles": { "base": null, "refs": { - "ContainerDefinition$environmentFiles": "A list of files containing the environment variables to pass to a container. This parameter maps to the --env-file option to docker run.
You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.
If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.
This field is not valid for containers in tasks using the Fargate launch type.
", + "ContainerDefinition$environmentFiles": "A list of files containing the environment variables to pass to a container. This parameter maps to the --env-file option to docker run.
You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.
If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide.
A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
" } }, @@ -1945,6 +1945,7 @@ "TaskDefinition$executionRoleArn": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
", "TaskDefinition$cpu": "The number of cpu units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:
256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The amount (in MiB) of memory used by the task.
If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified then the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition.
If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
The principal that registered the task definition.
", "TaskDefinitionPlacementConstraint$expression": "A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
", "TaskOverride$cpu": "The cpu override for the task.
", "TaskOverride$executionRoleArn": "The Amazon Resource Name (ARN) of the task execution IAM role override for the task.
", @@ -1961,7 +1962,7 @@ "TaskSet$platformVersion": "The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The absolute file path where the tmpfs volume is to be mounted.
", "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
", - "UpdateCapacityProviderRequest$name": "An object representing the parameters to update for the Auto Scaling group capacity provider.
", + "UpdateCapacityProviderRequest$name": "The name of the capacity provider to update.
", "UpdateClusterSettingsRequest$cluster": "The name of the cluster to modify the settings for.
", "UpdateContainerAgentRequest$cluster": "The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.
", "UpdateContainerAgentRequest$containerInstance": "The container instance ID or full ARN entries for the container instance on which you would like to update the Amazon ECS container agent.
", @@ -2284,6 +2285,8 @@ "Task$startedAt": "The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).
The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED).
The Unix timestamp for when the task definition was registered.
", + "TaskDefinition$deregisteredAt": "The Unix timestamp for when the task definition was deregistered.
", "TaskSet$createdAt": "The Unix timestamp for when the task set was created.
", "TaskSet$updatedAt": "The Unix timestamp for when the task set was last updated.
", "TaskSet$stabilityStatusAt": "The Unix timestamp for when the task set stability status was retrieved.
" diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index cc5b20ce3e9..92e92af86c0 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -277,9 +277,33 @@ "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "api.detective-fips.us-east-1.amazonaws.com" + }, "us-east-2" : { }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "api.detective-fips.us-east-2.amazonaws.com" + }, "us-west-1" : { }, - "us-west-2" : { } + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "api.detective-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "api.detective-fips.us-west-2.amazonaws.com" + } } }, "api.ecr" : { diff --git a/service/acmpca/api.go b/service/acmpca/api.go index 5a44121539d..f874f85bd06 100644 --- a/service/acmpca/api.go +++ b/service/acmpca/api.go @@ -768,7 +768,7 @@ func (c *ACMPCA) DescribeCertificateAuthorityRequest(input *DescribeCertificateA // * EXPIRED - Your private CA certificate has expired. // // * FAILED - Your private CA has failed. Your CA can fail because of problems -// such a network outage or backend AWS failure or other errors. A failed +// such a network outage or back-end AWS failure or other errors. A failed // CA can never return to the pending state. You must create a new CA. // // * DELETED - Your private CA is within the restoration period, after which @@ -1355,8 +1355,7 @@ func (c *ACMPCA) ImportCertificateAuthorityCertificateRequest(input *ImportCerti // must in place: // // In ACM Private CA, call the CreateCertificateAuthority (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) -// action to create the private CA that that you plan to back with the imported -// certificate. +// action to create the private CA that you plan to back with the imported certificate. // // Call the GetCertificateAuthorityCsr (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetCertificateAuthorityCsr.html) // action to generate a certificate signing request (CSR). @@ -1377,7 +1376,7 @@ func (c *ACMPCA) ImportCertificateAuthorityCertificateRequest(input *ImportCerti // * Installing a subordinate CA certificate whose parent authority is externally // hosted. // -// The following addtitional requirements apply when you import a CA certificate. +// The following additional requirements apply when you import a CA certificate. // // * Only a self-signed certificate can be imported as a root CA. // @@ -2729,15 +2728,12 @@ func (c *ACMPCA) UpdateCertificateAuthorityWithContext(ctx aws.Context, input *U return out, req.Send() } -// Contains information about the certificate subject. The certificate can be -// one issued by your private certificate authority (CA) or it can be your private -// CA certificate. The Subject field in the certificate identifies the entity -// that owns or controls the public key in the certificate. The entity can be -// a user, computer, device, or service. The Subject must contain an X.500 distinguished -// name (DN). A DN is a sequence of relative distinguished names (RDNs). The -// RDNs are separated by commas in the certificate. The DN must be unique for -// each entity, but your private CA can issue more than one certificate with -// the same DN to the same entity. +// Contains information about the certificate subject. The Subject field in +// the certificate identifies the entity that owns or controls the public key +// in the certificate. The entity can be a user, computer, device, or service. +// The Subject must contain an X.500 distinguished name (DN). A DN is a sequence +// of relative distinguished names (RDNs). The RDNs are separated by commas +// in the certificate. type ASN1Subject struct { _ struct{} `type:"structure"` @@ -2764,7 +2760,7 @@ type ASN1Subject struct { // Concatenation that typically contains the first letter of the GivenName, // the first letter of the middle name if one exists, and the first letter of - // the SurName. + // the Surname. Initials *string `type:"string"` // The locality (such as a city or town) in which the certificate subject is @@ -3000,6 +2996,70 @@ func (s *AccessMethod) SetCustomObjectIdentifier(v string) *AccessMethod { return s } +// Contains X.509 certificate information to be placed in an issued certificate. +// An APIPassthrough or APICSRPassthrough template variant must be selected, +// or else this parameter is ignored. +// +// If conflicting or duplicate certificate information is supplied from other +// sources, ACM Private CA applies order of operation rules (xxxxx) to determine +// what information is used. +type ApiPassthrough struct { + _ struct{} `type:"structure"` + + // Specifies X.509 extension information for a certificate. + Extensions *Extensions `type:"structure"` + + // Contains information about the certificate subject. The Subject field in + // the certificate identifies the entity that owns or controls the public key + // in the certificate. The entity can be a user, computer, device, or service. + // The Subject must contain an X.500 distinguished name (DN). A DN is a sequence + // of relative distinguished names (RDNs). The RDNs are separated by commas + // in the certificate. + Subject *ASN1Subject `type:"structure"` +} + +// String returns the string representation +func (s ApiPassthrough) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ApiPassthrough) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ApiPassthrough) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ApiPassthrough"} + if s.Extensions != nil { + if err := s.Extensions.Validate(); err != nil { + invalidParams.AddNested("Extensions", err.(request.ErrInvalidParams)) + } + } + if s.Subject != nil { + if err := s.Subject.Validate(); err != nil { + invalidParams.AddNested("Subject", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetExtensions sets the Extensions field's value. +func (s *ApiPassthrough) SetExtensions(v *Extensions) *ApiPassthrough { + s.Extensions = v + return s +} + +// SetSubject sets the Subject field's value. +func (s *ApiPassthrough) SetSubject(v *ASN1Subject) *ApiPassthrough { + s.Subject = v + return s +} + // Contains information about your private certificate authority (CA). Your // private CA can issue and revoke X.509 digital certificates. Digital certificates // verify that the entity named in the certificate Subject field owns or controls @@ -3479,12 +3539,13 @@ type CreateCertificateAuthorityInput struct { // CertificateAuthorityType is a required field CertificateAuthorityType *string `type:"string" required:"true" enum:"CertificateAuthorityType"` - // Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. - // For a given token, ACM Private CA creates exactly one CA. If you issue a - // subsequent call using the same token, ACM Private CA returns the ARN of the - // existing CA and takes no further action. If you change the idempotency token - // across multiple calls, ACM Private CA creates a unique CA for each unique - // token. + // Custom string that can be used to distinguish between calls to the CreateCertificateAuthority + // action. Idempotency tokens for CreateCertificateAuthority time out after + // five minutes. Therefore, if you call CreateCertificateAuthority multiple + // times with the same idempotency token within five minutes, ACM Private CA + // recognizes that you are requesting only certificate authority and will issue + // only one. If you change the idempotency token for each call, PCA recognizes + // that you are requesting multiple certificate authorities. IdempotencyToken *string `min:"1" type:"string"` // Contains a Boolean value that you can use to enable a certification revocation @@ -4354,21 +4415,153 @@ func (s *EdiPartyName) SetPartyName(v string) *EdiPartyName { return s } +// Specifies additional purposes for which the certified public key may be used +// other than basic purposes indicated in the KeyUsage extension. +type ExtendedKeyUsage struct { + _ struct{} `type:"structure"` + + // Specifies a custom ExtendedKeyUsage with an object identifier (OID). + ExtendedKeyUsageObjectIdentifier *string `type:"string"` + + // Specifies a standard ExtendedKeyUsage as defined as in RFC 5280 (https://tools.ietf.org/html/rfc5280#section-4.2.1.12). + ExtendedKeyUsageType *string `type:"string" enum:"ExtendedKeyUsageType"` +} + +// String returns the string representation +func (s ExtendedKeyUsage) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ExtendedKeyUsage) GoString() string { + return s.String() +} + +// SetExtendedKeyUsageObjectIdentifier sets the ExtendedKeyUsageObjectIdentifier field's value. +func (s *ExtendedKeyUsage) SetExtendedKeyUsageObjectIdentifier(v string) *ExtendedKeyUsage { + s.ExtendedKeyUsageObjectIdentifier = &v + return s +} + +// SetExtendedKeyUsageType sets the ExtendedKeyUsageType field's value. +func (s *ExtendedKeyUsage) SetExtendedKeyUsageType(v string) *ExtendedKeyUsage { + s.ExtendedKeyUsageType = &v + return s +} + +// Contains X.509 extension information for a certificate. +type Extensions struct { + _ struct{} `type:"structure"` + + // Contains a sequence of one or more policy information terms, each of which + // consists of an object identifier (OID) and optional qualifiers. For more + // information, see NIST's definition of Object Identifier (OID) (https://csrc.nist.gov/glossary/term/Object_Identifier). + // + // In an end-entity certificate, these terms indicate the policy under which + // the certificate was issued and the purposes for which it may be used. In + // a CA certificate, these terms limit the set of policies for certification + // paths that include this certificate. + CertificatePolicies []*PolicyInformation `min:"1" type:"list"` + + // Specifies additional purposes for which the certified public key may be used + // other than basic purposes indicated in the KeyUsage extension. + ExtendedKeyUsage []*ExtendedKeyUsage `min:"1" type:"list"` + + // Defines one or more purposes for which the key contained in the certificate + // can be used. Default value for each option is false. + KeyUsage *KeyUsage `type:"structure"` + + // The subject alternative name extension allows identities to be bound to the + // subject of the certificate. These identities may be included in addition + // to or in place of the identity in the subject field of the certificate. + SubjectAlternativeNames []*GeneralName `min:"1" type:"list"` +} + +// String returns the string representation +func (s Extensions) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Extensions) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Extensions) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Extensions"} + if s.CertificatePolicies != nil && len(s.CertificatePolicies) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CertificatePolicies", 1)) + } + if s.ExtendedKeyUsage != nil && len(s.ExtendedKeyUsage) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ExtendedKeyUsage", 1)) + } + if s.SubjectAlternativeNames != nil && len(s.SubjectAlternativeNames) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SubjectAlternativeNames", 1)) + } + if s.CertificatePolicies != nil { + for i, v := range s.CertificatePolicies { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "CertificatePolicies", i), err.(request.ErrInvalidParams)) + } + } + } + if s.SubjectAlternativeNames != nil { + for i, v := range s.SubjectAlternativeNames { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "SubjectAlternativeNames", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCertificatePolicies sets the CertificatePolicies field's value. +func (s *Extensions) SetCertificatePolicies(v []*PolicyInformation) *Extensions { + s.CertificatePolicies = v + return s +} + +// SetExtendedKeyUsage sets the ExtendedKeyUsage field's value. +func (s *Extensions) SetExtendedKeyUsage(v []*ExtendedKeyUsage) *Extensions { + s.ExtendedKeyUsage = v + return s +} + +// SetKeyUsage sets the KeyUsage field's value. +func (s *Extensions) SetKeyUsage(v *KeyUsage) *Extensions { + s.KeyUsage = v + return s +} + +// SetSubjectAlternativeNames sets the SubjectAlternativeNames field's value. +func (s *Extensions) SetSubjectAlternativeNames(v []*GeneralName) *Extensions { + s.SubjectAlternativeNames = v + return s +} + // Describes an ASN.1 X.400 GeneralName as defined in RFC 5280 (https://tools.ietf.org/html/rfc5280). -// Only one of the following naming options should be providied. Providing more +// Only one of the following naming options should be provided. Providing more // than one option results in an InvalidArgsException error. type GeneralName struct { _ struct{} `type:"structure"` - // Contains information about the certificate subject. The certificate can be - // one issued by your private certificate authority (CA) or it can be your private - // CA certificate. The Subject field in the certificate identifies the entity - // that owns or controls the public key in the certificate. The entity can be - // a user, computer, device, or service. The Subject must contain an X.500 distinguished - // name (DN). A DN is a sequence of relative distinguished names (RDNs). The - // RDNs are separated by commas in the certificate. The DN must be unique for - // each entity, but your private CA can issue more than one certificate with - // the same DN to the same entity. + // Contains information about the certificate subject. The Subject field in + // the certificate identifies the entity that owns or controls the public key + // in the certificate. The entity can be a user, computer, device, or service. + // The Subject must contain an X.500 distinguished name (DN). A DN is a sequence + // of relative distinguished names (RDNs). The RDNs are separated by commas + // in the certificate. DirectoryName *ASN1Subject `type:"structure"` // Represents GeneralName as a DNS name. @@ -5283,6 +5476,16 @@ func (s *InvalidTagException) RequestID() string { type IssueCertificateInput struct { _ struct{} `type:"structure"` + // Specifies X.509 certificate information to be included in the issued certificate. + // An APIPassthrough or APICSRPassthrough template variant must be selected, + // or else this parameter is ignored. For more information about using these + // templates, see Understanding Certificate Templates (https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html). + // + // If conflicting or duplicate certificate information is supplied during certificate + // issuance, ACM Private CA applies order of operation rules (xxxxx) to determine + // what information is used. + ApiPassthrough *ApiPassthrough `type:"structure"` + // The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority // (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html). // This must be of the form: @@ -5293,15 +5496,15 @@ type IssueCertificateInput struct { CertificateAuthorityArn *string `min:"5" type:"string" required:"true"` // The certificate signing request (CSR) for the certificate you want to issue. - // You can use the following OpenSSL command to create the CSR and a 2048 bit - // RSA private key. + // As an example, you can use the following OpenSSL command to create the CSR + // and a 2048 bit RSA private key. // // openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem // -out csr/test_cert_.csr // - // If you have a configuration file, you can use the following OpenSSL command. - // The usr_cert block in the configuration file contains your X509 version 3 - // extensions. + // If you have a configuration file, you can then use the following OpenSSL + // command. The usr_cert block in the configuration file contains your X509 + // version 3 extensions. // // openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 // -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr @@ -5314,19 +5517,20 @@ type IssueCertificateInput struct { // Csr is a required field Csr []byte `min:"1" type:"blob" required:"true"` - // Custom string that can be used to distinguish between calls to the IssueCertificate - // action. Idempotency tokens time out after one hour. Therefore, if you call - // IssueCertificate multiple times with the same idempotency token within 5 - // minutes, ACM Private CA recognizes that you are requesting only one certificate - // and will issue only one. If you change the idempotency token for each call, - // PCA recognizes that you are requesting multiple certificates. + // Alphanumeric string that can be used to distinguish between calls to the + // IssueCertificate action. Idempotency tokens for IssueCertificate time out + // after one minute. Therefore, if you call IssueCertificate multiple times + // with the same idempotency token within one minute, ACM Private CA recognizes + // that you are requesting only one certificate and will issue only one. If + // you change the idempotency token for each call, PCA recognizes that you are + // requesting multiple certificates. IdempotencyToken *string `min:"1" type:"string"` // The name of the algorithm that will be used to sign the certificate to be // issued. // // This parameter should not be confused with the SigningAlgorithm parameter - // used to sign a CSR. + // used to sign a CSR in the CreateCertificateAuthority action. // // SigningAlgorithm is a required field SigningAlgorithm *string `type:"string" required:"true" enum:"SigningAlgorithm"` @@ -5340,53 +5544,44 @@ type IssueCertificateInput struct { // Note: The CA depth configured on a subordinate CA certificate must not exceed // the limit set by its parents in the CA hierarchy. // - // The following service-owned TemplateArn values are supported by ACM Private - // CA: - // - // * arn:aws:acm-pca:::template/CodeSigningCertificate/V1 - // - // * arn:aws:acm-pca:::template/CodeSigningCertificate_CSRPassthrough/V1 - // - // * arn:aws:acm-pca:::template/EndEntityCertificate/V1 - // - // * arn:aws:acm-pca:::template/EndEntityCertificate_CSRPassthrough/V1 - // - // * arn:aws:acm-pca:::template/EndEntityClientAuthCertificate/V1 - // - // * arn:aws:acm-pca:::template/EndEntityClientAuthCertificate_CSRPassthrough/V1 - // - // * arn:aws:acm-pca:::template/EndEntityServerAuthCertificate/V1 - // - // * arn:aws:acm-pca:::template/EndEntityServerAuthCertificate_CSRPassthrough/V1 - // - // * arn:aws:acm-pca:::template/OCSPSigningCertificate/V1 - // - // * arn:aws:acm-pca:::template/OCSPSigningCertificate_CSRPassthrough/V1 - // - // * arn:aws:acm-pca:::template/RootCACertificate/V1 - // - // * arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1 + // For a list of TemplateArn values supported by ACM Private CA, see Understanding + // Certificate Templates (https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html). + TemplateArn *string `min:"5" type:"string"` + + // Information describing the end of the validity period of the certificate. + // This parameter sets the “Not After” date for the certificate. // - // * arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1 + // Certificate validity is the period of time during which a certificate is + // valid. Validity can be expressed as an explicit date and time when the certificate + // expires, or as a span of time after issuance, stated in days, months, or + // years. For more information, see Validity (https://tools.ietf.org/html/rfc5280#section-4.1.2.5) + // in RFC 5280. // - // * arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1 + // This value is unaffected when ValidityNotBefore is also specified. For example, + // if Validity is set to 20 days in the future, the certificate will expire + // 20 days from issuance time regardless of the ValidityNotBefore value. // - // * arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1 + // The end of the validity period configured on a certificate must not exceed + // the limit set on its parents in the CA hierarchy. // - // For more information, see Using Templates (https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html). - TemplateArn *string `min:"5" type:"string"` + // Validity is a required field + Validity *Validity `type:"structure" required:"true"` - // Information describing the validity period of the certificate. + // Information describing the start of the validity period of the certificate. + // This parameter sets the “Not Before" date for the certificate. // - // When issuing a certificate, ACM Private CA sets the "Not Before" date in - // the validity field to date and time minus 60 minutes. This is intended to - // compensate for time inconsistencies across systems of 60 minutes or less. + // By default, when issuing a certificate, ACM Private CA sets the "Not Before" + // date to the issuance time minus 60 minutes. This compensates for clock inconsistencies + // across computer systems. The ValidityNotBefore parameter can be used to customize + // the “Not Before” value. // - // The validity period configured on a certificate must not exceed the limit - // set by its parents in the CA hierarchy. + // Unlike the Validity parameter, the ValidityNotBefore parameter is optional. // - // Validity is a required field - Validity *Validity `type:"structure" required:"true"` + // The ValidityNotBefore value is expressed as an explicit date and time, using + // the Validity type value ABSOLUTE. For more information, see Validity (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_Validity.html) + // in this API reference and Validity (https://tools.ietf.org/html/rfc5280#section-4.1.2.5) + // in RFC 5280. + ValidityNotBefore *Validity `type:"structure"` } // String returns the string representation @@ -5426,11 +5621,21 @@ func (s *IssueCertificateInput) Validate() error { if s.Validity == nil { invalidParams.Add(request.NewErrParamRequired("Validity")) } + if s.ApiPassthrough != nil { + if err := s.ApiPassthrough.Validate(); err != nil { + invalidParams.AddNested("ApiPassthrough", err.(request.ErrInvalidParams)) + } + } if s.Validity != nil { if err := s.Validity.Validate(); err != nil { invalidParams.AddNested("Validity", err.(request.ErrInvalidParams)) } } + if s.ValidityNotBefore != nil { + if err := s.ValidityNotBefore.Validate(); err != nil { + invalidParams.AddNested("ValidityNotBefore", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -5438,6 +5643,12 @@ func (s *IssueCertificateInput) Validate() error { return nil } +// SetApiPassthrough sets the ApiPassthrough field's value. +func (s *IssueCertificateInput) SetApiPassthrough(v *ApiPassthrough) *IssueCertificateInput { + s.ApiPassthrough = v + return s +} + // SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value. func (s *IssueCertificateInput) SetCertificateAuthorityArn(v string) *IssueCertificateInput { s.CertificateAuthorityArn = &v @@ -5474,6 +5685,12 @@ func (s *IssueCertificateInput) SetValidity(v *Validity) *IssueCertificateInput return s } +// SetValidityNotBefore sets the ValidityNotBefore field's value. +func (s *IssueCertificateInput) SetValidityNotBefore(v *Validity) *IssueCertificateInput { + s.ValidityNotBefore = v + return s +} + type IssueCertificateOutput struct { _ struct{} `type:"structure"` @@ -6325,10 +6542,134 @@ func (s *PermissionAlreadyExistsException) RequestID() string { return s.RespMetadata.RequestID } +// Defines the X.509 CertificatePolicies extension. +type PolicyInformation struct { + _ struct{} `type:"structure"` + + // Specifies the object identifier (OID) of the certificate policy under which + // the certificate was issued. For more information, see NIST's definition of + // Object Identifier (OID) (https://csrc.nist.gov/glossary/term/Object_Identifier). + // + // CertPolicyId is a required field + CertPolicyId *string `type:"string" required:"true"` + + // Modifies the given CertPolicyId with a qualifier. ACM Private CA supports + // the certification practice statement (CPS) qualifier. + PolicyQualifiers []*PolicyQualifierInfo `min:"1" type:"list"` +} + +// String returns the string representation +func (s PolicyInformation) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PolicyInformation) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PolicyInformation) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PolicyInformation"} + if s.CertPolicyId == nil { + invalidParams.Add(request.NewErrParamRequired("CertPolicyId")) + } + if s.PolicyQualifiers != nil && len(s.PolicyQualifiers) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PolicyQualifiers", 1)) + } + if s.PolicyQualifiers != nil { + for i, v := range s.PolicyQualifiers { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "PolicyQualifiers", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCertPolicyId sets the CertPolicyId field's value. +func (s *PolicyInformation) SetCertPolicyId(v string) *PolicyInformation { + s.CertPolicyId = &v + return s +} + +// SetPolicyQualifiers sets the PolicyQualifiers field's value. +func (s *PolicyInformation) SetPolicyQualifiers(v []*PolicyQualifierInfo) *PolicyInformation { + s.PolicyQualifiers = v + return s +} + +// Modifies the CertPolicyId of a PolicyInformation object with a qualifier. +// ACM Private CA supports the certification practice statement (CPS) qualifier. +type PolicyQualifierInfo struct { + _ struct{} `type:"structure"` + + // Identifies the qualifier modifying a CertPolicyId. + // + // PolicyQualifierId is a required field + PolicyQualifierId *string `type:"string" required:"true" enum:"PolicyQualifierId"` + + // Defines the qualifier type. ACM Private CA supports the use of a URI for + // a CPS qualifier in this field. + // + // Qualifier is a required field + Qualifier *Qualifier `type:"structure" required:"true"` +} + +// String returns the string representation +func (s PolicyQualifierInfo) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PolicyQualifierInfo) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PolicyQualifierInfo) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PolicyQualifierInfo"} + if s.PolicyQualifierId == nil { + invalidParams.Add(request.NewErrParamRequired("PolicyQualifierId")) + } + if s.Qualifier == nil { + invalidParams.Add(request.NewErrParamRequired("Qualifier")) + } + if s.Qualifier != nil { + if err := s.Qualifier.Validate(); err != nil { + invalidParams.AddNested("Qualifier", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPolicyQualifierId sets the PolicyQualifierId field's value. +func (s *PolicyQualifierInfo) SetPolicyQualifierId(v string) *PolicyQualifierInfo { + s.PolicyQualifierId = &v + return s +} + +// SetQualifier sets the Qualifier field's value. +func (s *PolicyQualifierInfo) SetQualifier(v *Qualifier) *PolicyQualifierInfo { + s.Qualifier = v + return s +} + type PutPolicyInput struct { _ struct{} `type:"structure"` - // The path and filename of a JSON-formatted IAM policy to attach to the specified + // The path and file name of a JSON-formatted IAM policy to attach to the specified // private CA resource. If this policy does not contain all required statements // or if it includes any statement that is not allowed, the PutPolicy action // returns an InvalidPolicyException. For information about IAM policy and statement @@ -6404,6 +6745,48 @@ func (s PutPolicyOutput) GoString() string { return s.String() } +// Defines a PolicyInformation qualifier. ACM Private CA supports the certification +// practice statement (CPS) qualifier (https://tools.ietf.org/html/rfc5280#section-4.2.1.4) +// defined in RFC 5280. +type Qualifier struct { + _ struct{} `type:"structure"` + + // Contains a pointer to a certification practice statement (CPS) published + // by the CA. + // + // CpsUri is a required field + CpsUri *string `type:"string" required:"true"` +} + +// String returns the string representation +func (s Qualifier) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Qualifier) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Qualifier) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Qualifier"} + if s.CpsUri == nil { + invalidParams.Add(request.NewErrParamRequired("CpsUri")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCpsUri sets the CpsUri field's value. +func (s *Qualifier) SetCpsUri(v string) *Qualifier { + s.CpsUri = &v + return s +} + // Your request has already been completed. type RequestAlreadyProcessedException struct { _ struct{} `type:"structure"` @@ -7197,13 +7580,16 @@ func (s UpdateCertificateAuthorityOutput) GoString() string { } // Validity specifies the period of time during which a certificate is valid. -// Validity can be expressed as an explicit date and time when the certificate -// expires, or as a span of time after issuance, stated in days, months, or -// years. For more information, see Validity (https://tools.ietf.org/html/rfc5280#section-4.1.2.5) +// Validity can be expressed as an explicit date and time when the validity +// of a certificate starts or expires, or as a span of time after issuance, +// stated in days, months, or years. For more information, see Validity (https://tools.ietf.org/html/rfc5280#section-4.1.2.5) // in RFC 5280. // -// You can issue a certificate by calling the IssueCertificate (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_IssueCertificate.html) -// action. +// ACM Private CA API consumes the Validity data type differently in two distinct +// parameters of the IssueCertificate action. The required parameter IssueCertificate:Validity +// specifies the end of a certificate's validity period. The optional parameter +// IssueCertificate:ValidityNotBefore specifies a customized starting time for +// the validity period. type Validity struct { _ struct{} `type:"structure"` @@ -7221,8 +7607,8 @@ type Validity struct { // // * Output expiration date/time: 12/31/2049 23:59:59 // - // ABSOLUTE: The specific date and time when the certificate will expire, expressed - // in seconds since the Unix Epoch. + // ABSOLUTE: The specific date and time when the validity of a certificate will + // start or expire, expressed in seconds since the Unix Epoch. // // * Sample input value: 2524608000 // @@ -7419,6 +7805,50 @@ func CertificateAuthorityType_Values() []string { } } +const ( + // ExtendedKeyUsageTypeServerAuth is a ExtendedKeyUsageType enum value + ExtendedKeyUsageTypeServerAuth = "SERVER_AUTH" + + // ExtendedKeyUsageTypeClientAuth is a ExtendedKeyUsageType enum value + ExtendedKeyUsageTypeClientAuth = "CLIENT_AUTH" + + // ExtendedKeyUsageTypeCodeSigning is a ExtendedKeyUsageType enum value + ExtendedKeyUsageTypeCodeSigning = "CODE_SIGNING" + + // ExtendedKeyUsageTypeEmailProtection is a ExtendedKeyUsageType enum value + ExtendedKeyUsageTypeEmailProtection = "EMAIL_PROTECTION" + + // ExtendedKeyUsageTypeTimeStamping is a ExtendedKeyUsageType enum value + ExtendedKeyUsageTypeTimeStamping = "TIME_STAMPING" + + // ExtendedKeyUsageTypeOcspSigning is a ExtendedKeyUsageType enum value + ExtendedKeyUsageTypeOcspSigning = "OCSP_SIGNING" + + // ExtendedKeyUsageTypeSmartCardLogin is a ExtendedKeyUsageType enum value + ExtendedKeyUsageTypeSmartCardLogin = "SMART_CARD_LOGIN" + + // ExtendedKeyUsageTypeDocumentSigning is a ExtendedKeyUsageType enum value + ExtendedKeyUsageTypeDocumentSigning = "DOCUMENT_SIGNING" + + // ExtendedKeyUsageTypeCertificateTransparency is a ExtendedKeyUsageType enum value + ExtendedKeyUsageTypeCertificateTransparency = "CERTIFICATE_TRANSPARENCY" +) + +// ExtendedKeyUsageType_Values returns all elements of the ExtendedKeyUsageType enum +func ExtendedKeyUsageType_Values() []string { + return []string{ + ExtendedKeyUsageTypeServerAuth, + ExtendedKeyUsageTypeClientAuth, + ExtendedKeyUsageTypeCodeSigning, + ExtendedKeyUsageTypeEmailProtection, + ExtendedKeyUsageTypeTimeStamping, + ExtendedKeyUsageTypeOcspSigning, + ExtendedKeyUsageTypeSmartCardLogin, + ExtendedKeyUsageTypeDocumentSigning, + ExtendedKeyUsageTypeCertificateTransparency, + } +} + const ( // FailureReasonRequestTimedOut is a FailureReason enum value FailureReasonRequestTimedOut = "REQUEST_TIMED_OUT" @@ -7463,6 +7893,18 @@ func KeyAlgorithm_Values() []string { } } +const ( + // PolicyQualifierIdCps is a PolicyQualifierId enum value + PolicyQualifierIdCps = "CPS" +) + +// PolicyQualifierId_Values returns all elements of the PolicyQualifierId enum +func PolicyQualifierId_Values() []string { + return []string{ + PolicyQualifierIdCps, + } +} + const ( // ResourceOwnerSelf is a ResourceOwner enum value ResourceOwnerSelf = "SELF" diff --git a/service/chime/api.go b/service/chime/api.go index fad31746a4b..a852fc6285a 100644 --- a/service/chime/api.go +++ b/service/chime/api.go @@ -562,8 +562,8 @@ func (c *Chime) BatchCreateRoomMembershipRequest(input *BatchCreateRoomMembershi // BatchCreateRoomMembership API operation for Amazon Chime. // // Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. -// Members can be either users or bots. The member role designates whether the -// member is a chat room administrator or a general chat room member. +// Members can be users or bots. The member role designates whether the member +// is a chat room administrator or a general chat room member. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -766,7 +766,7 @@ func (c *Chime) BatchSuspendUserRequest(input *BatchSuspendUserInput) (req *requ // Chime Accounts (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) // in the Amazon Chime Administration Guide. // -// Users suspended from a Team account are disassociated from the account, but +// Users suspended from a Team account are disassociated from the account,but // they can continue to use Amazon Chime as free users. To remove the suspension // from suspended Team account users, invite them to the Team account again. // You can use the InviteUsers action to do so. @@ -977,7 +977,7 @@ func (c *Chime) BatchUpdatePhoneNumberRequest(input *BatchUpdatePhoneNumberInput // BatchUpdatePhoneNumber API operation for Amazon Chime. // // Updates phone number product types or calling names. You can update one attribute -// at a time for each UpdatePhoneNumberRequestItem. For example, you can update +// at a time for each UpdatePhoneNumberRequestItem . For example, you can update // either the product type or the calling name. // // For product types, choose from Amazon Chime Business Calling and Amazon Chime @@ -1284,8 +1284,8 @@ func (c *Chime) CreateAppInstanceRequest(input *CreateAppInstanceInput) (req *re // CreateAppInstance API operation for Amazon Chime. // -// Creates an Amazon Chime Messaging SDK AppInstance under an AWS Account. Only -// Messaging SDK customers use this API. CreateAppInstance supports idempotency +// Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only +// SDK messaging customers use this API. CreateAppInstance supports idempotency // behavior as described in the AWS API Standard. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -1392,7 +1392,7 @@ func (c *Chime) CreateAppInstanceAdminRequest(input *CreateAppInstanceAdminInput // Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can // perform the following actions. // -// * ChannelModerator actions across all channels in the app instance. +// * ChannelModerator actions across all channels in the AppInstance. // // * DeleteChannelMessage actions. // @@ -1809,6 +1809,9 @@ func (c *Chime) CreateChannelRequest(input *CreateChannelInput) (req *request.Re // // Restriction: You can't change a channel's privacy. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -1917,6 +1920,9 @@ func (c *Chime) CreateChannelBanRequest(input *CreateChannelBanInput) (req *requ // If you ban a user who is already part of a channel, that user is automatically // kicked from the channel. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2038,6 +2044,9 @@ func (c *Chime) CreateChannelMembershipRequest(input *CreateChannelMembershipInp // // * Private Channels: You must be a member to list or send messages. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2151,6 +2160,9 @@ func (c *Chime) CreateChannelModeratorRequest(input *CreateChannelModeratorInput // // * List messages in the channel. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2253,9 +2265,9 @@ func (c *Chime) CreateMeetingRequest(input *CreateMeetingInput) (req *request.Re // Creates a new Amazon Chime SDK meeting in the specified media Region with // no initial attendees. For more information about specifying media Regions, // see Amazon Chime SDK Media Regions (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) -// in the Amazon Chime Developer Guide. For more information about the Amazon +// in the Amazon Chime Developer Guide . For more information about the Amazon // Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) -// in the Amazon Chime Developer Guide. +// in the Amazon Chime Developer Guide . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2354,12 +2366,12 @@ func (c *Chime) CreateMeetingDialOutRequest(input *CreateMeetingDialOutInput) (r // // Uses the join token and call metadata in a meeting request (From number, // To number, and so forth) to initiate an outbound call to a public switched -// telephone network (PSTN) and joins them into Chime meeting. Also ensures +// telephone network (PSTN) and join them into a Chime meeting. Also ensures // that the From number belongs to the customer. // // To play welcome audio or implement an interactive voice response (IVR), use -// the CreateSipMediaApplicationCall API with the corresponding SIP media application -// ID. +// the CreateSipMediaApplicationCall action with the corresponding SIP media +// application ID. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2459,9 +2471,9 @@ func (c *Chime) CreateMeetingWithAttendeesRequest(input *CreateMeetingWithAttend // Creates a new Amazon Chime SDK meeting in the specified media Region, with // attendees. For more information about specifying media Regions, see Amazon // Chime SDK Media Regions (https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html) -// in the Amazon Chime Developer Guide. For more information about the Amazon +// in the Amazon Chime Developer Guide . For more information about the Amazon // Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) -// in the Amazon Chime Developer Guide. +// in the Amazon Chime Developer Guide . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3588,15 +3600,14 @@ func (c *Chime) DeleteAccountRequest(input *DeleteAccountInput) (req *request.Re // DeleteAccount API operation for Amazon Chime. // // Deletes the specified Amazon Chime account. You must suspend all users before -// deleting a Team account. You can use the BatchSuspendUser action to do so. +// deleting Team account. You can use the BatchSuspendUser action to dodo. // // For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed // domains for your Amazon Chime account before deletion. As soon as you release // the domain, all users under that account are suspended. // // Deleted accounts appear in your Disabled accounts list for 90 days. To restore -// a deleted account from your Disabled accounts list, you must contact AWS -// Support. +// deleted account from your Disabled accounts list, you must contact AWS Support. // // After 90 days, deleted accounts are permanently removed from your Disabled // accounts list. @@ -3821,9 +3832,6 @@ func (c *Chime) DeleteAppInstanceAdminRequest(input *DeleteAppInstanceAdminInput // * ForbiddenException // The client is permanently forbidden from making the request. // -// * ResourceLimitExceededException -// The request exceeds the resource limit. -// // * ThrottledClientException // The client exceeded its request rate limit. // @@ -3903,7 +3911,7 @@ func (c *Chime) DeleteAppInstanceStreamingConfigurationsRequest(input *DeleteApp // DeleteAppInstanceStreamingConfigurations API operation for Amazon Chime. // -// Deletes the streaming configurations of an app instance. +// Deletes the streaming configurations of an AppInstance. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4099,10 +4107,10 @@ func (c *Chime) DeleteAttendeeRequest(input *DeleteAttendeeInput) (req *request. // DeleteAttendee API operation for Amazon Chime. // // Deletes an attendee from the specified Amazon Chime SDK meeting and deletes -// their JoinToken. Attendees are automatically deleted when a Amazon Chime +// their JoinToken . Attendees are automatically deleted when a Amazon Chime // SDK meeting is deleted. For more information about the Amazon Chime SDK, // see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) -// in the Amazon Chime Developer Guide. +// in the Amazon Chime Developer Guide . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4205,6 +4213,9 @@ func (c *Chime) DeleteChannelRequest(input *DeleteChannelInput) (req *request.Re // Immediately makes a channel and its memberships inaccessible and marks them // for deletion. This is an irreversible process. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4302,6 +4313,9 @@ func (c *Chime) DeleteChannelBanRequest(input *DeleteChannelBanInput) (req *requ // // Removes a user from a channel's ban list. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4399,6 +4413,9 @@ func (c *Chime) DeleteChannelMembershipRequest(input *DeleteChannelMembershipInp // // Removes a member from a channel. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4498,6 +4515,9 @@ func (c *Chime) DeleteChannelMessageRequest(input *DeleteChannelMessageInput) (r // makes messages inaccessible immediately. A background process deletes any // revisions created by UpdateChannelMessage. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4595,6 +4615,9 @@ func (c *Chime) DeleteChannelModeratorRequest(input *DeleteChannelModeratorInput // // Deletes a channel moderator. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -4784,8 +4807,9 @@ func (c *Chime) DeleteMeetingRequest(input *DeleteMeetingInput) (req *request.Re // DeleteMeeting API operation for Amazon Chime. // // Deletes the specified Amazon Chime SDK meeting. When a meeting is deleted, -// its attendees are also deleted and clients can no longer join it. For more -// information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// its attendees are also deleted, clients connected to the meeting are disconnected, +// and clients can no longer join the meeting. For more information about the +// Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) // in the Amazon Chime Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -4884,9 +4908,9 @@ func (c *Chime) DeletePhoneNumberRequest(input *DeletePhoneNumberInput) (req *re // DeletePhoneNumber API operation for Amazon Chime. // -// Moves the specified phone number into the Deletion queue. A phone number -// must be disassociated from any users or Amazon Chime Voice Connectors before -// it can be deleted. +// Moves the specified phone number into the Deletionqueue. A phone number must +// be disassociated from any users or Amazon Chime Voice Connectors before it +// can be deleted. // // Deleted phone numbers remain in the Deletion queue for 7 days before they // are deleted permanently. @@ -6484,7 +6508,7 @@ func (c *Chime) DescribeAppInstanceUserRequest(input *DescribeAppInstanceUserInp // DescribeAppInstanceUser API operation for Amazon Chime. // -// Returns the full details of an AppInstanceUser. +// Returns the full details of an AppInstanceUser . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6580,7 +6604,10 @@ func (c *Chime) DescribeChannelRequest(input *DescribeChannelInput) (req *reques // DescribeChannel API operation for Amazon Chime. // -// Returns the full details of a channel in an Amazon Chime app instance. +// Returns the full details of a channel in an Amazon Chime AppInstance. +// +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6678,6 +6705,9 @@ func (c *Chime) DescribeChannelBanRequest(input *DescribeChannelBanInput) (req * // // Returns the full details of a channel ban. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6777,6 +6807,9 @@ func (c *Chime) DescribeChannelMembershipRequest(input *DescribeChannelMembershi // // Returns the full details of a user's channel membership. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -6874,8 +6907,11 @@ func (c *Chime) DescribeChannelMembershipForAppInstanceUserRequest(input *Descri // DescribeChannelMembershipForAppInstanceUser API operation for Amazon Chime. // -// Returns the details of a channel based on the membership of the AppInstanceUser -// specified. +// Returns the details of a channel based on the membership of the specified +// AppInstanceUser. +// +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6973,6 +7009,9 @@ func (c *Chime) DescribeChannelModeratedByAppInstanceUserRequest(input *Describe // // Returns the full details of a channel moderated by the specified AppInstanceUser. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7069,6 +7108,9 @@ func (c *Chime) DescribeChannelModeratorRequest(input *DescribeChannelModeratorI // // Returns the full details of a single ChannelModerator. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7657,7 +7699,7 @@ func (c *Chime) GetAccountSettingsRequest(input *GetAccountSettingsInput) (req * // GetAccountSettings API operation for Amazon Chime. // // Retrieves account settings for the specified Amazon Chime account ID, such -// as remote control and dial out settings. For more information about these +// as remote control and dialout settings. For more information about these // settings, see Use the Policies Page (https://docs.aws.amazon.com/chime/latest/ag/policies.html) // in the Amazon Chime Administration Guide. // @@ -7758,7 +7800,7 @@ func (c *Chime) GetAppInstanceRetentionSettingsRequest(input *GetAppInstanceRete // GetAppInstanceRetentionSettings API operation for Amazon Chime. // -// Gets the retention settings for an app instance. +// Gets the retention settings for an AppInstance. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7855,7 +7897,7 @@ func (c *Chime) GetAppInstanceStreamingConfigurationsRequest(input *GetAppInstan // GetAppInstanceStreamingConfigurations API operation for Amazon Chime. // -// Gets the streaming settings for an app instance. +// Gets the streaming settings for an AppInstance. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -7955,7 +7997,7 @@ func (c *Chime) GetAttendeeRequest(input *GetAttendeeInput) (req *request.Reques // Gets the Amazon Chime SDK attendee details for a specified meeting ID and // attendee ID. For more information about the Amazon Chime SDK, see Using the // Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) -// in the Amazon Chime Developer Guide. +// in the Amazon Chime Developer Guide . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8154,6 +8196,9 @@ func (c *Chime) GetChannelMessageRequest(input *GetChannelMessageInput) (req *re // // Gets the full details of a channel message. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -8445,7 +8490,7 @@ func (c *Chime) GetMeetingRequest(input *GetMeetingInput) (req *request.Request, // Gets the Amazon Chime SDK meeting details for the specified meeting ID. For // more information about the Amazon Chime SDK, see Using the Amazon Chime SDK // (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the Amazon -// Chime Developer Guide. +// Chime Developer Guide . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8544,7 +8589,7 @@ func (c *Chime) GetMessagingSessionEndpointRequest(input *GetMessagingSessionEnd // GetMessagingSessionEndpoint API operation for Amazon Chime. // -// The endpoint for the messaging session. +// The details of the endpoint for the messaging session. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -8733,8 +8778,9 @@ func (c *Chime) GetPhoneNumberOrderRequest(input *GetPhoneNumberOrderInput) (req // GetPhoneNumberOrder API operation for Amazon Chime. // -// Retrieves details for the specified phone number order, such as order creation -// timestamp, phone numbers in E.164 format, product type, and order status. +// Retrieves details for the specified phone number order, such as the order +// creation timestamp, phone numbers in E.164 format, product type, and order +// status. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9027,7 +9073,7 @@ func (c *Chime) GetRetentionSettingsRequest(input *GetRetentionSettingsInput) (r // Gets the retention settings for the specified Amazon Chime Enterprise account. // For more information about retention settings, see Managing Chat Retention // Policies (https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html) -// in the Amazon Chime Administration Guide. +// in the Amazon Chime Administration Guide . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9516,7 +9562,7 @@ func (c *Chime) GetUserRequest(input *GetUserInput) (req *request.Request, outpu // GetUser API operation for Amazon Chime. // // Retrieves details for the specified user ID, such as primary email address, -// license type, and personal meeting PIN. +// license type,and personal meeting PIN. // // To retrieve user details with an email address instead of a user ID, use // the ListUsers action, and then filter by email address. @@ -9715,7 +9761,7 @@ func (c *Chime) GetVoiceConnectorRequest(input *GetVoiceConnectorInput) (req *re // GetVoiceConnector API operation for Amazon Chime. // // Retrieves details for the specified Amazon Chime Voice Connector, such as -// timestamps, name, outbound host, and encryption requirements. +// timestamps,name, outbound host, and encryption requirements. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9911,7 +9957,7 @@ func (c *Chime) GetVoiceConnectorGroupRequest(input *GetVoiceConnectorGroupInput // GetVoiceConnectorGroup API operation for Amazon Chime. // // Retrieves details for the specified Amazon Chime Voice Connector group, such -// as timestamps, name, and associated VoiceConnectorItems. +// as timestamps,name, and associated VoiceConnectorItems . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -10010,7 +10056,7 @@ func (c *Chime) GetVoiceConnectorLoggingConfigurationRequest(input *GetVoiceConn // // Retrieves the logging configuration details for the specified Amazon Chime // Voice Connector. Shows whether SIP message logs are enabled for sending to -// Amazon CloudWatch. +// Amazon CloudWatch Logs. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -10706,7 +10752,7 @@ func (c *Chime) ListAccountsRequest(input *ListAccountsInput) (req *request.Requ // // Lists the Amazon Chime accounts under the administrator's AWS account. You // can filter accounts by account name prefix. To find out which Amazon Chime -// account a user belongs to, you can filter by the user's email address, which +// account a user belongs to, toucan filter by the user's email address, which // returns one account result. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -10864,7 +10910,7 @@ func (c *Chime) ListAppInstanceAdminsRequest(input *ListAppInstanceAdminsInput) // ListAppInstanceAdmins API operation for Amazon Chime. // -// Returns a list of the administrators in the app instance. +// Returns a list of the administrators in the AppInstance. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -10880,9 +10926,6 @@ func (c *Chime) ListAppInstanceAdminsRequest(input *ListAppInstanceAdminsInput) // * ForbiddenException // The client is permanently forbidden from making the request. // -// * ResourceLimitExceededException -// The request exceeds the resource limit. -// // * ThrottledClientException // The client exceeded its request rate limit. // @@ -11021,7 +11064,7 @@ func (c *Chime) ListAppInstanceUsersRequest(input *ListAppInstanceUsersInput) (r // ListAppInstanceUsers API operation for Amazon Chime. // -// List all AppInstanceUsers created under a single app instance. +// List all AppInstanceUsers created under a single AppInstance. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -11175,7 +11218,7 @@ func (c *Chime) ListAppInstancesRequest(input *ListAppInstancesInput) (req *requ // ListAppInstances API operation for Amazon Chime. // -// Lists all Amazon Chime app instances created under a single AWS account. +// Lists all Amazon Chime AppInstances created under a single AWS account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -11426,7 +11469,7 @@ func (c *Chime) ListAttendeesRequest(input *ListAttendeesInput) (req *request.Re // // Lists the attendees for the specified Amazon Chime SDK meeting. For more // information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) -// in the Amazon Chime Developer Guide. +// in the Amazon Chime Developer Guide . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -11741,6 +11784,9 @@ func (c *Chime) ListChannelBansRequest(input *ListChannelBansInput) (req *reques // // Lists all the users banned from a particular channel. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -11895,6 +11941,9 @@ func (c *Chime) ListChannelMembershipsRequest(input *ListChannelMembershipsInput // // Lists all channel memberships in a channel. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -12050,6 +12099,9 @@ func (c *Chime) ListChannelMembershipsForAppInstanceUserRequest(input *ListChann // Lists all channels that a particular AppInstanceUser is a part of. Only an // AppInstanceAdmin can call the API with a user ARN that is not their own. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -12203,12 +12255,15 @@ func (c *Chime) ListChannelMessagesRequest(input *ListChannelMessagesInput) (req // ListChannelMessages API operation for Amazon Chime. // // List all the messages in a channel. Returns a paginated list of ChannelMessages. -// Sorted in descending order by default, based on the creation timestamp. +// By default, sorted by creation timestamp in descending order . // // Redacted messages appear in the results as empty, since they are only redacted, // not deleted. Deleted messages do not appear in the results. This action always // returns the latest version of an edited message. // +// Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -12363,6 +12418,9 @@ func (c *Chime) ListChannelModeratorsRequest(input *ListChannelModeratorsInput) // // Lists all the moderators for a channel. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -12525,6 +12583,9 @@ func (c *Chime) ListChannelsRequest(input *ListChannelsInput) (req *request.Requ // * Only an AppInstanceAdmin can set privacy = PRIVATE to list the private // channels in an account. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -12677,7 +12738,10 @@ func (c *Chime) ListChannelsModeratedByAppInstanceUserRequest(input *ListChannel // ListChannelsModeratedByAppInstanceUser API operation for Amazon Chime. // -// A list of the channels moderated by an app instance user. +// A list of the channels moderated by an AppInstanceUser. +// +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -12928,7 +12992,7 @@ func (c *Chime) ListMeetingsRequest(input *ListMeetingsInput) (req *request.Requ // // Lists up to 100 active Amazon Chime SDK meetings. For more information about // the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) -// in the Amazon Chime Developer Guide. +// in the Amazon Chime Developer Guide . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -13252,6 +13316,9 @@ func (c *Chime) ListPhoneNumbersRequest(input *ListPhoneNumbersInput) (req *requ // * BadRequestException // The input parameters don't match the service's restrictions. // +// * NotFoundException +// One or more of the resources in the request does not exist in the system. +// // * ThrottledClientException // The client exceeded its request rate limit. // @@ -14905,7 +14972,7 @@ func (c *Chime) PutAppInstanceRetentionSettingsRequest(input *PutAppInstanceRete // PutAppInstanceRetentionSettings API operation for Amazon Chime. // -// Sets the amount of time in days that a given app instance retains data. +// Sets the amount of time in days that a given AppInstance retains data. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -15006,7 +15073,7 @@ func (c *Chime) PutAppInstanceStreamingConfigurationsRequest(input *PutAppInstan // PutAppInstanceStreamingConfigurations API operation for Amazon Chime. // -// The data streaming configurations of an app instance. +// The data streaming configurations of an AppInstance. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -15206,13 +15273,13 @@ func (c *Chime) PutRetentionSettingsRequest(input *PutRetentionSettingsInput) (r // We recommend using AWS CloudTrail to monitor usage of this API for your account. // For more information, see Logging Amazon Chime API Calls with AWS CloudTrail // (https://docs.aws.amazon.com/chime/latest/ag/cloudtrail.html) in the Amazon -// Chime Administration Guide. +// Chime Administration Guide . // // To turn off existing retention settings, remove the number of days from the // corresponding RetentionDays field in the RetentionSettings object. For more // information about retention settings, see Managing Chat Retention Policies // (https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html) in the -// Amazon Chime Administration Guide. +// Amazon Chime Administration Guide . // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -15812,7 +15879,7 @@ func (c *Chime) PutVoiceConnectorStreamingConfigurationRequest(input *PutVoiceCo // // Adds a streaming configuration for the specified Amazon Chime Voice Connector. // The streaming configuration specifies whether media streaming is enabled -// for sending to Amazon Kinesis. It also sets the retention period, in hours, +// for sending to Indonesians. It also sets the retention period, in hours, // for the Amazon Kinesis data. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -16116,6 +16183,9 @@ func (c *Chime) RedactChannelMessageRequest(input *RedactChannelMessageInput) (r // Redacts message content, but not metadata. The message exists in the back // end, but the action returns null content, and the state shows as redacted. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -16800,8 +16870,11 @@ func (c *Chime) SendChannelMessageRequest(input *SendChannelMessageInput) (req * // // Sends a message to a particular channel that the member is a part of. // -// STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL -// messages can contain 30 bytes of data and no metadata. +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// +// Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. +// CONTROL messages can contain 30 bytes of data and no metadata. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -17792,7 +17865,7 @@ func (c *Chime) UpdateAppInstanceUserRequest(input *UpdateAppInstanceUserInput) // UpdateAppInstanceUser API operation for Amazon Chime. // -// Updates the details for an AppInstanceUser. You can update names and metadata. +// Updates the details of an AppInstanceUser. You can update names and metadata. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -17994,6 +18067,9 @@ func (c *Chime) UpdateChannelRequest(input *UpdateChannelInput) (req *request.Re // // Restriction: You can't change a channel's privacy. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -18094,6 +18170,9 @@ func (c *Chime) UpdateChannelMessageRequest(input *UpdateChannelMessageInput) (r // // Updates the content of a message. // +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -18192,7 +18271,10 @@ func (c *Chime) UpdateChannelReadMarkerRequest(input *UpdateChannelReadMarkerInp // UpdateChannelReadMarker API operation for Amazon Chime. // -// Sets the timestamp to the point when a user last read messages in a channel. +// The details of the time when a user last read messages in a channel. +// +// The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn +// of the user that makes the API call as the value in the header. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -18886,7 +18968,7 @@ func (c *Chime) UpdateSipMediaApplicationRequest(input *UpdateSipMediaApplicatio // UpdateSipMediaApplication API operation for Amazon Chime. // -// Updates the details for the specified SIP media application. +// Updates the details of the specified SIP media application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -18987,7 +19069,7 @@ func (c *Chime) UpdateSipRuleRequest(input *UpdateSipRuleInput) (req *request.Re // UpdateSipRule API operation for Amazon Chime. // -// Updates the details for the specified SIP rule. +// Updates the details of the specified SIP rule. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -19384,7 +19466,7 @@ func (c *Chime) UpdateVoiceConnectorGroupRequest(input *UpdateVoiceConnectorGrou // UpdateVoiceConnectorGroup API operation for Amazon Chime. // -// Updates details for the specified Amazon Chime Voice Connector group, such +// Updates details of the specified Amazon Chime Voice Connector group, such // as the name and Amazon Chime Voice Connector priority ranking. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -19669,23 +19751,24 @@ func (s *AlexaForBusinessMetadata) SetIsAlexaForBusinessEnabled(v bool) *AlexaFo return s } -// An instance of a Chime messaging application. +// The details of an AppInstance, an instance of an Amazon Chime SDK messaging +// application. type AppInstance struct { _ struct{} `type:"structure"` // The ARN of the messaging instance. AppInstanceArn *string `min:"5" type:"string"` - // The time at which an app instance was created. In epoch milliseconds. + // The time at which an AppInstance was created. In epoch milliseconds. CreatedTimestamp *time.Time `type:"timestamp"` - // The time an app instance was last updated. In epoch milliseconds. + // The time an AppInstance was last updated. In epoch milliseconds. LastUpdatedTimestamp *time.Time `type:"timestamp"` - // The metadata of an app instance. + // The metadata of an AppInstance. Metadata *string `type:"string" sensitive:"true"` - // The name of an app instance. + // The name of an AppInstance. Name *string `min:"1" type:"string" sensitive:"true"` } @@ -19729,14 +19812,14 @@ func (s *AppInstance) SetName(v string) *AppInstance { return s } -// Promotes a user to the administrator role for the duration of an app instance. +// The details of an AppInstanceAdmin. type AppInstanceAdmin struct { _ struct{} `type:"structure"` - // The name and metadata of the app instance administrator. + // The AppInstanceAdmin data. Admin *Identity `type:"structure"` - // The ARN of the app instance administrator. + // The ARN of the AppInstance for which the user is an administrator. AppInstanceArn *string `min:"5" type:"string"` // The time at which an administrator was created. @@ -19771,11 +19854,11 @@ func (s *AppInstanceAdmin) SetCreatedTimestamp(v time.Time) *AppInstanceAdmin { return s } -// The identity and metadata of an administrator. +// Summary of the details of an AppInstanceAdmin. type AppInstanceAdminSummary struct { _ struct{} `type:"structure"` - // The name and metadata of the app instance administrator. + // The details of the AppInstanceAdmin. Admin *Identity `type:"structure"` } @@ -19795,11 +19878,11 @@ func (s *AppInstanceAdminSummary) SetAdmin(v *Identity) *AppInstanceAdminSummary return s } -// The length of time in days to retain messages. +// The details of the data-retention settings for an AppInstance. type AppInstanceRetentionSettings struct { _ struct{} `type:"structure"` - // The length of time in days to retain a channel. + // The length of time in days to retain the messages in a channel. ChannelRetentionSettings *ChannelRetentionSettings `type:"structure"` } @@ -19834,11 +19917,11 @@ func (s *AppInstanceRetentionSettings) SetChannelRetentionSettings(v *ChannelRet return s } -// The streaming configuration of an app instance. +// The details of the streaming configuration of an AppInstance. type AppInstanceStreamingConfiguration struct { _ struct{} `type:"structure"` - // The data type of the app instance. + // The type of data to be streamed. // // AppInstanceDataType is a required field AppInstanceDataType *string `type:"string" required:"true" enum:"AppInstanceDataType"` @@ -19890,17 +19973,17 @@ func (s *AppInstanceStreamingConfiguration) SetResourceArn(v string) *AppInstanc return s } -// The summary data for an app instance. +// Summary of the data for an AppInstance. type AppInstanceSummary struct { _ struct{} `type:"structure"` - // The app instance ARN. + // The AppInstance ARN. AppInstanceArn *string `min:"5" type:"string"` - // The metadata of the app instance summary. + // The metadata of the AppInstance. Metadata *string `type:"string" sensitive:"true"` - // The name of the app instance summary. + // The name of the AppInstance. Name *string `min:"1" type:"string" sensitive:"true"` } @@ -19932,23 +20015,23 @@ func (s *AppInstanceSummary) SetName(v string) *AppInstanceSummary { return s } -// The app instance user. +// The details of an AppInstanceUser. type AppInstanceUser struct { _ struct{} `type:"structure"` - // The ARN of the app instance user. + // The ARN of the AppInstanceUser. AppInstanceUserArn *string `min:"5" type:"string"` - // The time at which the app instance user was created. + // The time at which the AppInstanceUser was created. CreatedTimestamp *time.Time `type:"timestamp"` - // The time at which the app instance user was last updated. + // The time at which the AppInstanceUser was last updated. LastUpdatedTimestamp *time.Time `type:"timestamp"` - // The metadata of the app instance user. + // The metadata of the AppInstanceUser. Metadata *string `type:"string" sensitive:"true"` - // The name of the app instance user. + // The name of the AppInstanceUser. Name *string `min:"1" type:"string" sensitive:"true"` } @@ -19992,14 +20075,14 @@ func (s *AppInstanceUser) SetName(v string) *AppInstanceUser { return s } -// Lists the channels to which app instance users belong. +// Summary of the membership details of an AppInstanceUser. type AppInstanceUserMembershipSummary struct { _ struct{} `type:"structure"` - // The time at which a summary was last read. + // The time at which a message was last read. ReadMarkerTimestamp *time.Time `type:"timestamp"` - // The type of channel summary, + // The type of ChannelMembership. Type *string `type:"string" enum:"ChannelMembershipType"` } @@ -20025,17 +20108,17 @@ func (s *AppInstanceUserMembershipSummary) SetType(v string) *AppInstanceUserMem return s } -// The app instance user summary data . +// Summary of the details of an AppInstanceUser. type AppInstanceUserSummary struct { _ struct{} `type:"structure"` - // The ARN of the app instance user. + // The ARN of the AppInstanceUser. AppInstanceUserArn *string `min:"5" type:"string"` - // The metadata in an app instance user summary. + // The metadata of the AppInstanceUser. Metadata *string `type:"string" sensitive:"true"` - // The name in an app instance user summary. + // The name of an AppInstanceUser. Name *string `min:"1" type:"string" sensitive:"true"` } @@ -20405,10 +20488,10 @@ func (s AssociateSigninDelegateGroupsWithAccountOutput) GoString() string { return s.String() } -// An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken. -// The JoinToken allows a client to authenticate and join as the specified attendee. -// The JoinToken expires when the meeting ends or when DeleteAttendee is called. -// After that, the attendee is unable to join the meeting. +// An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken +// . The JoinToken allows a client to authenticate and join as the specified +// attendee. The JoinToken expires when the meeting ends or when DeleteAttendee +// is called. After that, the attendee is unable to join the meeting. // // We recommend securely transferring each JoinToken from your server application // to the client so that no other client has access to the token except for @@ -20420,8 +20503,7 @@ type Attendee struct { AttendeeId *string `type:"string"` // The Amazon Chime SDK external user ID. An idempotency token. Links the attendee - // to an identity managed by a builder application. If you create an attendee - // with the same external user id, the service returns the existing record. + // to an identity managed by a builder application. ExternalUserId *string `min:"2" type:"string" sensitive:"true"` // The join token used by the Amazon Chime SDK attendee. @@ -21221,26 +21303,26 @@ func (s *BusinessCallingSettings) SetCdrBucket(v string) *BusinessCallingSetting return s } -// Creates a channel. +// The details of a channel. type Channel struct { _ struct{} `type:"structure"` // The ARN of the channel. ChannelArn *string `min:"5" type:"string"` - // The administrator who created the channel. + // The AppInstanceUser who created the channel. CreatedBy *Identity `type:"structure"` - // The time at which the administrator created the channel. + // The time at which the AppInstanceUser created the channel. CreatedTimestamp *time.Time `type:"timestamp"` - // The time at which a member sent the last message in a session. + // The time at which a member sent the last message in the channel. LastMessageTimestamp *time.Time `type:"timestamp"` // The time at which a channel was last updated. LastUpdatedTimestamp *time.Time `type:"timestamp"` - // The metadata of the channel. + // The channel's metadata. Metadata *string `type:"string" sensitive:"true"` // The mode of the channel. @@ -21249,7 +21331,7 @@ type Channel struct { // The name of the channel. Name *string `min:"1" type:"string" sensitive:"true"` - // The channel's privacy setting, PUBLIC or HIDDEN. + // The channel's privacy setting. Privacy *string `type:"string" enum:"ChannelPrivacy"` } @@ -21317,14 +21399,14 @@ func (s *Channel) SetPrivacy(v string) *Channel { return s } -// Bans a user from a channel. +// The details of a channel ban. type ChannelBan struct { _ struct{} `type:"structure"` // The ARN of the channel from which a member is being banned. ChannelArn *string `min:"5" type:"string"` - // The parameter of the action. + // The AppInstanceUser who created the ban. CreatedBy *Identity `type:"structure"` // The time at which the ban was created. @@ -21368,7 +21450,7 @@ func (s *ChannelBan) SetMember(v *Identity) *ChannelBan { return s } -// The summary data for the channel ban. +// Summary of the details of a ChannelBan. type ChannelBanSummary struct { _ struct{} `type:"structure"` @@ -21392,7 +21474,7 @@ func (s *ChannelBanSummary) SetMember(v *Identity) *ChannelBanSummary { return s } -// Creates a channel member. +// The details of a channel member. type ChannelMembership struct { _ struct{} `type:"structure"` @@ -21402,8 +21484,7 @@ type ChannelMembership struct { // The time at which the channel membership was created. CreatedTimestamp *time.Time `type:"timestamp"` - // The identifier of the member who invited another member. Taken from the message - // header. + // The identifier of the member who invited another member. InvitedBy *Identity `type:"structure"` // The time at which a channel membership was last updated. @@ -21462,14 +21543,14 @@ func (s *ChannelMembership) SetType(v string) *ChannelMembership { return s } -// Returns the channel membership summary data for an app instance. +// Summary of the channel membership details of an AppInstanceUser. type ChannelMembershipForAppInstanceUserSummary struct { _ struct{} `type:"structure"` - // Returns the channel membership data for an app instance. + // Returns the channel membership data for an AppInstance. AppInstanceUserMembershipSummary *AppInstanceUserMembershipSummary `type:"structure"` - // The summary data for a channel. + // Summary of the details of a Channel. ChannelSummary *ChannelSummary `type:"structure"` } @@ -21495,7 +21576,7 @@ func (s *ChannelMembershipForAppInstanceUserSummary) SetChannelSummary(v *Channe return s } -// The summary data of a channel membership. +// Summary of the details of a ChannelMembership. type ChannelMembershipSummary struct { _ struct{} `type:"structure"` @@ -21519,7 +21600,7 @@ func (s *ChannelMembershipSummary) SetMember(v *Identity) *ChannelMembershipSumm return s } -// Creates a message in a channel. +// The details of a message in a channel. type ChannelMessage struct { _ struct{} `type:"structure"` @@ -21544,10 +21625,10 @@ type ChannelMessage struct { // The message metadata. Metadata *string `type:"string" sensitive:"true"` + // The persistence setting for a channel message. Persistence *string `type:"string" enum:"ChannelMessagePersistenceType"` - // Hides the content of a message. The message still exists on the back end, - // but this action only returns metadata. + // Hides the content of a message. Redacted *bool `type:"boolean"` // The message sender. @@ -21633,33 +21714,35 @@ func (s *ChannelMessage) SetType(v string) *ChannelMessage { return s } -// A summary of the messages in a channel. +// Summary of the messages in a Channel. type ChannelMessageSummary struct { _ struct{} `type:"structure"` - // The content of the message summary. + // The content of the message. Content *string `type:"string" sensitive:"true"` // The time at which the message summary was created. CreatedTimestamp *time.Time `type:"timestamp"` + // The time at which a message was last edited. LastEditedTimestamp *time.Time `type:"timestamp"` + // The time at which a message was last updated. LastUpdatedTimestamp *time.Time `type:"timestamp"` - // The ID of the message summary. + // The ID of the message. MessageId *string `min:"1" type:"string"` - // The metadata of the message summary. + // The metadata of the message. Metadata *string `type:"string" sensitive:"true"` - // Redacts the content of a message summary. + // Indicates whether a message was redacted. Redacted *bool `type:"boolean"` - // The sender of the message summary. + // The message sender. Sender *Identity `type:"structure"` - // The type of message summary. + // The type of message. Type *string `type:"string" enum:"ChannelMessageType"` } @@ -21727,11 +21810,11 @@ func (s *ChannelMessageSummary) SetType(v string) *ChannelMessageSummary { return s } -// Returns the summary data for a moderated channel. +// Summary of the details of a moderated channel. type ChannelModeratedByAppInstanceUserSummary struct { _ struct{} `type:"structure"` - // The summary data for a channel. + // Summary of the details of a Channel. ChannelSummary *ChannelSummary `type:"structure"` } @@ -21751,14 +21834,14 @@ func (s *ChannelModeratedByAppInstanceUserSummary) SetChannelSummary(v *ChannelS return s } -// Creates a moderator on a channel. +// The details of a channel moderator. type ChannelModerator struct { _ struct{} `type:"structure"` // The ARN of the moderator's channel. ChannelArn *string `min:"5" type:"string"` - // The member who created the moderator. + // The AppInstanceUser who created the moderator. CreatedBy *Identity `type:"structure"` // The time at which the moderator was created. @@ -21802,7 +21885,7 @@ func (s *ChannelModerator) SetModerator(v *Identity) *ChannelModerator { return s } -// Summary data of the moderators in a channel. +// Summary of the details of a ChannelModerator. type ChannelModeratorSummary struct { _ struct{} `type:"structure"` @@ -21826,11 +21909,11 @@ func (s *ChannelModeratorSummary) SetModerator(v *Identity) *ChannelModeratorSum return s } -// The retention settings for a channel. +// The details of the retention settings for a channel. type ChannelRetentionSettings struct { _ struct{} `type:"structure"` - // The time in days to retain a channel. + // The time in days to retain the messages in a channel. RetentionDays *int64 `min:"1" type:"integer"` } @@ -21863,26 +21946,26 @@ func (s *ChannelRetentionSettings) SetRetentionDays(v int64) *ChannelRetentionSe return s } -// The summary data for a channel. +// Summary of the details of a Channel. type ChannelSummary struct { _ struct{} `type:"structure"` - // The ARN of the channel summary. + // The ARN of the channel. ChannelArn *string `min:"5" type:"string"` // The time at which the last message in a channel was sent. LastMessageTimestamp *time.Time `type:"timestamp"` - // The metadata of the channel summary. + // The metadata of the channel. Metadata *string `type:"string" sensitive:"true"` - // The summary mode of the channel. + // The mode of the channel. Mode *string `type:"string" enum:"ChannelMode"` - // The parameter of the action. + // The name of the channel. Name *string `min:"1" type:"string" sensitive:"true"` - // The privacy setting of the channel being summarized, PUBLIC or HIDDEN. + // The privacy setting of the channel. Privacy *string `type:"string" enum:"ChannelPrivacy"` } @@ -21991,12 +22074,12 @@ func (s *ConflictException) RequestID() string { return s.RespMetadata.RequestID } -// The retention settings that determine how long to retain chat conversation -// messages for an Amazon Chime Enterprise account. +// The retention settings that determine how long to retain conversation messages +// for an Amazon Chime Enterprise account. type ConversationRetentionSettings struct { _ struct{} `type:"structure"` - // The number of days for which to retain chat conversation messages. + // The number of days for which to retain conversation messages. RetentionDays *int64 `min:"1" type:"integer"` } @@ -22073,8 +22156,7 @@ func (s *CreateAccountInput) SetName(v string) *CreateAccountInput { type CreateAccountOutput struct { _ struct{} `type:"structure"` - // The Amazon Chime account details. An AWS account can have multiple Amazon - // Chime accounts. + // The Amazon Chime account details. Account *Account `type:"structure"` } @@ -22097,12 +22179,12 @@ func (s *CreateAccountOutput) SetAccount(v *Account) *CreateAccountOutput { type CreateAppInstanceAdminInput struct { _ struct{} `type:"structure"` - // The ARN of the administrator of the current app instance. + // The ARN of the administrator of the current AppInstance. // // AppInstanceAdminArn is a required field AppInstanceAdminArn *string `min:"5" type:"string" required:"true"` - // The ARN of the app instance. + // The ARN of the AppInstance. // // AppInstanceArn is a required field AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"` @@ -22155,10 +22237,10 @@ func (s *CreateAppInstanceAdminInput) SetAppInstanceArn(v string) *CreateAppInst type CreateAppInstanceAdminOutput struct { _ struct{} `type:"structure"` - // The name and ARN of the admin for the app instance. + // The name and ARN of the admin for the AppInstance. AppInstanceAdmin *Identity `type:"structure"` - // The ARN of the of the admin for the app instance. + // The ARN of the of the admin for the AppInstance. AppInstanceArn *string `min:"5" type:"string"` } @@ -22187,16 +22269,19 @@ func (s *CreateAppInstanceAdminOutput) SetAppInstanceArn(v string) *CreateAppIns type CreateAppInstanceInput struct { _ struct{} `type:"structure"` - // The ClientRequestToken of the app instance. + // The ClientRequestToken of the AppInstance. ClientRequestToken *string `min:"2" type:"string" idempotencyToken:"true" sensitive:"true"` - // The metadata of the app instance. Limited to a 1KB string in UTF-8. + // The metadata of the AppInstance. Limited to a 1KB string in UTF-8. Metadata *string `type:"string" sensitive:"true"` - // The name of the app instance. + // The name of the AppInstance. // // Name is a required field Name *string `min:"1" type:"string" required:"true" sensitive:"true"` + + // Tags assigned to the AppInstanceUser. + Tags []*Tag `min:"1" type:"list"` } // String returns the string representation @@ -22221,6 +22306,19 @@ func (s *CreateAppInstanceInput) Validate() error { if s.Name != nil && len(*s.Name) < 1 { invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -22246,10 +22344,16 @@ func (s *CreateAppInstanceInput) SetName(v string) *CreateAppInstanceInput { return s } +// SetTags sets the Tags field's value. +func (s *CreateAppInstanceInput) SetTags(v []*Tag) *CreateAppInstanceInput { + s.Tags = v + return s +} + type CreateAppInstanceOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Number (ARN) of the app instance. + // The Amazon Resource Number (ARN) of the AppInstance. AppInstanceArn *string `min:"5" type:"string"` } @@ -22272,17 +22376,17 @@ func (s *CreateAppInstanceOutput) SetAppInstanceArn(v string) *CreateAppInstance type CreateAppInstanceUserInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance request. + // The ARN of the AppInstance request. // // AppInstanceArn is a required field AppInstanceArn *string `min:"5" type:"string" required:"true"` - // The user ID of the app instance. + // The user ID of the AppInstance. // // AppInstanceUserId is a required field AppInstanceUserId *string `min:"1" type:"string" required:"true" sensitive:"true"` - // The token assigned to the user requesting an app instance. + // The token assigned to the user requesting an AppInstance. ClientRequestToken *string `min:"2" type:"string" idempotencyToken:"true" sensitive:"true"` // The request's metadata. Limited to a 1KB string in UTF-8. @@ -22292,6 +22396,9 @@ type CreateAppInstanceUserInput struct { // // Name is a required field Name *string `min:"1" type:"string" required:"true" sensitive:"true"` + + // Tags assigned to the AppInstanceUser. + Tags []*Tag `min:"1" type:"list"` } // String returns the string representation @@ -22328,6 +22435,19 @@ func (s *CreateAppInstanceUserInput) Validate() error { if s.Name != nil && len(*s.Name) < 1 { invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -22365,6 +22485,12 @@ func (s *CreateAppInstanceUserInput) SetName(v string) *CreateAppInstanceUserInp return s } +// SetTags sets the Tags field's value. +func (s *CreateAppInstanceUserInput) SetTags(v []*Tag) *CreateAppInstanceUserInput { + s.Tags = v + return s +} + type CreateAppInstanceUserOutput struct { _ struct{} `type:"structure"` @@ -22401,8 +22527,7 @@ type CreateAttendeeError struct { ErrorMessage *string `type:"string"` // The Amazon Chime SDK external user ID. An idempotency token. Links the attendee - // to an identity managed by a builder application. If you create an attendee - // with the same external user id, the service returns the existing record. + // to an identity managed by a builder application. ExternalUserId *string `min:"2" type:"string" sensitive:"true"` } @@ -22438,8 +22563,7 @@ type CreateAttendeeInput struct { _ struct{} `type:"structure"` // The Amazon Chime SDK external user ID. An idempotency token. Links the attendee - // to an identity managed by a builder application. If you create an attendee - // with the same external user id, the service returns the existing record. + // to an identity managed by a builder application. // // ExternalUserId is a required field ExternalUserId *string `min:"2" type:"string" required:"true" sensitive:"true"` @@ -22545,11 +22669,7 @@ type CreateAttendeeRequestItem struct { _ struct{} `type:"structure"` // The Amazon Chime SDK external user ID. An idempotency token. Links the attendee - // to an identity managed by a builder application. If you create an attendee - // with the same external user id, the service returns the existing record. - // - // The Amazon Chime SDK external user ID. Links the attendee to an identity - // managed by a builder application. + // to an identity managed by a builder application. // // ExternalUserId is a required field ExternalUserId *string `min:"2" type:"string" required:"true" sensitive:"true"` @@ -22704,6 +22824,9 @@ type CreateChannelBanInput struct { // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The ARN of the member being banned. // // MemberArn is a required field @@ -22729,6 +22852,9 @@ func (s *CreateChannelBanInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MemberArn == nil { invalidParams.Add(request.NewErrParamRequired("MemberArn")) } @@ -22748,6 +22874,12 @@ func (s *CreateChannelBanInput) SetChannelArn(v string) *CreateChannelBanInput { return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *CreateChannelBanInput) SetChimeBearer(v string) *CreateChannelBanInput { + s.ChimeBearer = &v + return s +} + // SetMemberArn sets the MemberArn field's value. func (s *CreateChannelBanInput) SetMemberArn(v string) *CreateChannelBanInput { s.MemberArn = &v @@ -22794,6 +22926,9 @@ type CreateChannelInput struct { // AppInstanceArn is a required field AppInstanceArn *string `min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The client token for the request. An Idempotency token. ClientRequestToken *string `min:"2" type:"string" idempotencyToken:"true" sensitive:"true"` @@ -22813,9 +22948,10 @@ type CreateChannelInput struct { // The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable // by users outside the channel. Public channels are discoverable by anyone - // in the app instance. + // in the AppInstance. Privacy *string `type:"string" enum:"ChannelPrivacy"` + // The tags for the creation request. Tags []*Tag `min:"1" type:"list"` } @@ -22838,6 +22974,9 @@ func (s *CreateChannelInput) Validate() error { if s.AppInstanceArn != nil && len(*s.AppInstanceArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("AppInstanceArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 2 { invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 2)) } @@ -22873,6 +23012,12 @@ func (s *CreateChannelInput) SetAppInstanceArn(v string) *CreateChannelInput { return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *CreateChannelInput) SetChimeBearer(v string) *CreateChannelInput { + s.ChimeBearer = &v + return s +} + // SetClientRequestToken sets the ClientRequestToken field's value. func (s *CreateChannelInput) SetClientRequestToken(v string) *CreateChannelInput { s.ClientRequestToken = &v @@ -22917,6 +23062,9 @@ type CreateChannelMembershipInput struct { // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The ARN of the member you want to add to the channel. // // MemberArn is a required field @@ -22950,6 +23098,9 @@ func (s *CreateChannelMembershipInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MemberArn == nil { invalidParams.Add(request.NewErrParamRequired("MemberArn")) } @@ -22972,6 +23123,12 @@ func (s *CreateChannelMembershipInput) SetChannelArn(v string) *CreateChannelMem return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *CreateChannelMembershipInput) SetChimeBearer(v string) *CreateChannelMembershipInput { + s.ChimeBearer = &v + return s +} + // SetMemberArn sets the MemberArn field's value. func (s *CreateChannelMembershipInput) SetMemberArn(v string) *CreateChannelMembershipInput { s.MemberArn = &v @@ -23028,6 +23185,9 @@ type CreateChannelModeratorInput struct { // // ChannelModeratorArn is a required field ChannelModeratorArn *string `min:"5" type:"string" required:"true"` + + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` } // String returns the string representation @@ -23055,6 +23215,9 @@ func (s *CreateChannelModeratorInput) Validate() error { if s.ChannelModeratorArn != nil && len(*s.ChannelModeratorArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelModeratorArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if invalidParams.Len() > 0 { return invalidParams @@ -23074,6 +23237,12 @@ func (s *CreateChannelModeratorInput) SetChannelModeratorArn(v string) *CreateCh return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *CreateChannelModeratorInput) SetChimeBearer(v string) *CreateChannelModeratorInput { + s.ChimeBearer = &v + return s +} + type CreateChannelModeratorOutput struct { _ struct{} `type:"structure"` @@ -23137,21 +23306,14 @@ type CreateMeetingDialOutInput struct { // FromPhoneNumber is a required field FromPhoneNumber *string `type:"string" required:"true" sensitive:"true"` - // Token used by the Amazon Chime SDK attendee. Call the CreateAttendee API - // (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/chime/latest/APIReference/API_Attendee.html) - // to get a join token. + // Token used by the Amazon Chime SDK attendee. Call the CreateAttendee (https://docs.aws.amazon.com/chime/latest/APIReference/API_Attendee.htmlCreateAttendee) + // action to get a join token. // // JoinToken is a required field JoinToken *string `min:"2" type:"string" required:"true" sensitive:"true"` // The Amazon Chime SDK meeting ID. // - // Type: String - // - // Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12} - // - // Required: No - // // MeetingId is a required field MeetingId *string `location:"uri" locationName:"meetingId" type:"string" required:"true"` @@ -23258,10 +23420,10 @@ type CreateMeetingInput struct { // The Region in which to create the meeting. Default: us-east-1. // - // Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, - // ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, - // eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, - // us-west-2. + // Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 + // , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 + // , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 + // , us-east-2 , us-west-1 , us-west-2 . MediaRegion *string `type:"string"` // Reserved. @@ -23361,7 +23523,7 @@ func (s *CreateMeetingInput) SetTags(v []*Tag) *CreateMeetingInput { type CreateMeetingOutput struct { _ struct{} `type:"structure"` - // The meeting information, including the meeting ID and MediaPlacement. + // The meeting information, including the meeting ID and MediaPlacement . Meeting *Meeting `type:"structure"` } @@ -23394,20 +23556,20 @@ type CreateMeetingWithAttendeesInput struct { // The external meeting ID. ExternalMeetingId *string `min:"2" type:"string" sensitive:"true"` - // The Region in which to create the meeting. Default: us-east-1. + // The Region in which to create the meeting. Default: us-east-1 . // - // Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, - // ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1, eu-north-1, eu-south-1, - // eu-west-1, eu-west-2, eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, - // us-west-2. + // Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 + // , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 + // , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 + // , us-east-2 , us-west-1 , us-west-2 . MediaRegion *string `type:"string"` // Reserved. MeetingHostId *string `min:"2" type:"string" sensitive:"true"` - // The configuration for resource targets to receive notifications when Amazon - // Chime SDK meeting and attendee events occur. The Amazon Chime SDK supports - // resource targets located in the US East (N. Virginia) AWS Region (us-east-1). + // The resource target configurations for receiving Amazon Chime SDK meeting + // and attendee event notifications. The Amazon Chime SDK supports resource + // targets located in the US East (N. Virginia) AWS Region (us-east-1). NotificationsConfiguration *MeetingNotificationConfiguration `type:"structure"` // The tag key-value pairs. @@ -23981,15 +24143,19 @@ type CreateSipMediaApplicationCallInput struct { _ struct{} `type:"structure"` // The phone number that a user calls from. - FromPhoneNumber *string `type:"string" sensitive:"true"` + // + // FromPhoneNumber is a required field + FromPhoneNumber *string `type:"string" required:"true" sensitive:"true"` // The ID of the SIP media application. // // SipMediaApplicationId is a required field SipMediaApplicationId *string `location:"uri" locationName:"sipMediaApplicationId" type:"string" required:"true"` - // The phone number that the user dials in order to connect to a meeting - ToPhoneNumber *string `type:"string" sensitive:"true"` + // The phone number that the user dials in order to connect to a meeting. + // + // ToPhoneNumber is a required field + ToPhoneNumber *string `type:"string" required:"true" sensitive:"true"` } // String returns the string representation @@ -24005,12 +24171,18 @@ func (s CreateSipMediaApplicationCallInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *CreateSipMediaApplicationCallInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "CreateSipMediaApplicationCallInput"} + if s.FromPhoneNumber == nil { + invalidParams.Add(request.NewErrParamRequired("FromPhoneNumber")) + } if s.SipMediaApplicationId == nil { invalidParams.Add(request.NewErrParamRequired("SipMediaApplicationId")) } if s.SipMediaApplicationId != nil && len(*s.SipMediaApplicationId) < 1 { invalidParams.Add(request.NewErrParamMinLen("SipMediaApplicationId", 1)) } + if s.ToPhoneNumber == nil { + invalidParams.Add(request.NewErrParamRequired("ToPhoneNumber")) + } if invalidParams.Len() > 0 { return invalidParams @@ -24062,7 +24234,7 @@ func (s *CreateSipMediaApplicationCallOutput) SetSipMediaApplicationCall(v *SipM type CreateSipMediaApplicationInput struct { _ struct{} `type:"structure"` - // AWS Region assigned to the SIP media application. + // The AWS Region assigned to the SIP media application. // // AwsRegion is a required field AwsRegion *string `type:"string" required:"true"` @@ -24074,7 +24246,9 @@ type CreateSipMediaApplicationInput struct { Endpoints []*SipMediaApplicationEndpoint `min:"1" type:"list" required:"true"` // The SIP media application name. - Name *string `min:"1" type:"string"` + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` } // String returns the string representation @@ -24099,6 +24273,9 @@ func (s *CreateSipMediaApplicationInput) Validate() error { if s.Endpoints != nil && len(s.Endpoints) < 1 { invalidParams.Add(request.NewErrParamMinLen("Endpoints", 1)) } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } if s.Name != nil && len(*s.Name) < 1 { invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } @@ -24130,7 +24307,7 @@ func (s *CreateSipMediaApplicationInput) SetName(v string) *CreateSipMediaApplic type CreateSipMediaApplicationOutput struct { _ struct{} `type:"structure"` - // The Sip media application details. + // The SIP media application details. SipMediaApplication *SipMediaApplication `type:"structure"` } @@ -24168,21 +24345,18 @@ type CreateSipRuleInput struct { // TargetApplications is a required field TargetApplications []*SipRuleTargetApplication `min:"1" type:"list" required:"true"` - // The type of trigger whose value is assigned to the SIP rule in TriggerValue. - // Allowed trigger values are RequestUriHostname and ToPhoneNumber. + // The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname + // or ToPhoneNumber. // // TriggerType is a required field TriggerType *string `type:"string" required:"true" enum:"SipRuleTriggerType"` - // If TriggerType is RequestUriHostname then the value can be the outbound host - // name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber - // then the value can be a customer-owned phone number in E164 format. SipRule - // is triggered if the SIP application requests a host name, or a If TriggerType - // is RequestUriHostname, then the value can be the outbound hostname of an - // Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value - // can be a customer-owned phone number in E164 format. SipRule is triggered - // if the SIP application requests a host name, or a ToPhoneNumber value matches - // the incoming SIP request. + // If TriggerType is RequestUriHostname, the value can be the outbound host + // name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, + // the value can be a customer-owned phone number in the E164 format. The SipMediaApplication + // specified in the SipRule is triggered if the request URI in an incoming SIP + // request matches the RequestUriHostname, or if the To header in the incoming + // SIP request matches the ToPhoneNumber value. // // TriggerValue is a required field TriggerValue *string `type:"string" required:"true"` @@ -24468,7 +24642,7 @@ type CreateVoiceConnectorInput struct { _ struct{} `type:"structure"` // The AWS Region in which the Amazon Chime Voice Connector is created. Default - // value: us-east-1. + // value: us-east-1 . AwsRegion *string `type:"string" enum:"VoiceConnectorAwsRegion"` // The name of the Amazon Chime Voice Connector. @@ -24711,12 +24885,12 @@ func (s DeleteAccountOutput) GoString() string { type DeleteAppInstanceAdminInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance's administrator. + // The ARN of the AppInstance's administrator. // // AppInstanceAdminArn is a required field AppInstanceAdminArn *string `location:"uri" locationName:"appInstanceAdminArn" min:"5" type:"string" required:"true"` - // The ARN of the app instance. + // The ARN of the AppInstance. // // AppInstanceArn is a required field AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"` @@ -24783,7 +24957,7 @@ func (s DeleteAppInstanceAdminOutput) GoString() string { type DeleteAppInstanceInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance. + // The ARN of the AppInstance. // // AppInstanceArn is a required field AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"` @@ -25020,12 +25194,15 @@ func (s DeleteAttendeeOutput) GoString() string { type DeleteChannelBanInput struct { _ struct{} `type:"structure"` - // The ARN of the channel from which the app instance user was banned. + // The ARN of the channel from which the AppInstanceUser was banned. // // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` - // The ARN of the app instance user that you want to reinstate. + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + + // The ARN of the AppInstanceUser that you want to reinstate. // // MemberArn is a required field MemberArn *string `location:"uri" locationName:"memberArn" min:"5" type:"string" required:"true"` @@ -25050,6 +25227,9 @@ func (s *DeleteChannelBanInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MemberArn == nil { invalidParams.Add(request.NewErrParamRequired("MemberArn")) } @@ -25069,6 +25249,12 @@ func (s *DeleteChannelBanInput) SetChannelArn(v string) *DeleteChannelBanInput { return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *DeleteChannelBanInput) SetChimeBearer(v string) *DeleteChannelBanInput { + s.ChimeBearer = &v + return s +} + // SetMemberArn sets the MemberArn field's value. func (s *DeleteChannelBanInput) SetMemberArn(v string) *DeleteChannelBanInput { s.MemberArn = &v @@ -25096,6 +25282,9 @@ type DeleteChannelInput struct { // // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` } // String returns the string representation @@ -25117,6 +25306,9 @@ func (s *DeleteChannelInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if invalidParams.Len() > 0 { return invalidParams @@ -25130,6 +25322,12 @@ func (s *DeleteChannelInput) SetChannelArn(v string) *DeleteChannelInput { return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *DeleteChannelInput) SetChimeBearer(v string) *DeleteChannelInput { + s.ChimeBearer = &v + return s +} + type DeleteChannelMembershipInput struct { _ struct{} `type:"structure"` @@ -25138,6 +25336,9 @@ type DeleteChannelMembershipInput struct { // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The ARN of the member that you're removing from the channel. // // MemberArn is a required field @@ -25163,6 +25364,9 @@ func (s *DeleteChannelMembershipInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MemberArn == nil { invalidParams.Add(request.NewErrParamRequired("MemberArn")) } @@ -25182,6 +25386,12 @@ func (s *DeleteChannelMembershipInput) SetChannelArn(v string) *DeleteChannelMem return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *DeleteChannelMembershipInput) SetChimeBearer(v string) *DeleteChannelMembershipInput { + s.ChimeBearer = &v + return s +} + // SetMemberArn sets the MemberArn field's value. func (s *DeleteChannelMembershipInput) SetMemberArn(v string) *DeleteChannelMembershipInput { s.MemberArn = &v @@ -25210,6 +25420,9 @@ type DeleteChannelMessageInput struct { // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The ID of the message being deleted. // // MessageId is a required field @@ -25235,6 +25448,9 @@ func (s *DeleteChannelMessageInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MessageId == nil { invalidParams.Add(request.NewErrParamRequired("MessageId")) } @@ -25254,6 +25470,12 @@ func (s *DeleteChannelMessageInput) SetChannelArn(v string) *DeleteChannelMessag return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *DeleteChannelMessageInput) SetChimeBearer(v string) *DeleteChannelMessageInput { + s.ChimeBearer = &v + return s +} + // SetMessageId sets the MessageId field's value. func (s *DeleteChannelMessageInput) SetMessageId(v string) *DeleteChannelMessageInput { s.MessageId = &v @@ -25286,6 +25508,9 @@ type DeleteChannelModeratorInput struct { // // ChannelModeratorArn is a required field ChannelModeratorArn *string `location:"uri" locationName:"channelModeratorArn" min:"5" type:"string" required:"true"` + + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` } // String returns the string representation @@ -25313,6 +25538,9 @@ func (s *DeleteChannelModeratorInput) Validate() error { if s.ChannelModeratorArn != nil && len(*s.ChannelModeratorArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelModeratorArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if invalidParams.Len() > 0 { return invalidParams @@ -25332,6 +25560,12 @@ func (s *DeleteChannelModeratorInput) SetChannelModeratorArn(v string) *DeleteCh return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *DeleteChannelModeratorInput) SetChimeBearer(v string) *DeleteChannelModeratorInput { + s.ChimeBearer = &v + return s +} + type DeleteChannelModeratorOutput struct { _ struct{} `type:"structure"` } @@ -26343,12 +26577,12 @@ func (s DeleteVoiceConnectorTerminationOutput) GoString() string { type DescribeAppInstanceAdminInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance administrator. + // The ARN of the AppInstanceAdmin. // // AppInstanceAdminArn is a required field AppInstanceAdminArn *string `location:"uri" locationName:"appInstanceAdminArn" min:"5" type:"string" required:"true"` - // The ARN of the app instance. + // The ARN of the AppInstance. // // AppInstanceArn is a required field AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"` @@ -26401,7 +26635,7 @@ func (s *DescribeAppInstanceAdminInput) SetAppInstanceArn(v string) *DescribeApp type DescribeAppInstanceAdminOutput struct { _ struct{} `type:"structure"` - // The ARN and name of the app instance user, the ARN of the app instance, and + // The ARN and name of the AppInstanceUser, the ARN of the AppInstance, and // the created and last-updated timestamps. All timestamps use epoch milliseconds. AppInstanceAdmin *AppInstanceAdmin `type:"structure"` } @@ -26425,7 +26659,7 @@ func (s *DescribeAppInstanceAdminOutput) SetAppInstanceAdmin(v *AppInstanceAdmin type DescribeAppInstanceInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance. + // The ARN of the AppInstance. // // AppInstanceArn is a required field AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"` @@ -26467,7 +26701,7 @@ type DescribeAppInstanceOutput struct { _ struct{} `type:"structure"` // The ARN, metadata, created and last-updated timestamps, and the name of the - // app instance. All timestamps use epoch milliseconds. + // AppInstance. All timestamps use epoch milliseconds. AppInstance *AppInstance `type:"structure"` } @@ -26490,7 +26724,7 @@ func (s *DescribeAppInstanceOutput) SetAppInstance(v *AppInstance) *DescribeAppI type DescribeAppInstanceUserInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance user. + // The ARN of the AppInstanceUser. // // AppInstanceUserArn is a required field AppInstanceUserArn *string `location:"uri" locationName:"appInstanceUserArn" min:"5" type:"string" required:"true"` @@ -26531,7 +26765,7 @@ func (s *DescribeAppInstanceUserInput) SetAppInstanceUserArn(v string) *Describe type DescribeAppInstanceUserOutput struct { _ struct{} `type:"structure"` - // The name of the app instance user. + // The name of the AppInstanceUser. AppInstanceUser *AppInstanceUser `type:"structure"` } @@ -26559,6 +26793,9 @@ type DescribeChannelBanInput struct { // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The ARN of the member being banned. // // MemberArn is a required field @@ -26584,6 +26821,9 @@ func (s *DescribeChannelBanInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MemberArn == nil { invalidParams.Add(request.NewErrParamRequired("MemberArn")) } @@ -26603,6 +26843,12 @@ func (s *DescribeChannelBanInput) SetChannelArn(v string) *DescribeChannelBanInp return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *DescribeChannelBanInput) SetChimeBearer(v string) *DescribeChannelBanInput { + s.ChimeBearer = &v + return s +} + // SetMemberArn sets the MemberArn field's value. func (s *DescribeChannelBanInput) SetMemberArn(v string) *DescribeChannelBanInput { s.MemberArn = &v @@ -26639,6 +26885,9 @@ type DescribeChannelInput struct { // // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` } // String returns the string representation @@ -26660,6 +26909,9 @@ func (s *DescribeChannelInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if invalidParams.Len() > 0 { return invalidParams @@ -26673,6 +26925,12 @@ func (s *DescribeChannelInput) SetChannelArn(v string) *DescribeChannelInput { return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *DescribeChannelInput) SetChimeBearer(v string) *DescribeChannelInput { + s.ChimeBearer = &v + return s +} + type DescribeChannelMembershipForAppInstanceUserInput struct { _ struct{} `type:"structure"` @@ -26685,6 +26943,9 @@ type DescribeChannelMembershipForAppInstanceUserInput struct { // // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` } // String returns the string representation @@ -26712,6 +26973,9 @@ func (s *DescribeChannelMembershipForAppInstanceUserInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if invalidParams.Len() > 0 { return invalidParams @@ -26731,6 +26995,12 @@ func (s *DescribeChannelMembershipForAppInstanceUserInput) SetChannelArn(v strin return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *DescribeChannelMembershipForAppInstanceUserInput) SetChimeBearer(v string) *DescribeChannelMembershipForAppInstanceUserInput { + s.ChimeBearer = &v + return s +} + type DescribeChannelMembershipForAppInstanceUserOutput struct { _ struct{} `type:"structure"` @@ -26762,6 +27032,9 @@ type DescribeChannelMembershipInput struct { // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The ARN of the member. // // MemberArn is a required field @@ -26787,6 +27060,9 @@ func (s *DescribeChannelMembershipInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MemberArn == nil { invalidParams.Add(request.NewErrParamRequired("MemberArn")) } @@ -26806,6 +27082,12 @@ func (s *DescribeChannelMembershipInput) SetChannelArn(v string) *DescribeChanne return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *DescribeChannelMembershipInput) SetChimeBearer(v string) *DescribeChannelMembershipInput { + s.ChimeBearer = &v + return s +} + // SetMemberArn sets the MemberArn field's value. func (s *DescribeChannelMembershipInput) SetMemberArn(v string) *DescribeChannelMembershipInput { s.MemberArn = &v @@ -26838,7 +27120,7 @@ func (s *DescribeChannelMembershipOutput) SetChannelMembership(v *ChannelMembers type DescribeChannelModeratedByAppInstanceUserInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance user in the moderated channel. + // The ARN of the AppInstanceUser in the moderated channel. // // AppInstanceUserArn is a required field AppInstanceUserArn *string `location:"querystring" locationName:"app-instance-user-arn" min:"5" type:"string" required:"true"` @@ -26847,6 +27129,9 @@ type DescribeChannelModeratedByAppInstanceUserInput struct { // // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` } // String returns the string representation @@ -26874,6 +27159,9 @@ func (s *DescribeChannelModeratedByAppInstanceUserInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if invalidParams.Len() > 0 { return invalidParams @@ -26893,6 +27181,12 @@ func (s *DescribeChannelModeratedByAppInstanceUserInput) SetChannelArn(v string) return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *DescribeChannelModeratedByAppInstanceUserInput) SetChimeBearer(v string) *DescribeChannelModeratedByAppInstanceUserInput { + s.ChimeBearer = &v + return s +} + type DescribeChannelModeratedByAppInstanceUserOutput struct { _ struct{} `type:"structure"` @@ -26928,6 +27222,9 @@ type DescribeChannelModeratorInput struct { // // ChannelModeratorArn is a required field ChannelModeratorArn *string `location:"uri" locationName:"channelModeratorArn" min:"5" type:"string" required:"true"` + + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` } // String returns the string representation @@ -26955,6 +27252,9 @@ func (s *DescribeChannelModeratorInput) Validate() error { if s.ChannelModeratorArn != nil && len(*s.ChannelModeratorArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelModeratorArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if invalidParams.Len() > 0 { return invalidParams @@ -26974,6 +27274,12 @@ func (s *DescribeChannelModeratorInput) SetChannelModeratorArn(v string) *Descri return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *DescribeChannelModeratorInput) SetChimeBearer(v string) *DescribeChannelModeratorInput { + s.ChimeBearer = &v + return s +} + type DescribeChannelModeratorOutput struct { _ struct{} `type:"structure"` @@ -27568,8 +27874,7 @@ func (s *GetAccountInput) SetAccountId(v string) *GetAccountInput { type GetAccountOutput struct { _ struct{} `type:"structure"` - // The Amazon Chime account details. An AWS account can have multiple Amazon - // Chime accounts. + // The Amazon Chime account details. Account *Account `type:"structure"` } @@ -27656,7 +27961,7 @@ func (s *GetAccountSettingsOutput) SetAccountSettings(v *AccountSettings) *GetAc type GetAppInstanceRetentionSettingsInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance. + // The ARN of the AppInstance. // // AppInstanceArn is a required field AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"` @@ -27697,7 +28002,7 @@ func (s *GetAppInstanceRetentionSettingsInput) SetAppInstanceArn(v string) *GetA type GetAppInstanceRetentionSettingsOutput struct { _ struct{} `type:"structure"` - // The retention settings for the app instance. + // The retention settings for the AppInstance. AppInstanceRetentionSettings *AppInstanceRetentionSettings `type:"structure"` // The timestamp representing the time at which the specified items are retained, @@ -27730,7 +28035,7 @@ func (s *GetAppInstanceRetentionSettingsOutput) SetInitiateDeletionTimestamp(v t type GetAppInstanceStreamingConfigurationsInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance. + // The ARN of the AppInstance. // // AppInstanceArn is a required field AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"` @@ -27961,6 +28266,9 @@ type GetChannelMessageInput struct { // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The ID of the message. // // MessageId is a required field @@ -27986,6 +28294,9 @@ func (s *GetChannelMessageInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MessageId == nil { invalidParams.Add(request.NewErrParamRequired("MessageId")) } @@ -28005,6 +28316,12 @@ func (s *GetChannelMessageInput) SetChannelArn(v string) *GetChannelMessageInput return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *GetChannelMessageInput) SetChimeBearer(v string) *GetChannelMessageInput { + s.ChimeBearer = &v + return s +} + // SetMessageId sets the MessageId field's value. func (s *GetChannelMessageInput) SetMessageId(v string) *GetChannelMessageInput { s.MessageId = &v @@ -28716,7 +29033,7 @@ func (s *GetSipMediaApplicationInput) SetSipMediaApplicationId(v string) *GetSip type GetSipMediaApplicationLoggingConfigurationInput struct { _ struct{} `type:"structure"` - // The ID of the SIP media application. + // The SIP media application ID. // // SipMediaApplicationId is a required field SipMediaApplicationId *string `location:"uri" locationName:"sipMediaApplicationId" type:"string" required:"true"` @@ -29602,7 +29919,7 @@ func (s *GetVoiceConnectorTerminationOutput) SetTermination(v *Termination) *Get return s } -// The ARN and name of a user. +// The details of a user. type Identity struct { _ struct{} `type:"structure"` @@ -29843,10 +30160,10 @@ func (s *ListAccountsInput) SetUserEmail(v string) *ListAccountsInput { type ListAccountsOutput struct { _ struct{} `type:"structure"` - // The list of accounts. + // List of Amazon Chime accounts and account details. Accounts []*Account `type:"list"` - // The account's user token. + // The token to use to retrieve the next page of results. NextToken *string `type:"string"` } @@ -29875,7 +30192,7 @@ func (s *ListAccountsOutput) SetNextToken(v string) *ListAccountsOutput { type ListAppInstanceAdminsInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance. + // The ARN of the AppInstance. // // AppInstanceArn is a required field AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"` @@ -29941,7 +30258,7 @@ type ListAppInstanceAdminsOutput struct { // The information for each administrator. AppInstanceAdmins []*AppInstanceAdminSummary `type:"list"` - // The ARN of the app instance. + // The ARN of the AppInstance. AppInstanceArn *string `min:"5" type:"string"` // The token returned from previous API requests until the number of administrators @@ -29980,7 +30297,7 @@ func (s *ListAppInstanceAdminsOutput) SetNextToken(v string) *ListAppInstanceAdm type ListAppInstanceUsersInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance. + // The ARN of the AppInstance. // // AppInstanceArn is a required field AppInstanceArn *string `location:"querystring" locationName:"app-instance-arn" min:"5" type:"string" required:"true"` @@ -30042,10 +30359,10 @@ func (s *ListAppInstanceUsersInput) SetNextToken(v string) *ListAppInstanceUsers type ListAppInstanceUsersOutput struct { _ struct{} `type:"structure"` - // The ARN of the app instance. + // The ARN of the AppInstance. AppInstanceArn *string `min:"5" type:"string"` - // The information for each of the requested app instance users. + // The information for each requested AppInstanceUser. AppInstanceUsers []*AppInstanceUserSummary `type:"list"` // The token passed by previous API calls until all requested users are returned. @@ -30083,11 +30400,11 @@ func (s *ListAppInstanceUsersOutput) SetNextToken(v string) *ListAppInstanceUser type ListAppInstancesInput struct { _ struct{} `type:"structure"` - // The maximum number of app instances that you want to return. + // The maximum number of AppInstances that you want to return. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` // The token passed by previous API requests until you reach the maximum number - // of app instances. + // of AppInstances. NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"` } @@ -30129,11 +30446,11 @@ func (s *ListAppInstancesInput) SetNextToken(v string) *ListAppInstancesInput { type ListAppInstancesOutput struct { _ struct{} `type:"structure"` - // The information for each app instance. + // The information for each AppInstance. AppInstances []*AppInstanceSummary `type:"list"` - // The token passed by previous API requests until the maximum number of app - // instances is reached. + // The token passed by previous API requests until the maximum number of AppInstances + // is reached. NextToken *string `type:"string" sensitive:"true"` } @@ -30437,6 +30754,9 @@ type ListChannelBansInput struct { // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The maximum number of bans that you want returned. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` @@ -30463,6 +30783,9 @@ func (s *ListChannelBansInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -30479,6 +30802,12 @@ func (s *ListChannelBansInput) SetChannelArn(v string) *ListChannelBansInput { return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *ListChannelBansInput) SetChimeBearer(v string) *ListChannelBansInput { + s.ChimeBearer = &v + return s +} + // SetMaxResults sets the MaxResults field's value. func (s *ListChannelBansInput) SetMaxResults(v int64) *ListChannelBansInput { s.MaxResults = &v @@ -30535,9 +30864,12 @@ func (s *ListChannelBansOutput) SetNextToken(v string) *ListChannelBansOutput { type ListChannelMembershipsForAppInstanceUserInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance users + // The ARN of the AppInstanceUsers AppInstanceUserArn *string `location:"querystring" locationName:"app-instance-user-arn" min:"5" type:"string"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The maximum number of users that you want returned. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` @@ -30562,6 +30894,9 @@ func (s *ListChannelMembershipsForAppInstanceUserInput) Validate() error { if s.AppInstanceUserArn != nil && len(*s.AppInstanceUserArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("AppInstanceUserArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -30578,6 +30913,12 @@ func (s *ListChannelMembershipsForAppInstanceUserInput) SetAppInstanceUserArn(v return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *ListChannelMembershipsForAppInstanceUserInput) SetChimeBearer(v string) *ListChannelMembershipsForAppInstanceUserInput { + s.ChimeBearer = &v + return s +} + // SetMaxResults sets the MaxResults field's value. func (s *ListChannelMembershipsForAppInstanceUserInput) SetMaxResults(v int64) *ListChannelMembershipsForAppInstanceUserInput { s.MaxResults = &v @@ -30630,11 +30971,14 @@ type ListChannelMembershipsInput struct { // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The maximum number of channel memberships that you want returned. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` // The token passed by previous API calls until all requested channel memberships - // are returned.. + // are returned. NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"` // The membership type of a user, DEFAULT or HIDDEN. Default members are always @@ -30663,6 +31007,9 @@ func (s *ListChannelMembershipsInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -30679,6 +31026,12 @@ func (s *ListChannelMembershipsInput) SetChannelArn(v string) *ListChannelMember return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *ListChannelMembershipsInput) SetChimeBearer(v string) *ListChannelMembershipsInput { + s.ChimeBearer = &v + return s +} + // SetMaxResults sets the MaxResults field's value. func (s *ListChannelMembershipsInput) SetMaxResults(v int64) *ListChannelMembershipsInput { s.MaxResults = &v @@ -30747,6 +31100,9 @@ type ListChannelMessagesInput struct { // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The maximum number of messages that you want returned. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` @@ -30783,6 +31139,9 @@ func (s *ListChannelMessagesInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -30799,6 +31158,12 @@ func (s *ListChannelMessagesInput) SetChannelArn(v string) *ListChannelMessagesI return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *ListChannelMessagesInput) SetChimeBearer(v string) *ListChannelMessagesInput { + s.ChimeBearer = &v + return s +} + // SetMaxResults sets the MaxResults field's value. func (s *ListChannelMessagesInput) SetMaxResults(v int64) *ListChannelMessagesInput { s.MaxResults = &v @@ -30835,7 +31200,7 @@ type ListChannelMessagesOutput struct { // The ARN of the channel containing the requested messages. ChannelArn *string `min:"5" type:"string"` - // The information about and content of each requested message. + // The information about, and content of, each requested message. ChannelMessages []*ChannelMessageSummary `type:"list"` // The token passed by previous API calls until all requested messages are returned. @@ -30878,6 +31243,9 @@ type ListChannelModeratorsInput struct { // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The maximum number of moderators that you want returned. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` @@ -30905,6 +31273,9 @@ func (s *ListChannelModeratorsInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -30921,6 +31292,12 @@ func (s *ListChannelModeratorsInput) SetChannelArn(v string) *ListChannelModerat return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *ListChannelModeratorsInput) SetChimeBearer(v string) *ListChannelModeratorsInput { + s.ChimeBearer = &v + return s +} + // SetMaxResults sets the MaxResults field's value. func (s *ListChannelModeratorsInput) SetMaxResults(v int64) *ListChannelModeratorsInput { s.MaxResults = &v @@ -30978,11 +31355,14 @@ func (s *ListChannelModeratorsOutput) SetNextToken(v string) *ListChannelModerat type ListChannelsInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance. + // The ARN of the AppInstance. // // AppInstanceArn is a required field AppInstanceArn *string `location:"querystring" locationName:"app-instance-arn" min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The maximum number of channels that you want to return. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` @@ -30990,8 +31370,7 @@ type ListChannelsInput struct { NextToken *string `location:"querystring" locationName:"next-token" type:"string" sensitive:"true"` // The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves - // private channels. Only an app instance administrator can retrieve private - // channels. + // private channels. Only an AppInstanceAdmin can retrieve private channels. Privacy *string `location:"querystring" locationName:"privacy" type:"string" enum:"ChannelPrivacy"` } @@ -31014,6 +31393,9 @@ func (s *ListChannelsInput) Validate() error { if s.AppInstanceArn != nil && len(*s.AppInstanceArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("AppInstanceArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -31030,6 +31412,12 @@ func (s *ListChannelsInput) SetAppInstanceArn(v string) *ListChannelsInput { return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *ListChannelsInput) SetChimeBearer(v string) *ListChannelsInput { + s.ChimeBearer = &v + return s +} + // SetMaxResults sets the MaxResults field's value. func (s *ListChannelsInput) SetMaxResults(v int64) *ListChannelsInput { s.MaxResults = &v @@ -31054,6 +31442,9 @@ type ListChannelsModeratedByAppInstanceUserInput struct { // The ARN of the user in the moderated channel. AppInstanceUserArn *string `location:"querystring" locationName:"app-instance-user-arn" min:"5" type:"string"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The maximum number of channels in the request. MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"` @@ -31078,6 +31469,9 @@ func (s *ListChannelsModeratedByAppInstanceUserInput) Validate() error { if s.AppInstanceUserArn != nil && len(*s.AppInstanceUserArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("AppInstanceUserArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -31094,6 +31488,12 @@ func (s *ListChannelsModeratedByAppInstanceUserInput) SetAppInstanceUserArn(v st return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *ListChannelsModeratedByAppInstanceUserInput) SetChimeBearer(v string) *ListChannelsModeratedByAppInstanceUserInput { + s.ChimeBearer = &v + return s +} + // SetMaxResults sets the MaxResults field's value. func (s *ListChannelsModeratedByAppInstanceUserInput) SetMaxResults(v int64) *ListChannelsModeratedByAppInstanceUserInput { s.MaxResults = &v @@ -32564,10 +32964,10 @@ type Meeting struct { // The media placement for the meeting. MediaPlacement *MediaPlacement `type:"structure"` - // The Region in which to create the meeting. Available values: af-south-1, - // ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, - // ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, - // eu-west-3, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2. + // The Region in which you create the meeting. Available values: af-south-1 + // , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 + // , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 + // , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 . MediaRegion *string `type:"string"` // The Amazon Chime SDK meeting ID. @@ -32608,9 +33008,9 @@ func (s *Meeting) SetMeetingId(v string) *Meeting { return s } -// The configuration for resource targets to receive notifications when Amazon -// Chime SDK meeting and attendee events occur. The Amazon Chime SDK supports -// resource targets located in the US East (N. Virginia) AWS Region (us-east-1). +// The resource target configurations for receiving Amazon Chime SDK meeting +// and attendee event notifications. The Amazon Chime SDK supports resource +// targets located in the US East (N. Virginia) AWS Region (us-east-1). type MeetingNotificationConfiguration struct { _ struct{} `type:"structure"` @@ -32794,11 +33194,11 @@ func (s *MembershipItem) SetRole(v string) *MembershipItem { return s } -// The endpoint of a meeting session. +// The websocket endpoint used to connect to Amazon Chime SDK messaging. type MessagingSessionEndpoint struct { _ struct{} `type:"structure"` - // The URL of a meeting session endpoint. + // The endpoint to which you establish a websocket connection. Url *string `type:"string"` } @@ -32986,7 +33386,7 @@ type OriginationRoute struct { Protocol *string `type:"string" enum:"OriginationRouteProtocol"` // The weight associated with the host. If hosts are equal in priority, calls - // are distributed among them based on their relative weight. + // are redistributed among them based on their relative weight. Weight *int64 `min:"1" type:"integer"` } @@ -33367,7 +33767,7 @@ func (s *PhoneNumberError) SetPhoneNumberId(v string) *PhoneNumberError { type PhoneNumberOrder struct { _ struct{} `type:"structure"` - // The phone number order creation timestamp, in ISO 8601 format. + // The phone number order creation time stamp, in ISO 8601 format. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` // The ordered phone number details, such as the phone number in E.164 format @@ -33383,7 +33783,7 @@ type PhoneNumberOrder struct { // The status of the phone number order. Status *string `type:"string" enum:"PhoneNumberOrderStatus"` - // The updated phone number order timestamp, in ISO 8601 format. + // The updated phone number order time stamp, in ISO 8601 format. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` } @@ -33492,10 +33892,10 @@ type ProxySession struct { // The proxy session capabilities. Capabilities []*string `type:"list"` - // The created timestamp, in ISO 8601 format. + // The created time stamp, in ISO 8601 format. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` - // The ended timestamp, in ISO 8601 format. + // The ended time stamp, in ISO 8601 format. EndedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` // The number of minutes allowed for the proxy session. @@ -33524,7 +33924,7 @@ type ProxySession struct { // The status of the proxy session. Status *string `type:"string" enum:"ProxySessionStatus"` - // The updated timestamp, in ISO 8601 format. + // The updated time stamp, in ISO 8601 format. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` // The Amazon Chime voice connector ID. @@ -33622,7 +34022,7 @@ func (s *ProxySession) SetVoiceConnectorId(v string) *ProxySession { type PutAppInstanceRetentionSettingsInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance. + // The ARN of the AppInstance. // // AppInstanceArn is a required field AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"` @@ -33714,12 +34114,12 @@ func (s *PutAppInstanceRetentionSettingsOutput) SetInitiateDeletionTimestamp(v t type PutAppInstanceStreamingConfigurationsInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance. + // The ARN of the AppInstance. // // AppInstanceArn is a required field AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"` - // The streaming configurations set for an app instance. + // The streaming configurations set for an AppInstance. // // AppInstanceStreamingConfigurations is a required field AppInstanceStreamingConfigurations []*AppInstanceStreamingConfiguration `min:"1" type:"list" required:"true"` @@ -33782,7 +34182,7 @@ func (s *PutAppInstanceStreamingConfigurationsInput) SetAppInstanceStreamingConf type PutAppInstanceStreamingConfigurationsOutput struct { _ struct{} `type:"structure"` - // The streaming configurations of an app instance. + // The streaming configurations of an AppInstance. AppInstanceStreamingConfigurations []*AppInstanceStreamingConfiguration `min:"1" type:"list"` } @@ -33998,7 +34398,7 @@ func (s *PutRetentionSettingsOutput) SetRetentionSettings(v *RetentionSettings) type PutSipMediaApplicationLoggingConfigurationInput struct { _ struct{} `type:"structure"` - // The ID of the specified SIP media application + // The SIP media application ID. // // SipMediaApplicationId is a required field SipMediaApplicationId *string `location:"uri" locationName:"sipMediaApplicationId" type:"string" required:"true"` @@ -34048,7 +34448,7 @@ func (s *PutSipMediaApplicationLoggingConfigurationInput) SetSipMediaApplication type PutSipMediaApplicationLoggingConfigurationOutput struct { _ struct{} `type:"structure"` - // The actual logging configuration. + // Logging configuration of the SIP media application. SipMediaApplicationLoggingConfiguration *SipMediaApplicationLoggingConfiguration `type:"structure"` } @@ -34664,6 +35064,9 @@ type RedactChannelMessageInput struct { // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The ID of the message being redacted. // // MessageId is a required field @@ -34689,6 +35092,9 @@ func (s *RedactChannelMessageInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MessageId == nil { invalidParams.Add(request.NewErrParamRequired("MessageId")) } @@ -34708,6 +35114,12 @@ func (s *RedactChannelMessageInput) SetChannelArn(v string) *RedactChannelMessag return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *RedactChannelMessageInput) SetChimeBearer(v string) *RedactChannelMessageInput { + s.ChimeBearer = &v + return s +} + // SetMessageId sets the MessageId field's value. func (s *RedactChannelMessageInput) SetMessageId(v string) *RedactChannelMessageInput { s.MessageId = &v @@ -35210,7 +35622,7 @@ func (s *RestorePhoneNumberOutput) SetPhoneNumber(v *PhoneNumber) *RestorePhoneN } // The retention settings for an Amazon Chime Enterprise account that determine -// how long to retain items such as chat room messages and chat conversation +// how long to retain items such as chat-room messages and chat-conversation // messages. type RetentionSettings struct { _ struct{} `type:"structure"` @@ -35393,12 +35805,12 @@ func (s *RoomMembership) SetUpdatedTimestamp(v time.Time) *RoomMembership { return s } -// The retention settings that determine how long to retain chat room messages +// The retention settings that determine how long to retain chat-room messages // for an Amazon Chime Enterprise account. type RoomRetentionSettings struct { _ struct{} `type:"structure"` - // The number of days for which to retain chat room messages. + // The number of days for which to retain chat-room messages. RetentionDays *int64 `min:"1" type:"integer"` } @@ -35555,6 +35967,9 @@ type SendChannelMessageInput struct { // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The Idempotency token for each client request. ClientRequestToken *string `min:"2" type:"string" idempotencyToken:"true" sensitive:"true"` @@ -35596,6 +36011,9 @@ func (s *SendChannelMessageInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 2 { invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 2)) } @@ -35624,6 +36042,12 @@ func (s *SendChannelMessageInput) SetChannelArn(v string) *SendChannelMessageInp return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *SendChannelMessageInput) SetChimeBearer(v string) *SendChannelMessageInput { + s.ChimeBearer = &v + return s +} + // SetClientRequestToken sets the ClientRequestToken field's value. func (s *SendChannelMessageInput) SetClientRequestToken(v string) *SendChannelMessageInput { s.ClientRequestToken = &v @@ -35827,8 +36251,8 @@ func (s *SigninDelegateGroup) SetGroupName(v string) *SigninDelegateGroup { return s } -// The SIP media application details, including name and endpoints. An AWS account -// can have multiple SIP media applications. +// The details of the SIP media application, including name and endpoints. An +// AWS account can have multiple SIP media applications. type SipMediaApplication struct { _ struct{} `type:"structure"` @@ -35922,12 +36346,12 @@ func (s *SipMediaApplicationCall) SetTransactionId(v string) *SipMediaApplicatio return s } -// Endpoints to specify as part of a SIP media application. +// The endpoint assigned to the SIP media application. type SipMediaApplicationEndpoint struct { _ struct{} `type:"structure"` - // Valid Amazon Resource Name (ARN) of the Lambda function of the same AWS Region - // where the SIP media application is created. + // Valid Amazon Resource Name (ARN) of the Lambda function. The function must + // be created in the same AWS Region as the SIP media application. LambdaArn *string `type:"string" sensitive:"true"` } @@ -35976,11 +36400,11 @@ func (s *SipMediaApplicationLoggingConfiguration) SetEnableSipMediaApplicationMe type SipRule struct { _ struct{} `type:"structure"` - // The SIP rule created timestamp, in ISO 8601 format. + // The time at which the SIP rule was created, in ISO 8601 format. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` - // Indicates if the SIP rule is enabled or disabled. You must disable a rule - // before you can delete it. + // Indicates whether the SIP rule is enabled or disabled. You must disable a + // rule before you can delete it. Disabled *bool `type:"boolean"` // The name of the SIP rule. @@ -35989,11 +36413,13 @@ type SipRule struct { // The SIP rule ID. SipRuleId *string `type:"string"` - // List of SIP media applications with priority and AWS Region. You can only - // use one SIP application per AWS Region and priority combination. + // Target SIP media application and other details, such as priority and AWS + // Region, to be specified in the SIP rule. Only one SIP rule per AWS Region + // can be provided. TargetApplications []*SipRuleTargetApplication `min:"1" type:"list"` - // The type of trigger whose value is assigned to the SIP rule in TriggerValue. + // The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname + // or ToPhoneNumber. TriggerType *string `type:"string" enum:"SipRuleTriggerType"` // If TriggerType is RequestUriHostname, then the value can be the outbound @@ -36003,7 +36429,7 @@ type SipRule struct { // in the incoming SIP request. TriggerValue *string `type:"string"` - // The SIP rule updated timestamp, in ISO 8601 format. + // The time at which the SIP rule was last updated, in ISO 8601 format. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` } @@ -36065,13 +36491,13 @@ func (s *SipRule) SetUpdatedTimestamp(v time.Time) *SipRule { return s } -// Target SIP media application along with other details like priority and AWS -// Region to be specified in the SIP rule. Only one SIP rule per AWS Region +// Target SIP media application and other details, such as priority and AWS +// Region, to be specified in the SIP rule. Only one SIP rule per AWS Region // can be provided. type SipRuleTargetApplication struct { _ struct{} `type:"structure"` - // AWS Region of target application. + // The AWS Region of the target application. AwsRegion *string `type:"string"` // Priority of the SIP media application in the target list. @@ -37196,8 +37622,7 @@ func (s *UpdateAccountInput) SetName(v string) *UpdateAccountInput { type UpdateAccountOutput struct { _ struct{} `type:"structure"` - // The Amazon Chime account details. An AWS account can have multiple Amazon - // Chime accounts. + // The updated Amazon Chime account details. Account *Account `type:"structure"` } @@ -37289,7 +37714,7 @@ func (s UpdateAccountSettingsOutput) GoString() string { type UpdateAppInstanceInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance. + // The ARN of the AppInstance. // // AppInstanceArn is a required field AppInstanceArn *string `location:"uri" locationName:"appInstanceArn" min:"5" type:"string" required:"true"` @@ -37356,7 +37781,7 @@ func (s *UpdateAppInstanceInput) SetName(v string) *UpdateAppInstanceInput { type UpdateAppInstanceOutput struct { _ struct{} `type:"structure"` - // The ARN of the app instance. + // The ARN of the AppInstance. AppInstanceArn *string `min:"5" type:"string"` } @@ -37379,15 +37804,15 @@ func (s *UpdateAppInstanceOutput) SetAppInstanceArn(v string) *UpdateAppInstance type UpdateAppInstanceUserInput struct { _ struct{} `type:"structure"` - // The ARN of the app instance user. + // The ARN of the AppInstanceUser. // // AppInstanceUserArn is a required field AppInstanceUserArn *string `location:"uri" locationName:"appInstanceUserArn" min:"5" type:"string" required:"true"` - // The metadata of the app instance user. + // The metadata of the AppInstanceUser. Metadata *string `type:"string" sensitive:"true"` - // The name of the app instance user. + // The name of the AppInstanceUser. // // Name is a required field Name *string `min:"1" type:"string" required:"true" sensitive:"true"` @@ -37446,7 +37871,7 @@ func (s *UpdateAppInstanceUserInput) SetName(v string) *UpdateAppInstanceUserInp type UpdateAppInstanceUserOutput struct { _ struct{} `type:"structure"` - // The ARN of the app instance user. + // The ARN of the AppInstanceUser. AppInstanceUserArn *string `min:"5" type:"string"` } @@ -37564,7 +37989,10 @@ type UpdateChannelInput struct { // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` - // The metadata of the channel. + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + + // The metadata for the update request. Metadata *string `type:"string" sensitive:"true"` // The mode of the update request. @@ -37597,6 +38025,9 @@ func (s *UpdateChannelInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.Mode == nil { invalidParams.Add(request.NewErrParamRequired("Mode")) } @@ -37619,6 +38050,12 @@ func (s *UpdateChannelInput) SetChannelArn(v string) *UpdateChannelInput { return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *UpdateChannelInput) SetChimeBearer(v string) *UpdateChannelInput { + s.ChimeBearer = &v + return s +} + // SetMetadata sets the Metadata field's value. func (s *UpdateChannelInput) SetMetadata(v string) *UpdateChannelInput { s.Metadata = &v @@ -37645,6 +38082,9 @@ type UpdateChannelMessageInput struct { // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` + // The content of the message being updated. Content *string `type:"string" sensitive:"true"` @@ -37676,6 +38116,9 @@ func (s *UpdateChannelMessageInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if s.MessageId == nil { invalidParams.Add(request.NewErrParamRequired("MessageId")) } @@ -37695,6 +38138,12 @@ func (s *UpdateChannelMessageInput) SetChannelArn(v string) *UpdateChannelMessag return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *UpdateChannelMessageInput) SetChimeBearer(v string) *UpdateChannelMessageInput { + s.ChimeBearer = &v + return s +} + // SetContent sets the Content field's value. func (s *UpdateChannelMessageInput) SetContent(v string) *UpdateChannelMessageInput { s.Content = &v @@ -37775,6 +38224,9 @@ type UpdateChannelReadMarkerInput struct { // // ChannelArn is a required field ChannelArn *string `location:"uri" locationName:"channelArn" min:"5" type:"string" required:"true"` + + // The AppInstanceUserArn of the user that makes the API call. + ChimeBearer *string `location:"header" locationName:"x-amz-chime-bearer" min:"5" type:"string"` } // String returns the string representation @@ -37796,6 +38248,9 @@ func (s *UpdateChannelReadMarkerInput) Validate() error { if s.ChannelArn != nil && len(*s.ChannelArn) < 5 { invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 5)) } + if s.ChimeBearer != nil && len(*s.ChimeBearer) < 5 { + invalidParams.Add(request.NewErrParamMinLen("ChimeBearer", 5)) + } if invalidParams.Len() > 0 { return invalidParams @@ -37809,6 +38264,12 @@ func (s *UpdateChannelReadMarkerInput) SetChannelArn(v string) *UpdateChannelRea return s } +// SetChimeBearer sets the ChimeBearer field's value. +func (s *UpdateChannelReadMarkerInput) SetChimeBearer(v string) *UpdateChannelReadMarkerInput { + s.ChimeBearer = &v + return s +} + type UpdateChannelReadMarkerOutput struct { _ struct{} `type:"structure"` @@ -39371,13 +39832,13 @@ func (s *VoiceConnector) SetVoiceConnectorId(v string) *VoiceConnector { type VoiceConnectorGroup struct { _ struct{} `type:"structure"` - // The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format. + // The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format. CreatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` // The name of the Amazon Chime Voice Connector group. Name *string `min:"1" type:"string"` - // The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format. + // The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601"` // The Amazon Chime Voice Connector group ID. diff --git a/service/chime/doc.go b/service/chime/doc.go index 3502d10adb8..0952e110439 100644 --- a/service/chime/doc.go +++ b/service/chime/doc.go @@ -33,10 +33,10 @@ // commands, see the Amazon Chime commands (https://docs.aws.amazon.com/cli/latest/reference/chime/index.html) // in the AWS CLI Command Reference. // -// Using REST +// Using REST APIs // // If you use REST to make API calls, you must authenticate your request by -// providing a signature. Amazon Chime supports Signature Version 4. For more +// providing a signature. Amazon Chime supports signature version 4. For more // information, see Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) // in the Amazon Web Services General Reference. // diff --git a/service/ecs/api.go b/service/ecs/api.go index c67971ce249..8d525eb3ebc 100644 --- a/service/ecs/api.go +++ b/service/ecs/api.go @@ -7393,9 +7393,6 @@ type ContainerDefinition struct { // to use unique variable names. For more information, see Specifying Environment // Variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) // in the Amazon Elastic Container Service Developer Guide. - // - // This field is not valid for containers in tasks using the Fargate launch - // type. EnvironmentFiles []*EnvironmentFile `locationName:"environmentFiles" type:"list"` // If the essential parameter of a container is marked as true, and that container @@ -18684,6 +18681,9 @@ type TaskDefinition struct { // (30 GB) in increments of 1024 (1 GB) Cpu *string `locationName:"cpu" type:"string"` + // The Unix timestamp for when the task definition was deregistered. + DeregisteredAt *time.Time `locationName:"deregisteredAt" type:"timestamp"` + // The Amazon Resource Name (ARN) of the task execution role that grants the // Amazon ECS container agent permission to make AWS API calls on your behalf. // The task execution IAM role is required depending on the requirements of @@ -18837,6 +18837,12 @@ type TaskDefinition struct { // in the Amazon Elastic Container Service Developer Guide. ProxyConfiguration *ProxyConfiguration `locationName:"proxyConfiguration" type:"structure"` + // The Unix timestamp for when the task definition was registered. + RegisteredAt *time.Time `locationName:"registeredAt" type:"timestamp"` + + // The principal that registered the task definition. + RegisteredBy *string `locationName:"registeredBy" type:"string"` + // The container instance attributes required by your task. This field is not // valid if you are using the Fargate launch type for your task. RequiresAttributes []*Attribute `locationName:"requiresAttributes" type:"list"` @@ -18911,6 +18917,12 @@ func (s *TaskDefinition) SetCpu(v string) *TaskDefinition { return s } +// SetDeregisteredAt sets the DeregisteredAt field's value. +func (s *TaskDefinition) SetDeregisteredAt(v time.Time) *TaskDefinition { + s.DeregisteredAt = &v + return s +} + // SetExecutionRoleArn sets the ExecutionRoleArn field's value. func (s *TaskDefinition) SetExecutionRoleArn(v string) *TaskDefinition { s.ExecutionRoleArn = &v @@ -18965,6 +18977,18 @@ func (s *TaskDefinition) SetProxyConfiguration(v *ProxyConfiguration) *TaskDefin return s } +// SetRegisteredAt sets the RegisteredAt field's value. +func (s *TaskDefinition) SetRegisteredAt(v time.Time) *TaskDefinition { + s.RegisteredAt = &v + return s +} + +// SetRegisteredBy sets the RegisteredBy field's value. +func (s *TaskDefinition) SetRegisteredBy(v string) *TaskDefinition { + s.RegisteredBy = &v + return s +} + // SetRequiresAttributes sets the RequiresAttributes field's value. func (s *TaskDefinition) SetRequiresAttributes(v []*Attribute) *TaskDefinition { s.RequiresAttributes = v @@ -19763,13 +19787,13 @@ func (s UntagResourceOutput) GoString() string { type UpdateCapacityProviderInput struct { _ struct{} `type:"structure"` - // The name of the capacity provider to update. + // An object representing the parameters to update for the Auto Scaling group + // capacity provider. // // AutoScalingGroupProvider is a required field AutoScalingGroupProvider *AutoScalingGroupProviderUpdate `locationName:"autoScalingGroupProvider" type:"structure" required:"true"` - // An object representing the parameters to update for the Auto Scaling group - // capacity provider. + // The name of the capacity provider to update. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"`