Grants one or more permissions on a private CA 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.
+ * ,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/DeleteCertificateAuthorityCommand.ts b/clients/client-acm-pca/commands/DeleteCertificateAuthorityCommand.ts
index 58363026268a8..311ef7180558a 100644
--- a/clients/client-acm-pca/commands/DeleteCertificateAuthorityCommand.ts
+++ b/clients/client-acm-pca/commands/DeleteCertificateAuthorityCommand.ts
@@ -20,6 +20,28 @@ import {
export type DeleteCertificateAuthorityCommandInput = DeleteCertificateAuthorityRequest;
export type DeleteCertificateAuthorityCommandOutput = __MetadataBearer;
+/**
+ * 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.
+ */
export class DeleteCertificateAuthorityCommand extends $Command<
DeleteCertificateAuthorityCommandInput,
DeleteCertificateAuthorityCommandOutput,
@@ -34,6 +56,9 @@ export class DeleteCertificateAuthorityCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/DeletePermissionCommand.ts b/clients/client-acm-pca/commands/DeletePermissionCommand.ts
index b1d3c2fef7f21..0080feb9cd01d 100644
--- a/clients/client-acm-pca/commands/DeletePermissionCommand.ts
+++ b/clients/client-acm-pca/commands/DeletePermissionCommand.ts
@@ -20,6 +20,37 @@ import {
export type DeletePermissionCommandInput = DeletePermissionRequest;
export type DeletePermissionCommandOutput = __MetadataBearer;
+/**
+ * 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.
+ *
+ *
+ */
export class DeletePermissionCommand extends $Command<
DeletePermissionCommandInput,
DeletePermissionCommandOutput,
@@ -34,6 +65,9 @@ export class DeletePermissionCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/DeletePolicyCommand.ts b/clients/client-acm-pca/commands/DeletePolicyCommand.ts
index db487037b7c8c..e9e45058264ca 100644
--- a/clients/client-acm-pca/commands/DeletePolicyCommand.ts
+++ b/clients/client-acm-pca/commands/DeletePolicyCommand.ts
@@ -20,6 +20,43 @@ import {
export type DeletePolicyCommandInput = DeletePolicyRequest;
export type DeletePolicyCommandOutput = __MetadataBearer;
+/**
+ * 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 Using AWS Resource Access Manager
+ * (RAM) with ACM Private CA.
+ *
+ *
+ */
export class DeletePolicyCommand extends $Command<
DeletePolicyCommandInput,
DeletePolicyCommandOutput,
@@ -34,6 +71,9 @@ export class DeletePolicyCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/DescribeCertificateAuthorityAuditReportCommand.ts b/clients/client-acm-pca/commands/DescribeCertificateAuthorityAuditReportCommand.ts
index be538f4a78f15..eec1847242123 100644
--- a/clients/client-acm-pca/commands/DescribeCertificateAuthorityAuditReportCommand.ts
+++ b/clients/client-acm-pca/commands/DescribeCertificateAuthorityAuditReportCommand.ts
@@ -24,6 +24,12 @@ export type DescribeCertificateAuthorityAuditReportCommandInput = DescribeCertif
export type DescribeCertificateAuthorityAuditReportCommandOutput = DescribeCertificateAuthorityAuditReportResponse &
__MetadataBearer;
+/**
+ * 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.
+ */
export class DescribeCertificateAuthorityAuditReportCommand extends $Command<
DescribeCertificateAuthorityAuditReportCommandInput,
DescribeCertificateAuthorityAuditReportCommandOutput,
@@ -38,6 +44,9 @@ export class DescribeCertificateAuthorityAuditReportCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/DescribeCertificateAuthorityCommand.ts b/clients/client-acm-pca/commands/DescribeCertificateAuthorityCommand.ts
index 55966c0239db8..2045121afc3f2 100644
--- a/clients/client-acm-pca/commands/DescribeCertificateAuthorityCommand.ts
+++ b/clients/client-acm-pca/commands/DescribeCertificateAuthorityCommand.ts
@@ -20,6 +20,49 @@ import {
export type DescribeCertificateAuthorityCommandInput = DescribeCertificateAuthorityRequest;
export type DescribeCertificateAuthorityCommandOutput = DescribeCertificateAuthorityResponse & __MetadataBearer;
+/**
+ * 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.
+ *
+ *
+ */
export class DescribeCertificateAuthorityCommand extends $Command<
DescribeCertificateAuthorityCommandInput,
DescribeCertificateAuthorityCommandOutput,
@@ -34,6 +77,9 @@ export class DescribeCertificateAuthorityCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/GetCertificateAuthorityCertificateCommand.ts b/clients/client-acm-pca/commands/GetCertificateAuthorityCertificateCommand.ts
index 1234728b30220..014d5f3838ca5 100644
--- a/clients/client-acm-pca/commands/GetCertificateAuthorityCertificateCommand.ts
+++ b/clients/client-acm-pca/commands/GetCertificateAuthorityCertificateCommand.ts
@@ -24,6 +24,12 @@ export type GetCertificateAuthorityCertificateCommandInput = GetCertificateAutho
export type GetCertificateAuthorityCertificateCommandOutput = GetCertificateAuthorityCertificateResponse &
__MetadataBearer;
+/**
+ * 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.
+ */
export class GetCertificateAuthorityCertificateCommand extends $Command<
GetCertificateAuthorityCertificateCommandInput,
GetCertificateAuthorityCertificateCommandOutput,
@@ -38,6 +44,9 @@ export class GetCertificateAuthorityCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/GetCertificateAuthorityCsrCommand.ts b/clients/client-acm-pca/commands/GetCertificateAuthorityCsrCommand.ts
index 6900c9ccc32f1..a167851cf5771 100644
--- a/clients/client-acm-pca/commands/GetCertificateAuthorityCsrCommand.ts
+++ b/clients/client-acm-pca/commands/GetCertificateAuthorityCsrCommand.ts
@@ -20,6 +20,13 @@ import {
export type GetCertificateAuthorityCsrCommandInput = GetCertificateAuthorityCsrRequest;
export type GetCertificateAuthorityCsrCommandOutput = GetCertificateAuthorityCsrResponse & __MetadataBearer;
+/**
+ * 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.
+ */
export class GetCertificateAuthorityCsrCommand extends $Command<
GetCertificateAuthorityCsrCommandInput,
GetCertificateAuthorityCsrCommandOutput,
@@ -34,6 +41,9 @@ export class GetCertificateAuthorityCsrCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/GetCertificateCommand.ts b/clients/client-acm-pca/commands/GetCertificateCommand.ts
index 7d386fb05aa12..17e539b2c671e 100644
--- a/clients/client-acm-pca/commands/GetCertificateCommand.ts
+++ b/clients/client-acm-pca/commands/GetCertificateCommand.ts
@@ -20,6 +20,16 @@ import {
export type GetCertificateCommandInput = GetCertificateRequest;
export type GetCertificateCommandOutput = GetCertificateResponse & __MetadataBearer;
+/**
+ * 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.
+ */
export class GetCertificateCommand extends $Command<
GetCertificateCommandInput,
GetCertificateCommandOutput,
@@ -34,6 +44,9 @@ export class GetCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/GetPolicyCommand.ts b/clients/client-acm-pca/commands/GetPolicyCommand.ts
index 4ec3c601b1897..8d8d743922adf 100644
--- a/clients/client-acm-pca/commands/GetPolicyCommand.ts
+++ b/clients/client-acm-pca/commands/GetPolicyCommand.ts
@@ -17,6 +17,39 @@ import {
export type GetPolicyCommandInput = GetPolicyRequest;
export type GetPolicyCommandOutput = GetPolicyResponse & __MetadataBearer;
+/**
+ * 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 Using AWS Resource Access Manager
+ * (RAM) with ACM Private CA.
+ *
+ *
+ */
export class GetPolicyCommand extends $Command<
GetPolicyCommandInput,
GetPolicyCommandOutput,
@@ -31,6 +64,9 @@ export class GetPolicyCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/ImportCertificateAuthorityCertificateCommand.ts b/clients/client-acm-pca/commands/ImportCertificateAuthorityCertificateCommand.ts
index 53480e071fba6..4069d232f934e 100644
--- a/clients/client-acm-pca/commands/ImportCertificateAuthorityCertificateCommand.ts
+++ b/clients/client-acm-pca/commands/ImportCertificateAuthorityCertificateCommand.ts
@@ -20,6 +20,123 @@ import {
export type ImportCertificateAuthorityCertificateCommandInput = ImportCertificateAuthorityCertificateRequest;
export type ImportCertificateAuthorityCertificateCommandOutput = __MetadataBearer;
+/**
+ * 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.
+ *
+ *
+ * The following requirements apply when you import a CA certificate.
+ *
+ * -
+ *
You cannot import a non-self-signed certificate for use as a root CA.
+ *
+ * -
+ *
You cannot import a self-signed certificate for use as a subordinate
+ * CA.
+ *
+ * -
+ *
Your certificate chain must not include the private CA certificate that you
+ * are importing.
+ *
+ * -
+ *
Your ACM Private CA-hosted or on-premises CA certificate 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.
+ *
+ */
export class ImportCertificateAuthorityCertificateCommand extends $Command<
ImportCertificateAuthorityCertificateCommandInput,
ImportCertificateAuthorityCertificateCommandOutput,
@@ -34,6 +151,9 @@ export class ImportCertificateAuthorityCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/IssueCertificateCommand.ts b/clients/client-acm-pca/commands/IssueCertificateCommand.ts
index 62db08f8e2bdb..4471fffdd2606 100644
--- a/clients/client-acm-pca/commands/IssueCertificateCommand.ts
+++ b/clients/client-acm-pca/commands/IssueCertificateCommand.ts
@@ -20,6 +20,17 @@ import {
export type IssueCertificateCommandInput = IssueCertificateRequest;
export type IssueCertificateCommandOutput = IssueCertificateResponse & __MetadataBearer;
+/**
+ * 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.
+ *
+ */
export class IssueCertificateCommand extends $Command<
IssueCertificateCommandInput,
IssueCertificateCommandOutput,
@@ -34,6 +45,9 @@ export class IssueCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/ListCertificateAuthoritiesCommand.ts b/clients/client-acm-pca/commands/ListCertificateAuthoritiesCommand.ts
index 9a17699c911f6..41f4bbdd010ab 100644
--- a/clients/client-acm-pca/commands/ListCertificateAuthoritiesCommand.ts
+++ b/clients/client-acm-pca/commands/ListCertificateAuthoritiesCommand.ts
@@ -20,6 +20,9 @@ import {
export type ListCertificateAuthoritiesCommandInput = ListCertificateAuthoritiesRequest;
export type ListCertificateAuthoritiesCommandOutput = ListCertificateAuthoritiesResponse & __MetadataBearer;
+/**
+ * Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.
+ */
export class ListCertificateAuthoritiesCommand extends $Command<
ListCertificateAuthoritiesCommandInput,
ListCertificateAuthoritiesCommandOutput,
@@ -34,6 +37,9 @@ export class ListCertificateAuthoritiesCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/ListPermissionsCommand.ts b/clients/client-acm-pca/commands/ListPermissionsCommand.ts
index cbc7e1c0b4bba..7290571a8d31c 100644
--- a/clients/client-acm-pca/commands/ListPermissionsCommand.ts
+++ b/clients/client-acm-pca/commands/ListPermissionsCommand.ts
@@ -20,6 +20,36 @@ import {
export type ListPermissionsCommandInput = ListPermissionsRequest;
export type ListPermissionsCommandOutput = ListPermissionsResponse & __MetadataBearer;
+/**
+ * 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.
+ *
+ *
+ */
export class ListPermissionsCommand extends $Command<
ListPermissionsCommandInput,
ListPermissionsCommandOutput,
@@ -34,6 +64,9 @@ export class ListPermissionsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/ListTagsCommand.ts b/clients/client-acm-pca/commands/ListTagsCommand.ts
index 08cc2116c9044..7fca3588d36fb 100644
--- a/clients/client-acm-pca/commands/ListTagsCommand.ts
+++ b/clients/client-acm-pca/commands/ListTagsCommand.ts
@@ -17,6 +17,12 @@ import {
export type ListTagsCommandInput = ListTagsRequest;
export type ListTagsCommandOutput = ListTagsResponse & __MetadataBearer;
+/**
+ * Lists the tags, if any, that are associated with your private CA or one that has been
+ * shared with you. Tags are labels that you can use to identify and organize your CAs.
+ * Each tag consists of a key and an optional value. Call the TagCertificateAuthority
+ * action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.
+ */
export class ListTagsCommand extends $Command {
// Start section: command_properties
// End section: command_properties
@@ -27,6 +33,9 @@ export class ListTagsCommand extends $Command,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/PutPolicyCommand.ts b/clients/client-acm-pca/commands/PutPolicyCommand.ts
index 3e722314b9ce4..0dc6dd53220e0 100644
--- a/clients/client-acm-pca/commands/PutPolicyCommand.ts
+++ b/clients/client-acm-pca/commands/PutPolicyCommand.ts
@@ -17,6 +17,40 @@ import {
export type PutPolicyCommandInput = PutPolicyRequest;
export type PutPolicyCommandOutput = __MetadataBearer;
+/**
+ * Attaches a resource-based policy to a private CA.
+ * A policy can also be applied by sharing a private CA through AWS Resource Access Manager
+ * (RAM).
+ * The policy can be displayed with GetPolicy 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 Using AWS Resource Access Manager
+ * (RAM) with ACM Private CA.
+ *
+ *
+ */
export class PutPolicyCommand extends $Command<
PutPolicyCommandInput,
PutPolicyCommandOutput,
@@ -31,6 +65,9 @@ export class PutPolicyCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/RestoreCertificateAuthorityCommand.ts b/clients/client-acm-pca/commands/RestoreCertificateAuthorityCommand.ts
index 94d55d4ffde0f..3340dc83df556 100644
--- a/clients/client-acm-pca/commands/RestoreCertificateAuthorityCommand.ts
+++ b/clients/client-acm-pca/commands/RestoreCertificateAuthorityCommand.ts
@@ -20,6 +20,19 @@ import {
export type RestoreCertificateAuthorityCommandInput = RestoreCertificateAuthorityRequest;
export type RestoreCertificateAuthorityCommandOutput = __MetadataBearer;
+/**
+ * Restores a certificate authority (CA) that is in the DELETED state. You
+ * can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days.
+ * If you did not specify a PermanentDeletionTimeInDays
+ * value, by default you can restore the CA at any time in a 30 day period. You can check
+ * the time remaining in the restoration period of a private CA in the DELETED
+ * state by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to
+ * its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to
+ * ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the
+ * PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate
+ * authority into the private CA before it can be activated. You cannot restore a CA after
+ * the restoration period has ended.
+ */
export class RestoreCertificateAuthorityCommand extends $Command<
RestoreCertificateAuthorityCommandInput,
RestoreCertificateAuthorityCommandOutput,
@@ -34,6 +47,9 @@ export class RestoreCertificateAuthorityCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/RevokeCertificateCommand.ts b/clients/client-acm-pca/commands/RevokeCertificateCommand.ts
index 3dd478ff52baa..34bb2a00c4bd3 100644
--- a/clients/client-acm-pca/commands/RevokeCertificateCommand.ts
+++ b/clients/client-acm-pca/commands/RevokeCertificateCommand.ts
@@ -20,6 +20,28 @@ import {
export type RevokeCertificateCommandInput = RevokeCertificateRequest;
export type RevokeCertificateCommandOutput = __MetadataBearer;
+/**
+ * Revokes a certificate that was issued inside ACM Private CA. If you enable a certificate
+ * revocation list (CRL) when you create or update your private CA, information about the
+ * revoked certificates will be included in the CRL. ACM Private CA writes the CRL to an S3 bucket
+ * that you specify. A CRL is typically updated approximately 30 minutes after a
+ * certificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes
+ * further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the
+ * metrics CRLGenerated and MisconfiguredCRLBucket. For more
+ * information, see Supported CloudWatch Metrics.
+ *
+ * Both PCA and the IAM principal must have permission to write to
+ * the S3 bucket that you specify. If the IAM principal making the call
+ * does not have permission to write to the bucket, then an exception is
+ * thrown. For more information, see Configure
+ * Access to ACM Private CA.
+ *
+ * ACM Private CA also writes revocation information to the audit report. For more information,
+ * see CreateCertificateAuthorityAuditReport.
+ *
+ * You cannot revoke a root CA self-signed certificate.
+ *
+ */
export class RevokeCertificateCommand extends $Command<
RevokeCertificateCommandInput,
RevokeCertificateCommandOutput,
@@ -34,6 +56,9 @@ export class RevokeCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/TagCertificateAuthorityCommand.ts b/clients/client-acm-pca/commands/TagCertificateAuthorityCommand.ts
index 96faae3372a29..6595fbf20f98d 100644
--- a/clients/client-acm-pca/commands/TagCertificateAuthorityCommand.ts
+++ b/clients/client-acm-pca/commands/TagCertificateAuthorityCommand.ts
@@ -20,6 +20,16 @@ import {
export type TagCertificateAuthorityCommandInput = TagCertificateAuthorityRequest;
export type TagCertificateAuthorityCommandOutput = __MetadataBearer;
+/**
+ * Adds one or more tags to your private CA. Tags are labels that you can use to identify
+ * and organize your AWS resources. Each tag consists of a key and an optional value. You
+ * specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag
+ * by using a key-value pair. You can apply a tag to just one private CA if you want to
+ * identify a specific characteristic of that CA, or you can apply the same tag to multiple
+ * private CAs if you want to filter for a common relationship among those CAs. To remove
+ * one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are
+ * associated with your CA.
+ */
export class TagCertificateAuthorityCommand extends $Command<
TagCertificateAuthorityCommandInput,
TagCertificateAuthorityCommandOutput,
@@ -34,6 +44,9 @@ export class TagCertificateAuthorityCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/UntagCertificateAuthorityCommand.ts b/clients/client-acm-pca/commands/UntagCertificateAuthorityCommand.ts
index e0883cf1af0d9..8f66eeef16432 100644
--- a/clients/client-acm-pca/commands/UntagCertificateAuthorityCommand.ts
+++ b/clients/client-acm-pca/commands/UntagCertificateAuthorityCommand.ts
@@ -20,6 +20,13 @@ import {
export type UntagCertificateAuthorityCommandInput = UntagCertificateAuthorityRequest;
export type UntagCertificateAuthorityCommandOutput = __MetadataBearer;
+/**
+ * Remove one or more tags from your private CA. A tag consists of a key-value pair. If
+ * you do not specify the value portion of the tag when calling this action, the tag will
+ * be removed regardless of value. If you specify a value, the tag is removed only if it is
+ * associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are
+ * associated with your CA.
+ */
export class UntagCertificateAuthorityCommand extends $Command<
UntagCertificateAuthorityCommandInput,
UntagCertificateAuthorityCommandOutput,
@@ -34,6 +41,9 @@ export class UntagCertificateAuthorityCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/commands/UpdateCertificateAuthorityCommand.ts b/clients/client-acm-pca/commands/UpdateCertificateAuthorityCommand.ts
index aa8382c7c45b6..e45a64bafd5e1 100644
--- a/clients/client-acm-pca/commands/UpdateCertificateAuthorityCommand.ts
+++ b/clients/client-acm-pca/commands/UpdateCertificateAuthorityCommand.ts
@@ -20,6 +20,19 @@ import {
export type UpdateCertificateAuthorityCommandInput = UpdateCertificateAuthorityRequest;
export type UpdateCertificateAuthorityCommandOutput = __MetadataBearer;
+/**
+ * Updates the status or configuration of a private certificate authority (CA). Your
+ * private CA must be in the ACTIVE or DISABLED state before you
+ * can update it. You can disable a private CA that is in the ACTIVE state or
+ * make a CA that is in the DISABLED state active again.
+ *
+ * Both PCA and the IAM principal must have permission to write to
+ * the S3 bucket that you specify. If the IAM principal making the call
+ * does not have permission to write to the bucket, then an exception is
+ * thrown. For more information, see Configure
+ * Access to ACM Private CA.
+ *
+ */
export class UpdateCertificateAuthorityCommand extends $Command<
UpdateCertificateAuthorityCommandInput,
UpdateCertificateAuthorityCommandOutput,
@@ -34,6 +47,9 @@ export class UpdateCertificateAuthorityCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMPCAClientResolvedConfig,
diff --git a/clients/client-acm-pca/package.json b/clients/client-acm-pca/package.json
index 189c66be943da..c1d88d2dd4b16 100644
--- a/clients/client-acm-pca/package.json
+++ b/clients/client-acm-pca/package.json
@@ -3,8 +3,8 @@
"description": "AWS SDK for JavaScript Acm Pca Client for Node.js, Browser and React Native",
"version": "1.0.0-rc.7",
"scripts": {
- "clean": "npm run remove-definitions && npm run remove-dist",
- "build-documentation": "npm run clean && typedoc ./",
+ "clean": "yarn remove-definitions && yarn remove-dist && yarn remove-documentation",
+ "build-documentation": "yarn remove-documentation && typedoc ./",
"prepublishOnly": "yarn build",
"pretest": "yarn build:cjs",
"remove-definitions": "rimraf ./types",
@@ -63,7 +63,7 @@
"@types/node": "^12.7.5",
"jest": "^26.1.0",
"rimraf": "^3.0.0",
- "typedoc": "^0.17.8",
+ "typedoc": "^0.19.2",
"typescript": "~4.0.2"
},
"engines": {
diff --git a/clients/client-acm-pca/pagination/ListCertificateAuthoritiesPaginator.ts b/clients/client-acm-pca/pagination/ListCertificateAuthoritiesPaginator.ts
index 570b26606d0f3..ddf4b93eaa080 100644
--- a/clients/client-acm-pca/pagination/ListCertificateAuthoritiesPaginator.ts
+++ b/clients/client-acm-pca/pagination/ListCertificateAuthoritiesPaginator.ts
@@ -8,6 +8,9 @@ import {
import { ACMPCAPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: ACMPCAClient,
input: ListCertificateAuthoritiesCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new ListCertificateAuthoritiesCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: ACMPCA,
input: ListCertificateAuthoritiesCommandInput,
diff --git a/clients/client-acm-pca/pagination/ListPermissionsPaginator.ts b/clients/client-acm-pca/pagination/ListPermissionsPaginator.ts
index 3d85f4bb07c01..2580d0a7d3c64 100644
--- a/clients/client-acm-pca/pagination/ListPermissionsPaginator.ts
+++ b/clients/client-acm-pca/pagination/ListPermissionsPaginator.ts
@@ -8,6 +8,9 @@ import {
import { ACMPCAPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: ACMPCAClient,
input: ListPermissionsCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new ListPermissionsCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: ACMPCA,
input: ListPermissionsCommandInput,
diff --git a/clients/client-acm-pca/pagination/ListTagsPaginator.ts b/clients/client-acm-pca/pagination/ListTagsPaginator.ts
index a3540094ebce4..9bb8401c24793 100644
--- a/clients/client-acm-pca/pagination/ListTagsPaginator.ts
+++ b/clients/client-acm-pca/pagination/ListTagsPaginator.ts
@@ -4,6 +4,9 @@ import { ListTagsCommand, ListTagsCommandInput, ListTagsCommandOutput } from "..
import { ACMPCAPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: ACMPCAClient,
input: ListTagsCommandInput,
@@ -12,6 +15,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new ListTagsCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: ACMPCA,
input: ListTagsCommandInput,
diff --git a/clients/client-acm-pca/runtimeConfig.browser.ts b/clients/client-acm-pca/runtimeConfig.browser.ts
index f831bec34ac27..90ffd3b77df6e 100644
--- a/clients/client-acm-pca/runtimeConfig.browser.ts
+++ b/clients/client-acm-pca/runtimeConfig.browser.ts
@@ -12,6 +12,9 @@ import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-browser";
import { ClientDefaults } from "./ACMPCAClient";
import { ClientSharedValues } from "./runtimeConfig.shared";
+/**
+ * @internal
+ */
export const ClientDefaultValues: Required = {
...ClientSharedValues,
runtime: "browser",
diff --git a/clients/client-acm-pca/runtimeConfig.native.ts b/clients/client-acm-pca/runtimeConfig.native.ts
index f9f4817858145..d103502caad3b 100644
--- a/clients/client-acm-pca/runtimeConfig.native.ts
+++ b/clients/client-acm-pca/runtimeConfig.native.ts
@@ -5,6 +5,9 @@ import { parseUrl } from "@aws-sdk/url-parser-node";
import { ClientDefaults } from "./ACMPCAClient";
import { ClientDefaultValues as BrowserDefaults } from "./runtimeConfig.browser";
+/**
+ * @internal
+ */
export const ClientDefaultValues: Required = {
...BrowserDefaults,
runtime: "react-native",
diff --git a/clients/client-acm-pca/runtimeConfig.shared.ts b/clients/client-acm-pca/runtimeConfig.shared.ts
index ba390775262a1..9108e958895c1 100644
--- a/clients/client-acm-pca/runtimeConfig.shared.ts
+++ b/clients/client-acm-pca/runtimeConfig.shared.ts
@@ -1,6 +1,9 @@
import { defaultRegionInfoProvider } from "./endpoints";
import { Logger as __Logger } from "@aws-sdk/types";
+/**
+ * @internal
+ */
export const ClientSharedValues = {
apiVersion: "2017-08-22",
disableHostPrefix: false,
diff --git a/clients/client-acm-pca/runtimeConfig.ts b/clients/client-acm-pca/runtimeConfig.ts
index 499187269c5d5..f7c71161f59e6 100644
--- a/clients/client-acm-pca/runtimeConfig.ts
+++ b/clients/client-acm-pca/runtimeConfig.ts
@@ -14,6 +14,9 @@ import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-node";
import { ClientDefaults } from "./ACMPCAClient";
import { ClientSharedValues } from "./runtimeConfig.shared";
+/**
+ * @internal
+ */
export const ClientDefaultValues: Required = {
...ClientSharedValues,
runtime: "node",
diff --git a/clients/client-acm-pca/tsconfig.json b/clients/client-acm-pca/tsconfig.json
index 3b440583a9a24..4cf936f614b4d 100644
--- a/clients/client-acm-pca/tsconfig.json
+++ b/clients/client-acm-pca/tsconfig.json
@@ -16,13 +16,16 @@
"outDir": "dist/cjs"
},
"typedocOptions": {
- "exclude": "**/node_modules/**",
- "excludedNotExported": true,
+ "exclude": ["**/node_modules/**", "**/*.spec.ts", "./protocols/*.ts", "./e2e/*.ts", "./endpoints.ts"],
+ "excludeNotExported": true,
"excludePrivate": true,
"hideGenerator": true,
"ignoreCompilerErrors": true,
+ "includeDeclarations": true,
+ "readme": "./README.md",
"mode": "file",
"out": "./docs",
- "plugin": "@aws-sdk/client-documentation-generator"
+ "theme": "minimal",
+ "plugin": ["@aws-sdk/client-documentation-generator"]
}
}
diff --git a/clients/client-acm/commands/AddTagsToCertificateCommand.ts b/clients/client-acm/commands/AddTagsToCertificateCommand.ts
index fdab3ebc39cd1..36d9fae83ecb7 100644
--- a/clients/client-acm/commands/AddTagsToCertificateCommand.ts
+++ b/clients/client-acm/commands/AddTagsToCertificateCommand.ts
@@ -20,6 +20,24 @@ import {
export type AddTagsToCertificateCommandInput = AddTagsToCertificateRequest;
export type AddTagsToCertificateCommandOutput = __MetadataBearer;
+/**
+ * Adds one or more tags to an ACM certificate. Tags are labels that you can use to
+ * identify and organize your AWS resources. Each tag consists of a key and an
+ * optional value. You specify the certificate on input by its Amazon Resource Name
+ * (ARN). You specify the tag by using a key-value pair.
+ *
+ * You can apply a tag to just one certificate if you want to identify a specific
+ * characteristic of that certificate, or you can apply the same tag to multiple certificates if
+ * you want to filter for a common relationship among those certificates. Similarly, you can
+ * apply the same tag to multiple resources if you want to specify a relationship among those
+ * resources. For example, you can add the same tag to an ACM certificate and an Elastic Load
+ * Balancing load balancer to indicate that they are both used by the same website. For more
+ * information, see Tagging ACM
+ * certificates.
+ *
+ * To remove one or more tags, use the RemoveTagsFromCertificate action. To
+ * view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.
+ */
export class AddTagsToCertificateCommand extends $Command<
AddTagsToCertificateCommandInput,
AddTagsToCertificateCommandOutput,
@@ -34,6 +52,9 @@ export class AddTagsToCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMClientResolvedConfig,
diff --git a/clients/client-acm/commands/DeleteCertificateCommand.ts b/clients/client-acm/commands/DeleteCertificateCommand.ts
index 7b0d2263a2d43..48da50fe3efd9 100644
--- a/clients/client-acm/commands/DeleteCertificateCommand.ts
+++ b/clients/client-acm/commands/DeleteCertificateCommand.ts
@@ -20,6 +20,16 @@ import {
export type DeleteCertificateCommandInput = DeleteCertificateRequest;
export type DeleteCertificateCommandOutput = __MetadataBearer;
+/**
+ * Deletes a certificate and its associated private key. If this action succeeds, the
+ * certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by AWS
+ * services integrated with ACM.
+ *
+ * You cannot delete an ACM certificate that is being used by another AWS service. To
+ * delete a certificate that is in use, the certificate association must first be
+ * removed.
+ *
+ */
export class DeleteCertificateCommand extends $Command<
DeleteCertificateCommandInput,
DeleteCertificateCommandOutput,
@@ -34,6 +44,9 @@ export class DeleteCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMClientResolvedConfig,
diff --git a/clients/client-acm/commands/DescribeCertificateCommand.ts b/clients/client-acm/commands/DescribeCertificateCommand.ts
index 4256b98fc8cbe..81595502b4eff 100644
--- a/clients/client-acm/commands/DescribeCertificateCommand.ts
+++ b/clients/client-acm/commands/DescribeCertificateCommand.ts
@@ -20,6 +20,9 @@ import {
export type DescribeCertificateCommandInput = DescribeCertificateRequest;
export type DescribeCertificateCommandOutput = DescribeCertificateResponse & __MetadataBearer;
+/**
+ * Returns detailed metadata about the specified ACM certificate.
+ */
export class DescribeCertificateCommand extends $Command<
DescribeCertificateCommandInput,
DescribeCertificateCommandOutput,
@@ -34,6 +37,9 @@ export class DescribeCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMClientResolvedConfig,
diff --git a/clients/client-acm/commands/ExportCertificateCommand.ts b/clients/client-acm/commands/ExportCertificateCommand.ts
index 33bd7588cda97..d21ba8baf24c4 100644
--- a/clients/client-acm/commands/ExportCertificateCommand.ts
+++ b/clients/client-acm/commands/ExportCertificateCommand.ts
@@ -20,6 +20,15 @@ import {
export type ExportCertificateCommandInput = ExportCertificateRequest;
export type ExportCertificateCommandOutput = ExportCertificateResponse & __MetadataBearer;
+/**
+ * Exports a private certificate issued by a private certificate authority (CA) for use
+ * anywhere. The exported file contains the certificate, the certificate chain, and the encrypted
+ * private 2048-bit RSA key associated with the public key that is embedded in the certificate.
+ * For security, you must assign a passphrase for the private key when exporting it.
+ * For information about exporting and formatting a certificate using the ACM console or
+ * CLI, see Export a
+ * Private Certificate.
+ */
export class ExportCertificateCommand extends $Command<
ExportCertificateCommandInput,
ExportCertificateCommandOutput,
@@ -34,6 +43,9 @@ export class ExportCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMClientResolvedConfig,
diff --git a/clients/client-acm/commands/GetCertificateCommand.ts b/clients/client-acm/commands/GetCertificateCommand.ts
index 59b850106d30b..fb310ec95bb63 100644
--- a/clients/client-acm/commands/GetCertificateCommand.ts
+++ b/clients/client-acm/commands/GetCertificateCommand.ts
@@ -20,6 +20,12 @@ import {
export type GetCertificateCommandInput = GetCertificateRequest;
export type GetCertificateCommandOutput = GetCertificateResponse & __MetadataBearer;
+/**
+ * Retrieves an Amazon-issued certificate and its certificate chain. The chain consists of
+ * the certificate of the issuing CA and the intermediate certificates of any other subordinate
+ * CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode
+ * the certificates and inspect individual fields.
+ */
export class GetCertificateCommand extends $Command<
GetCertificateCommandInput,
GetCertificateCommandOutput,
@@ -34,6 +40,9 @@ export class GetCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMClientResolvedConfig,
diff --git a/clients/client-acm/commands/ImportCertificateCommand.ts b/clients/client-acm/commands/ImportCertificateCommand.ts
index 21064b6197c86..5a295118c7539 100644
--- a/clients/client-acm/commands/ImportCertificateCommand.ts
+++ b/clients/client-acm/commands/ImportCertificateCommand.ts
@@ -20,6 +20,77 @@ import {
export type ImportCertificateCommandInput = ImportCertificateRequest;
export type ImportCertificateCommandOutput = ImportCertificateResponse & __MetadataBearer;
+/**
+ * Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with
+ * ACM. Note that integrated
+ * services allow only certificate types and keys they support to be associated with
+ * their resources. Further, their support differs depending on whether the certificate is
+ * imported into IAM or into ACM. For more information, see the documentation for each
+ * service. For more information about importing certificates into ACM, see Importing
+ * Certificates in the AWS Certificate Manager User Guide.
+ *
+ *
+ * ACM does not provide managed renewal for certificates that you import.
+ *
+ *
+ * Note the following guidelines when importing third party certificates:
+ *
+ *
+ *
+ * -
+ *
You must enter the private key that matches the certificate you are importing.
+ *
+ * -
+ *
The private key must be unencrypted. You cannot import a private key that is protected
+ * by a password or a passphrase.
+ *
+ * -
+ *
If the certificate you are importing is not self-signed, you must enter its
+ * certificate chain.
+ *
+ * -
+ *
If a certificate chain is included, the issuer must be the subject of one of the
+ * certificates in the chain.
+ *
+ * -
+ *
The certificate, private key, and certificate chain must be PEM-encoded.
+ *
+ * -
+ *
The current time must be between the Not Before and Not
+ * After certificate fields.
+ *
+ * -
+ *
The Issuer field must not be empty.
+ *
+ * -
+ *
The OCSP authority URL, if present, must not exceed 1000 characters.
+ *
+ * -
+ *
To import a new certificate, omit the CertificateArn argument. Include
+ * this argument only when you want to replace a previously imported certifica
+ *
+ * -
+ *
When you import a certificate by using the CLI, you must specify the certificate, the
+ * certificate chain, and the private key by their file names preceded by
+ * file://. For example, you can specify a certificate saved in the
+ * C:\temp folder as file://C:\temp\certificate_to_import.pem. If
+ * you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.
+ *
+ * -
+ *
When you import a certificate by using an SDK, you must specify the certificate, the
+ * certificate chain, and the private key files in the manner required by the programming
+ * language you're using.
+ *
+ * -
+ *
The cryptographic algorithm of an imported certificate must match the algorithm of the
+ * signing CA. For example, if the signing CA key type is RSA, then the certificate key type
+ * must also be RSA.
+ *
+ *
+ *
+ * This operation returns the Amazon
+ * Resource Name (ARN) of the imported certificate.
+ */
export class ImportCertificateCommand extends $Command<
ImportCertificateCommandInput,
ImportCertificateCommandOutput,
@@ -34,6 +105,9 @@ export class ImportCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMClientResolvedConfig,
diff --git a/clients/client-acm/commands/ListCertificatesCommand.ts b/clients/client-acm/commands/ListCertificatesCommand.ts
index 76e4394929bf4..b046bcce43cf8 100644
--- a/clients/client-acm/commands/ListCertificatesCommand.ts
+++ b/clients/client-acm/commands/ListCertificatesCommand.ts
@@ -20,6 +20,12 @@ import {
export type ListCertificatesCommandInput = ListCertificatesRequest;
export type ListCertificatesCommandOutput = ListCertificatesResponse & __MetadataBearer;
+/**
+ * Retrieves a list of certificate ARNs and domain names. You can request that only
+ * certificates that match a specific status be listed. You can also filter by specific
+ * attributes of the certificate. Default filtering returns only RSA_2048
+ * certificates. For more information, see Filters.
+ */
export class ListCertificatesCommand extends $Command<
ListCertificatesCommandInput,
ListCertificatesCommandOutput,
@@ -34,6 +40,9 @@ export class ListCertificatesCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMClientResolvedConfig,
diff --git a/clients/client-acm/commands/ListTagsForCertificateCommand.ts b/clients/client-acm/commands/ListTagsForCertificateCommand.ts
index 66db089c5b7d0..115fcd66d6642 100644
--- a/clients/client-acm/commands/ListTagsForCertificateCommand.ts
+++ b/clients/client-acm/commands/ListTagsForCertificateCommand.ts
@@ -20,6 +20,11 @@ import {
export type ListTagsForCertificateCommandInput = ListTagsForCertificateRequest;
export type ListTagsForCertificateCommandOutput = ListTagsForCertificateResponse & __MetadataBearer;
+/**
+ * Lists the tags that have been applied to the ACM certificate. Use the certificate's
+ * Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate,
+ * use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.
+ */
export class ListTagsForCertificateCommand extends $Command<
ListTagsForCertificateCommandInput,
ListTagsForCertificateCommandOutput,
@@ -34,6 +39,9 @@ export class ListTagsForCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMClientResolvedConfig,
diff --git a/clients/client-acm/commands/RemoveTagsFromCertificateCommand.ts b/clients/client-acm/commands/RemoveTagsFromCertificateCommand.ts
index f6168602caf37..6d0e4f7c4ad02 100644
--- a/clients/client-acm/commands/RemoveTagsFromCertificateCommand.ts
+++ b/clients/client-acm/commands/RemoveTagsFromCertificateCommand.ts
@@ -20,6 +20,15 @@ import {
export type RemoveTagsFromCertificateCommandInput = RemoveTagsFromCertificateRequest;
export type RemoveTagsFromCertificateCommandOutput = __MetadataBearer;
+/**
+ * Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If
+ * you do not specify the value portion of the tag when calling this function, the tag will be
+ * removed regardless of value. If you specify a value, the tag is removed only if it is
+ * associated with the specified value.
+ *
+ * To add tags to a certificate, use the AddTagsToCertificate action. To
+ * view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.
+ */
export class RemoveTagsFromCertificateCommand extends $Command<
RemoveTagsFromCertificateCommandInput,
RemoveTagsFromCertificateCommandOutput,
@@ -34,6 +43,9 @@ export class RemoveTagsFromCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMClientResolvedConfig,
diff --git a/clients/client-acm/commands/RenewCertificateCommand.ts b/clients/client-acm/commands/RenewCertificateCommand.ts
index 5736486ff1684..7b20d780e8363 100644
--- a/clients/client-acm/commands/RenewCertificateCommand.ts
+++ b/clients/client-acm/commands/RenewCertificateCommand.ts
@@ -20,6 +20,13 @@ import {
export type RenewCertificateCommandInput = RenewCertificateRequest;
export type RenewCertificateCommandOutput = __MetadataBearer;
+/**
+ * Renews an eligable ACM certificate. At this time, only exported private certificates can
+ * be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must
+ * first grant the ACM
+ * service principal permission to do so. For more information, see Testing Managed Renewal
+ * in the ACM User Guide.
+ */
export class RenewCertificateCommand extends $Command<
RenewCertificateCommandInput,
RenewCertificateCommandOutput,
@@ -34,6 +41,9 @@ export class RenewCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMClientResolvedConfig,
diff --git a/clients/client-acm/commands/RequestCertificateCommand.ts b/clients/client-acm/commands/RequestCertificateCommand.ts
index d1721252b26be..fbbaf64113415 100644
--- a/clients/client-acm/commands/RequestCertificateCommand.ts
+++ b/clients/client-acm/commands/RequestCertificateCommand.ts
@@ -20,6 +20,18 @@ import {
export type RequestCertificateCommandInput = RequestCertificateRequest;
export type RequestCertificateCommandOutput = RequestCertificateResponse & __MetadataBearer;
+/**
+ * Requests an ACM certificate for use with other AWS services. To request an ACM
+ * certificate, you must specify a fully qualified domain name (FQDN) in the
+ * DomainName parameter. You can also specify additional FQDNs in the
+ * SubjectAlternativeNames parameter.
+ *
+ * If you are requesting a private certificate, domain validation is not required. If you are
+ * requesting a public certificate, each domain name that you specify must be validated to verify
+ * that you own or control the domain. You can use DNS validation or email validation.
+ * We recommend that you use DNS validation. ACM issues public certificates after receiving
+ * approval from the domain owner.
+ */
export class RequestCertificateCommand extends $Command<
RequestCertificateCommandInput,
RequestCertificateCommandOutput,
@@ -34,6 +46,9 @@ export class RequestCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMClientResolvedConfig,
diff --git a/clients/client-acm/commands/ResendValidationEmailCommand.ts b/clients/client-acm/commands/ResendValidationEmailCommand.ts
index e20b1ccb27b1f..e2145582a14b7 100644
--- a/clients/client-acm/commands/ResendValidationEmailCommand.ts
+++ b/clients/client-acm/commands/ResendValidationEmailCommand.ts
@@ -20,6 +20,17 @@ import {
export type ResendValidationEmailCommandInput = ResendValidationEmailRequest;
export type ResendValidationEmailCommandOutput = __MetadataBearer;
+/**
+ * Resends the email that requests domain ownership validation. The domain owner or an
+ * authorized representative must approve the ACM certificate before it can be issued. The
+ * certificate can be approved by clicking a link in the mail to navigate to the Amazon
+ * certificate approval website and then clicking I Approve.
+ * However, the validation email can be blocked by spam filters. Therefore, if you do not receive
+ * the original mail, you can request that the mail be resent within 72 hours of requesting the
+ * ACM certificate. If more than 72 hours have elapsed since your original request or since
+ * your last attempt to resend validation mail, you must request a new certificate. For more
+ * information about setting up your contact email addresses, see Configure Email for your Domain.
+ */
export class ResendValidationEmailCommand extends $Command<
ResendValidationEmailCommandInput,
ResendValidationEmailCommandOutput,
@@ -34,6 +45,9 @@ export class ResendValidationEmailCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMClientResolvedConfig,
diff --git a/clients/client-acm/commands/UpdateCertificateOptionsCommand.ts b/clients/client-acm/commands/UpdateCertificateOptionsCommand.ts
index a59416ef9b773..569836dab51ec 100644
--- a/clients/client-acm/commands/UpdateCertificateOptionsCommand.ts
+++ b/clients/client-acm/commands/UpdateCertificateOptionsCommand.ts
@@ -20,6 +20,12 @@ import {
export type UpdateCertificateOptionsCommandInput = UpdateCertificateOptionsRequest;
export type UpdateCertificateOptionsCommandOutput = __MetadataBearer;
+/**
+ * Updates a certificate. Currently, you can use this function to specify whether to opt in
+ * to or out of recording your certificate in a certificate transparency log. For more
+ * information, see Opting Out of
+ * Certificate Transparency Logging.
+ */
export class UpdateCertificateOptionsCommand extends $Command<
UpdateCertificateOptionsCommandInput,
UpdateCertificateOptionsCommandOutput,
@@ -34,6 +40,9 @@ export class UpdateCertificateOptionsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: ACMClientResolvedConfig,
diff --git a/clients/client-acm/package.json b/clients/client-acm/package.json
index d4a53c46fc9fb..59729cc0a0fdd 100644
--- a/clients/client-acm/package.json
+++ b/clients/client-acm/package.json
@@ -3,8 +3,8 @@
"description": "AWS SDK for JavaScript Acm Client for Node.js, Browser and React Native",
"version": "1.0.0-rc.7",
"scripts": {
- "clean": "npm run remove-definitions && npm run remove-dist",
- "build-documentation": "npm run clean && typedoc ./",
+ "clean": "yarn remove-definitions && yarn remove-dist && yarn remove-documentation",
+ "build-documentation": "yarn remove-documentation && typedoc ./",
"prepublishOnly": "yarn build",
"pretest": "yarn build:cjs",
"remove-definitions": "rimraf ./types",
@@ -63,7 +63,7 @@
"@types/node": "^12.7.5",
"jest": "^26.1.0",
"rimraf": "^3.0.0",
- "typedoc": "^0.17.8",
+ "typedoc": "^0.19.2",
"typescript": "~4.0.2"
},
"engines": {
diff --git a/clients/client-acm/pagination/ListCertificatesPaginator.ts b/clients/client-acm/pagination/ListCertificatesPaginator.ts
index 013f67fc4dbda..5fcdf8bcbaf57 100644
--- a/clients/client-acm/pagination/ListCertificatesPaginator.ts
+++ b/clients/client-acm/pagination/ListCertificatesPaginator.ts
@@ -8,6 +8,9 @@ import {
import { ACMPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: ACMClient,
input: ListCertificatesCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new ListCertificatesCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: ACM,
input: ListCertificatesCommandInput,
diff --git a/clients/client-acm/runtimeConfig.browser.ts b/clients/client-acm/runtimeConfig.browser.ts
index 733dc7143e815..de4dbeb0f4be4 100644
--- a/clients/client-acm/runtimeConfig.browser.ts
+++ b/clients/client-acm/runtimeConfig.browser.ts
@@ -12,6 +12,9 @@ import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-browser";
import { ClientDefaults } from "./ACMClient";
import { ClientSharedValues } from "./runtimeConfig.shared";
+/**
+ * @internal
+ */
export const ClientDefaultValues: Required = {
...ClientSharedValues,
runtime: "browser",
diff --git a/clients/client-acm/runtimeConfig.native.ts b/clients/client-acm/runtimeConfig.native.ts
index 02b31f2e4f855..df9a10ab63b65 100644
--- a/clients/client-acm/runtimeConfig.native.ts
+++ b/clients/client-acm/runtimeConfig.native.ts
@@ -5,6 +5,9 @@ import { parseUrl } from "@aws-sdk/url-parser-node";
import { ClientDefaults } from "./ACMClient";
import { ClientDefaultValues as BrowserDefaults } from "./runtimeConfig.browser";
+/**
+ * @internal
+ */
export const ClientDefaultValues: Required = {
...BrowserDefaults,
runtime: "react-native",
diff --git a/clients/client-acm/runtimeConfig.shared.ts b/clients/client-acm/runtimeConfig.shared.ts
index f231ae207d978..1aaee2b66dc65 100644
--- a/clients/client-acm/runtimeConfig.shared.ts
+++ b/clients/client-acm/runtimeConfig.shared.ts
@@ -1,6 +1,9 @@
import { defaultRegionInfoProvider } from "./endpoints";
import { Logger as __Logger } from "@aws-sdk/types";
+/**
+ * @internal
+ */
export const ClientSharedValues = {
apiVersion: "2015-12-08",
disableHostPrefix: false,
diff --git a/clients/client-acm/runtimeConfig.ts b/clients/client-acm/runtimeConfig.ts
index 278eba42a7d60..b40f62b46c221 100644
--- a/clients/client-acm/runtimeConfig.ts
+++ b/clients/client-acm/runtimeConfig.ts
@@ -14,6 +14,9 @@ import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-node";
import { ClientDefaults } from "./ACMClient";
import { ClientSharedValues } from "./runtimeConfig.shared";
+/**
+ * @internal
+ */
export const ClientDefaultValues: Required = {
...ClientSharedValues,
runtime: "node",
diff --git a/clients/client-acm/tsconfig.json b/clients/client-acm/tsconfig.json
index 3b440583a9a24..4cf936f614b4d 100644
--- a/clients/client-acm/tsconfig.json
+++ b/clients/client-acm/tsconfig.json
@@ -16,13 +16,16 @@
"outDir": "dist/cjs"
},
"typedocOptions": {
- "exclude": "**/node_modules/**",
- "excludedNotExported": true,
+ "exclude": ["**/node_modules/**", "**/*.spec.ts", "./protocols/*.ts", "./e2e/*.ts", "./endpoints.ts"],
+ "excludeNotExported": true,
"excludePrivate": true,
"hideGenerator": true,
"ignoreCompilerErrors": true,
+ "includeDeclarations": true,
+ "readme": "./README.md",
"mode": "file",
"out": "./docs",
- "plugin": "@aws-sdk/client-documentation-generator"
+ "theme": "minimal",
+ "plugin": ["@aws-sdk/client-documentation-generator"]
}
}
diff --git a/clients/client-alexa-for-business/commands/ApproveSkillCommand.ts b/clients/client-alexa-for-business/commands/ApproveSkillCommand.ts
index 468fbf99f5f13..0883660674d0c 100644
--- a/clients/client-alexa-for-business/commands/ApproveSkillCommand.ts
+++ b/clients/client-alexa-for-business/commands/ApproveSkillCommand.ts
@@ -20,6 +20,10 @@ import {
export type ApproveSkillCommandInput = ApproveSkillRequest;
export type ApproveSkillCommandOutput = ApproveSkillResponse & __MetadataBearer;
+/**
+ * Associates a skill with the organization under the customer's AWS account. If a skill
+ * is private, the user implicitly accepts access to this skill during enablement.
+ */
export class ApproveSkillCommand extends $Command<
ApproveSkillCommandInput,
ApproveSkillCommandOutput,
@@ -34,6 +38,9 @@ export class ApproveSkillCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/AssociateContactWithAddressBookCommand.ts b/clients/client-alexa-for-business/commands/AssociateContactWithAddressBookCommand.ts
index d7f88434d4553..bcf4ad85af384 100644
--- a/clients/client-alexa-for-business/commands/AssociateContactWithAddressBookCommand.ts
+++ b/clients/client-alexa-for-business/commands/AssociateContactWithAddressBookCommand.ts
@@ -20,6 +20,9 @@ import {
export type AssociateContactWithAddressBookCommandInput = AssociateContactWithAddressBookRequest;
export type AssociateContactWithAddressBookCommandOutput = AssociateContactWithAddressBookResponse & __MetadataBearer;
+/**
+ * Associates a contact with a given address book.
+ */
export class AssociateContactWithAddressBookCommand extends $Command<
AssociateContactWithAddressBookCommandInput,
AssociateContactWithAddressBookCommandOutput,
@@ -34,6 +37,9 @@ export class AssociateContactWithAddressBookCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/AssociateDeviceWithNetworkProfileCommand.ts b/clients/client-alexa-for-business/commands/AssociateDeviceWithNetworkProfileCommand.ts
index b60187e10ea30..bc93211d72b1c 100644
--- a/clients/client-alexa-for-business/commands/AssociateDeviceWithNetworkProfileCommand.ts
+++ b/clients/client-alexa-for-business/commands/AssociateDeviceWithNetworkProfileCommand.ts
@@ -24,6 +24,9 @@ export type AssociateDeviceWithNetworkProfileCommandInput = AssociateDeviceWithN
export type AssociateDeviceWithNetworkProfileCommandOutput = AssociateDeviceWithNetworkProfileResponse &
__MetadataBearer;
+/**
+ * Associates a device with the specified network profile.
+ */
export class AssociateDeviceWithNetworkProfileCommand extends $Command<
AssociateDeviceWithNetworkProfileCommandInput,
AssociateDeviceWithNetworkProfileCommandOutput,
@@ -38,6 +41,9 @@ export class AssociateDeviceWithNetworkProfileCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/AssociateDeviceWithRoomCommand.ts b/clients/client-alexa-for-business/commands/AssociateDeviceWithRoomCommand.ts
index 6eae62e66ddb0..bd201d5407b0a 100644
--- a/clients/client-alexa-for-business/commands/AssociateDeviceWithRoomCommand.ts
+++ b/clients/client-alexa-for-business/commands/AssociateDeviceWithRoomCommand.ts
@@ -20,6 +20,11 @@ import {
export type AssociateDeviceWithRoomCommandInput = AssociateDeviceWithRoomRequest;
export type AssociateDeviceWithRoomCommandOutput = AssociateDeviceWithRoomResponse & __MetadataBearer;
+/**
+ * Associates a device with a given room. This applies all the settings from the room
+ * profile to the device, and all the skills in any skill groups added to that room. This
+ * operation requires the device to be online, or else a manual sync is required.
+ */
export class AssociateDeviceWithRoomCommand extends $Command<
AssociateDeviceWithRoomCommandInput,
AssociateDeviceWithRoomCommandOutput,
@@ -34,6 +39,9 @@ export class AssociateDeviceWithRoomCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/AssociateSkillGroupWithRoomCommand.ts b/clients/client-alexa-for-business/commands/AssociateSkillGroupWithRoomCommand.ts
index 1e8144a23fb15..84cf094da8188 100644
--- a/clients/client-alexa-for-business/commands/AssociateSkillGroupWithRoomCommand.ts
+++ b/clients/client-alexa-for-business/commands/AssociateSkillGroupWithRoomCommand.ts
@@ -20,6 +20,10 @@ import {
export type AssociateSkillGroupWithRoomCommandInput = AssociateSkillGroupWithRoomRequest;
export type AssociateSkillGroupWithRoomCommandOutput = AssociateSkillGroupWithRoomResponse & __MetadataBearer;
+/**
+ * Associates a skill group with a given room. This enables all skills in the associated
+ * skill group on all devices in the room.
+ */
export class AssociateSkillGroupWithRoomCommand extends $Command<
AssociateSkillGroupWithRoomCommandInput,
AssociateSkillGroupWithRoomCommandOutput,
@@ -34,6 +38,9 @@ export class AssociateSkillGroupWithRoomCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/AssociateSkillWithSkillGroupCommand.ts b/clients/client-alexa-for-business/commands/AssociateSkillWithSkillGroupCommand.ts
index 364a2aca3030b..4f6a911e17b55 100644
--- a/clients/client-alexa-for-business/commands/AssociateSkillWithSkillGroupCommand.ts
+++ b/clients/client-alexa-for-business/commands/AssociateSkillWithSkillGroupCommand.ts
@@ -20,6 +20,9 @@ import {
export type AssociateSkillWithSkillGroupCommandInput = AssociateSkillWithSkillGroupRequest;
export type AssociateSkillWithSkillGroupCommandOutput = AssociateSkillWithSkillGroupResponse & __MetadataBearer;
+/**
+ * Associates a skill with a skill group.
+ */
export class AssociateSkillWithSkillGroupCommand extends $Command<
AssociateSkillWithSkillGroupCommandInput,
AssociateSkillWithSkillGroupCommandOutput,
@@ -34,6 +37,9 @@ export class AssociateSkillWithSkillGroupCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/AssociateSkillWithUsersCommand.ts b/clients/client-alexa-for-business/commands/AssociateSkillWithUsersCommand.ts
index 304c6e75699e2..1d2d766abe236 100644
--- a/clients/client-alexa-for-business/commands/AssociateSkillWithUsersCommand.ts
+++ b/clients/client-alexa-for-business/commands/AssociateSkillWithUsersCommand.ts
@@ -20,6 +20,9 @@ import {
export type AssociateSkillWithUsersCommandInput = AssociateSkillWithUsersRequest;
export type AssociateSkillWithUsersCommandOutput = AssociateSkillWithUsersResponse & __MetadataBearer;
+/**
+ * Makes a private skill available for enrolled users to enable on their devices.
+ */
export class AssociateSkillWithUsersCommand extends $Command<
AssociateSkillWithUsersCommandInput,
AssociateSkillWithUsersCommandOutput,
@@ -34,6 +37,9 @@ export class AssociateSkillWithUsersCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/CreateAddressBookCommand.ts b/clients/client-alexa-for-business/commands/CreateAddressBookCommand.ts
index c8e511cf85e63..243bce70cbcd0 100644
--- a/clients/client-alexa-for-business/commands/CreateAddressBookCommand.ts
+++ b/clients/client-alexa-for-business/commands/CreateAddressBookCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateAddressBookCommandInput = CreateAddressBookRequest;
export type CreateAddressBookCommandOutput = CreateAddressBookResponse & __MetadataBearer;
+/**
+ * Creates an address book with the specified details.
+ */
export class CreateAddressBookCommand extends $Command<
CreateAddressBookCommandInput,
CreateAddressBookCommandOutput,
@@ -34,6 +37,9 @@ export class CreateAddressBookCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/CreateBusinessReportScheduleCommand.ts b/clients/client-alexa-for-business/commands/CreateBusinessReportScheduleCommand.ts
index 332a4c4d4ff03..33d7efff07413 100644
--- a/clients/client-alexa-for-business/commands/CreateBusinessReportScheduleCommand.ts
+++ b/clients/client-alexa-for-business/commands/CreateBusinessReportScheduleCommand.ts
@@ -20,6 +20,10 @@ import {
export type CreateBusinessReportScheduleCommandInput = CreateBusinessReportScheduleRequest;
export type CreateBusinessReportScheduleCommandOutput = CreateBusinessReportScheduleResponse & __MetadataBearer;
+/**
+ * Creates a recurring schedule for usage reports to deliver to the specified S3
+ * location with a specified daily or weekly interval.
+ */
export class CreateBusinessReportScheduleCommand extends $Command<
CreateBusinessReportScheduleCommandInput,
CreateBusinessReportScheduleCommandOutput,
@@ -34,6 +38,9 @@ export class CreateBusinessReportScheduleCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/CreateConferenceProviderCommand.ts b/clients/client-alexa-for-business/commands/CreateConferenceProviderCommand.ts
index 050d090c821ed..6371345cb751b 100644
--- a/clients/client-alexa-for-business/commands/CreateConferenceProviderCommand.ts
+++ b/clients/client-alexa-for-business/commands/CreateConferenceProviderCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateConferenceProviderCommandInput = CreateConferenceProviderRequest;
export type CreateConferenceProviderCommandOutput = CreateConferenceProviderResponse & __MetadataBearer;
+/**
+ * Adds a new conference provider under the user's AWS account.
+ */
export class CreateConferenceProviderCommand extends $Command<
CreateConferenceProviderCommandInput,
CreateConferenceProviderCommandOutput,
@@ -34,6 +37,9 @@ export class CreateConferenceProviderCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/CreateContactCommand.ts b/clients/client-alexa-for-business/commands/CreateContactCommand.ts
index c71abb0a9646f..65dcd27401ac3 100644
--- a/clients/client-alexa-for-business/commands/CreateContactCommand.ts
+++ b/clients/client-alexa-for-business/commands/CreateContactCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateContactCommandInput = CreateContactRequest;
export type CreateContactCommandOutput = CreateContactResponse & __MetadataBearer;
+/**
+ * Creates a contact with the specified details.
+ */
export class CreateContactCommand extends $Command<
CreateContactCommandInput,
CreateContactCommandOutput,
@@ -34,6 +37,9 @@ export class CreateContactCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/CreateGatewayGroupCommand.ts b/clients/client-alexa-for-business/commands/CreateGatewayGroupCommand.ts
index 2b55b43e4fc9d..aae7d3c3e351d 100644
--- a/clients/client-alexa-for-business/commands/CreateGatewayGroupCommand.ts
+++ b/clients/client-alexa-for-business/commands/CreateGatewayGroupCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateGatewayGroupCommandInput = CreateGatewayGroupRequest;
export type CreateGatewayGroupCommandOutput = CreateGatewayGroupResponse & __MetadataBearer;
+/**
+ * Creates a gateway group with the specified details.
+ */
export class CreateGatewayGroupCommand extends $Command<
CreateGatewayGroupCommandInput,
CreateGatewayGroupCommandOutput,
@@ -34,6 +37,9 @@ export class CreateGatewayGroupCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/CreateNetworkProfileCommand.ts b/clients/client-alexa-for-business/commands/CreateNetworkProfileCommand.ts
index 300cc3822d70f..15beea52121d5 100644
--- a/clients/client-alexa-for-business/commands/CreateNetworkProfileCommand.ts
+++ b/clients/client-alexa-for-business/commands/CreateNetworkProfileCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateNetworkProfileCommandInput = CreateNetworkProfileRequest;
export type CreateNetworkProfileCommandOutput = CreateNetworkProfileResponse & __MetadataBearer;
+/**
+ * Creates a network profile with the specified details.
+ */
export class CreateNetworkProfileCommand extends $Command<
CreateNetworkProfileCommandInput,
CreateNetworkProfileCommandOutput,
@@ -34,6 +37,9 @@ export class CreateNetworkProfileCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/CreateProfileCommand.ts b/clients/client-alexa-for-business/commands/CreateProfileCommand.ts
index d7849b9d02be0..f8c2c730994a6 100644
--- a/clients/client-alexa-for-business/commands/CreateProfileCommand.ts
+++ b/clients/client-alexa-for-business/commands/CreateProfileCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateProfileCommandInput = CreateProfileRequest;
export type CreateProfileCommandOutput = CreateProfileResponse & __MetadataBearer;
+/**
+ * Creates a new room profile with the specified details.
+ */
export class CreateProfileCommand extends $Command<
CreateProfileCommandInput,
CreateProfileCommandOutput,
@@ -34,6 +37,9 @@ export class CreateProfileCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/CreateRoomCommand.ts b/clients/client-alexa-for-business/commands/CreateRoomCommand.ts
index 4f666e28ecc8d..df847fcf7df3c 100644
--- a/clients/client-alexa-for-business/commands/CreateRoomCommand.ts
+++ b/clients/client-alexa-for-business/commands/CreateRoomCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateRoomCommandInput = CreateRoomRequest;
export type CreateRoomCommandOutput = CreateRoomResponse & __MetadataBearer;
+/**
+ * Creates a room with the specified details.
+ */
export class CreateRoomCommand extends $Command<
CreateRoomCommandInput,
CreateRoomCommandOutput,
@@ -34,6 +37,9 @@ export class CreateRoomCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/CreateSkillGroupCommand.ts b/clients/client-alexa-for-business/commands/CreateSkillGroupCommand.ts
index 948e91bde5d13..0d59b2553eccf 100644
--- a/clients/client-alexa-for-business/commands/CreateSkillGroupCommand.ts
+++ b/clients/client-alexa-for-business/commands/CreateSkillGroupCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateSkillGroupCommandInput = CreateSkillGroupRequest;
export type CreateSkillGroupCommandOutput = CreateSkillGroupResponse & __MetadataBearer;
+/**
+ * Creates a skill group with a specified name and description.
+ */
export class CreateSkillGroupCommand extends $Command<
CreateSkillGroupCommandInput,
CreateSkillGroupCommandOutput,
@@ -34,6 +37,9 @@ export class CreateSkillGroupCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/CreateUserCommand.ts b/clients/client-alexa-for-business/commands/CreateUserCommand.ts
index f2a8ebab7bdb5..1886421eeb6ad 100644
--- a/clients/client-alexa-for-business/commands/CreateUserCommand.ts
+++ b/clients/client-alexa-for-business/commands/CreateUserCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateUserCommandInput = CreateUserRequest;
export type CreateUserCommandOutput = CreateUserResponse & __MetadataBearer;
+/**
+ * Creates a user.
+ */
export class CreateUserCommand extends $Command<
CreateUserCommandInput,
CreateUserCommandOutput,
@@ -34,6 +37,9 @@ export class CreateUserCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DeleteAddressBookCommand.ts b/clients/client-alexa-for-business/commands/DeleteAddressBookCommand.ts
index c76fbbd5270f5..e92d7f224285b 100644
--- a/clients/client-alexa-for-business/commands/DeleteAddressBookCommand.ts
+++ b/clients/client-alexa-for-business/commands/DeleteAddressBookCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteAddressBookCommandInput = DeleteAddressBookRequest;
export type DeleteAddressBookCommandOutput = DeleteAddressBookResponse & __MetadataBearer;
+/**
+ * Deletes an address book by the address book ARN.
+ */
export class DeleteAddressBookCommand extends $Command<
DeleteAddressBookCommandInput,
DeleteAddressBookCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteAddressBookCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DeleteBusinessReportScheduleCommand.ts b/clients/client-alexa-for-business/commands/DeleteBusinessReportScheduleCommand.ts
index 9a38b823cdc38..87501c025c3e4 100644
--- a/clients/client-alexa-for-business/commands/DeleteBusinessReportScheduleCommand.ts
+++ b/clients/client-alexa-for-business/commands/DeleteBusinessReportScheduleCommand.ts
@@ -20,6 +20,10 @@ import {
export type DeleteBusinessReportScheduleCommandInput = DeleteBusinessReportScheduleRequest;
export type DeleteBusinessReportScheduleCommandOutput = DeleteBusinessReportScheduleResponse & __MetadataBearer;
+/**
+ * Deletes the recurring report delivery schedule with the specified schedule
+ * ARN.
+ */
export class DeleteBusinessReportScheduleCommand extends $Command<
DeleteBusinessReportScheduleCommandInput,
DeleteBusinessReportScheduleCommandOutput,
@@ -34,6 +38,9 @@ export class DeleteBusinessReportScheduleCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DeleteConferenceProviderCommand.ts b/clients/client-alexa-for-business/commands/DeleteConferenceProviderCommand.ts
index 66afaed750808..745deb027a4c1 100644
--- a/clients/client-alexa-for-business/commands/DeleteConferenceProviderCommand.ts
+++ b/clients/client-alexa-for-business/commands/DeleteConferenceProviderCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteConferenceProviderCommandInput = DeleteConferenceProviderRequest;
export type DeleteConferenceProviderCommandOutput = DeleteConferenceProviderResponse & __MetadataBearer;
+/**
+ * Deletes a conference provider.
+ */
export class DeleteConferenceProviderCommand extends $Command<
DeleteConferenceProviderCommandInput,
DeleteConferenceProviderCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteConferenceProviderCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DeleteContactCommand.ts b/clients/client-alexa-for-business/commands/DeleteContactCommand.ts
index 8a837bf55725e..85a9ab3517361 100644
--- a/clients/client-alexa-for-business/commands/DeleteContactCommand.ts
+++ b/clients/client-alexa-for-business/commands/DeleteContactCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteContactCommandInput = DeleteContactRequest;
export type DeleteContactCommandOutput = DeleteContactResponse & __MetadataBearer;
+/**
+ * Deletes a contact by the contact ARN.
+ */
export class DeleteContactCommand extends $Command<
DeleteContactCommandInput,
DeleteContactCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteContactCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DeleteDeviceCommand.ts b/clients/client-alexa-for-business/commands/DeleteDeviceCommand.ts
index 13bc00517427f..e05c36b727bee 100644
--- a/clients/client-alexa-for-business/commands/DeleteDeviceCommand.ts
+++ b/clients/client-alexa-for-business/commands/DeleteDeviceCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteDeviceCommandInput = DeleteDeviceRequest;
export type DeleteDeviceCommandOutput = DeleteDeviceResponse & __MetadataBearer;
+/**
+ * Removes a device from Alexa For Business.
+ */
export class DeleteDeviceCommand extends $Command<
DeleteDeviceCommandInput,
DeleteDeviceCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteDeviceCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DeleteDeviceUsageDataCommand.ts b/clients/client-alexa-for-business/commands/DeleteDeviceUsageDataCommand.ts
index c2b1ce3b20bcd..15cf7eaf1e1ad 100644
--- a/clients/client-alexa-for-business/commands/DeleteDeviceUsageDataCommand.ts
+++ b/clients/client-alexa-for-business/commands/DeleteDeviceUsageDataCommand.ts
@@ -20,6 +20,11 @@ import {
export type DeleteDeviceUsageDataCommandInput = DeleteDeviceUsageDataRequest;
export type DeleteDeviceUsageDataCommandOutput = DeleteDeviceUsageDataResponse & __MetadataBearer;
+/**
+ * When this action is called for a specified shared device, it allows authorized users to
+ * delete the device's entire previous history of voice input data and associated response
+ * data. This action can be called once every 24 hours for a specific shared device.
+ */
export class DeleteDeviceUsageDataCommand extends $Command<
DeleteDeviceUsageDataCommandInput,
DeleteDeviceUsageDataCommandOutput,
@@ -34,6 +39,9 @@ export class DeleteDeviceUsageDataCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DeleteGatewayGroupCommand.ts b/clients/client-alexa-for-business/commands/DeleteGatewayGroupCommand.ts
index af3656cd889bc..3a07ab52d72f8 100644
--- a/clients/client-alexa-for-business/commands/DeleteGatewayGroupCommand.ts
+++ b/clients/client-alexa-for-business/commands/DeleteGatewayGroupCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteGatewayGroupCommandInput = DeleteGatewayGroupRequest;
export type DeleteGatewayGroupCommandOutput = DeleteGatewayGroupResponse & __MetadataBearer;
+/**
+ * Deletes a gateway group.
+ */
export class DeleteGatewayGroupCommand extends $Command<
DeleteGatewayGroupCommandInput,
DeleteGatewayGroupCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteGatewayGroupCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DeleteNetworkProfileCommand.ts b/clients/client-alexa-for-business/commands/DeleteNetworkProfileCommand.ts
index 047e9ed81ff5a..9b52b897ffc8b 100644
--- a/clients/client-alexa-for-business/commands/DeleteNetworkProfileCommand.ts
+++ b/clients/client-alexa-for-business/commands/DeleteNetworkProfileCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteNetworkProfileCommandInput = DeleteNetworkProfileRequest;
export type DeleteNetworkProfileCommandOutput = DeleteNetworkProfileResponse & __MetadataBearer;
+/**
+ * Deletes a network profile by the network profile ARN.
+ */
export class DeleteNetworkProfileCommand extends $Command<
DeleteNetworkProfileCommandInput,
DeleteNetworkProfileCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteNetworkProfileCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DeleteProfileCommand.ts b/clients/client-alexa-for-business/commands/DeleteProfileCommand.ts
index 2755859cc9400..5b2c47184bf57 100644
--- a/clients/client-alexa-for-business/commands/DeleteProfileCommand.ts
+++ b/clients/client-alexa-for-business/commands/DeleteProfileCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteProfileCommandInput = DeleteProfileRequest;
export type DeleteProfileCommandOutput = DeleteProfileResponse & __MetadataBearer;
+/**
+ * Deletes a room profile by the profile ARN.
+ */
export class DeleteProfileCommand extends $Command<
DeleteProfileCommandInput,
DeleteProfileCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteProfileCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DeleteRoomCommand.ts b/clients/client-alexa-for-business/commands/DeleteRoomCommand.ts
index aa92ba02578f8..675876cd2700b 100644
--- a/clients/client-alexa-for-business/commands/DeleteRoomCommand.ts
+++ b/clients/client-alexa-for-business/commands/DeleteRoomCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteRoomCommandInput = DeleteRoomRequest;
export type DeleteRoomCommandOutput = DeleteRoomResponse & __MetadataBearer;
+/**
+ * Deletes a room by the room ARN.
+ */
export class DeleteRoomCommand extends $Command<
DeleteRoomCommandInput,
DeleteRoomCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteRoomCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DeleteRoomSkillParameterCommand.ts b/clients/client-alexa-for-business/commands/DeleteRoomSkillParameterCommand.ts
index 5a091d5b7d154..400756529e4ee 100644
--- a/clients/client-alexa-for-business/commands/DeleteRoomSkillParameterCommand.ts
+++ b/clients/client-alexa-for-business/commands/DeleteRoomSkillParameterCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteRoomSkillParameterCommandInput = DeleteRoomSkillParameterRequest;
export type DeleteRoomSkillParameterCommandOutput = DeleteRoomSkillParameterResponse & __MetadataBearer;
+/**
+ * Deletes room skill parameter details by room, skill, and parameter key ID.
+ */
export class DeleteRoomSkillParameterCommand extends $Command<
DeleteRoomSkillParameterCommandInput,
DeleteRoomSkillParameterCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteRoomSkillParameterCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DeleteSkillAuthorizationCommand.ts b/clients/client-alexa-for-business/commands/DeleteSkillAuthorizationCommand.ts
index e770b3e85f68b..5ee930f1ca0ee 100644
--- a/clients/client-alexa-for-business/commands/DeleteSkillAuthorizationCommand.ts
+++ b/clients/client-alexa-for-business/commands/DeleteSkillAuthorizationCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteSkillAuthorizationCommandInput = DeleteSkillAuthorizationRequest;
export type DeleteSkillAuthorizationCommandOutput = DeleteSkillAuthorizationResponse & __MetadataBearer;
+/**
+ * Unlinks a third-party account from a skill.
+ */
export class DeleteSkillAuthorizationCommand extends $Command<
DeleteSkillAuthorizationCommandInput,
DeleteSkillAuthorizationCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteSkillAuthorizationCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DeleteSkillGroupCommand.ts b/clients/client-alexa-for-business/commands/DeleteSkillGroupCommand.ts
index add5170bb7cfe..f80b3fd05e11a 100644
--- a/clients/client-alexa-for-business/commands/DeleteSkillGroupCommand.ts
+++ b/clients/client-alexa-for-business/commands/DeleteSkillGroupCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteSkillGroupCommandInput = DeleteSkillGroupRequest;
export type DeleteSkillGroupCommandOutput = DeleteSkillGroupResponse & __MetadataBearer;
+/**
+ * Deletes a skill group by skill group ARN.
+ */
export class DeleteSkillGroupCommand extends $Command<
DeleteSkillGroupCommandInput,
DeleteSkillGroupCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteSkillGroupCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DeleteUserCommand.ts b/clients/client-alexa-for-business/commands/DeleteUserCommand.ts
index 943d1056dd696..3b74ab50bac23 100644
--- a/clients/client-alexa-for-business/commands/DeleteUserCommand.ts
+++ b/clients/client-alexa-for-business/commands/DeleteUserCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteUserCommandInput = DeleteUserRequest;
export type DeleteUserCommandOutput = DeleteUserResponse & __MetadataBearer;
+/**
+ * Deletes a specified user by user ARN and enrollment ARN.
+ */
export class DeleteUserCommand extends $Command<
DeleteUserCommandInput,
DeleteUserCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteUserCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DisassociateContactFromAddressBookCommand.ts b/clients/client-alexa-for-business/commands/DisassociateContactFromAddressBookCommand.ts
index 89cea97559314..83f24b85d6bb6 100644
--- a/clients/client-alexa-for-business/commands/DisassociateContactFromAddressBookCommand.ts
+++ b/clients/client-alexa-for-business/commands/DisassociateContactFromAddressBookCommand.ts
@@ -24,6 +24,9 @@ export type DisassociateContactFromAddressBookCommandInput = DisassociateContact
export type DisassociateContactFromAddressBookCommandOutput = DisassociateContactFromAddressBookResponse &
__MetadataBearer;
+/**
+ * Disassociates a contact from a given address book.
+ */
export class DisassociateContactFromAddressBookCommand extends $Command<
DisassociateContactFromAddressBookCommandInput,
DisassociateContactFromAddressBookCommandOutput,
@@ -38,6 +41,9 @@ export class DisassociateContactFromAddressBookCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DisassociateDeviceFromRoomCommand.ts b/clients/client-alexa-for-business/commands/DisassociateDeviceFromRoomCommand.ts
index bd1b78e32bde0..ed70756089a6b 100644
--- a/clients/client-alexa-for-business/commands/DisassociateDeviceFromRoomCommand.ts
+++ b/clients/client-alexa-for-business/commands/DisassociateDeviceFromRoomCommand.ts
@@ -20,6 +20,11 @@ import {
export type DisassociateDeviceFromRoomCommandInput = DisassociateDeviceFromRoomRequest;
export type DisassociateDeviceFromRoomCommandOutput = DisassociateDeviceFromRoomResponse & __MetadataBearer;
+/**
+ * Disassociates a device from its current room. The device continues to be connected to
+ * the Wi-Fi network and is still registered to the account. The device settings and skills
+ * are removed from the room.
+ */
export class DisassociateDeviceFromRoomCommand extends $Command<
DisassociateDeviceFromRoomCommandInput,
DisassociateDeviceFromRoomCommandOutput,
@@ -34,6 +39,9 @@ export class DisassociateDeviceFromRoomCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DisassociateSkillFromSkillGroupCommand.ts b/clients/client-alexa-for-business/commands/DisassociateSkillFromSkillGroupCommand.ts
index 8e4ec08687ef8..6b7ee05585451 100644
--- a/clients/client-alexa-for-business/commands/DisassociateSkillFromSkillGroupCommand.ts
+++ b/clients/client-alexa-for-business/commands/DisassociateSkillFromSkillGroupCommand.ts
@@ -20,6 +20,9 @@ import {
export type DisassociateSkillFromSkillGroupCommandInput = DisassociateSkillFromSkillGroupRequest;
export type DisassociateSkillFromSkillGroupCommandOutput = DisassociateSkillFromSkillGroupResponse & __MetadataBearer;
+/**
+ * Disassociates a skill from a skill group.
+ */
export class DisassociateSkillFromSkillGroupCommand extends $Command<
DisassociateSkillFromSkillGroupCommandInput,
DisassociateSkillFromSkillGroupCommandOutput,
@@ -34,6 +37,9 @@ export class DisassociateSkillFromSkillGroupCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DisassociateSkillFromUsersCommand.ts b/clients/client-alexa-for-business/commands/DisassociateSkillFromUsersCommand.ts
index 09c5e1b9b4cd7..998552190eee7 100644
--- a/clients/client-alexa-for-business/commands/DisassociateSkillFromUsersCommand.ts
+++ b/clients/client-alexa-for-business/commands/DisassociateSkillFromUsersCommand.ts
@@ -20,6 +20,10 @@ import {
export type DisassociateSkillFromUsersCommandInput = DisassociateSkillFromUsersRequest;
export type DisassociateSkillFromUsersCommandOutput = DisassociateSkillFromUsersResponse & __MetadataBearer;
+/**
+ * Makes a private skill unavailable for enrolled users and prevents them from enabling it
+ * on their devices.
+ */
export class DisassociateSkillFromUsersCommand extends $Command<
DisassociateSkillFromUsersCommandInput,
DisassociateSkillFromUsersCommandOutput,
@@ -34,6 +38,9 @@ export class DisassociateSkillFromUsersCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/DisassociateSkillGroupFromRoomCommand.ts b/clients/client-alexa-for-business/commands/DisassociateSkillGroupFromRoomCommand.ts
index 05c9d4dc0c600..9273ce2cdbe36 100644
--- a/clients/client-alexa-for-business/commands/DisassociateSkillGroupFromRoomCommand.ts
+++ b/clients/client-alexa-for-business/commands/DisassociateSkillGroupFromRoomCommand.ts
@@ -20,6 +20,10 @@ import {
export type DisassociateSkillGroupFromRoomCommandInput = DisassociateSkillGroupFromRoomRequest;
export type DisassociateSkillGroupFromRoomCommandOutput = DisassociateSkillGroupFromRoomResponse & __MetadataBearer;
+/**
+ * Disassociates a skill group from a specified room. This disables all skills in the
+ * skill group on all devices in the room.
+ */
export class DisassociateSkillGroupFromRoomCommand extends $Command<
DisassociateSkillGroupFromRoomCommandInput,
DisassociateSkillGroupFromRoomCommandOutput,
@@ -34,6 +38,9 @@ export class DisassociateSkillGroupFromRoomCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/ForgetSmartHomeAppliancesCommand.ts b/clients/client-alexa-for-business/commands/ForgetSmartHomeAppliancesCommand.ts
index b21eb6b0fe332..0423399323fa3 100644
--- a/clients/client-alexa-for-business/commands/ForgetSmartHomeAppliancesCommand.ts
+++ b/clients/client-alexa-for-business/commands/ForgetSmartHomeAppliancesCommand.ts
@@ -20,6 +20,9 @@ import {
export type ForgetSmartHomeAppliancesCommandInput = ForgetSmartHomeAppliancesRequest;
export type ForgetSmartHomeAppliancesCommandOutput = ForgetSmartHomeAppliancesResponse & __MetadataBearer;
+/**
+ * Forgets smart home appliances associated to a room.
+ */
export class ForgetSmartHomeAppliancesCommand extends $Command<
ForgetSmartHomeAppliancesCommandInput,
ForgetSmartHomeAppliancesCommandOutput,
@@ -34,6 +37,9 @@ export class ForgetSmartHomeAppliancesCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/GetAddressBookCommand.ts b/clients/client-alexa-for-business/commands/GetAddressBookCommand.ts
index e333cdab44052..cafcccdd47a01 100644
--- a/clients/client-alexa-for-business/commands/GetAddressBookCommand.ts
+++ b/clients/client-alexa-for-business/commands/GetAddressBookCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetAddressBookCommandInput = GetAddressBookRequest;
export type GetAddressBookCommandOutput = GetAddressBookResponse & __MetadataBearer;
+/**
+ * Gets address the book details by the address book ARN.
+ */
export class GetAddressBookCommand extends $Command<
GetAddressBookCommandInput,
GetAddressBookCommandOutput,
@@ -34,6 +37,9 @@ export class GetAddressBookCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/GetConferencePreferenceCommand.ts b/clients/client-alexa-for-business/commands/GetConferencePreferenceCommand.ts
index a3a4e041bc732..a47f71096c5f6 100644
--- a/clients/client-alexa-for-business/commands/GetConferencePreferenceCommand.ts
+++ b/clients/client-alexa-for-business/commands/GetConferencePreferenceCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetConferencePreferenceCommandInput = GetConferencePreferenceRequest;
export type GetConferencePreferenceCommandOutput = GetConferencePreferenceResponse & __MetadataBearer;
+/**
+ * Retrieves the existing conference preferences.
+ */
export class GetConferencePreferenceCommand extends $Command<
GetConferencePreferenceCommandInput,
GetConferencePreferenceCommandOutput,
@@ -34,6 +37,9 @@ export class GetConferencePreferenceCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/GetConferenceProviderCommand.ts b/clients/client-alexa-for-business/commands/GetConferenceProviderCommand.ts
index 4481daa728257..a0961b1e04a97 100644
--- a/clients/client-alexa-for-business/commands/GetConferenceProviderCommand.ts
+++ b/clients/client-alexa-for-business/commands/GetConferenceProviderCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetConferenceProviderCommandInput = GetConferenceProviderRequest;
export type GetConferenceProviderCommandOutput = GetConferenceProviderResponse & __MetadataBearer;
+/**
+ * Gets details about a specific conference provider.
+ */
export class GetConferenceProviderCommand extends $Command<
GetConferenceProviderCommandInput,
GetConferenceProviderCommandOutput,
@@ -34,6 +37,9 @@ export class GetConferenceProviderCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/GetContactCommand.ts b/clients/client-alexa-for-business/commands/GetContactCommand.ts
index 72f386811676d..47373ecfab170 100644
--- a/clients/client-alexa-for-business/commands/GetContactCommand.ts
+++ b/clients/client-alexa-for-business/commands/GetContactCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetContactCommandInput = GetContactRequest;
export type GetContactCommandOutput = GetContactResponse & __MetadataBearer;
+/**
+ * Gets the contact details by the contact ARN.
+ */
export class GetContactCommand extends $Command<
GetContactCommandInput,
GetContactCommandOutput,
@@ -34,6 +37,9 @@ export class GetContactCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/GetDeviceCommand.ts b/clients/client-alexa-for-business/commands/GetDeviceCommand.ts
index 5a442ab8ae3dc..8cc14350bb584 100644
--- a/clients/client-alexa-for-business/commands/GetDeviceCommand.ts
+++ b/clients/client-alexa-for-business/commands/GetDeviceCommand.ts
@@ -17,6 +17,9 @@ import {
export type GetDeviceCommandInput = GetDeviceRequest;
export type GetDeviceCommandOutput = GetDeviceResponse & __MetadataBearer;
+/**
+ * Gets the details of a device by device ARN.
+ */
export class GetDeviceCommand extends $Command<
GetDeviceCommandInput,
GetDeviceCommandOutput,
@@ -31,6 +34,9 @@ export class GetDeviceCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/GetGatewayCommand.ts b/clients/client-alexa-for-business/commands/GetGatewayCommand.ts
index 5088dad878bf7..698712577f3ed 100644
--- a/clients/client-alexa-for-business/commands/GetGatewayCommand.ts
+++ b/clients/client-alexa-for-business/commands/GetGatewayCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetGatewayCommandInput = GetGatewayRequest;
export type GetGatewayCommandOutput = GetGatewayResponse & __MetadataBearer;
+/**
+ * Retrieves the details of a gateway.
+ */
export class GetGatewayCommand extends $Command<
GetGatewayCommandInput,
GetGatewayCommandOutput,
@@ -34,6 +37,9 @@ export class GetGatewayCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/GetGatewayGroupCommand.ts b/clients/client-alexa-for-business/commands/GetGatewayGroupCommand.ts
index 6973f36751c18..80f980f5125f9 100644
--- a/clients/client-alexa-for-business/commands/GetGatewayGroupCommand.ts
+++ b/clients/client-alexa-for-business/commands/GetGatewayGroupCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetGatewayGroupCommandInput = GetGatewayGroupRequest;
export type GetGatewayGroupCommandOutput = GetGatewayGroupResponse & __MetadataBearer;
+/**
+ * Retrieves the details of a gateway group.
+ */
export class GetGatewayGroupCommand extends $Command<
GetGatewayGroupCommandInput,
GetGatewayGroupCommandOutput,
@@ -34,6 +37,9 @@ export class GetGatewayGroupCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/GetInvitationConfigurationCommand.ts b/clients/client-alexa-for-business/commands/GetInvitationConfigurationCommand.ts
index b1f31c1111457..d7b68e8b2de8a 100644
--- a/clients/client-alexa-for-business/commands/GetInvitationConfigurationCommand.ts
+++ b/clients/client-alexa-for-business/commands/GetInvitationConfigurationCommand.ts
@@ -20,6 +20,10 @@ import {
export type GetInvitationConfigurationCommandInput = GetInvitationConfigurationRequest;
export type GetInvitationConfigurationCommandOutput = GetInvitationConfigurationResponse & __MetadataBearer;
+/**
+ * Retrieves the configured values for the user enrollment invitation email
+ * template.
+ */
export class GetInvitationConfigurationCommand extends $Command<
GetInvitationConfigurationCommandInput,
GetInvitationConfigurationCommandOutput,
@@ -34,6 +38,9 @@ export class GetInvitationConfigurationCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/GetNetworkProfileCommand.ts b/clients/client-alexa-for-business/commands/GetNetworkProfileCommand.ts
index 38ec6d8862b27..37cf276c6cd04 100644
--- a/clients/client-alexa-for-business/commands/GetNetworkProfileCommand.ts
+++ b/clients/client-alexa-for-business/commands/GetNetworkProfileCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetNetworkProfileCommandInput = GetNetworkProfileRequest;
export type GetNetworkProfileCommandOutput = GetNetworkProfileResponse & __MetadataBearer;
+/**
+ * Gets the network profile details by the network profile ARN.
+ */
export class GetNetworkProfileCommand extends $Command<
GetNetworkProfileCommandInput,
GetNetworkProfileCommandOutput,
@@ -34,6 +37,9 @@ export class GetNetworkProfileCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/GetProfileCommand.ts b/clients/client-alexa-for-business/commands/GetProfileCommand.ts
index c95a052f690bd..aee8cee39b895 100644
--- a/clients/client-alexa-for-business/commands/GetProfileCommand.ts
+++ b/clients/client-alexa-for-business/commands/GetProfileCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetProfileCommandInput = GetProfileRequest;
export type GetProfileCommandOutput = GetProfileResponse & __MetadataBearer;
+/**
+ * Gets the details of a room profile by profile ARN.
+ */
export class GetProfileCommand extends $Command<
GetProfileCommandInput,
GetProfileCommandOutput,
@@ -34,6 +37,9 @@ export class GetProfileCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/GetRoomCommand.ts b/clients/client-alexa-for-business/commands/GetRoomCommand.ts
index 2410ea0e0859c..062870f4ec4c6 100644
--- a/clients/client-alexa-for-business/commands/GetRoomCommand.ts
+++ b/clients/client-alexa-for-business/commands/GetRoomCommand.ts
@@ -17,6 +17,9 @@ import {
export type GetRoomCommandInput = GetRoomRequest;
export type GetRoomCommandOutput = GetRoomResponse & __MetadataBearer;
+/**
+ * Gets room details by room ARN.
+ */
export class GetRoomCommand extends $Command<
GetRoomCommandInput,
GetRoomCommandOutput,
@@ -31,6 +34,9 @@ export class GetRoomCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/GetRoomSkillParameterCommand.ts b/clients/client-alexa-for-business/commands/GetRoomSkillParameterCommand.ts
index 6c4a17451ac30..f1fad80c501eb 100644
--- a/clients/client-alexa-for-business/commands/GetRoomSkillParameterCommand.ts
+++ b/clients/client-alexa-for-business/commands/GetRoomSkillParameterCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetRoomSkillParameterCommandInput = GetRoomSkillParameterRequest;
export type GetRoomSkillParameterCommandOutput = GetRoomSkillParameterResponse & __MetadataBearer;
+/**
+ * Gets room skill parameter details by room, skill, and parameter key ARN.
+ */
export class GetRoomSkillParameterCommand extends $Command<
GetRoomSkillParameterCommandInput,
GetRoomSkillParameterCommandOutput,
@@ -34,6 +37,9 @@ export class GetRoomSkillParameterCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/GetSkillGroupCommand.ts b/clients/client-alexa-for-business/commands/GetSkillGroupCommand.ts
index 1f06d947f79c5..79f043495a091 100644
--- a/clients/client-alexa-for-business/commands/GetSkillGroupCommand.ts
+++ b/clients/client-alexa-for-business/commands/GetSkillGroupCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetSkillGroupCommandInput = GetSkillGroupRequest;
export type GetSkillGroupCommandOutput = GetSkillGroupResponse & __MetadataBearer;
+/**
+ * Gets skill group details by skill group ARN.
+ */
export class GetSkillGroupCommand extends $Command<
GetSkillGroupCommandInput,
GetSkillGroupCommandOutput,
@@ -34,6 +37,9 @@ export class GetSkillGroupCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/ListBusinessReportSchedulesCommand.ts b/clients/client-alexa-for-business/commands/ListBusinessReportSchedulesCommand.ts
index bd1800641f955..6690c8f47c461 100644
--- a/clients/client-alexa-for-business/commands/ListBusinessReportSchedulesCommand.ts
+++ b/clients/client-alexa-for-business/commands/ListBusinessReportSchedulesCommand.ts
@@ -20,6 +20,9 @@ import {
export type ListBusinessReportSchedulesCommandInput = ListBusinessReportSchedulesRequest;
export type ListBusinessReportSchedulesCommandOutput = ListBusinessReportSchedulesResponse & __MetadataBearer;
+/**
+ * Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.
+ */
export class ListBusinessReportSchedulesCommand extends $Command<
ListBusinessReportSchedulesCommandInput,
ListBusinessReportSchedulesCommandOutput,
@@ -34,6 +37,9 @@ export class ListBusinessReportSchedulesCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/ListConferenceProvidersCommand.ts b/clients/client-alexa-for-business/commands/ListConferenceProvidersCommand.ts
index 8b7d7f721ae45..9c0c6055c1066 100644
--- a/clients/client-alexa-for-business/commands/ListConferenceProvidersCommand.ts
+++ b/clients/client-alexa-for-business/commands/ListConferenceProvidersCommand.ts
@@ -20,6 +20,9 @@ import {
export type ListConferenceProvidersCommandInput = ListConferenceProvidersRequest;
export type ListConferenceProvidersCommandOutput = ListConferenceProvidersResponse & __MetadataBearer;
+/**
+ * Lists conference providers under a specific AWS account.
+ */
export class ListConferenceProvidersCommand extends $Command<
ListConferenceProvidersCommandInput,
ListConferenceProvidersCommandOutput,
@@ -34,6 +37,9 @@ export class ListConferenceProvidersCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/ListDeviceEventsCommand.ts b/clients/client-alexa-for-business/commands/ListDeviceEventsCommand.ts
index 0108797bb0ddf..d9d91aa7f75e2 100644
--- a/clients/client-alexa-for-business/commands/ListDeviceEventsCommand.ts
+++ b/clients/client-alexa-for-business/commands/ListDeviceEventsCommand.ts
@@ -20,6 +20,10 @@ import {
export type ListDeviceEventsCommandInput = ListDeviceEventsRequest;
export type ListDeviceEventsCommandOutput = ListDeviceEventsResponse & __MetadataBearer;
+/**
+ * Lists the device event history, including device connection status, for up to 30
+ * days.
+ */
export class ListDeviceEventsCommand extends $Command<
ListDeviceEventsCommandInput,
ListDeviceEventsCommandOutput,
@@ -34,6 +38,9 @@ export class ListDeviceEventsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/ListGatewayGroupsCommand.ts b/clients/client-alexa-for-business/commands/ListGatewayGroupsCommand.ts
index 013b5c570a3a6..394c1cdd5778d 100644
--- a/clients/client-alexa-for-business/commands/ListGatewayGroupsCommand.ts
+++ b/clients/client-alexa-for-business/commands/ListGatewayGroupsCommand.ts
@@ -20,6 +20,10 @@ import {
export type ListGatewayGroupsCommandInput = ListGatewayGroupsRequest;
export type ListGatewayGroupsCommandOutput = ListGatewayGroupsResponse & __MetadataBearer;
+/**
+ * Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of
+ * a specific gateway group.
+ */
export class ListGatewayGroupsCommand extends $Command<
ListGatewayGroupsCommandInput,
ListGatewayGroupsCommandOutput,
@@ -34,6 +38,9 @@ export class ListGatewayGroupsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/ListGatewaysCommand.ts b/clients/client-alexa-for-business/commands/ListGatewaysCommand.ts
index 66eecd8a6cae5..5da51dd6ca102 100644
--- a/clients/client-alexa-for-business/commands/ListGatewaysCommand.ts
+++ b/clients/client-alexa-for-business/commands/ListGatewaysCommand.ts
@@ -20,6 +20,11 @@ import {
export type ListGatewaysCommandInput = ListGatewaysRequest;
export type ListGatewaysCommandOutput = ListGatewaysResponse & __MetadataBearer;
+/**
+ * Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific
+ * gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries
+ * of gateways that are associated with that gateway group ARN.
+ */
export class ListGatewaysCommand extends $Command<
ListGatewaysCommandInput,
ListGatewaysCommandOutput,
@@ -34,6 +39,9 @@ export class ListGatewaysCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/ListSkillsCommand.ts b/clients/client-alexa-for-business/commands/ListSkillsCommand.ts
index 88af7bff7ad5a..9f288d5de72dd 100644
--- a/clients/client-alexa-for-business/commands/ListSkillsCommand.ts
+++ b/clients/client-alexa-for-business/commands/ListSkillsCommand.ts
@@ -20,6 +20,9 @@ import {
export type ListSkillsCommandInput = ListSkillsRequest;
export type ListSkillsCommandOutput = ListSkillsResponse & __MetadataBearer;
+/**
+ * Lists all enabled skills in a specific skill group.
+ */
export class ListSkillsCommand extends $Command<
ListSkillsCommandInput,
ListSkillsCommandOutput,
@@ -34,6 +37,9 @@ export class ListSkillsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/ListSkillsStoreCategoriesCommand.ts b/clients/client-alexa-for-business/commands/ListSkillsStoreCategoriesCommand.ts
index 1cd96411d1e83..82b1f7395e1aa 100644
--- a/clients/client-alexa-for-business/commands/ListSkillsStoreCategoriesCommand.ts
+++ b/clients/client-alexa-for-business/commands/ListSkillsStoreCategoriesCommand.ts
@@ -20,6 +20,9 @@ import {
export type ListSkillsStoreCategoriesCommandInput = ListSkillsStoreCategoriesRequest;
export type ListSkillsStoreCategoriesCommandOutput = ListSkillsStoreCategoriesResponse & __MetadataBearer;
+/**
+ * Lists all categories in the Alexa skill store.
+ */
export class ListSkillsStoreCategoriesCommand extends $Command<
ListSkillsStoreCategoriesCommandInput,
ListSkillsStoreCategoriesCommandOutput,
@@ -34,6 +37,9 @@ export class ListSkillsStoreCategoriesCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/ListSkillsStoreSkillsByCategoryCommand.ts b/clients/client-alexa-for-business/commands/ListSkillsStoreSkillsByCategoryCommand.ts
index 1614878ebc0a7..8d464f59493e4 100644
--- a/clients/client-alexa-for-business/commands/ListSkillsStoreSkillsByCategoryCommand.ts
+++ b/clients/client-alexa-for-business/commands/ListSkillsStoreSkillsByCategoryCommand.ts
@@ -20,6 +20,9 @@ import {
export type ListSkillsStoreSkillsByCategoryCommandInput = ListSkillsStoreSkillsByCategoryRequest;
export type ListSkillsStoreSkillsByCategoryCommandOutput = ListSkillsStoreSkillsByCategoryResponse & __MetadataBearer;
+/**
+ * Lists all skills in the Alexa skill store by category.
+ */
export class ListSkillsStoreSkillsByCategoryCommand extends $Command<
ListSkillsStoreSkillsByCategoryCommandInput,
ListSkillsStoreSkillsByCategoryCommandOutput,
@@ -34,6 +37,9 @@ export class ListSkillsStoreSkillsByCategoryCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/ListSmartHomeAppliancesCommand.ts b/clients/client-alexa-for-business/commands/ListSmartHomeAppliancesCommand.ts
index fae038bf3005b..72f5e1279fe71 100644
--- a/clients/client-alexa-for-business/commands/ListSmartHomeAppliancesCommand.ts
+++ b/clients/client-alexa-for-business/commands/ListSmartHomeAppliancesCommand.ts
@@ -20,6 +20,9 @@ import {
export type ListSmartHomeAppliancesCommandInput = ListSmartHomeAppliancesRequest;
export type ListSmartHomeAppliancesCommandOutput = ListSmartHomeAppliancesResponse & __MetadataBearer;
+/**
+ * Lists all of the smart home appliances associated with a room.
+ */
export class ListSmartHomeAppliancesCommand extends $Command<
ListSmartHomeAppliancesCommandInput,
ListSmartHomeAppliancesCommandOutput,
@@ -34,6 +37,9 @@ export class ListSmartHomeAppliancesCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/ListTagsCommand.ts b/clients/client-alexa-for-business/commands/ListTagsCommand.ts
index 1c40dad3e1e10..fbdedec916fef 100644
--- a/clients/client-alexa-for-business/commands/ListTagsCommand.ts
+++ b/clients/client-alexa-for-business/commands/ListTagsCommand.ts
@@ -17,6 +17,9 @@ import {
export type ListTagsCommandInput = ListTagsRequest;
export type ListTagsCommandOutput = ListTagsResponse & __MetadataBearer;
+/**
+ * Lists all tags for the specified resource.
+ */
export class ListTagsCommand extends $Command<
ListTagsCommandInput,
ListTagsCommandOutput,
@@ -31,6 +34,9 @@ export class ListTagsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/PutConferencePreferenceCommand.ts b/clients/client-alexa-for-business/commands/PutConferencePreferenceCommand.ts
index 9eb7c76712493..0ec6e1ba431b9 100644
--- a/clients/client-alexa-for-business/commands/PutConferencePreferenceCommand.ts
+++ b/clients/client-alexa-for-business/commands/PutConferencePreferenceCommand.ts
@@ -20,6 +20,10 @@ import {
export type PutConferencePreferenceCommandInput = PutConferencePreferenceRequest;
export type PutConferencePreferenceCommandOutput = PutConferencePreferenceResponse & __MetadataBearer;
+/**
+ * Sets the conference preferences on a specific conference provider at the account
+ * level.
+ */
export class PutConferencePreferenceCommand extends $Command<
PutConferencePreferenceCommandInput,
PutConferencePreferenceCommandOutput,
@@ -34,6 +38,9 @@ export class PutConferencePreferenceCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/PutInvitationConfigurationCommand.ts b/clients/client-alexa-for-business/commands/PutInvitationConfigurationCommand.ts
index 518583b0023d1..b766de45b4ef3 100644
--- a/clients/client-alexa-for-business/commands/PutInvitationConfigurationCommand.ts
+++ b/clients/client-alexa-for-business/commands/PutInvitationConfigurationCommand.ts
@@ -20,6 +20,10 @@ import {
export type PutInvitationConfigurationCommandInput = PutInvitationConfigurationRequest;
export type PutInvitationConfigurationCommandOutput = PutInvitationConfigurationResponse & __MetadataBearer;
+/**
+ * Configures the email template for the user enrollment invitation with the specified
+ * attributes.
+ */
export class PutInvitationConfigurationCommand extends $Command<
PutInvitationConfigurationCommandInput,
PutInvitationConfigurationCommandOutput,
@@ -34,6 +38,9 @@ export class PutInvitationConfigurationCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/PutRoomSkillParameterCommand.ts b/clients/client-alexa-for-business/commands/PutRoomSkillParameterCommand.ts
index 9e0e0ad08bbb2..57486cfe3b791 100644
--- a/clients/client-alexa-for-business/commands/PutRoomSkillParameterCommand.ts
+++ b/clients/client-alexa-for-business/commands/PutRoomSkillParameterCommand.ts
@@ -20,6 +20,10 @@ import {
export type PutRoomSkillParameterCommandInput = PutRoomSkillParameterRequest;
export type PutRoomSkillParameterCommandOutput = PutRoomSkillParameterResponse & __MetadataBearer;
+/**
+ * Updates room skill parameter details by room, skill, and parameter key ID. Not all
+ * skills have a room skill parameter.
+ */
export class PutRoomSkillParameterCommand extends $Command<
PutRoomSkillParameterCommandInput,
PutRoomSkillParameterCommandOutput,
@@ -34,6 +38,9 @@ export class PutRoomSkillParameterCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/PutSkillAuthorizationCommand.ts b/clients/client-alexa-for-business/commands/PutSkillAuthorizationCommand.ts
index a0ee97d7d7efd..52bd5a672564a 100644
--- a/clients/client-alexa-for-business/commands/PutSkillAuthorizationCommand.ts
+++ b/clients/client-alexa-for-business/commands/PutSkillAuthorizationCommand.ts
@@ -20,6 +20,11 @@ import {
export type PutSkillAuthorizationCommandInput = PutSkillAuthorizationRequest;
export type PutSkillAuthorizationCommandOutput = PutSkillAuthorizationResponse & __MetadataBearer;
+/**
+ * Links a user's account to a third-party skill provider. If this API operation is
+ * called by an assumed IAM role, the skill being linked must be a private skill. Also, the
+ * skill must be owned by the AWS account that assumed the IAM role.
+ */
export class PutSkillAuthorizationCommand extends $Command<
PutSkillAuthorizationCommandInput,
PutSkillAuthorizationCommandOutput,
@@ -34,6 +39,9 @@ export class PutSkillAuthorizationCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/RegisterAVSDeviceCommand.ts b/clients/client-alexa-for-business/commands/RegisterAVSDeviceCommand.ts
index 32f80cd8c79bd..9489dfb232804 100644
--- a/clients/client-alexa-for-business/commands/RegisterAVSDeviceCommand.ts
+++ b/clients/client-alexa-for-business/commands/RegisterAVSDeviceCommand.ts
@@ -20,6 +20,10 @@ import {
export type RegisterAVSDeviceCommandInput = RegisterAVSDeviceRequest;
export type RegisterAVSDeviceCommandOutput = RegisterAVSDeviceResponse & __MetadataBearer;
+/**
+ * Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM)
+ * using Alexa Voice Service (AVS).
+ */
export class RegisterAVSDeviceCommand extends $Command<
RegisterAVSDeviceCommandInput,
RegisterAVSDeviceCommandOutput,
@@ -34,6 +38,9 @@ export class RegisterAVSDeviceCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/RejectSkillCommand.ts b/clients/client-alexa-for-business/commands/RejectSkillCommand.ts
index 5b6686a24f2f1..1540c989045a2 100644
--- a/clients/client-alexa-for-business/commands/RejectSkillCommand.ts
+++ b/clients/client-alexa-for-business/commands/RejectSkillCommand.ts
@@ -20,6 +20,11 @@ import {
export type RejectSkillCommandInput = RejectSkillRequest;
export type RejectSkillCommandOutput = RejectSkillResponse & __MetadataBearer;
+/**
+ * Disassociates a skill from the organization under a user's AWS account. If the skill
+ * is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill
+ * that is rejected can be added later by calling the ApproveSkill API.
+ */
export class RejectSkillCommand extends $Command<
RejectSkillCommandInput,
RejectSkillCommandOutput,
@@ -34,6 +39,9 @@ export class RejectSkillCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/ResolveRoomCommand.ts b/clients/client-alexa-for-business/commands/ResolveRoomCommand.ts
index 7cf107301b5ed..873a191eb29be 100644
--- a/clients/client-alexa-for-business/commands/ResolveRoomCommand.ts
+++ b/clients/client-alexa-for-business/commands/ResolveRoomCommand.ts
@@ -20,6 +20,10 @@ import {
export type ResolveRoomCommandInput = ResolveRoomRequest;
export type ResolveRoomCommandOutput = ResolveRoomResponse & __MetadataBearer;
+/**
+ * Determines the details for the room from which a skill request was invoked. This
+ * operation is used by skill developers.
+ */
export class ResolveRoomCommand extends $Command<
ResolveRoomCommandInput,
ResolveRoomCommandOutput,
@@ -34,6 +38,9 @@ export class ResolveRoomCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/RevokeInvitationCommand.ts b/clients/client-alexa-for-business/commands/RevokeInvitationCommand.ts
index ed045cbf9b821..602b26aa21e24 100644
--- a/clients/client-alexa-for-business/commands/RevokeInvitationCommand.ts
+++ b/clients/client-alexa-for-business/commands/RevokeInvitationCommand.ts
@@ -20,6 +20,9 @@ import {
export type RevokeInvitationCommandInput = RevokeInvitationRequest;
export type RevokeInvitationCommandOutput = RevokeInvitationResponse & __MetadataBearer;
+/**
+ * Revokes an invitation and invalidates the enrollment URL.
+ */
export class RevokeInvitationCommand extends $Command<
RevokeInvitationCommandInput,
RevokeInvitationCommandOutput,
@@ -34,6 +37,9 @@ export class RevokeInvitationCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/SearchAddressBooksCommand.ts b/clients/client-alexa-for-business/commands/SearchAddressBooksCommand.ts
index e45b61903458f..c4be560295ca7 100644
--- a/clients/client-alexa-for-business/commands/SearchAddressBooksCommand.ts
+++ b/clients/client-alexa-for-business/commands/SearchAddressBooksCommand.ts
@@ -20,6 +20,10 @@ import {
export type SearchAddressBooksCommandInput = SearchAddressBooksRequest;
export type SearchAddressBooksCommandOutput = SearchAddressBooksResponse & __MetadataBearer;
+/**
+ * Searches address books and lists the ones that meet a set of filter and sort
+ * criteria.
+ */
export class SearchAddressBooksCommand extends $Command<
SearchAddressBooksCommandInput,
SearchAddressBooksCommandOutput,
@@ -34,6 +38,9 @@ export class SearchAddressBooksCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/SearchContactsCommand.ts b/clients/client-alexa-for-business/commands/SearchContactsCommand.ts
index c4c2492ec9782..f280de552611e 100644
--- a/clients/client-alexa-for-business/commands/SearchContactsCommand.ts
+++ b/clients/client-alexa-for-business/commands/SearchContactsCommand.ts
@@ -20,6 +20,10 @@ import {
export type SearchContactsCommandInput = SearchContactsRequest;
export type SearchContactsCommandOutput = SearchContactsResponse & __MetadataBearer;
+/**
+ * Searches contacts and lists the ones that meet a set of filter and sort
+ * criteria.
+ */
export class SearchContactsCommand extends $Command<
SearchContactsCommandInput,
SearchContactsCommandOutput,
@@ -34,6 +38,9 @@ export class SearchContactsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/SearchDevicesCommand.ts b/clients/client-alexa-for-business/commands/SearchDevicesCommand.ts
index 5d128407de2f1..d5e98578b1b83 100644
--- a/clients/client-alexa-for-business/commands/SearchDevicesCommand.ts
+++ b/clients/client-alexa-for-business/commands/SearchDevicesCommand.ts
@@ -20,6 +20,9 @@ import {
export type SearchDevicesCommandInput = SearchDevicesRequest;
export type SearchDevicesCommandOutput = SearchDevicesResponse & __MetadataBearer;
+/**
+ * Searches devices and lists the ones that meet a set of filter criteria.
+ */
export class SearchDevicesCommand extends $Command<
SearchDevicesCommandInput,
SearchDevicesCommandOutput,
@@ -34,6 +37,9 @@ export class SearchDevicesCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/SearchNetworkProfilesCommand.ts b/clients/client-alexa-for-business/commands/SearchNetworkProfilesCommand.ts
index d87b8dfe487b4..8288a11871ec7 100644
--- a/clients/client-alexa-for-business/commands/SearchNetworkProfilesCommand.ts
+++ b/clients/client-alexa-for-business/commands/SearchNetworkProfilesCommand.ts
@@ -20,6 +20,10 @@ import {
export type SearchNetworkProfilesCommandInput = SearchNetworkProfilesRequest;
export type SearchNetworkProfilesCommandOutput = SearchNetworkProfilesResponse & __MetadataBearer;
+/**
+ * Searches network profiles and lists the ones that meet a set of filter and sort
+ * criteria.
+ */
export class SearchNetworkProfilesCommand extends $Command<
SearchNetworkProfilesCommandInput,
SearchNetworkProfilesCommandOutput,
@@ -34,6 +38,9 @@ export class SearchNetworkProfilesCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/SearchProfilesCommand.ts b/clients/client-alexa-for-business/commands/SearchProfilesCommand.ts
index ad86432cf82e4..0ee5878308baa 100644
--- a/clients/client-alexa-for-business/commands/SearchProfilesCommand.ts
+++ b/clients/client-alexa-for-business/commands/SearchProfilesCommand.ts
@@ -20,6 +20,10 @@ import {
export type SearchProfilesCommandInput = SearchProfilesRequest;
export type SearchProfilesCommandOutput = SearchProfilesResponse & __MetadataBearer;
+/**
+ * Searches room profiles and lists the ones that meet a set of filter
+ * criteria.
+ */
export class SearchProfilesCommand extends $Command<
SearchProfilesCommandInput,
SearchProfilesCommandOutput,
@@ -34,6 +38,9 @@ export class SearchProfilesCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/SearchRoomsCommand.ts b/clients/client-alexa-for-business/commands/SearchRoomsCommand.ts
index 94ba322ddd711..7514a2983ed4e 100644
--- a/clients/client-alexa-for-business/commands/SearchRoomsCommand.ts
+++ b/clients/client-alexa-for-business/commands/SearchRoomsCommand.ts
@@ -20,6 +20,10 @@ import {
export type SearchRoomsCommandInput = SearchRoomsRequest;
export type SearchRoomsCommandOutput = SearchRoomsResponse & __MetadataBearer;
+/**
+ * Searches rooms and lists the ones that meet a set of filter and sort
+ * criteria.
+ */
export class SearchRoomsCommand extends $Command<
SearchRoomsCommandInput,
SearchRoomsCommandOutput,
@@ -34,6 +38,9 @@ export class SearchRoomsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/SearchSkillGroupsCommand.ts b/clients/client-alexa-for-business/commands/SearchSkillGroupsCommand.ts
index 42eab41987ee5..f0b022eeed407 100644
--- a/clients/client-alexa-for-business/commands/SearchSkillGroupsCommand.ts
+++ b/clients/client-alexa-for-business/commands/SearchSkillGroupsCommand.ts
@@ -20,6 +20,10 @@ import {
export type SearchSkillGroupsCommandInput = SearchSkillGroupsRequest;
export type SearchSkillGroupsCommandOutput = SearchSkillGroupsResponse & __MetadataBearer;
+/**
+ * Searches skill groups and lists the ones that meet a set of filter and sort
+ * criteria.
+ */
export class SearchSkillGroupsCommand extends $Command<
SearchSkillGroupsCommandInput,
SearchSkillGroupsCommandOutput,
@@ -34,6 +38,9 @@ export class SearchSkillGroupsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/SearchUsersCommand.ts b/clients/client-alexa-for-business/commands/SearchUsersCommand.ts
index a43b9885035fd..c26e5c9abc4ac 100644
--- a/clients/client-alexa-for-business/commands/SearchUsersCommand.ts
+++ b/clients/client-alexa-for-business/commands/SearchUsersCommand.ts
@@ -20,6 +20,10 @@ import {
export type SearchUsersCommandInput = SearchUsersRequest;
export type SearchUsersCommandOutput = SearchUsersResponse & __MetadataBearer;
+/**
+ * Searches users and lists the ones that meet a set of filter and sort
+ * criteria.
+ */
export class SearchUsersCommand extends $Command<
SearchUsersCommandInput,
SearchUsersCommandOutput,
@@ -34,6 +38,9 @@ export class SearchUsersCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/SendAnnouncementCommand.ts b/clients/client-alexa-for-business/commands/SendAnnouncementCommand.ts
index 81901106fe485..d3d248e7661fe 100644
--- a/clients/client-alexa-for-business/commands/SendAnnouncementCommand.ts
+++ b/clients/client-alexa-for-business/commands/SendAnnouncementCommand.ts
@@ -20,6 +20,10 @@ import {
export type SendAnnouncementCommandInput = SendAnnouncementRequest;
export type SendAnnouncementCommandOutput = SendAnnouncementResponse & __MetadataBearer;
+/**
+ * Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that
+ * are identified by a search or filter.
+ */
export class SendAnnouncementCommand extends $Command<
SendAnnouncementCommandInput,
SendAnnouncementCommandOutput,
@@ -34,6 +38,9 @@ export class SendAnnouncementCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/SendInvitationCommand.ts b/clients/client-alexa-for-business/commands/SendInvitationCommand.ts
index df035ee420f43..3c98afe0a3253 100644
--- a/clients/client-alexa-for-business/commands/SendInvitationCommand.ts
+++ b/clients/client-alexa-for-business/commands/SendInvitationCommand.ts
@@ -20,6 +20,10 @@ import {
export type SendInvitationCommandInput = SendInvitationRequest;
export type SendInvitationCommandOutput = SendInvitationResponse & __MetadataBearer;
+/**
+ * Sends an enrollment invitation email with a URL to a user. The URL is valid for 30
+ * days or until you call this operation again, whichever comes first.
+ */
export class SendInvitationCommand extends $Command<
SendInvitationCommandInput,
SendInvitationCommandOutput,
@@ -34,6 +38,9 @@ export class SendInvitationCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/StartDeviceSyncCommand.ts b/clients/client-alexa-for-business/commands/StartDeviceSyncCommand.ts
index 70577e0f9b4e4..535e11c1bd1e8 100644
--- a/clients/client-alexa-for-business/commands/StartDeviceSyncCommand.ts
+++ b/clients/client-alexa-for-business/commands/StartDeviceSyncCommand.ts
@@ -20,6 +20,30 @@ import {
export type StartDeviceSyncCommandInput = StartDeviceSyncRequest;
export type StartDeviceSyncCommandOutput = StartDeviceSyncResponse & __MetadataBearer;
+/**
+ * Resets a device and its account to the known default settings. This clears all
+ * information and settings set by previous users in the following ways:
+ *
+ * -
+ *
Bluetooth - This unpairs all bluetooth devices paired with your echo
+ * device.
+ *
+ * -
+ *
Volume - This resets the echo device's volume to the default value.
+ *
+ * -
+ *
Notifications - This clears all notifications from your echo device.
+ *
+ * -
+ *
Lists - This clears all to-do items from your echo device.
+ *
+ * -
+ *
Settings - This internally syncs the room's profile (if the device is assigned to
+ * a room), contacts, address books, delegation access for account linking, and
+ * communications (if enabled on the room profile).
+ *
+ *
+ */
export class StartDeviceSyncCommand extends $Command<
StartDeviceSyncCommandInput,
StartDeviceSyncCommandOutput,
@@ -34,6 +58,9 @@ export class StartDeviceSyncCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/StartSmartHomeApplianceDiscoveryCommand.ts b/clients/client-alexa-for-business/commands/StartSmartHomeApplianceDiscoveryCommand.ts
index c4269666789d6..658bc593f456d 100644
--- a/clients/client-alexa-for-business/commands/StartSmartHomeApplianceDiscoveryCommand.ts
+++ b/clients/client-alexa-for-business/commands/StartSmartHomeApplianceDiscoveryCommand.ts
@@ -20,6 +20,10 @@ import {
export type StartSmartHomeApplianceDiscoveryCommandInput = StartSmartHomeApplianceDiscoveryRequest;
export type StartSmartHomeApplianceDiscoveryCommandOutput = StartSmartHomeApplianceDiscoveryResponse & __MetadataBearer;
+/**
+ * Initiates the discovery of any smart home appliances associated with the
+ * room.
+ */
export class StartSmartHomeApplianceDiscoveryCommand extends $Command<
StartSmartHomeApplianceDiscoveryCommandInput,
StartSmartHomeApplianceDiscoveryCommandOutput,
@@ -34,6 +38,9 @@ export class StartSmartHomeApplianceDiscoveryCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/TagResourceCommand.ts b/clients/client-alexa-for-business/commands/TagResourceCommand.ts
index d86a6dfab7cbd..b4001cca3e5b0 100644
--- a/clients/client-alexa-for-business/commands/TagResourceCommand.ts
+++ b/clients/client-alexa-for-business/commands/TagResourceCommand.ts
@@ -20,6 +20,9 @@ import {
export type TagResourceCommandInput = TagResourceRequest;
export type TagResourceCommandOutput = TagResourceResponse & __MetadataBearer;
+/**
+ * Adds metadata tags to a specified resource.
+ */
export class TagResourceCommand extends $Command<
TagResourceCommandInput,
TagResourceCommandOutput,
@@ -34,6 +37,9 @@ export class TagResourceCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/UntagResourceCommand.ts b/clients/client-alexa-for-business/commands/UntagResourceCommand.ts
index 70d8b9ad36cee..13e907431f822 100644
--- a/clients/client-alexa-for-business/commands/UntagResourceCommand.ts
+++ b/clients/client-alexa-for-business/commands/UntagResourceCommand.ts
@@ -20,6 +20,9 @@ import {
export type UntagResourceCommandInput = UntagResourceRequest;
export type UntagResourceCommandOutput = UntagResourceResponse & __MetadataBearer;
+/**
+ * Removes metadata tags from a specified resource.
+ */
export class UntagResourceCommand extends $Command<
UntagResourceCommandInput,
UntagResourceCommandOutput,
@@ -34,6 +37,9 @@ export class UntagResourceCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/UpdateAddressBookCommand.ts b/clients/client-alexa-for-business/commands/UpdateAddressBookCommand.ts
index 32fb1b83fd378..cf37b6fc6f3a6 100644
--- a/clients/client-alexa-for-business/commands/UpdateAddressBookCommand.ts
+++ b/clients/client-alexa-for-business/commands/UpdateAddressBookCommand.ts
@@ -20,6 +20,9 @@ import {
export type UpdateAddressBookCommandInput = UpdateAddressBookRequest;
export type UpdateAddressBookCommandOutput = UpdateAddressBookResponse & __MetadataBearer;
+/**
+ * Updates address book details by the address book ARN.
+ */
export class UpdateAddressBookCommand extends $Command<
UpdateAddressBookCommandInput,
UpdateAddressBookCommandOutput,
@@ -34,6 +37,9 @@ export class UpdateAddressBookCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/UpdateBusinessReportScheduleCommand.ts b/clients/client-alexa-for-business/commands/UpdateBusinessReportScheduleCommand.ts
index b85f27b833261..964a25ec6b6db 100644
--- a/clients/client-alexa-for-business/commands/UpdateBusinessReportScheduleCommand.ts
+++ b/clients/client-alexa-for-business/commands/UpdateBusinessReportScheduleCommand.ts
@@ -20,6 +20,10 @@ import {
export type UpdateBusinessReportScheduleCommandInput = UpdateBusinessReportScheduleRequest;
export type UpdateBusinessReportScheduleCommandOutput = UpdateBusinessReportScheduleResponse & __MetadataBearer;
+/**
+ * Updates the configuration of the report delivery schedule with the specified schedule
+ * ARN.
+ */
export class UpdateBusinessReportScheduleCommand extends $Command<
UpdateBusinessReportScheduleCommandInput,
UpdateBusinessReportScheduleCommandOutput,
@@ -34,6 +38,9 @@ export class UpdateBusinessReportScheduleCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/UpdateConferenceProviderCommand.ts b/clients/client-alexa-for-business/commands/UpdateConferenceProviderCommand.ts
index 109a92162a098..29e46773f3138 100644
--- a/clients/client-alexa-for-business/commands/UpdateConferenceProviderCommand.ts
+++ b/clients/client-alexa-for-business/commands/UpdateConferenceProviderCommand.ts
@@ -20,6 +20,9 @@ import {
export type UpdateConferenceProviderCommandInput = UpdateConferenceProviderRequest;
export type UpdateConferenceProviderCommandOutput = UpdateConferenceProviderResponse & __MetadataBearer;
+/**
+ * Updates an existing conference provider's settings.
+ */
export class UpdateConferenceProviderCommand extends $Command<
UpdateConferenceProviderCommandInput,
UpdateConferenceProviderCommandOutput,
@@ -34,6 +37,9 @@ export class UpdateConferenceProviderCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/UpdateContactCommand.ts b/clients/client-alexa-for-business/commands/UpdateContactCommand.ts
index cadce838c9274..2a5b8b9a6fd50 100644
--- a/clients/client-alexa-for-business/commands/UpdateContactCommand.ts
+++ b/clients/client-alexa-for-business/commands/UpdateContactCommand.ts
@@ -20,6 +20,9 @@ import {
export type UpdateContactCommandInput = UpdateContactRequest;
export type UpdateContactCommandOutput = UpdateContactResponse & __MetadataBearer;
+/**
+ * Updates the contact details by the contact ARN.
+ */
export class UpdateContactCommand extends $Command<
UpdateContactCommandInput,
UpdateContactCommandOutput,
@@ -34,6 +37,9 @@ export class UpdateContactCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/UpdateDeviceCommand.ts b/clients/client-alexa-for-business/commands/UpdateDeviceCommand.ts
index 35e96e776f846..b7a1b0763c078 100644
--- a/clients/client-alexa-for-business/commands/UpdateDeviceCommand.ts
+++ b/clients/client-alexa-for-business/commands/UpdateDeviceCommand.ts
@@ -20,6 +20,9 @@ import {
export type UpdateDeviceCommandInput = UpdateDeviceRequest;
export type UpdateDeviceCommandOutput = UpdateDeviceResponse & __MetadataBearer;
+/**
+ * Updates the device name by device ARN.
+ */
export class UpdateDeviceCommand extends $Command<
UpdateDeviceCommandInput,
UpdateDeviceCommandOutput,
@@ -34,6 +37,9 @@ export class UpdateDeviceCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/UpdateGatewayCommand.ts b/clients/client-alexa-for-business/commands/UpdateGatewayCommand.ts
index b4dd89c5156d3..e40ecdc4496b3 100644
--- a/clients/client-alexa-for-business/commands/UpdateGatewayCommand.ts
+++ b/clients/client-alexa-for-business/commands/UpdateGatewayCommand.ts
@@ -20,6 +20,10 @@ import {
export type UpdateGatewayCommandInput = UpdateGatewayRequest;
export type UpdateGatewayCommandOutput = UpdateGatewayResponse & __MetadataBearer;
+/**
+ * Updates the details of a gateway. If any optional field is not provided, the existing
+ * corresponding value is left unmodified.
+ */
export class UpdateGatewayCommand extends $Command<
UpdateGatewayCommandInput,
UpdateGatewayCommandOutput,
@@ -34,6 +38,9 @@ export class UpdateGatewayCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/UpdateGatewayGroupCommand.ts b/clients/client-alexa-for-business/commands/UpdateGatewayGroupCommand.ts
index 785a836161a5f..8cc0b4d73eb8f 100644
--- a/clients/client-alexa-for-business/commands/UpdateGatewayGroupCommand.ts
+++ b/clients/client-alexa-for-business/commands/UpdateGatewayGroupCommand.ts
@@ -20,6 +20,10 @@ import {
export type UpdateGatewayGroupCommandInput = UpdateGatewayGroupRequest;
export type UpdateGatewayGroupCommandOutput = UpdateGatewayGroupResponse & __MetadataBearer;
+/**
+ * Updates the details of a gateway group. If any optional field is not provided, the
+ * existing corresponding value is left unmodified.
+ */
export class UpdateGatewayGroupCommand extends $Command<
UpdateGatewayGroupCommandInput,
UpdateGatewayGroupCommandOutput,
@@ -34,6 +38,9 @@ export class UpdateGatewayGroupCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/UpdateNetworkProfileCommand.ts b/clients/client-alexa-for-business/commands/UpdateNetworkProfileCommand.ts
index da307cbc001ab..0e96882c3bb0b 100644
--- a/clients/client-alexa-for-business/commands/UpdateNetworkProfileCommand.ts
+++ b/clients/client-alexa-for-business/commands/UpdateNetworkProfileCommand.ts
@@ -20,6 +20,9 @@ import {
export type UpdateNetworkProfileCommandInput = UpdateNetworkProfileRequest;
export type UpdateNetworkProfileCommandOutput = UpdateNetworkProfileResponse & __MetadataBearer;
+/**
+ * Updates a network profile by the network profile ARN.
+ */
export class UpdateNetworkProfileCommand extends $Command<
UpdateNetworkProfileCommandInput,
UpdateNetworkProfileCommandOutput,
@@ -34,6 +37,9 @@ export class UpdateNetworkProfileCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/UpdateProfileCommand.ts b/clients/client-alexa-for-business/commands/UpdateProfileCommand.ts
index 28e5ab0201805..9e76f2e6aeeeb 100644
--- a/clients/client-alexa-for-business/commands/UpdateProfileCommand.ts
+++ b/clients/client-alexa-for-business/commands/UpdateProfileCommand.ts
@@ -20,6 +20,9 @@ import {
export type UpdateProfileCommandInput = UpdateProfileRequest;
export type UpdateProfileCommandOutput = UpdateProfileResponse & __MetadataBearer;
+/**
+ * Updates an existing room profile by room profile ARN.
+ */
export class UpdateProfileCommand extends $Command<
UpdateProfileCommandInput,
UpdateProfileCommandOutput,
@@ -34,6 +37,9 @@ export class UpdateProfileCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/UpdateRoomCommand.ts b/clients/client-alexa-for-business/commands/UpdateRoomCommand.ts
index 36f604f5c23a8..d8387e80f3824 100644
--- a/clients/client-alexa-for-business/commands/UpdateRoomCommand.ts
+++ b/clients/client-alexa-for-business/commands/UpdateRoomCommand.ts
@@ -20,6 +20,9 @@ import {
export type UpdateRoomCommandInput = UpdateRoomRequest;
export type UpdateRoomCommandOutput = UpdateRoomResponse & __MetadataBearer;
+/**
+ * Updates room details by room ARN.
+ */
export class UpdateRoomCommand extends $Command<
UpdateRoomCommandInput,
UpdateRoomCommandOutput,
@@ -34,6 +37,9 @@ export class UpdateRoomCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/commands/UpdateSkillGroupCommand.ts b/clients/client-alexa-for-business/commands/UpdateSkillGroupCommand.ts
index 3112014de6744..268a1010d5b8e 100644
--- a/clients/client-alexa-for-business/commands/UpdateSkillGroupCommand.ts
+++ b/clients/client-alexa-for-business/commands/UpdateSkillGroupCommand.ts
@@ -20,6 +20,9 @@ import {
export type UpdateSkillGroupCommandInput = UpdateSkillGroupRequest;
export type UpdateSkillGroupCommandOutput = UpdateSkillGroupResponse & __MetadataBearer;
+/**
+ * Updates skill group details by skill group ARN.
+ */
export class UpdateSkillGroupCommand extends $Command<
UpdateSkillGroupCommandInput,
UpdateSkillGroupCommandOutput,
@@ -34,6 +37,9 @@ export class UpdateSkillGroupCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AlexaForBusinessClientResolvedConfig,
diff --git a/clients/client-alexa-for-business/package.json b/clients/client-alexa-for-business/package.json
index 8fac7898fc760..bfd633173c453 100644
--- a/clients/client-alexa-for-business/package.json
+++ b/clients/client-alexa-for-business/package.json
@@ -3,8 +3,8 @@
"description": "AWS SDK for JavaScript Alexa For Business Client for Node.js, Browser and React Native",
"version": "1.0.0-rc.7",
"scripts": {
- "clean": "npm run remove-definitions && npm run remove-dist",
- "build-documentation": "npm run clean && typedoc ./",
+ "clean": "yarn remove-definitions && yarn remove-dist && yarn remove-documentation",
+ "build-documentation": "yarn remove-documentation && typedoc ./",
"prepublishOnly": "yarn build",
"pretest": "yarn build:cjs",
"remove-definitions": "rimraf ./types",
@@ -65,7 +65,7 @@
"@types/uuid": "^3.0.0",
"jest": "^26.1.0",
"rimraf": "^3.0.0",
- "typedoc": "^0.17.8",
+ "typedoc": "^0.19.2",
"typescript": "~4.0.2"
},
"engines": {
diff --git a/clients/client-alexa-for-business/pagination/ListBusinessReportSchedulesPaginator.ts b/clients/client-alexa-for-business/pagination/ListBusinessReportSchedulesPaginator.ts
index 216da46cde56c..d0a955bf6a0e5 100644
--- a/clients/client-alexa-for-business/pagination/ListBusinessReportSchedulesPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/ListBusinessReportSchedulesPaginator.ts
@@ -8,6 +8,9 @@ import {
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: ListBusinessReportSchedulesCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new ListBusinessReportSchedulesCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: ListBusinessReportSchedulesCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/ListConferenceProvidersPaginator.ts b/clients/client-alexa-for-business/pagination/ListConferenceProvidersPaginator.ts
index fdfad86936d88..1593cf366e5d0 100644
--- a/clients/client-alexa-for-business/pagination/ListConferenceProvidersPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/ListConferenceProvidersPaginator.ts
@@ -8,6 +8,9 @@ import {
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: ListConferenceProvidersCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new ListConferenceProvidersCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: ListConferenceProvidersCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/ListDeviceEventsPaginator.ts b/clients/client-alexa-for-business/pagination/ListDeviceEventsPaginator.ts
index 152a3a20e0813..e92b160f8a554 100644
--- a/clients/client-alexa-for-business/pagination/ListDeviceEventsPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/ListDeviceEventsPaginator.ts
@@ -8,6 +8,9 @@ import {
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: ListDeviceEventsCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new ListDeviceEventsCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: ListDeviceEventsCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/ListGatewayGroupsPaginator.ts b/clients/client-alexa-for-business/pagination/ListGatewayGroupsPaginator.ts
index a8358f64b8a4d..d5e58dd0d5269 100644
--- a/clients/client-alexa-for-business/pagination/ListGatewayGroupsPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/ListGatewayGroupsPaginator.ts
@@ -8,6 +8,9 @@ import {
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: ListGatewayGroupsCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new ListGatewayGroupsCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: ListGatewayGroupsCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/ListGatewaysPaginator.ts b/clients/client-alexa-for-business/pagination/ListGatewaysPaginator.ts
index 1838bcde90078..efa9becc73295 100644
--- a/clients/client-alexa-for-business/pagination/ListGatewaysPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/ListGatewaysPaginator.ts
@@ -8,6 +8,9 @@ import {
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: ListGatewaysCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new ListGatewaysCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: ListGatewaysCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/ListSkillsPaginator.ts b/clients/client-alexa-for-business/pagination/ListSkillsPaginator.ts
index 85e4d2b5ef5a6..281e7164337fe 100644
--- a/clients/client-alexa-for-business/pagination/ListSkillsPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/ListSkillsPaginator.ts
@@ -4,6 +4,9 @@ import { ListSkillsCommand, ListSkillsCommandInput, ListSkillsCommandOutput } fr
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: ListSkillsCommandInput,
@@ -12,6 +15,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new ListSkillsCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: ListSkillsCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/ListSkillsStoreCategoriesPaginator.ts b/clients/client-alexa-for-business/pagination/ListSkillsStoreCategoriesPaginator.ts
index 3a854e88361a4..c3e860f7dce2e 100644
--- a/clients/client-alexa-for-business/pagination/ListSkillsStoreCategoriesPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/ListSkillsStoreCategoriesPaginator.ts
@@ -8,6 +8,9 @@ import {
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: ListSkillsStoreCategoriesCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new ListSkillsStoreCategoriesCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: ListSkillsStoreCategoriesCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/ListSkillsStoreSkillsByCategoryPaginator.ts b/clients/client-alexa-for-business/pagination/ListSkillsStoreSkillsByCategoryPaginator.ts
index 6d962f7680b5f..33a16751000de 100644
--- a/clients/client-alexa-for-business/pagination/ListSkillsStoreSkillsByCategoryPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/ListSkillsStoreSkillsByCategoryPaginator.ts
@@ -8,6 +8,9 @@ import {
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: ListSkillsStoreSkillsByCategoryCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new ListSkillsStoreSkillsByCategoryCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: ListSkillsStoreSkillsByCategoryCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/ListSmartHomeAppliancesPaginator.ts b/clients/client-alexa-for-business/pagination/ListSmartHomeAppliancesPaginator.ts
index 8ecf1b4852f93..58710ae0b91c4 100644
--- a/clients/client-alexa-for-business/pagination/ListSmartHomeAppliancesPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/ListSmartHomeAppliancesPaginator.ts
@@ -8,6 +8,9 @@ import {
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: ListSmartHomeAppliancesCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new ListSmartHomeAppliancesCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: ListSmartHomeAppliancesCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/ListTagsPaginator.ts b/clients/client-alexa-for-business/pagination/ListTagsPaginator.ts
index 68346a1e422d7..82c8d6ea22b96 100644
--- a/clients/client-alexa-for-business/pagination/ListTagsPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/ListTagsPaginator.ts
@@ -4,6 +4,9 @@ import { ListTagsCommand, ListTagsCommandInput, ListTagsCommandOutput } from "..
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: ListTagsCommandInput,
@@ -12,6 +15,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new ListTagsCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: ListTagsCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/SearchAddressBooksPaginator.ts b/clients/client-alexa-for-business/pagination/SearchAddressBooksPaginator.ts
index bc5b0ef83628d..c282380885c08 100644
--- a/clients/client-alexa-for-business/pagination/SearchAddressBooksPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/SearchAddressBooksPaginator.ts
@@ -8,6 +8,9 @@ import {
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: SearchAddressBooksCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new SearchAddressBooksCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: SearchAddressBooksCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/SearchContactsPaginator.ts b/clients/client-alexa-for-business/pagination/SearchContactsPaginator.ts
index d518030ea6422..cbfb5c4ebfcae 100644
--- a/clients/client-alexa-for-business/pagination/SearchContactsPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/SearchContactsPaginator.ts
@@ -8,6 +8,9 @@ import {
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: SearchContactsCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new SearchContactsCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: SearchContactsCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/SearchDevicesPaginator.ts b/clients/client-alexa-for-business/pagination/SearchDevicesPaginator.ts
index 52ed3cd7a8c9d..08bc10a7a0c7e 100644
--- a/clients/client-alexa-for-business/pagination/SearchDevicesPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/SearchDevicesPaginator.ts
@@ -8,6 +8,9 @@ import {
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: SearchDevicesCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new SearchDevicesCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: SearchDevicesCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/SearchNetworkProfilesPaginator.ts b/clients/client-alexa-for-business/pagination/SearchNetworkProfilesPaginator.ts
index ae25527e6bcae..6e5759d8f068f 100644
--- a/clients/client-alexa-for-business/pagination/SearchNetworkProfilesPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/SearchNetworkProfilesPaginator.ts
@@ -8,6 +8,9 @@ import {
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: SearchNetworkProfilesCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new SearchNetworkProfilesCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: SearchNetworkProfilesCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/SearchProfilesPaginator.ts b/clients/client-alexa-for-business/pagination/SearchProfilesPaginator.ts
index aa28ea9e7f5e8..9849184b78449 100644
--- a/clients/client-alexa-for-business/pagination/SearchProfilesPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/SearchProfilesPaginator.ts
@@ -8,6 +8,9 @@ import {
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: SearchProfilesCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new SearchProfilesCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: SearchProfilesCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/SearchRoomsPaginator.ts b/clients/client-alexa-for-business/pagination/SearchRoomsPaginator.ts
index 0cee511b54d79..af64ab1da5d56 100644
--- a/clients/client-alexa-for-business/pagination/SearchRoomsPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/SearchRoomsPaginator.ts
@@ -4,6 +4,9 @@ import { SearchRoomsCommand, SearchRoomsCommandInput, SearchRoomsCommandOutput }
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: SearchRoomsCommandInput,
@@ -12,6 +15,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new SearchRoomsCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: SearchRoomsCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/SearchSkillGroupsPaginator.ts b/clients/client-alexa-for-business/pagination/SearchSkillGroupsPaginator.ts
index b7dfe9ee0e0d6..3dcf97f38b405 100644
--- a/clients/client-alexa-for-business/pagination/SearchSkillGroupsPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/SearchSkillGroupsPaginator.ts
@@ -8,6 +8,9 @@ import {
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: SearchSkillGroupsCommandInput,
@@ -16,6 +19,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new SearchSkillGroupsCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: SearchSkillGroupsCommandInput,
diff --git a/clients/client-alexa-for-business/pagination/SearchUsersPaginator.ts b/clients/client-alexa-for-business/pagination/SearchUsersPaginator.ts
index ee2e8f7c579a3..0a013e1836d0d 100644
--- a/clients/client-alexa-for-business/pagination/SearchUsersPaginator.ts
+++ b/clients/client-alexa-for-business/pagination/SearchUsersPaginator.ts
@@ -4,6 +4,9 @@ import { SearchUsersCommand, SearchUsersCommandInput, SearchUsersCommandOutput }
import { AlexaForBusinessPaginationConfiguration } from "./Interfaces";
import { Paginator } from "@aws-sdk/types";
+/**
+ * @private
+ */
const makePagedClientRequest = async (
client: AlexaForBusinessClient,
input: SearchUsersCommandInput,
@@ -12,6 +15,9 @@ const makePagedClientRequest = async (
// @ts-ignore
return await client.send(new SearchUsersCommand(input), ...args);
};
+/**
+ * @private
+ */
const makePagedRequest = async (
client: AlexaForBusiness,
input: SearchUsersCommandInput,
diff --git a/clients/client-alexa-for-business/runtimeConfig.browser.ts b/clients/client-alexa-for-business/runtimeConfig.browser.ts
index a321853770f23..0dfea46d68b72 100644
--- a/clients/client-alexa-for-business/runtimeConfig.browser.ts
+++ b/clients/client-alexa-for-business/runtimeConfig.browser.ts
@@ -12,6 +12,9 @@ import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-browser";
import { ClientDefaults } from "./AlexaForBusinessClient";
import { ClientSharedValues } from "./runtimeConfig.shared";
+/**
+ * @internal
+ */
export const ClientDefaultValues: Required = {
...ClientSharedValues,
runtime: "browser",
diff --git a/clients/client-alexa-for-business/runtimeConfig.native.ts b/clients/client-alexa-for-business/runtimeConfig.native.ts
index c1c1516e768c3..0a2c52c955f39 100644
--- a/clients/client-alexa-for-business/runtimeConfig.native.ts
+++ b/clients/client-alexa-for-business/runtimeConfig.native.ts
@@ -5,6 +5,9 @@ import { parseUrl } from "@aws-sdk/url-parser-node";
import { ClientDefaults } from "./AlexaForBusinessClient";
import { ClientDefaultValues as BrowserDefaults } from "./runtimeConfig.browser";
+/**
+ * @internal
+ */
export const ClientDefaultValues: Required = {
...BrowserDefaults,
runtime: "react-native",
diff --git a/clients/client-alexa-for-business/runtimeConfig.shared.ts b/clients/client-alexa-for-business/runtimeConfig.shared.ts
index c28e7b6703a5c..b8b52feb36573 100644
--- a/clients/client-alexa-for-business/runtimeConfig.shared.ts
+++ b/clients/client-alexa-for-business/runtimeConfig.shared.ts
@@ -1,6 +1,9 @@
import { defaultRegionInfoProvider } from "./endpoints";
import { Logger as __Logger } from "@aws-sdk/types";
+/**
+ * @internal
+ */
export const ClientSharedValues = {
apiVersion: "2017-11-09",
disableHostPrefix: false,
diff --git a/clients/client-alexa-for-business/runtimeConfig.ts b/clients/client-alexa-for-business/runtimeConfig.ts
index 4420bf5a41385..a7671434b4188 100644
--- a/clients/client-alexa-for-business/runtimeConfig.ts
+++ b/clients/client-alexa-for-business/runtimeConfig.ts
@@ -14,6 +14,9 @@ import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-node";
import { ClientDefaults } from "./AlexaForBusinessClient";
import { ClientSharedValues } from "./runtimeConfig.shared";
+/**
+ * @internal
+ */
export const ClientDefaultValues: Required = {
...ClientSharedValues,
runtime: "node",
diff --git a/clients/client-alexa-for-business/tsconfig.json b/clients/client-alexa-for-business/tsconfig.json
index 3b440583a9a24..4cf936f614b4d 100644
--- a/clients/client-alexa-for-business/tsconfig.json
+++ b/clients/client-alexa-for-business/tsconfig.json
@@ -16,13 +16,16 @@
"outDir": "dist/cjs"
},
"typedocOptions": {
- "exclude": "**/node_modules/**",
- "excludedNotExported": true,
+ "exclude": ["**/node_modules/**", "**/*.spec.ts", "./protocols/*.ts", "./e2e/*.ts", "./endpoints.ts"],
+ "excludeNotExported": true,
"excludePrivate": true,
"hideGenerator": true,
"ignoreCompilerErrors": true,
+ "includeDeclarations": true,
+ "readme": "./README.md",
"mode": "file",
"out": "./docs",
- "plugin": "@aws-sdk/client-documentation-generator"
+ "theme": "minimal",
+ "plugin": ["@aws-sdk/client-documentation-generator"]
}
}
diff --git a/clients/client-amplify/commands/CreateAppCommand.ts b/clients/client-amplify/commands/CreateAppCommand.ts
index cc16ad97cce8a..e166f6373cfd2 100644
--- a/clients/client-amplify/commands/CreateAppCommand.ts
+++ b/clients/client-amplify/commands/CreateAppCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateAppCommandInput = CreateAppRequest;
export type CreateAppCommandOutput = CreateAppResult & __MetadataBearer;
+/**
+ * Creates a new Amplify app.
+ */
export class CreateAppCommand extends $Command<
CreateAppCommandInput,
CreateAppCommandOutput,
@@ -34,6 +37,9 @@ export class CreateAppCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/CreateBackendEnvironmentCommand.ts b/clients/client-amplify/commands/CreateBackendEnvironmentCommand.ts
index 328062aba4d7b..9f92084e27506 100644
--- a/clients/client-amplify/commands/CreateBackendEnvironmentCommand.ts
+++ b/clients/client-amplify/commands/CreateBackendEnvironmentCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateBackendEnvironmentCommandInput = CreateBackendEnvironmentRequest;
export type CreateBackendEnvironmentCommandOutput = CreateBackendEnvironmentResult & __MetadataBearer;
+/**
+ * Creates a new backend environment for an Amplify app.
+ */
export class CreateBackendEnvironmentCommand extends $Command<
CreateBackendEnvironmentCommandInput,
CreateBackendEnvironmentCommandOutput,
@@ -34,6 +37,9 @@ export class CreateBackendEnvironmentCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/CreateBranchCommand.ts b/clients/client-amplify/commands/CreateBranchCommand.ts
index d267b3ef98803..0a241ef633f47 100644
--- a/clients/client-amplify/commands/CreateBranchCommand.ts
+++ b/clients/client-amplify/commands/CreateBranchCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateBranchCommandInput = CreateBranchRequest;
export type CreateBranchCommandOutput = CreateBranchResult & __MetadataBearer;
+/**
+ * Creates a new branch for an Amplify app.
+ */
export class CreateBranchCommand extends $Command<
CreateBranchCommandInput,
CreateBranchCommandOutput,
@@ -34,6 +37,9 @@ export class CreateBranchCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/CreateDeploymentCommand.ts b/clients/client-amplify/commands/CreateDeploymentCommand.ts
index 20bdaa75f5a93..6418b31127897 100644
--- a/clients/client-amplify/commands/CreateDeploymentCommand.ts
+++ b/clients/client-amplify/commands/CreateDeploymentCommand.ts
@@ -20,6 +20,10 @@ import {
export type CreateDeploymentCommandInput = CreateDeploymentRequest;
export type CreateDeploymentCommandOutput = CreateDeploymentResult & __MetadataBearer;
+/**
+ * Creates a deployment for a manually deployed Amplify app. Manually deployed apps are
+ * not connected to a repository.
+ */
export class CreateDeploymentCommand extends $Command<
CreateDeploymentCommandInput,
CreateDeploymentCommandOutput,
@@ -34,6 +38,9 @@ export class CreateDeploymentCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/CreateDomainAssociationCommand.ts b/clients/client-amplify/commands/CreateDomainAssociationCommand.ts
index 0b901780aaf6b..0d1f7b18e31a2 100644
--- a/clients/client-amplify/commands/CreateDomainAssociationCommand.ts
+++ b/clients/client-amplify/commands/CreateDomainAssociationCommand.ts
@@ -20,6 +20,10 @@ import {
export type CreateDomainAssociationCommandInput = CreateDomainAssociationRequest;
export type CreateDomainAssociationCommandOutput = CreateDomainAssociationResult & __MetadataBearer;
+/**
+ * Creates a new domain association for an Amplify app. This action associates a custom
+ * domain with the Amplify app
+ */
export class CreateDomainAssociationCommand extends $Command<
CreateDomainAssociationCommandInput,
CreateDomainAssociationCommandOutput,
@@ -34,6 +38,9 @@ export class CreateDomainAssociationCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/CreateWebhookCommand.ts b/clients/client-amplify/commands/CreateWebhookCommand.ts
index 125b263a8a79d..0ce88bb17ef5c 100644
--- a/clients/client-amplify/commands/CreateWebhookCommand.ts
+++ b/clients/client-amplify/commands/CreateWebhookCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateWebhookCommandInput = CreateWebhookRequest;
export type CreateWebhookCommandOutput = CreateWebhookResult & __MetadataBearer;
+/**
+ * Creates a new webhook on an Amplify app.
+ */
export class CreateWebhookCommand extends $Command<
CreateWebhookCommandInput,
CreateWebhookCommandOutput,
@@ -34,6 +37,9 @@ export class CreateWebhookCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/DeleteAppCommand.ts b/clients/client-amplify/commands/DeleteAppCommand.ts
index 0fcf201357799..8f02840c7d7b4 100644
--- a/clients/client-amplify/commands/DeleteAppCommand.ts
+++ b/clients/client-amplify/commands/DeleteAppCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteAppCommandInput = DeleteAppRequest;
export type DeleteAppCommandOutput = DeleteAppResult & __MetadataBearer;
+/**
+ * Deletes an existing Amplify app specified by an app ID.
+ */
export class DeleteAppCommand extends $Command<
DeleteAppCommandInput,
DeleteAppCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteAppCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/DeleteBackendEnvironmentCommand.ts b/clients/client-amplify/commands/DeleteBackendEnvironmentCommand.ts
index deae6786db97c..66255b5aa5261 100644
--- a/clients/client-amplify/commands/DeleteBackendEnvironmentCommand.ts
+++ b/clients/client-amplify/commands/DeleteBackendEnvironmentCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteBackendEnvironmentCommandInput = DeleteBackendEnvironmentRequest;
export type DeleteBackendEnvironmentCommandOutput = DeleteBackendEnvironmentResult & __MetadataBearer;
+/**
+ * Deletes a backend environment for an Amplify app.
+ */
export class DeleteBackendEnvironmentCommand extends $Command<
DeleteBackendEnvironmentCommandInput,
DeleteBackendEnvironmentCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteBackendEnvironmentCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/DeleteBranchCommand.ts b/clients/client-amplify/commands/DeleteBranchCommand.ts
index bf8160b73e9e2..581d8f399b516 100644
--- a/clients/client-amplify/commands/DeleteBranchCommand.ts
+++ b/clients/client-amplify/commands/DeleteBranchCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteBranchCommandInput = DeleteBranchRequest;
export type DeleteBranchCommandOutput = DeleteBranchResult & __MetadataBearer;
+/**
+ * Deletes a branch for an Amplify app.
+ */
export class DeleteBranchCommand extends $Command<
DeleteBranchCommandInput,
DeleteBranchCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteBranchCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/DeleteDomainAssociationCommand.ts b/clients/client-amplify/commands/DeleteDomainAssociationCommand.ts
index a3c2e8f1ae5ab..a00bf0faa047a 100644
--- a/clients/client-amplify/commands/DeleteDomainAssociationCommand.ts
+++ b/clients/client-amplify/commands/DeleteDomainAssociationCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteDomainAssociationCommandInput = DeleteDomainAssociationRequest;
export type DeleteDomainAssociationCommandOutput = DeleteDomainAssociationResult & __MetadataBearer;
+/**
+ * Deletes a domain association for an Amplify app.
+ */
export class DeleteDomainAssociationCommand extends $Command<
DeleteDomainAssociationCommandInput,
DeleteDomainAssociationCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteDomainAssociationCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/DeleteJobCommand.ts b/clients/client-amplify/commands/DeleteJobCommand.ts
index ce77c0e3c1b87..6ef23d3bc3fb7 100644
--- a/clients/client-amplify/commands/DeleteJobCommand.ts
+++ b/clients/client-amplify/commands/DeleteJobCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteJobCommandInput = DeleteJobRequest;
export type DeleteJobCommandOutput = DeleteJobResult & __MetadataBearer;
+/**
+ * Deletes a job for a branch of an Amplify app.
+ */
export class DeleteJobCommand extends $Command<
DeleteJobCommandInput,
DeleteJobCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteJobCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/DeleteWebhookCommand.ts b/clients/client-amplify/commands/DeleteWebhookCommand.ts
index b3b9783d10536..d82058ee52d08 100644
--- a/clients/client-amplify/commands/DeleteWebhookCommand.ts
+++ b/clients/client-amplify/commands/DeleteWebhookCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteWebhookCommandInput = DeleteWebhookRequest;
export type DeleteWebhookCommandOutput = DeleteWebhookResult & __MetadataBearer;
+/**
+ * Deletes a webhook.
+ */
export class DeleteWebhookCommand extends $Command<
DeleteWebhookCommandInput,
DeleteWebhookCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteWebhookCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/GenerateAccessLogsCommand.ts b/clients/client-amplify/commands/GenerateAccessLogsCommand.ts
index 28a6ec707f3f6..7aa9248da693e 100644
--- a/clients/client-amplify/commands/GenerateAccessLogsCommand.ts
+++ b/clients/client-amplify/commands/GenerateAccessLogsCommand.ts
@@ -20,6 +20,10 @@ import {
export type GenerateAccessLogsCommandInput = GenerateAccessLogsRequest;
export type GenerateAccessLogsCommandOutput = GenerateAccessLogsResult & __MetadataBearer;
+/**
+ * Returns the website access logs for a specific time range using a presigned URL.
+ *
+ */
export class GenerateAccessLogsCommand extends $Command<
GenerateAccessLogsCommandInput,
GenerateAccessLogsCommandOutput,
@@ -34,6 +38,9 @@ export class GenerateAccessLogsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/GetAppCommand.ts b/clients/client-amplify/commands/GetAppCommand.ts
index 220c1a8c19a02..6b44944ccea28 100644
--- a/clients/client-amplify/commands/GetAppCommand.ts
+++ b/clients/client-amplify/commands/GetAppCommand.ts
@@ -17,6 +17,9 @@ import {
export type GetAppCommandInput = GetAppRequest;
export type GetAppCommandOutput = GetAppResult & __MetadataBearer;
+/**
+ * Returns an existing Amplify app by appID.
+ */
export class GetAppCommand extends $Command {
// Start section: command_properties
// End section: command_properties
@@ -27,6 +30,9 @@ export class GetAppCommand extends $Command,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/GetArtifactUrlCommand.ts b/clients/client-amplify/commands/GetArtifactUrlCommand.ts
index 61428389e5f2a..5d7995c8b5c14 100644
--- a/clients/client-amplify/commands/GetArtifactUrlCommand.ts
+++ b/clients/client-amplify/commands/GetArtifactUrlCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetArtifactUrlCommandInput = GetArtifactUrlRequest;
export type GetArtifactUrlCommandOutput = GetArtifactUrlResult & __MetadataBearer;
+/**
+ * Returns the artifact info that corresponds to an artifact id.
+ */
export class GetArtifactUrlCommand extends $Command<
GetArtifactUrlCommandInput,
GetArtifactUrlCommandOutput,
@@ -34,6 +37,9 @@ export class GetArtifactUrlCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/GetBackendEnvironmentCommand.ts b/clients/client-amplify/commands/GetBackendEnvironmentCommand.ts
index 60c009bfa8bae..f0665cdfc8955 100644
--- a/clients/client-amplify/commands/GetBackendEnvironmentCommand.ts
+++ b/clients/client-amplify/commands/GetBackendEnvironmentCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetBackendEnvironmentCommandInput = GetBackendEnvironmentRequest;
export type GetBackendEnvironmentCommandOutput = GetBackendEnvironmentResult & __MetadataBearer;
+/**
+ * Returns a backend environment for an Amplify app.
+ */
export class GetBackendEnvironmentCommand extends $Command<
GetBackendEnvironmentCommandInput,
GetBackendEnvironmentCommandOutput,
@@ -34,6 +37,9 @@ export class GetBackendEnvironmentCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/GetBranchCommand.ts b/clients/client-amplify/commands/GetBranchCommand.ts
index 1cd217a2fe735..7052f10c429db 100644
--- a/clients/client-amplify/commands/GetBranchCommand.ts
+++ b/clients/client-amplify/commands/GetBranchCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetBranchCommandInput = GetBranchRequest;
export type GetBranchCommandOutput = GetBranchResult & __MetadataBearer;
+/**
+ * Returns a branch for an Amplify app.
+ */
export class GetBranchCommand extends $Command<
GetBranchCommandInput,
GetBranchCommandOutput,
@@ -34,6 +37,9 @@ export class GetBranchCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/GetDomainAssociationCommand.ts b/clients/client-amplify/commands/GetDomainAssociationCommand.ts
index c82ebb5443f56..ec3bf73c87945 100644
--- a/clients/client-amplify/commands/GetDomainAssociationCommand.ts
+++ b/clients/client-amplify/commands/GetDomainAssociationCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetDomainAssociationCommandInput = GetDomainAssociationRequest;
export type GetDomainAssociationCommandOutput = GetDomainAssociationResult & __MetadataBearer;
+/**
+ * Returns the domain information for an Amplify app.
+ */
export class GetDomainAssociationCommand extends $Command<
GetDomainAssociationCommandInput,
GetDomainAssociationCommandOutput,
@@ -34,6 +37,9 @@ export class GetDomainAssociationCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/GetJobCommand.ts b/clients/client-amplify/commands/GetJobCommand.ts
index 464e83ab294d9..e2f3657f9d932 100644
--- a/clients/client-amplify/commands/GetJobCommand.ts
+++ b/clients/client-amplify/commands/GetJobCommand.ts
@@ -17,6 +17,9 @@ import {
export type GetJobCommandInput = GetJobRequest;
export type GetJobCommandOutput = GetJobResult & __MetadataBearer;
+/**
+ * Returns a job for a branch of an Amplify app.
+ */
export class GetJobCommand extends $Command {
// Start section: command_properties
// End section: command_properties
@@ -27,6 +30,9 @@ export class GetJobCommand extends $Command,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/GetWebhookCommand.ts b/clients/client-amplify/commands/GetWebhookCommand.ts
index 2283080edb2b6..b5ce40fcaf137 100644
--- a/clients/client-amplify/commands/GetWebhookCommand.ts
+++ b/clients/client-amplify/commands/GetWebhookCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetWebhookCommandInput = GetWebhookRequest;
export type GetWebhookCommandOutput = GetWebhookResult & __MetadataBearer;
+/**
+ * Returns the webhook information that corresponds to a specified webhook ID.
+ */
export class GetWebhookCommand extends $Command<
GetWebhookCommandInput,
GetWebhookCommandOutput,
@@ -34,6 +37,9 @@ export class GetWebhookCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/ListAppsCommand.ts b/clients/client-amplify/commands/ListAppsCommand.ts
index 68627b004a951..bdcc343ea89e0 100644
--- a/clients/client-amplify/commands/ListAppsCommand.ts
+++ b/clients/client-amplify/commands/ListAppsCommand.ts
@@ -20,6 +20,9 @@ import {
export type ListAppsCommandInput = ListAppsRequest;
export type ListAppsCommandOutput = ListAppsResult & __MetadataBearer;
+/**
+ * Returns a list of the existing Amplify apps.
+ */
export class ListAppsCommand extends $Command<
ListAppsCommandInput,
ListAppsCommandOutput,
@@ -34,6 +37,9 @@ export class ListAppsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/ListArtifactsCommand.ts b/clients/client-amplify/commands/ListArtifactsCommand.ts
index a627b956b3380..8e0800d069a63 100644
--- a/clients/client-amplify/commands/ListArtifactsCommand.ts
+++ b/clients/client-amplify/commands/ListArtifactsCommand.ts
@@ -20,6 +20,9 @@ import {
export type ListArtifactsCommandInput = ListArtifactsRequest;
export type ListArtifactsCommandOutput = ListArtifactsResult & __MetadataBearer;
+/**
+ * Returns a list of artifacts for a specified app, branch, and job.
+ */
export class ListArtifactsCommand extends $Command<
ListArtifactsCommandInput,
ListArtifactsCommandOutput,
@@ -34,6 +37,9 @@ export class ListArtifactsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/ListBackendEnvironmentsCommand.ts b/clients/client-amplify/commands/ListBackendEnvironmentsCommand.ts
index beb12851907aa..f3e3d559f1be2 100644
--- a/clients/client-amplify/commands/ListBackendEnvironmentsCommand.ts
+++ b/clients/client-amplify/commands/ListBackendEnvironmentsCommand.ts
@@ -20,6 +20,9 @@ import {
export type ListBackendEnvironmentsCommandInput = ListBackendEnvironmentsRequest;
export type ListBackendEnvironmentsCommandOutput = ListBackendEnvironmentsResult & __MetadataBearer;
+/**
+ * Lists the backend environments for an Amplify app.
+ */
export class ListBackendEnvironmentsCommand extends $Command<
ListBackendEnvironmentsCommandInput,
ListBackendEnvironmentsCommandOutput,
@@ -34,6 +37,9 @@ export class ListBackendEnvironmentsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/ListBranchesCommand.ts b/clients/client-amplify/commands/ListBranchesCommand.ts
index 4c317085b6711..993ee4b230dec 100644
--- a/clients/client-amplify/commands/ListBranchesCommand.ts
+++ b/clients/client-amplify/commands/ListBranchesCommand.ts
@@ -20,6 +20,9 @@ import {
export type ListBranchesCommandInput = ListBranchesRequest;
export type ListBranchesCommandOutput = ListBranchesResult & __MetadataBearer;
+/**
+ * Lists the branches of an Amplify app.
+ */
export class ListBranchesCommand extends $Command<
ListBranchesCommandInput,
ListBranchesCommandOutput,
@@ -34,6 +37,9 @@ export class ListBranchesCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/ListDomainAssociationsCommand.ts b/clients/client-amplify/commands/ListDomainAssociationsCommand.ts
index 34f693b6ffe61..ce17ccd080d23 100644
--- a/clients/client-amplify/commands/ListDomainAssociationsCommand.ts
+++ b/clients/client-amplify/commands/ListDomainAssociationsCommand.ts
@@ -20,6 +20,9 @@ import {
export type ListDomainAssociationsCommandInput = ListDomainAssociationsRequest;
export type ListDomainAssociationsCommandOutput = ListDomainAssociationsResult & __MetadataBearer;
+/**
+ * Returns the domain associations for an Amplify app.
+ */
export class ListDomainAssociationsCommand extends $Command<
ListDomainAssociationsCommandInput,
ListDomainAssociationsCommandOutput,
@@ -34,6 +37,9 @@ export class ListDomainAssociationsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/ListJobsCommand.ts b/clients/client-amplify/commands/ListJobsCommand.ts
index 86315ca38d187..eade18a49cf93 100644
--- a/clients/client-amplify/commands/ListJobsCommand.ts
+++ b/clients/client-amplify/commands/ListJobsCommand.ts
@@ -20,6 +20,9 @@ import {
export type ListJobsCommandInput = ListJobsRequest;
export type ListJobsCommandOutput = ListJobsResult & __MetadataBearer;
+/**
+ * Lists the jobs for a branch of an Amplify app.
+ */
export class ListJobsCommand extends $Command<
ListJobsCommandInput,
ListJobsCommandOutput,
@@ -34,6 +37,9 @@ export class ListJobsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/ListTagsForResourceCommand.ts b/clients/client-amplify/commands/ListTagsForResourceCommand.ts
index 1bbde544b0dfd..39a6ddad921ef 100644
--- a/clients/client-amplify/commands/ListTagsForResourceCommand.ts
+++ b/clients/client-amplify/commands/ListTagsForResourceCommand.ts
@@ -20,6 +20,9 @@ import {
export type ListTagsForResourceCommandInput = ListTagsForResourceRequest;
export type ListTagsForResourceCommandOutput = ListTagsForResourceResponse & __MetadataBearer;
+/**
+ * Returns a list of tags for a specified Amazon Resource Name (ARN).
+ */
export class ListTagsForResourceCommand extends $Command<
ListTagsForResourceCommandInput,
ListTagsForResourceCommandOutput,
@@ -34,6 +37,9 @@ export class ListTagsForResourceCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/ListWebhooksCommand.ts b/clients/client-amplify/commands/ListWebhooksCommand.ts
index e4983c381fa00..cdb9499bbd005 100644
--- a/clients/client-amplify/commands/ListWebhooksCommand.ts
+++ b/clients/client-amplify/commands/ListWebhooksCommand.ts
@@ -20,6 +20,9 @@ import {
export type ListWebhooksCommandInput = ListWebhooksRequest;
export type ListWebhooksCommandOutput = ListWebhooksResult & __MetadataBearer;
+/**
+ * Returns a list of webhooks for an Amplify app.
+ */
export class ListWebhooksCommand extends $Command<
ListWebhooksCommandInput,
ListWebhooksCommandOutput,
@@ -34,6 +37,9 @@ export class ListWebhooksCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/StartDeploymentCommand.ts b/clients/client-amplify/commands/StartDeploymentCommand.ts
index 2e4e9d012a3d4..58328c320eb1e 100644
--- a/clients/client-amplify/commands/StartDeploymentCommand.ts
+++ b/clients/client-amplify/commands/StartDeploymentCommand.ts
@@ -20,6 +20,10 @@ import {
export type StartDeploymentCommandInput = StartDeploymentRequest;
export type StartDeploymentCommandOutput = StartDeploymentResult & __MetadataBearer;
+/**
+ * Starts a deployment for a manually deployed app. Manually deployed apps are not
+ * connected to a repository.
+ */
export class StartDeploymentCommand extends $Command<
StartDeploymentCommandInput,
StartDeploymentCommandOutput,
@@ -34,6 +38,9 @@ export class StartDeploymentCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/StartJobCommand.ts b/clients/client-amplify/commands/StartJobCommand.ts
index 3a8df5d742802..0402f70bd88b0 100644
--- a/clients/client-amplify/commands/StartJobCommand.ts
+++ b/clients/client-amplify/commands/StartJobCommand.ts
@@ -20,6 +20,9 @@ import {
export type StartJobCommandInput = StartJobRequest;
export type StartJobCommandOutput = StartJobResult & __MetadataBearer;
+/**
+ * Starts a new job for a branch of an Amplify app.
+ */
export class StartJobCommand extends $Command<
StartJobCommandInput,
StartJobCommandOutput,
@@ -34,6 +37,9 @@ export class StartJobCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/StopJobCommand.ts b/clients/client-amplify/commands/StopJobCommand.ts
index e6a67109b1084..9fafa428cbdd8 100644
--- a/clients/client-amplify/commands/StopJobCommand.ts
+++ b/clients/client-amplify/commands/StopJobCommand.ts
@@ -20,6 +20,9 @@ import {
export type StopJobCommandInput = StopJobRequest;
export type StopJobCommandOutput = StopJobResult & __MetadataBearer;
+/**
+ * Stops a job that is in progress for a branch of an Amplify app.
+ */
export class StopJobCommand extends $Command {
// Start section: command_properties
// End section: command_properties
@@ -30,6 +33,9 @@ export class StopJobCommand extends $Command,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/TagResourceCommand.ts b/clients/client-amplify/commands/TagResourceCommand.ts
index 5d18166443289..15f9b78c83279 100644
--- a/clients/client-amplify/commands/TagResourceCommand.ts
+++ b/clients/client-amplify/commands/TagResourceCommand.ts
@@ -20,6 +20,9 @@ import {
export type TagResourceCommandInput = TagResourceRequest;
export type TagResourceCommandOutput = TagResourceResponse & __MetadataBearer;
+/**
+ * Tags the resource with a tag key and value.
+ */
export class TagResourceCommand extends $Command<
TagResourceCommandInput,
TagResourceCommandOutput,
@@ -34,6 +37,9 @@ export class TagResourceCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/UntagResourceCommand.ts b/clients/client-amplify/commands/UntagResourceCommand.ts
index 2f99e59e6ac5b..0bf1270cc3154 100644
--- a/clients/client-amplify/commands/UntagResourceCommand.ts
+++ b/clients/client-amplify/commands/UntagResourceCommand.ts
@@ -20,6 +20,9 @@ import {
export type UntagResourceCommandInput = UntagResourceRequest;
export type UntagResourceCommandOutput = UntagResourceResponse & __MetadataBearer;
+/**
+ * Untags a resource with a specified Amazon Resource Name (ARN).
+ */
export class UntagResourceCommand extends $Command<
UntagResourceCommandInput,
UntagResourceCommandOutput,
@@ -34,6 +37,9 @@ export class UntagResourceCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/UpdateAppCommand.ts b/clients/client-amplify/commands/UpdateAppCommand.ts
index 1098f42cc5b83..6d96c6a552f14 100644
--- a/clients/client-amplify/commands/UpdateAppCommand.ts
+++ b/clients/client-amplify/commands/UpdateAppCommand.ts
@@ -20,6 +20,9 @@ import {
export type UpdateAppCommandInput = UpdateAppRequest;
export type UpdateAppCommandOutput = UpdateAppResult & __MetadataBearer;
+/**
+ * Updates an existing Amplify app.
+ */
export class UpdateAppCommand extends $Command<
UpdateAppCommandInput,
UpdateAppCommandOutput,
@@ -34,6 +37,9 @@ export class UpdateAppCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/UpdateBranchCommand.ts b/clients/client-amplify/commands/UpdateBranchCommand.ts
index 60d618706924a..d17aef810b005 100644
--- a/clients/client-amplify/commands/UpdateBranchCommand.ts
+++ b/clients/client-amplify/commands/UpdateBranchCommand.ts
@@ -20,6 +20,9 @@ import {
export type UpdateBranchCommandInput = UpdateBranchRequest;
export type UpdateBranchCommandOutput = UpdateBranchResult & __MetadataBearer;
+/**
+ * Updates a branch for an Amplify app.
+ */
export class UpdateBranchCommand extends $Command<
UpdateBranchCommandInput,
UpdateBranchCommandOutput,
@@ -34,6 +37,9 @@ export class UpdateBranchCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/UpdateDomainAssociationCommand.ts b/clients/client-amplify/commands/UpdateDomainAssociationCommand.ts
index 08e5888c15c06..217b1180d76e0 100644
--- a/clients/client-amplify/commands/UpdateDomainAssociationCommand.ts
+++ b/clients/client-amplify/commands/UpdateDomainAssociationCommand.ts
@@ -20,6 +20,9 @@ import {
export type UpdateDomainAssociationCommandInput = UpdateDomainAssociationRequest;
export type UpdateDomainAssociationCommandOutput = UpdateDomainAssociationResult & __MetadataBearer;
+/**
+ * Creates a new domain association for an Amplify app.
+ */
export class UpdateDomainAssociationCommand extends $Command<
UpdateDomainAssociationCommandInput,
UpdateDomainAssociationCommandOutput,
@@ -34,6 +37,9 @@ export class UpdateDomainAssociationCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/commands/UpdateWebhookCommand.ts b/clients/client-amplify/commands/UpdateWebhookCommand.ts
index c9b0eaec9dc13..93fd54df3401a 100644
--- a/clients/client-amplify/commands/UpdateWebhookCommand.ts
+++ b/clients/client-amplify/commands/UpdateWebhookCommand.ts
@@ -20,6 +20,9 @@ import {
export type UpdateWebhookCommandInput = UpdateWebhookRequest;
export type UpdateWebhookCommandOutput = UpdateWebhookResult & __MetadataBearer;
+/**
+ * Updates a webhook.
+ */
export class UpdateWebhookCommand extends $Command<
UpdateWebhookCommandInput,
UpdateWebhookCommandOutput,
@@ -34,6 +37,9 @@ export class UpdateWebhookCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: AmplifyClientResolvedConfig,
diff --git a/clients/client-amplify/package.json b/clients/client-amplify/package.json
index d9a2ea96fe4f0..5151926f1ee55 100644
--- a/clients/client-amplify/package.json
+++ b/clients/client-amplify/package.json
@@ -3,8 +3,8 @@
"description": "AWS SDK for JavaScript Amplify Client for Node.js, Browser and React Native",
"version": "1.0.0-rc.7",
"scripts": {
- "clean": "npm run remove-definitions && npm run remove-dist",
- "build-documentation": "npm run clean && typedoc ./",
+ "clean": "yarn remove-definitions && yarn remove-dist && yarn remove-documentation",
+ "build-documentation": "yarn remove-documentation && typedoc ./",
"prepublishOnly": "yarn build",
"pretest": "yarn build:cjs",
"remove-definitions": "rimraf ./types",
@@ -63,7 +63,7 @@
"@types/node": "^12.7.5",
"jest": "^26.1.0",
"rimraf": "^3.0.0",
- "typedoc": "^0.17.8",
+ "typedoc": "^0.19.2",
"typescript": "~4.0.2"
},
"engines": {
diff --git a/clients/client-amplify/runtimeConfig.browser.ts b/clients/client-amplify/runtimeConfig.browser.ts
index 16cd600b5d6aa..83571a02912c0 100644
--- a/clients/client-amplify/runtimeConfig.browser.ts
+++ b/clients/client-amplify/runtimeConfig.browser.ts
@@ -12,6 +12,9 @@ import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-browser";
import { ClientDefaults } from "./AmplifyClient";
import { ClientSharedValues } from "./runtimeConfig.shared";
+/**
+ * @internal
+ */
export const ClientDefaultValues: Required = {
...ClientSharedValues,
runtime: "browser",
diff --git a/clients/client-amplify/runtimeConfig.native.ts b/clients/client-amplify/runtimeConfig.native.ts
index e8bcac31500ca..67186c904256e 100644
--- a/clients/client-amplify/runtimeConfig.native.ts
+++ b/clients/client-amplify/runtimeConfig.native.ts
@@ -5,6 +5,9 @@ import { parseUrl } from "@aws-sdk/url-parser-node";
import { ClientDefaults } from "./AmplifyClient";
import { ClientDefaultValues as BrowserDefaults } from "./runtimeConfig.browser";
+/**
+ * @internal
+ */
export const ClientDefaultValues: Required = {
...BrowserDefaults,
runtime: "react-native",
diff --git a/clients/client-amplify/runtimeConfig.shared.ts b/clients/client-amplify/runtimeConfig.shared.ts
index e7d36219cebea..fa4781c1d0ddb 100644
--- a/clients/client-amplify/runtimeConfig.shared.ts
+++ b/clients/client-amplify/runtimeConfig.shared.ts
@@ -1,6 +1,9 @@
import { defaultRegionInfoProvider } from "./endpoints";
import { Logger as __Logger } from "@aws-sdk/types";
+/**
+ * @internal
+ */
export const ClientSharedValues = {
apiVersion: "2017-07-25",
disableHostPrefix: false,
diff --git a/clients/client-amplify/runtimeConfig.ts b/clients/client-amplify/runtimeConfig.ts
index b8547f1838a50..98bbb08b8ee35 100644
--- a/clients/client-amplify/runtimeConfig.ts
+++ b/clients/client-amplify/runtimeConfig.ts
@@ -14,6 +14,9 @@ import { fromUtf8, toUtf8 } from "@aws-sdk/util-utf8-node";
import { ClientDefaults } from "./AmplifyClient";
import { ClientSharedValues } from "./runtimeConfig.shared";
+/**
+ * @internal
+ */
export const ClientDefaultValues: Required = {
...ClientSharedValues,
runtime: "node",
diff --git a/clients/client-amplify/tsconfig.json b/clients/client-amplify/tsconfig.json
index 3b440583a9a24..4cf936f614b4d 100644
--- a/clients/client-amplify/tsconfig.json
+++ b/clients/client-amplify/tsconfig.json
@@ -16,13 +16,16 @@
"outDir": "dist/cjs"
},
"typedocOptions": {
- "exclude": "**/node_modules/**",
- "excludedNotExported": true,
+ "exclude": ["**/node_modules/**", "**/*.spec.ts", "./protocols/*.ts", "./e2e/*.ts", "./endpoints.ts"],
+ "excludeNotExported": true,
"excludePrivate": true,
"hideGenerator": true,
"ignoreCompilerErrors": true,
+ "includeDeclarations": true,
+ "readme": "./README.md",
"mode": "file",
"out": "./docs",
- "plugin": "@aws-sdk/client-documentation-generator"
+ "theme": "minimal",
+ "plugin": ["@aws-sdk/client-documentation-generator"]
}
}
diff --git a/clients/client-api-gateway/commands/CreateApiKeyCommand.ts b/clients/client-api-gateway/commands/CreateApiKeyCommand.ts
index 919367ba542a9..fe9f375b0d219 100644
--- a/clients/client-api-gateway/commands/CreateApiKeyCommand.ts
+++ b/clients/client-api-gateway/commands/CreateApiKeyCommand.ts
@@ -20,6 +20,10 @@ import {
export type CreateApiKeyCommandInput = CreateApiKeyRequest;
export type CreateApiKeyCommandOutput = ApiKey & __MetadataBearer;
+/**
+ * Create an ApiKey resource.
+ *
+ */
export class CreateApiKeyCommand extends $Command<
CreateApiKeyCommandInput,
CreateApiKeyCommandOutput,
@@ -34,6 +38,9 @@ export class CreateApiKeyCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/CreateAuthorizerCommand.ts b/clients/client-api-gateway/commands/CreateAuthorizerCommand.ts
index 9895be299d774..5a52f6d2a7d30 100644
--- a/clients/client-api-gateway/commands/CreateAuthorizerCommand.ts
+++ b/clients/client-api-gateway/commands/CreateAuthorizerCommand.ts
@@ -20,6 +20,10 @@ import {
export type CreateAuthorizerCommandInput = CreateAuthorizerRequest;
export type CreateAuthorizerCommandOutput = Authorizer & __MetadataBearer;
+/**
+ * Adds a new Authorizer resource to an existing RestApi resource.
+ *
+ */
export class CreateAuthorizerCommand extends $Command<
CreateAuthorizerCommandInput,
CreateAuthorizerCommandOutput,
@@ -34,6 +38,9 @@ export class CreateAuthorizerCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/CreateBasePathMappingCommand.ts b/clients/client-api-gateway/commands/CreateBasePathMappingCommand.ts
index ad9b285334c13..af4256d928de8 100644
--- a/clients/client-api-gateway/commands/CreateBasePathMappingCommand.ts
+++ b/clients/client-api-gateway/commands/CreateBasePathMappingCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateBasePathMappingCommandInput = CreateBasePathMappingRequest;
export type CreateBasePathMappingCommandOutput = BasePathMapping & __MetadataBearer;
+/**
+ * Creates a new BasePathMapping resource.
+ */
export class CreateBasePathMappingCommand extends $Command<
CreateBasePathMappingCommandInput,
CreateBasePathMappingCommandOutput,
@@ -34,6 +37,9 @@ export class CreateBasePathMappingCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/CreateDeploymentCommand.ts b/clients/client-api-gateway/commands/CreateDeploymentCommand.ts
index 9c057a7634fb0..2465767fb3567 100644
--- a/clients/client-api-gateway/commands/CreateDeploymentCommand.ts
+++ b/clients/client-api-gateway/commands/CreateDeploymentCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateDeploymentCommandInput = CreateDeploymentRequest;
export type CreateDeploymentCommandOutput = Deployment & __MetadataBearer;
+/**
+ * Creates a Deployment resource, which makes a specified RestApi callable over the internet.
+ */
export class CreateDeploymentCommand extends $Command<
CreateDeploymentCommandInput,
CreateDeploymentCommandOutput,
@@ -34,6 +37,9 @@ export class CreateDeploymentCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/CreateDocumentationPartCommand.ts b/clients/client-api-gateway/commands/CreateDocumentationPartCommand.ts
index ae6333058e8c8..8bf0636640c48 100644
--- a/clients/client-api-gateway/commands/CreateDocumentationPartCommand.ts
+++ b/clients/client-api-gateway/commands/CreateDocumentationPartCommand.ts
@@ -34,6 +34,9 @@ export class CreateDocumentationPartCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/CreateDocumentationVersionCommand.ts b/clients/client-api-gateway/commands/CreateDocumentationVersionCommand.ts
index 94fecd22551ed..009fb434f6e2e 100644
--- a/clients/client-api-gateway/commands/CreateDocumentationVersionCommand.ts
+++ b/clients/client-api-gateway/commands/CreateDocumentationVersionCommand.ts
@@ -34,6 +34,9 @@ export class CreateDocumentationVersionCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/CreateDomainNameCommand.ts b/clients/client-api-gateway/commands/CreateDomainNameCommand.ts
index e14b06689c12d..c115db0029bac 100644
--- a/clients/client-api-gateway/commands/CreateDomainNameCommand.ts
+++ b/clients/client-api-gateway/commands/CreateDomainNameCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateDomainNameCommandInput = CreateDomainNameRequest;
export type CreateDomainNameCommandOutput = DomainName & __MetadataBearer;
+/**
+ * Creates a new domain name.
+ */
export class CreateDomainNameCommand extends $Command<
CreateDomainNameCommandInput,
CreateDomainNameCommandOutput,
@@ -34,6 +37,9 @@ export class CreateDomainNameCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/CreateModelCommand.ts b/clients/client-api-gateway/commands/CreateModelCommand.ts
index 7d3fd6ff37131..da88cae3e6ef5 100644
--- a/clients/client-api-gateway/commands/CreateModelCommand.ts
+++ b/clients/client-api-gateway/commands/CreateModelCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateModelCommandInput = CreateModelRequest;
export type CreateModelCommandOutput = Model & __MetadataBearer;
+/**
+ * Adds a new Model resource to an existing RestApi resource.
+ */
export class CreateModelCommand extends $Command<
CreateModelCommandInput,
CreateModelCommandOutput,
@@ -34,6 +37,9 @@ export class CreateModelCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/CreateRequestValidatorCommand.ts b/clients/client-api-gateway/commands/CreateRequestValidatorCommand.ts
index f9f8eff551fc9..9a6223aaa1682 100644
--- a/clients/client-api-gateway/commands/CreateRequestValidatorCommand.ts
+++ b/clients/client-api-gateway/commands/CreateRequestValidatorCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateRequestValidatorCommandInput = CreateRequestValidatorRequest;
export type CreateRequestValidatorCommandOutput = RequestValidator & __MetadataBearer;
+/**
+ * Creates a ReqeustValidator of a given RestApi.
+ */
export class CreateRequestValidatorCommand extends $Command<
CreateRequestValidatorCommandInput,
CreateRequestValidatorCommandOutput,
@@ -34,6 +37,9 @@ export class CreateRequestValidatorCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/CreateResourceCommand.ts b/clients/client-api-gateway/commands/CreateResourceCommand.ts
index 72481c34d3876..d531c89bfb6d9 100644
--- a/clients/client-api-gateway/commands/CreateResourceCommand.ts
+++ b/clients/client-api-gateway/commands/CreateResourceCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateResourceCommandInput = CreateResourceRequest;
export type CreateResourceCommandOutput = Resource & __MetadataBearer;
+/**
+ * Creates a Resource resource.
+ */
export class CreateResourceCommand extends $Command<
CreateResourceCommandInput,
CreateResourceCommandOutput,
@@ -34,6 +37,9 @@ export class CreateResourceCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/CreateRestApiCommand.ts b/clients/client-api-gateway/commands/CreateRestApiCommand.ts
index 4d900be90af6d..d1f0edb779f2c 100644
--- a/clients/client-api-gateway/commands/CreateRestApiCommand.ts
+++ b/clients/client-api-gateway/commands/CreateRestApiCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateRestApiCommandInput = CreateRestApiRequest;
export type CreateRestApiCommandOutput = RestApi & __MetadataBearer;
+/**
+ * Creates a new RestApi resource.
+ */
export class CreateRestApiCommand extends $Command<
CreateRestApiCommandInput,
CreateRestApiCommandOutput,
@@ -34,6 +37,9 @@ export class CreateRestApiCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/CreateStageCommand.ts b/clients/client-api-gateway/commands/CreateStageCommand.ts
index 15434e51928f8..e499552a2ef08 100644
--- a/clients/client-api-gateway/commands/CreateStageCommand.ts
+++ b/clients/client-api-gateway/commands/CreateStageCommand.ts
@@ -20,6 +20,10 @@ import {
export type CreateStageCommandInput = CreateStageRequest;
export type CreateStageCommandOutput = Stage & __MetadataBearer;
+/**
+ * Creates a new Stage resource that references a pre-existing Deployment for the API.
+ *
+ */
export class CreateStageCommand extends $Command<
CreateStageCommandInput,
CreateStageCommandOutput,
@@ -34,6 +38,9 @@ export class CreateStageCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/CreateUsagePlanCommand.ts b/clients/client-api-gateway/commands/CreateUsagePlanCommand.ts
index 819a0b4cff9da..4d171ca962a84 100644
--- a/clients/client-api-gateway/commands/CreateUsagePlanCommand.ts
+++ b/clients/client-api-gateway/commands/CreateUsagePlanCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateUsagePlanCommandInput = CreateUsagePlanRequest;
export type CreateUsagePlanCommandOutput = UsagePlan & __MetadataBearer;
+/**
+ * Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
+ */
export class CreateUsagePlanCommand extends $Command<
CreateUsagePlanCommandInput,
CreateUsagePlanCommandOutput,
@@ -34,6 +37,9 @@ export class CreateUsagePlanCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/CreateUsagePlanKeyCommand.ts b/clients/client-api-gateway/commands/CreateUsagePlanKeyCommand.ts
index 2a2c1c945776c..b7b6f3126a569 100644
--- a/clients/client-api-gateway/commands/CreateUsagePlanKeyCommand.ts
+++ b/clients/client-api-gateway/commands/CreateUsagePlanKeyCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateUsagePlanKeyCommandInput = CreateUsagePlanKeyRequest;
export type CreateUsagePlanKeyCommandOutput = UsagePlanKey & __MetadataBearer;
+/**
+ * Creates a usage plan key for adding an existing API key to a usage plan.
+ */
export class CreateUsagePlanKeyCommand extends $Command<
CreateUsagePlanKeyCommandInput,
CreateUsagePlanKeyCommandOutput,
@@ -34,6 +37,9 @@ export class CreateUsagePlanKeyCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/CreateVpcLinkCommand.ts b/clients/client-api-gateway/commands/CreateVpcLinkCommand.ts
index 1f22111017e2d..5e3c63363b33b 100644
--- a/clients/client-api-gateway/commands/CreateVpcLinkCommand.ts
+++ b/clients/client-api-gateway/commands/CreateVpcLinkCommand.ts
@@ -20,6 +20,9 @@ import {
export type CreateVpcLinkCommandInput = CreateVpcLinkRequest;
export type CreateVpcLinkCommandOutput = VpcLink & __MetadataBearer;
+/**
+ * Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
+ */
export class CreateVpcLinkCommand extends $Command<
CreateVpcLinkCommandInput,
CreateVpcLinkCommandOutput,
@@ -34,6 +37,9 @@ export class CreateVpcLinkCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteApiKeyCommand.ts b/clients/client-api-gateway/commands/DeleteApiKeyCommand.ts
index 45a875f05567a..f0f8f20a40f51 100644
--- a/clients/client-api-gateway/commands/DeleteApiKeyCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteApiKeyCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteApiKeyCommandInput = DeleteApiKeyRequest;
export type DeleteApiKeyCommandOutput = __MetadataBearer;
+/**
+ * Deletes the ApiKey resource.
+ */
export class DeleteApiKeyCommand extends $Command<
DeleteApiKeyCommandInput,
DeleteApiKeyCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteApiKeyCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteAuthorizerCommand.ts b/clients/client-api-gateway/commands/DeleteAuthorizerCommand.ts
index 9b408dbff453a..64f4e3c9eeb98 100644
--- a/clients/client-api-gateway/commands/DeleteAuthorizerCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteAuthorizerCommand.ts
@@ -20,6 +20,10 @@ import {
export type DeleteAuthorizerCommandInput = DeleteAuthorizerRequest;
export type DeleteAuthorizerCommandOutput = __MetadataBearer;
+/**
+ * Deletes an existing Authorizer resource.
+ *
+ */
export class DeleteAuthorizerCommand extends $Command<
DeleteAuthorizerCommandInput,
DeleteAuthorizerCommandOutput,
@@ -34,6 +38,9 @@ export class DeleteAuthorizerCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteBasePathMappingCommand.ts b/clients/client-api-gateway/commands/DeleteBasePathMappingCommand.ts
index 0d7090ede78e9..fc4d7bf646784 100644
--- a/clients/client-api-gateway/commands/DeleteBasePathMappingCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteBasePathMappingCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteBasePathMappingCommandInput = DeleteBasePathMappingRequest;
export type DeleteBasePathMappingCommandOutput = __MetadataBearer;
+/**
+ * Deletes the BasePathMapping resource.
+ */
export class DeleteBasePathMappingCommand extends $Command<
DeleteBasePathMappingCommandInput,
DeleteBasePathMappingCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteBasePathMappingCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteClientCertificateCommand.ts b/clients/client-api-gateway/commands/DeleteClientCertificateCommand.ts
index 8138b7cf436b9..5cf89cb3bf0b4 100644
--- a/clients/client-api-gateway/commands/DeleteClientCertificateCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteClientCertificateCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteClientCertificateCommandInput = DeleteClientCertificateRequest;
export type DeleteClientCertificateCommandOutput = __MetadataBearer;
+/**
+ * Deletes the ClientCertificate resource.
+ */
export class DeleteClientCertificateCommand extends $Command<
DeleteClientCertificateCommandInput,
DeleteClientCertificateCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteClientCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteDeploymentCommand.ts b/clients/client-api-gateway/commands/DeleteDeploymentCommand.ts
index 70bd3c1678e5d..dcf2929aeb99f 100644
--- a/clients/client-api-gateway/commands/DeleteDeploymentCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteDeploymentCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteDeploymentCommandInput = DeleteDeploymentRequest;
export type DeleteDeploymentCommandOutput = __MetadataBearer;
+/**
+ * Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
+ */
export class DeleteDeploymentCommand extends $Command<
DeleteDeploymentCommandInput,
DeleteDeploymentCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteDeploymentCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteDocumentationPartCommand.ts b/clients/client-api-gateway/commands/DeleteDocumentationPartCommand.ts
index 0ca229590ee26..83d3fa88fa21f 100644
--- a/clients/client-api-gateway/commands/DeleteDocumentationPartCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteDocumentationPartCommand.ts
@@ -34,6 +34,9 @@ export class DeleteDocumentationPartCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteDocumentationVersionCommand.ts b/clients/client-api-gateway/commands/DeleteDocumentationVersionCommand.ts
index 71265d801adc4..f23567ed6e6b4 100644
--- a/clients/client-api-gateway/commands/DeleteDocumentationVersionCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteDocumentationVersionCommand.ts
@@ -34,6 +34,9 @@ export class DeleteDocumentationVersionCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteDomainNameCommand.ts b/clients/client-api-gateway/commands/DeleteDomainNameCommand.ts
index 18e8f51a4b60c..12598a8710612 100644
--- a/clients/client-api-gateway/commands/DeleteDomainNameCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteDomainNameCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteDomainNameCommandInput = DeleteDomainNameRequest;
export type DeleteDomainNameCommandOutput = __MetadataBearer;
+/**
+ * Deletes the DomainName resource.
+ */
export class DeleteDomainNameCommand extends $Command<
DeleteDomainNameCommandInput,
DeleteDomainNameCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteDomainNameCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteGatewayResponseCommand.ts b/clients/client-api-gateway/commands/DeleteGatewayResponseCommand.ts
index fdcc8096a6ed0..c1d455c265336 100644
--- a/clients/client-api-gateway/commands/DeleteGatewayResponseCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteGatewayResponseCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteGatewayResponseCommandInput = DeleteGatewayResponseRequest;
export type DeleteGatewayResponseCommandOutput = __MetadataBearer;
+/**
+ * Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
+ */
export class DeleteGatewayResponseCommand extends $Command<
DeleteGatewayResponseCommandInput,
DeleteGatewayResponseCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteGatewayResponseCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteIntegrationCommand.ts b/clients/client-api-gateway/commands/DeleteIntegrationCommand.ts
index f3610bf971e19..996923beb7d2a 100644
--- a/clients/client-api-gateway/commands/DeleteIntegrationCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteIntegrationCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteIntegrationCommandInput = DeleteIntegrationRequest;
export type DeleteIntegrationCommandOutput = __MetadataBearer;
+/**
+ * Represents a delete integration.
+ */
export class DeleteIntegrationCommand extends $Command<
DeleteIntegrationCommandInput,
DeleteIntegrationCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteIntegrationCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteIntegrationResponseCommand.ts b/clients/client-api-gateway/commands/DeleteIntegrationResponseCommand.ts
index a0fb2743f604c..b0415ddcc6ac3 100644
--- a/clients/client-api-gateway/commands/DeleteIntegrationResponseCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteIntegrationResponseCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteIntegrationResponseCommandInput = DeleteIntegrationResponseRequest;
export type DeleteIntegrationResponseCommandOutput = __MetadataBearer;
+/**
+ * Represents a delete integration response.
+ */
export class DeleteIntegrationResponseCommand extends $Command<
DeleteIntegrationResponseCommandInput,
DeleteIntegrationResponseCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteIntegrationResponseCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteMethodCommand.ts b/clients/client-api-gateway/commands/DeleteMethodCommand.ts
index 984ab7d28f6f7..1323a9ba6edef 100644
--- a/clients/client-api-gateway/commands/DeleteMethodCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteMethodCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteMethodCommandInput = DeleteMethodRequest;
export type DeleteMethodCommandOutput = __MetadataBearer;
+/**
+ * Deletes an existing Method resource.
+ */
export class DeleteMethodCommand extends $Command<
DeleteMethodCommandInput,
DeleteMethodCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteMethodCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteMethodResponseCommand.ts b/clients/client-api-gateway/commands/DeleteMethodResponseCommand.ts
index 9bfb04d433d90..3f6320ea7ae0c 100644
--- a/clients/client-api-gateway/commands/DeleteMethodResponseCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteMethodResponseCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteMethodResponseCommandInput = DeleteMethodResponseRequest;
export type DeleteMethodResponseCommandOutput = __MetadataBearer;
+/**
+ * Deletes an existing MethodResponse resource.
+ */
export class DeleteMethodResponseCommand extends $Command<
DeleteMethodResponseCommandInput,
DeleteMethodResponseCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteMethodResponseCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteModelCommand.ts b/clients/client-api-gateway/commands/DeleteModelCommand.ts
index b9ea8e64d56fa..ad575f494f781 100644
--- a/clients/client-api-gateway/commands/DeleteModelCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteModelCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteModelCommandInput = DeleteModelRequest;
export type DeleteModelCommandOutput = __MetadataBearer;
+/**
+ * Deletes a model.
+ */
export class DeleteModelCommand extends $Command<
DeleteModelCommandInput,
DeleteModelCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteModelCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteRequestValidatorCommand.ts b/clients/client-api-gateway/commands/DeleteRequestValidatorCommand.ts
index 904d8936294db..39af0569434f4 100644
--- a/clients/client-api-gateway/commands/DeleteRequestValidatorCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteRequestValidatorCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteRequestValidatorCommandInput = DeleteRequestValidatorRequest;
export type DeleteRequestValidatorCommandOutput = __MetadataBearer;
+/**
+ * Deletes a RequestValidator of a given RestApi.
+ */
export class DeleteRequestValidatorCommand extends $Command<
DeleteRequestValidatorCommandInput,
DeleteRequestValidatorCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteRequestValidatorCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteResourceCommand.ts b/clients/client-api-gateway/commands/DeleteResourceCommand.ts
index 781c0552bfcd0..1d9b0d64aaca5 100644
--- a/clients/client-api-gateway/commands/DeleteResourceCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteResourceCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteResourceCommandInput = DeleteResourceRequest;
export type DeleteResourceCommandOutput = __MetadataBearer;
+/**
+ * Deletes a Resource resource.
+ */
export class DeleteResourceCommand extends $Command<
DeleteResourceCommandInput,
DeleteResourceCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteResourceCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteRestApiCommand.ts b/clients/client-api-gateway/commands/DeleteRestApiCommand.ts
index d1c74145752dc..19e9905bfe190 100644
--- a/clients/client-api-gateway/commands/DeleteRestApiCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteRestApiCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteRestApiCommandInput = DeleteRestApiRequest;
export type DeleteRestApiCommandOutput = __MetadataBearer;
+/**
+ * Deletes the specified API.
+ */
export class DeleteRestApiCommand extends $Command<
DeleteRestApiCommandInput,
DeleteRestApiCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteRestApiCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteStageCommand.ts b/clients/client-api-gateway/commands/DeleteStageCommand.ts
index cf27bde0cb8e6..8d8d0eab9b36a 100644
--- a/clients/client-api-gateway/commands/DeleteStageCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteStageCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteStageCommandInput = DeleteStageRequest;
export type DeleteStageCommandOutput = __MetadataBearer;
+/**
+ * Deletes a Stage resource.
+ */
export class DeleteStageCommand extends $Command<
DeleteStageCommandInput,
DeleteStageCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteStageCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteUsagePlanCommand.ts b/clients/client-api-gateway/commands/DeleteUsagePlanCommand.ts
index 8fb32e80f0c28..c927b7daccf12 100644
--- a/clients/client-api-gateway/commands/DeleteUsagePlanCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteUsagePlanCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteUsagePlanCommandInput = DeleteUsagePlanRequest;
export type DeleteUsagePlanCommandOutput = __MetadataBearer;
+/**
+ * Deletes a usage plan of a given plan Id.
+ */
export class DeleteUsagePlanCommand extends $Command<
DeleteUsagePlanCommandInput,
DeleteUsagePlanCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteUsagePlanCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteUsagePlanKeyCommand.ts b/clients/client-api-gateway/commands/DeleteUsagePlanKeyCommand.ts
index 8545a613e283b..1b1562910e813 100644
--- a/clients/client-api-gateway/commands/DeleteUsagePlanKeyCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteUsagePlanKeyCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteUsagePlanKeyCommandInput = DeleteUsagePlanKeyRequest;
export type DeleteUsagePlanKeyCommandOutput = __MetadataBearer;
+/**
+ * Deletes a usage plan key and remove the underlying API key from the associated usage plan.
+ */
export class DeleteUsagePlanKeyCommand extends $Command<
DeleteUsagePlanKeyCommandInput,
DeleteUsagePlanKeyCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteUsagePlanKeyCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/DeleteVpcLinkCommand.ts b/clients/client-api-gateway/commands/DeleteVpcLinkCommand.ts
index 4f2f7c04a5a95..6ceadbd2dec98 100644
--- a/clients/client-api-gateway/commands/DeleteVpcLinkCommand.ts
+++ b/clients/client-api-gateway/commands/DeleteVpcLinkCommand.ts
@@ -20,6 +20,9 @@ import {
export type DeleteVpcLinkCommandInput = DeleteVpcLinkRequest;
export type DeleteVpcLinkCommandOutput = __MetadataBearer;
+/**
+ * Deletes an existing VpcLink of a specified identifier.
+ */
export class DeleteVpcLinkCommand extends $Command<
DeleteVpcLinkCommandInput,
DeleteVpcLinkCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteVpcLinkCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/FlushStageAuthorizersCacheCommand.ts b/clients/client-api-gateway/commands/FlushStageAuthorizersCacheCommand.ts
index bc1a63a200bf1..4b2517406652e 100644
--- a/clients/client-api-gateway/commands/FlushStageAuthorizersCacheCommand.ts
+++ b/clients/client-api-gateway/commands/FlushStageAuthorizersCacheCommand.ts
@@ -20,6 +20,9 @@ import {
export type FlushStageAuthorizersCacheCommandInput = FlushStageAuthorizersCacheRequest;
export type FlushStageAuthorizersCacheCommandOutput = __MetadataBearer;
+/**
+ * Flushes all authorizer cache entries on a stage.
+ */
export class FlushStageAuthorizersCacheCommand extends $Command<
FlushStageAuthorizersCacheCommandInput,
FlushStageAuthorizersCacheCommandOutput,
@@ -34,6 +37,9 @@ export class FlushStageAuthorizersCacheCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/FlushStageCacheCommand.ts b/clients/client-api-gateway/commands/FlushStageCacheCommand.ts
index 0d3b71b437db1..1b9cb6bbe2e10 100644
--- a/clients/client-api-gateway/commands/FlushStageCacheCommand.ts
+++ b/clients/client-api-gateway/commands/FlushStageCacheCommand.ts
@@ -20,6 +20,9 @@ import {
export type FlushStageCacheCommandInput = FlushStageCacheRequest;
export type FlushStageCacheCommandOutput = __MetadataBearer;
+/**
+ * Flushes a stage's cache.
+ */
export class FlushStageCacheCommand extends $Command<
FlushStageCacheCommandInput,
FlushStageCacheCommandOutput,
@@ -34,6 +37,9 @@ export class FlushStageCacheCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/GenerateClientCertificateCommand.ts b/clients/client-api-gateway/commands/GenerateClientCertificateCommand.ts
index 89d71ec903977..07b47014e771e 100644
--- a/clients/client-api-gateway/commands/GenerateClientCertificateCommand.ts
+++ b/clients/client-api-gateway/commands/GenerateClientCertificateCommand.ts
@@ -20,6 +20,9 @@ import {
export type GenerateClientCertificateCommandInput = GenerateClientCertificateRequest;
export type GenerateClientCertificateCommandOutput = ClientCertificate & __MetadataBearer;
+/**
+ * Generates a ClientCertificate resource.
+ */
export class GenerateClientCertificateCommand extends $Command<
GenerateClientCertificateCommandInput,
GenerateClientCertificateCommandOutput,
@@ -34,6 +37,9 @@ export class GenerateClientCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/GetAccountCommand.ts b/clients/client-api-gateway/commands/GetAccountCommand.ts
index 8245dc6169ea5..3d1771c7a4928 100644
--- a/clients/client-api-gateway/commands/GetAccountCommand.ts
+++ b/clients/client-api-gateway/commands/GetAccountCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetAccountCommandInput = GetAccountRequest;
export type GetAccountCommandOutput = Account & __MetadataBearer;
+/**
+ * Gets information about the current Account resource.
+ */
export class GetAccountCommand extends $Command<
GetAccountCommandInput,
GetAccountCommandOutput,
@@ -34,6 +37,9 @@ export class GetAccountCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/GetApiKeyCommand.ts b/clients/client-api-gateway/commands/GetApiKeyCommand.ts
index 99fc65d6cdae4..8e8f4c35040a2 100644
--- a/clients/client-api-gateway/commands/GetApiKeyCommand.ts
+++ b/clients/client-api-gateway/commands/GetApiKeyCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetApiKeyCommandInput = GetApiKeyRequest;
export type GetApiKeyCommandOutput = ApiKey & __MetadataBearer;
+/**
+ * Gets information about the current ApiKey resource.
+ */
export class GetApiKeyCommand extends $Command<
GetApiKeyCommandInput,
GetApiKeyCommandOutput,
@@ -34,6 +37,9 @@ export class GetApiKeyCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/GetApiKeysCommand.ts b/clients/client-api-gateway/commands/GetApiKeysCommand.ts
index 0c911f3e4d3d9..3b042663b1a69 100644
--- a/clients/client-api-gateway/commands/GetApiKeysCommand.ts
+++ b/clients/client-api-gateway/commands/GetApiKeysCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetApiKeysCommandInput = GetApiKeysRequest;
export type GetApiKeysCommandOutput = ApiKeys & __MetadataBearer;
+/**
+ * Gets information about the current ApiKeys resource.
+ */
export class GetApiKeysCommand extends $Command<
GetApiKeysCommandInput,
GetApiKeysCommandOutput,
@@ -34,6 +37,9 @@ export class GetApiKeysCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/GetAuthorizerCommand.ts b/clients/client-api-gateway/commands/GetAuthorizerCommand.ts
index 1a13c789e44e6..afad33abf77c5 100644
--- a/clients/client-api-gateway/commands/GetAuthorizerCommand.ts
+++ b/clients/client-api-gateway/commands/GetAuthorizerCommand.ts
@@ -20,6 +20,10 @@ import {
export type GetAuthorizerCommandInput = GetAuthorizerRequest;
export type GetAuthorizerCommandOutput = Authorizer & __MetadataBearer;
+/**
+ * Describe an existing Authorizer resource.
+ *
+ */
export class GetAuthorizerCommand extends $Command<
GetAuthorizerCommandInput,
GetAuthorizerCommandOutput,
@@ -34,6 +38,9 @@ export class GetAuthorizerCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/GetAuthorizersCommand.ts b/clients/client-api-gateway/commands/GetAuthorizersCommand.ts
index 2c35eebee0d5e..129578398a67a 100644
--- a/clients/client-api-gateway/commands/GetAuthorizersCommand.ts
+++ b/clients/client-api-gateway/commands/GetAuthorizersCommand.ts
@@ -20,6 +20,10 @@ import {
export type GetAuthorizersCommandInput = GetAuthorizersRequest;
export type GetAuthorizersCommandOutput = Authorizers & __MetadataBearer;
+/**
+ * Describe an existing Authorizers resource.
+ *
+ */
export class GetAuthorizersCommand extends $Command<
GetAuthorizersCommandInput,
GetAuthorizersCommandOutput,
@@ -34,6 +38,9 @@ export class GetAuthorizersCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/GetBasePathMappingCommand.ts b/clients/client-api-gateway/commands/GetBasePathMappingCommand.ts
index a6b9faed2af1a..ba5b10da0030b 100644
--- a/clients/client-api-gateway/commands/GetBasePathMappingCommand.ts
+++ b/clients/client-api-gateway/commands/GetBasePathMappingCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetBasePathMappingCommandInput = GetBasePathMappingRequest;
export type GetBasePathMappingCommandOutput = BasePathMapping & __MetadataBearer;
+/**
+ * Describe a BasePathMapping resource.
+ */
export class GetBasePathMappingCommand extends $Command<
GetBasePathMappingCommandInput,
GetBasePathMappingCommandOutput,
@@ -34,6 +37,9 @@ export class GetBasePathMappingCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/GetBasePathMappingsCommand.ts b/clients/client-api-gateway/commands/GetBasePathMappingsCommand.ts
index 4d5529498295c..e06fd11bbf560 100644
--- a/clients/client-api-gateway/commands/GetBasePathMappingsCommand.ts
+++ b/clients/client-api-gateway/commands/GetBasePathMappingsCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetBasePathMappingsCommandInput = GetBasePathMappingsRequest;
export type GetBasePathMappingsCommandOutput = BasePathMappings & __MetadataBearer;
+/**
+ * Represents a collection of BasePathMapping resources.
+ */
export class GetBasePathMappingsCommand extends $Command<
GetBasePathMappingsCommandInput,
GetBasePathMappingsCommandOutput,
@@ -34,6 +37,9 @@ export class GetBasePathMappingsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/GetClientCertificateCommand.ts b/clients/client-api-gateway/commands/GetClientCertificateCommand.ts
index e339e6a8dca96..a4d2e805a45fe 100644
--- a/clients/client-api-gateway/commands/GetClientCertificateCommand.ts
+++ b/clients/client-api-gateway/commands/GetClientCertificateCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetClientCertificateCommandInput = GetClientCertificateRequest;
export type GetClientCertificateCommandOutput = ClientCertificate & __MetadataBearer;
+/**
+ * Gets information about the current ClientCertificate resource.
+ */
export class GetClientCertificateCommand extends $Command<
GetClientCertificateCommandInput,
GetClientCertificateCommandOutput,
@@ -34,6 +37,9 @@ export class GetClientCertificateCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/GetClientCertificatesCommand.ts b/clients/client-api-gateway/commands/GetClientCertificatesCommand.ts
index c6c66137168db..63b92b24506be 100644
--- a/clients/client-api-gateway/commands/GetClientCertificatesCommand.ts
+++ b/clients/client-api-gateway/commands/GetClientCertificatesCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetClientCertificatesCommandInput = GetClientCertificatesRequest;
export type GetClientCertificatesCommandOutput = ClientCertificates & __MetadataBearer;
+/**
+ * Gets a collection of ClientCertificate resources.
+ */
export class GetClientCertificatesCommand extends $Command<
GetClientCertificatesCommandInput,
GetClientCertificatesCommandOutput,
@@ -34,6 +37,9 @@ export class GetClientCertificatesCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/GetDeploymentCommand.ts b/clients/client-api-gateway/commands/GetDeploymentCommand.ts
index 87a252c97ba68..a782c3c4ae6e0 100644
--- a/clients/client-api-gateway/commands/GetDeploymentCommand.ts
+++ b/clients/client-api-gateway/commands/GetDeploymentCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetDeploymentCommandInput = GetDeploymentRequest;
export type GetDeploymentCommandOutput = Deployment & __MetadataBearer;
+/**
+ * Gets information about a Deployment resource.
+ */
export class GetDeploymentCommand extends $Command<
GetDeploymentCommandInput,
GetDeploymentCommandOutput,
@@ -34,6 +37,9 @@ export class GetDeploymentCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/GetDeploymentsCommand.ts b/clients/client-api-gateway/commands/GetDeploymentsCommand.ts
index 42ca29b41621d..20e490662a508 100644
--- a/clients/client-api-gateway/commands/GetDeploymentsCommand.ts
+++ b/clients/client-api-gateway/commands/GetDeploymentsCommand.ts
@@ -20,6 +20,9 @@ import {
export type GetDeploymentsCommandInput = GetDeploymentsRequest;
export type GetDeploymentsCommandOutput = Deployments & __MetadataBearer;
+/**
+ * Gets information about a Deployments collection.
+ */
export class GetDeploymentsCommand extends $Command<
GetDeploymentsCommandInput,
GetDeploymentsCommandOutput,
@@ -34,6 +37,9 @@ export class GetDeploymentsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/GetDocumentationPartCommand.ts b/clients/client-api-gateway/commands/GetDocumentationPartCommand.ts
index fe0ccbd32f7b3..7bd37d55ab526 100644
--- a/clients/client-api-gateway/commands/GetDocumentationPartCommand.ts
+++ b/clients/client-api-gateway/commands/GetDocumentationPartCommand.ts
@@ -34,6 +34,9 @@ export class GetDocumentationPartCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack,
configuration: APIGatewayClientResolvedConfig,
diff --git a/clients/client-api-gateway/commands/GetDocumentationPartsCommand.ts b/clients/client-api-gateway/commands/GetDocumentationPartsCommand.ts
index 3f11a07ca733d..0c111d96b4b47 100644
--- a/clients/client-api-gateway/commands/GetDocumentationPartsCommand.ts
+++ b/clients/client-api-gateway/commands/GetDocumentationPartsCommand.ts
@@ -34,6 +34,9 @@ export class GetDocumentationPartsCommand extends $Command<
// End section: command_constructor
}
+ /**
+ * @internal
+ */
resolveMiddleware(
clientStack: MiddlewareStack