You can use AWS Certificate Manager (ACM) to manage SSL/TLS certificates for your AWS-based websites - * and applications. For more information about using ACM, see the AWS Certificate Manager User Guide.
+ *You can use Amazon Web Services Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites + * and applications. For more information about using ACM, see the Amazon Web Services Certificate Manager User Guide.
*/ export class ACM extends ACMClient { /** *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
+ * identify and organize your Amazon Web Services 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.
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 + * 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 Amazon Web Services * services integrated with ACM.
*You cannot delete an ACM certificate that is being used by another AWS service. To + *
You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To * delete a certificate that is in use, the certificate association must first be * removed.
*Returns the account - * configuration options associated with an AWS account.
+ * configuration options associated with an Amazon Web Services account. */ public getAccountConfiguration( args: GetAccountConfigurationCommandInput, @@ -307,13 +307,13 @@ export class ACM extends ACMClient { } /** - *Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with + *
Imports a certificate into Amazon Web Services 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.
+ * Certificates in the Amazon Web Services Certificate Manager User Guide. * *ACM does not provide managed renewal for certificates that you import.
@@ -594,16 +594,21 @@ export class ACM extends ACMClient { } /** - *Requests an ACM certificate for use with other AWS services. To request an ACM + *
Requests an ACM certificate for use with other Amazon Web Services 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.
+ * + *ACM behavior differs from the https://tools.ietf.org/html/rfc6125#appendix-B.2RFC 6125 specification of the + * certificate validation process. first checks for a subject alternative name, and, if it + * finds one, ignores the common name (CN)
+ *You can use AWS Certificate Manager (ACM) to manage SSL/TLS certificates for your AWS-based websites - * and applications. For more information about using ACM, see the AWS Certificate Manager User Guide.
+ *You can use Amazon Web Services Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites + * and applications. For more information about using ACM, see the Amazon Web Services Certificate Manager User Guide.
*/ export class ACMClient extends __Client< __HttpHandlerOptions, diff --git a/clients/client-acm/README.md b/clients/client-acm/README.md index 842ed13505ab6..d529b670eaf43 100644 --- a/clients/client-acm/README.md +++ b/clients/client-acm/README.md @@ -7,10 +7,10 @@ AWS SDK for JavaScript ACM Client for Node.js, Browser and React Native. -You can use AWS Certificate Manager (ACM) to manage SSL/TLS certificates for your AWS-based websites -and applications. For more information about using ACM, see the AWS Certificate Manager User Guide.
+You can use Amazon Web Services Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites +and applications. For more information about using ACM, see the Amazon Web Services Certificate Manager User Guide.
## Installing diff --git a/clients/client-acm/commands/AddTagsToCertificateCommand.ts b/clients/client-acm/commands/AddTagsToCertificateCommand.ts index d0bbb16ad9ab1..e77eedf7b872a 100644 --- a/clients/client-acm/commands/AddTagsToCertificateCommand.ts +++ b/clients/client-acm/commands/AddTagsToCertificateCommand.ts @@ -22,7 +22,7 @@ export interface AddTagsToCertificateCommandOutput extends __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
+ * identify and organize your Amazon Web Services 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.
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 + * 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 Amazon Web Services * services integrated with ACM.
*You cannot delete an ACM certificate that is being used by another AWS service. To + *
You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To * delete a certificate that is in use, the certificate association must first be * removed.
*Returns the account - * configuration options associated with an AWS account.
+ * configuration options associated with an Amazon Web Services account. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-acm/commands/ImportCertificateCommand.ts b/clients/client-acm/commands/ImportCertificateCommand.ts index 0a254c46be9d7..f9c79a5f904e7 100644 --- a/clients/client-acm/commands/ImportCertificateCommand.ts +++ b/clients/client-acm/commands/ImportCertificateCommand.ts @@ -21,13 +21,13 @@ export interface ImportCertificateCommandInput extends ImportCertificateRequest export interface ImportCertificateCommandOutput extends ImportCertificateResponse, __MetadataBearer {} /** - *Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with + *
Imports a certificate into Amazon Web Services 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.
+ * Certificates in the Amazon Web Services Certificate Manager User Guide. * *ACM does not provide managed renewal for certificates that you import.
diff --git a/clients/client-acm/commands/RequestCertificateCommand.ts b/clients/client-acm/commands/RequestCertificateCommand.ts index e760c9b957c16..c9d587cab95e7 100644 --- a/clients/client-acm/commands/RequestCertificateCommand.ts +++ b/clients/client-acm/commands/RequestCertificateCommand.ts @@ -21,16 +21,21 @@ export interface RequestCertificateCommandInput extends RequestCertificateReques export interface RequestCertificateCommandOutput extends RequestCertificateResponse, __MetadataBearer {} /** - *Requests an ACM certificate for use with other AWS services. To request an ACM + *
Requests an ACM certificate for use with other Amazon Web Services 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.
+ * + *ACM behavior differs from the https://tools.ietf.org/html/rfc6125#appendix-B.2RFC 6125 specification of the + * certificate validation process. first checks for a subject alternative name, and, if it + * finds one, ignores the common name (CN)
+ *Contains a DNS record value that you can use to can use to validate ownership or control + *
Contains a DNS record value that you can use to validate ownership or control * of a domain. This is used by the DescribeCertificate action.
*/ export interface ResourceRecord { @@ -429,6 +429,7 @@ export enum KeyAlgorithm { EC_secp521r1 = "EC_secp521r1", RSA_1024 = "RSA_1024", RSA_2048 = "RSA_2048", + RSA_3072 = "RSA_3072", RSA_4096 = "RSA_4096", } @@ -585,7 +586,7 @@ export interface CertificateDetail { /** *The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see * Amazon Resource Names (ARNs) in - * the AWS General Reference.
+ * the Amazon Web Services General Reference. */ CertificateArn?: string; @@ -681,15 +682,15 @@ export interface CertificateDetail { SignatureAlgorithm?: string; /** - *A list of ARNs for the AWS resources that are using the certificate. A certificate can - * be used by multiple AWS resources.
+ *A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can + * be used by multiple Amazon Web Services resources.
*/ InUseBy?: string[]; /** *The reason the certificate request failed. This value exists only when the certificate
* status is FAILED. For more information, see Certificate Request
- * Failed in the AWS Certificate Manager User Guide.
The certificate is in use by another AWS service in the caller's account. Remove the + *
The certificate is in use by another Amazon Web Services service in the caller's account. Remove the * association and try again.
*/ export interface ResourceInUseException extends __SmithyException, $MetadataBearer { @@ -914,7 +915,7 @@ export namespace RequestInProgressException { /** *Object containing - * expiration events options associated with an AWS account.
+ * expiration events options associated with an Amazon Web Services account. */ export interface ExpiryEventsConfiguration { /** @@ -938,7 +939,7 @@ export namespace ExpiryEventsConfiguration { export interface GetAccountConfigurationResponse { /** *Expiration events - * configuration options associated with the AWS account.
+ * configuration options associated with the Amazon Web Services account. */ ExpiryEvents?: ExpiryEventsConfiguration; } @@ -1300,7 +1301,7 @@ export namespace PutAccountConfigurationRequest { /** *The supplied input - * failed to satisfy constraints of an AWS service.
+ * failed to satisfy constraints of an Amazon Web Services service. */ export interface ValidationException extends __SmithyException, $MetadataBearer { name: "ValidationException"; @@ -1512,7 +1513,7 @@ export interface RequestCertificateRequest { *The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used * to issue the certificate. If you do not provide an ARN and you are trying to request a private * certificate, ACM will attempt to issue a public certificate. For more information about - * private CAs, see the AWS Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form:
+ * private CAs, see the Amazon Web Services Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form: * *
* arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
diff --git a/clients/client-amplifybackend/models/models_0.ts b/clients/client-amplifybackend/models/models_0.ts
index b04c34b256d74..4998b7e4de3ae 100644
--- a/clients/client-amplifybackend/models/models_0.ts
+++ b/clients/client-amplifybackend/models/models_0.ts
@@ -386,7 +386,7 @@ export interface BackendAPIResourceConfig {
AdditionalAuthTypes?: BackendAPIAuthType[];
/**
- *
The API name used to interact with the data model, configured as a part of the amplify project.
+ *The API name used to interact with the data model, configured as a part of your Amplify project.
*/ ApiName?: string; @@ -581,7 +581,7 @@ export namespace SmsSettings { */ export interface CreateBackendAuthForgotPasswordConfig { /** - *Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.
+ *Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.
*/ DeliveryMethod: DeliveryMethod | string | undefined; @@ -641,11 +641,11 @@ export namespace Settings { } /** - *Describes whether multi-factor authentication policies should be applied for your Amazon Cognito user pool configured as a part of your Amplify project.
+ *Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
*/ export interface CreateBackendAuthMFAConfig { /** - *Describes whether MFA should be [ON, OFF, OPTIONAL] for authentication in your Amplify project.
+ *Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.
*/ MFAMode: MFAMode | string | undefined; @@ -682,12 +682,12 @@ export enum OAuthScopesElement { */ export interface BackendAuthSocialProviderConfig { /** - *Describes the client_id which can be obtained from the third-party social federation provider.
+ *Describes the client_id, which can be obtained from the third-party social federation provider.
*/ ClientId?: string; /** - *Describes the client_secret which can be obtained from third-party social federation providers.
+ *Describes the client_secret, which can be obtained from third-party social federation providers.
*/ ClientSecret?: string; } @@ -701,6 +701,40 @@ export namespace BackendAuthSocialProviderConfig { }); } +/** + *Describes Apple social federation configurations for allowing your app users to sign in using OAuth.
+ */ +export interface BackendAuthAppleProviderConfig { + /** + *Describes the client_id (also called Services ID) that comes from Apple.
+ */ + ClientId?: string; + + /** + *Describes the key_id that comes from Apple.
+ */ + KeyId?: string; + + /** + *Describes the private_key that comes from Apple.
+ */ + PrivateKey?: string; + + /** + *Describes the team_id that comes from Apple.
+ */ + TeamId?: string; +} + +export namespace BackendAuthAppleProviderConfig { + /** + * @internal + */ + export const filterSensitiveLog = (obj: BackendAuthAppleProviderConfig): any => ({ + ...obj, + }); +} + /** *The settings for using the social identity providers for access to your Amplify app.
*/ @@ -719,6 +753,11 @@ export interface SocialProviderSettings { *Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
*/ LoginWithAmazon?: BackendAuthSocialProviderConfig; + + /** + *Describes Apple social federation configurations for allowing your app users to sign in using OAuth.
+ */ + SignInWithApple?: BackendAuthAppleProviderConfig; } export namespace SocialProviderSettings { @@ -755,7 +794,7 @@ export interface CreateBackendAuthOAuthConfig { RedirectSignInURIs: string[] | undefined; /** - *Redirect URLs used by OAuth when a user signs out of an Amplify app.
+ *Redirect URLs that OAuth uses when a user signs out of an Amplify app.
*/ RedirectSignOutURIs: string[] | undefined; @@ -835,7 +874,7 @@ export interface CreateBackendAuthUserPoolConfig { ForgotPassword?: CreateBackendAuthForgotPasswordConfig; /** - *Describes whether multi-factor authentication policies should be applied for your Amazon Cognito user pool configured as a part of your Amplify project.
+ *Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
*/ Mfa?: CreateBackendAuthMFAConfig; @@ -2164,7 +2203,7 @@ export namespace UpdateBackendAPIResponse { */ export interface UpdateBackendAuthIdentityPoolConfig { /** - *A boolean value which can be set to allow or disallow guest-level authorization into your Amplify app.
+ *A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.
*/ UnauthenticatedLogin?: boolean; } @@ -2251,12 +2290,12 @@ export interface UpdateBackendAuthOAuthConfig { OAuthScopes?: (OAuthScopesElement | string)[]; /** - *Redirect URLs used by OAuth when a user signs in to an Amplify app.
+ *Redirect URLs that OAuth uses when a user signs in to an Amplify app.
*/ RedirectSignInURIs?: string[]; /** - *Redirect URLs used by OAuth when a user signs out of an Amplify app.
+ *Redirect URLs that OAuth uses when a user signs out of an Amplify app.
*/ RedirectSignOutURIs?: string[]; @@ -2309,7 +2348,7 @@ export interface UpdateBackendAuthUserPoolConfig { ForgotPassword?: UpdateBackendAuthForgotPasswordConfig; /** - *Describes whether multi-factor authentication policies should be applied for your Amazon Cognito user pool configured as a part of your Amplify project.
+ *Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
*/ Mfa?: UpdateBackendAuthMFAConfig; @@ -2551,7 +2590,7 @@ export interface UpdateBackendJobRequest { JobId: string | undefined; /** - *Filters the list of response objects to only include those with the specified operation name.
+ *Filters the list of response objects to include only those with the specified operation name.
*/ Operation?: string; diff --git a/clients/client-amplifybackend/protocols/Aws_restJson1.ts b/clients/client-amplifybackend/protocols/Aws_restJson1.ts index 1a9ce968aa3cb..261d96d83f00e 100644 --- a/clients/client-amplifybackend/protocols/Aws_restJson1.ts +++ b/clients/client-amplifybackend/protocols/Aws_restJson1.ts @@ -44,6 +44,7 @@ import { BackendAPIAuthType, BackendAPIConflictResolution, BackendAPIResourceConfig, + BackendAuthAppleProviderConfig, BackendAuthSocialProviderConfig, BackendJobRespObj, BadRequestException, @@ -3641,6 +3642,18 @@ const serializeAws_restJson1BackendAPIResourceConfig = ( }; }; +const serializeAws_restJson1BackendAuthAppleProviderConfig = ( + input: BackendAuthAppleProviderConfig, + context: __SerdeContext +): any => { + return { + ...(input.ClientId !== undefined && input.ClientId !== null && { client_id: input.ClientId }), + ...(input.KeyId !== undefined && input.KeyId !== null && { key_id: input.KeyId }), + ...(input.PrivateKey !== undefined && input.PrivateKey !== null && { private_key: input.PrivateKey }), + ...(input.TeamId !== undefined && input.TeamId !== null && { team_id: input.TeamId }), + }; +}; + const serializeAws_restJson1BackendAuthSocialProviderConfig = ( input: BackendAuthSocialProviderConfig, context: __SerdeContext @@ -3914,6 +3927,10 @@ const serializeAws_restJson1SocialProviderSettings = (input: SocialProviderSetti input.LoginWithAmazon !== null && { LoginWithAmazon: serializeAws_restJson1BackendAuthSocialProviderConfig(input.LoginWithAmazon, context), }), + ...(input.SignInWithApple !== undefined && + input.SignInWithApple !== null && { + SignInWithApple: serializeAws_restJson1BackendAuthAppleProviderConfig(input.SignInWithApple, context), + }), }; }; @@ -4097,6 +4114,18 @@ const deserializeAws_restJson1BackendAPIResourceConfig = ( } as any; }; +const deserializeAws_restJson1BackendAuthAppleProviderConfig = ( + output: any, + context: __SerdeContext +): BackendAuthAppleProviderConfig => { + return { + ClientId: __expectString(output.client_id), + KeyId: __expectString(output.key_id), + PrivateKey: __expectString(output.private_key), + TeamId: __expectString(output.team_id), + } as any; +}; + const deserializeAws_restJson1BackendAuthSocialProviderConfig = ( output: any, context: __SerdeContext @@ -4388,6 +4417,10 @@ const deserializeAws_restJson1SocialProviderSettings = ( output.LoginWithAmazon !== undefined && output.LoginWithAmazon !== null ? deserializeAws_restJson1BackendAuthSocialProviderConfig(output.LoginWithAmazon, context) : undefined, + SignInWithApple: + output.SignInWithApple !== undefined && output.SignInWithApple !== null + ? deserializeAws_restJson1BackendAuthAppleProviderConfig(output.SignInWithApple, context) + : undefined, } as any; }; diff --git a/clients/client-appintegrations/AppIntegrations.ts b/clients/client-appintegrations/AppIntegrations.ts index 63ec5edb5cffb..71d84e96c9969 100644 --- a/clients/client-appintegrations/AppIntegrations.ts +++ b/clients/client-appintegrations/AppIntegrations.ts @@ -43,16 +43,13 @@ import { import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- * - *The Amazon AppIntegrations service enables you to configure and reuse connections to external applications.
+ *The Amazon AppIntegrations service enables you to configure and reuse connections to external applications.
*For information about how you can use external applications with Amazon Connect, see Set up pre-built integrations in the Amazon Connect Administrator Guide.
*/ export class AppIntegrations extends AppIntegrationsClient { /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Creates an EventIntegration, given a specified name, description, and a reference to an - * Amazon Eventbridge bus in your account and a partner event source that will push events to that bus. No + *
Creates an EventIntegration, given a specified name, description, and a reference to an + * Amazon EventBridge bus in your account and a partner event source that pushes events to that bus. No * objects are created in the your account, only metadata that is persisted on the EventIntegration * control plane.
*/ @@ -86,8 +83,7 @@ export class AppIntegrations extends AppIntegrationsClient { } /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Deletes the specified existing event integration. If the event integration is associated + *
Deletes the specified existing event integration. If the event integration is associated * with clients, the request is rejected.
*/ public deleteEventIntegration( @@ -120,8 +116,7 @@ export class AppIntegrations extends AppIntegrationsClient { } /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Return information about the event integration.
+ *Return information about the event integration.
*/ public getEventIntegration( args: GetEventIntegrationCommandInput, @@ -153,8 +148,7 @@ export class AppIntegrations extends AppIntegrationsClient { } /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Returns a paginated list of event integration associations in the account.
+ *Returns a paginated list of event integration associations in the account.
*/ public listEventIntegrationAssociations( args: ListEventIntegrationAssociationsCommandInput, @@ -186,8 +180,7 @@ export class AppIntegrations extends AppIntegrationsClient { } /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Returns a paginated list of event integrations in the account.
+ *Returns a paginated list of event integrations in the account.
*/ public listEventIntegrations( args: ListEventIntegrationsCommandInput, @@ -219,8 +212,7 @@ export class AppIntegrations extends AppIntegrationsClient { } /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Lists the tags for the specified resource.
+ *Lists the tags for the specified resource.
*/ public listTagsForResource( args: ListTagsForResourceCommandInput, @@ -252,8 +244,7 @@ export class AppIntegrations extends AppIntegrationsClient { } /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Adds the specified tags to the specified resource.
+ *Adds the specified tags to the specified resource.
*/ public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): PromiseThe Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Removes the specified tags from the specified resource.
+ *Removes the specified tags from the specified resource.
*/ public untagResource( args: UntagResourceCommandInput, @@ -312,8 +302,7 @@ export class AppIntegrations extends AppIntegrationsClient { } /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Updates the description of an event integration.
+ *Updates the description of an event integration.
*/ public updateEventIntegration( args: UpdateEventIntegrationCommandInput, diff --git a/clients/client-appintegrations/AppIntegrationsClient.ts b/clients/client-appintegrations/AppIntegrationsClient.ts index c30e894209050..30b23cf6e6da0 100644 --- a/clients/client-appintegrations/AppIntegrationsClient.ts +++ b/clients/client-appintegrations/AppIntegrationsClient.ts @@ -248,9 +248,7 @@ type AppIntegrationsClientResolvedConfigType = __SmithyResolvedConfiguration<__H export interface AppIntegrationsClientResolvedConfig extends AppIntegrationsClientResolvedConfigType {} /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- * - *The Amazon AppIntegrations service enables you to configure and reuse connections to external applications.
+ *The Amazon AppIntegrations service enables you to configure and reuse connections to external applications.
*For information about how you can use external applications with Amazon Connect, see Set up pre-built integrations in the Amazon Connect Administrator Guide.
*/ export class AppIntegrationsClient extends __Client< diff --git a/clients/client-appintegrations/README.md b/clients/client-appintegrations/README.md index 8921ac51ce656..be23ca55ddda5 100644 --- a/clients/client-appintegrations/README.md +++ b/clients/client-appintegrations/README.md @@ -7,8 +7,6 @@ AWS SDK for JavaScript AppIntegrations Client for Node.js, Browser and React Native. -The Amazon AppIntegrations APIs are in preview release and are subject to change.
-The Amazon AppIntegrations service enables you to configure and reuse connections to external applications.
For information about how you can use external applications with Amazon Connect, see Set up pre-built integrations in the Amazon Connect Administrator Guide.
diff --git a/clients/client-appintegrations/commands/CreateEventIntegrationCommand.ts b/clients/client-appintegrations/commands/CreateEventIntegrationCommand.ts index 65d098f2be457..08ac861633e61 100644 --- a/clients/client-appintegrations/commands/CreateEventIntegrationCommand.ts +++ b/clients/client-appintegrations/commands/CreateEventIntegrationCommand.ts @@ -21,9 +21,8 @@ export interface CreateEventIntegrationCommandInput extends CreateEventIntegrati export interface CreateEventIntegrationCommandOutput extends CreateEventIntegrationResponse, __MetadataBearer {} /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Creates an EventIntegration, given a specified name, description, and a reference to an - * Amazon Eventbridge bus in your account and a partner event source that will push events to that bus. No + *
Creates an EventIntegration, given a specified name, description, and a reference to an + * Amazon EventBridge bus in your account and a partner event source that pushes events to that bus. No * objects are created in the your account, only metadata that is persisted on the EventIntegration * control plane.
* @example diff --git a/clients/client-appintegrations/commands/DeleteEventIntegrationCommand.ts b/clients/client-appintegrations/commands/DeleteEventIntegrationCommand.ts index f8b0af51625ee..a8ff0301a3e1d 100644 --- a/clients/client-appintegrations/commands/DeleteEventIntegrationCommand.ts +++ b/clients/client-appintegrations/commands/DeleteEventIntegrationCommand.ts @@ -21,8 +21,7 @@ export interface DeleteEventIntegrationCommandInput extends DeleteEventIntegrati export interface DeleteEventIntegrationCommandOutput extends DeleteEventIntegrationResponse, __MetadataBearer {} /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Deletes the specified existing event integration. If the event integration is associated + *
Deletes the specified existing event integration. If the event integration is associated * with clients, the request is rejected.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-appintegrations/commands/GetEventIntegrationCommand.ts b/clients/client-appintegrations/commands/GetEventIntegrationCommand.ts index a1dfc020ff43e..8684ddbee2afa 100644 --- a/clients/client-appintegrations/commands/GetEventIntegrationCommand.ts +++ b/clients/client-appintegrations/commands/GetEventIntegrationCommand.ts @@ -21,8 +21,7 @@ export interface GetEventIntegrationCommandInput extends GetEventIntegrationRequ export interface GetEventIntegrationCommandOutput extends GetEventIntegrationResponse, __MetadataBearer {} /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Return information about the event integration.
+ *Return information about the event integration.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-appintegrations/commands/ListEventIntegrationAssociationsCommand.ts b/clients/client-appintegrations/commands/ListEventIntegrationAssociationsCommand.ts index 211034c843219..c7f9fa27d1ed1 100644 --- a/clients/client-appintegrations/commands/ListEventIntegrationAssociationsCommand.ts +++ b/clients/client-appintegrations/commands/ListEventIntegrationAssociationsCommand.ts @@ -23,8 +23,7 @@ export interface ListEventIntegrationAssociationsCommandOutput __MetadataBearer {} /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Returns a paginated list of event integration associations in the account.
+ *Returns a paginated list of event integration associations in the account.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-appintegrations/commands/ListEventIntegrationsCommand.ts b/clients/client-appintegrations/commands/ListEventIntegrationsCommand.ts index 1913d2a739397..584c1b0e83ebb 100644 --- a/clients/client-appintegrations/commands/ListEventIntegrationsCommand.ts +++ b/clients/client-appintegrations/commands/ListEventIntegrationsCommand.ts @@ -21,8 +21,7 @@ export interface ListEventIntegrationsCommandInput extends ListEventIntegrations export interface ListEventIntegrationsCommandOutput extends ListEventIntegrationsResponse, __MetadataBearer {} /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Returns a paginated list of event integrations in the account.
+ *Returns a paginated list of event integrations in the account.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-appintegrations/commands/ListTagsForResourceCommand.ts b/clients/client-appintegrations/commands/ListTagsForResourceCommand.ts index 17f8f50975e8c..49975a8568609 100644 --- a/clients/client-appintegrations/commands/ListTagsForResourceCommand.ts +++ b/clients/client-appintegrations/commands/ListTagsForResourceCommand.ts @@ -21,8 +21,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {} /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Lists the tags for the specified resource.
+ *Lists the tags for the specified resource.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-appintegrations/commands/TagResourceCommand.ts b/clients/client-appintegrations/commands/TagResourceCommand.ts index 8b7a1f65a4e14..b54d762fe1699 100644 --- a/clients/client-appintegrations/commands/TagResourceCommand.ts +++ b/clients/client-appintegrations/commands/TagResourceCommand.ts @@ -21,8 +21,7 @@ export interface TagResourceCommandInput extends TagResourceRequest {} export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {} /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Adds the specified tags to the specified resource.
+ *Adds the specified tags to the specified resource.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-appintegrations/commands/UntagResourceCommand.ts b/clients/client-appintegrations/commands/UntagResourceCommand.ts index 57ac0789a8484..224f75c061d07 100644 --- a/clients/client-appintegrations/commands/UntagResourceCommand.ts +++ b/clients/client-appintegrations/commands/UntagResourceCommand.ts @@ -21,8 +21,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {} export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {} /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Removes the specified tags from the specified resource.
+ *Removes the specified tags from the specified resource.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-appintegrations/commands/UpdateEventIntegrationCommand.ts b/clients/client-appintegrations/commands/UpdateEventIntegrationCommand.ts index caa552e8de213..72300f964f838 100644 --- a/clients/client-appintegrations/commands/UpdateEventIntegrationCommand.ts +++ b/clients/client-appintegrations/commands/UpdateEventIntegrationCommand.ts @@ -21,8 +21,7 @@ export interface UpdateEventIntegrationCommandInput extends UpdateEventIntegrati export interface UpdateEventIntegrationCommandOutput extends UpdateEventIntegrationResponse, __MetadataBearer {} /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *Updates the description of an event integration.
+ *Updates the description of an event integration.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-appintegrations/models/models_0.ts b/clients/client-appintegrations/models/models_0.ts index e50b262912907..1150587c6c7ba 100644 --- a/clients/client-appintegrations/models/models_0.ts +++ b/clients/client-appintegrations/models/models_0.ts @@ -19,8 +19,7 @@ export namespace AccessDeniedException { } /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *The event filter.
+ *The event filter.
*/ export interface EventFilter { /** @@ -55,7 +54,7 @@ export interface CreateEventIntegrationRequest { EventFilter: EventFilter | undefined; /** - *The Eventbridge bus.
+ *The EventBridge bus.
*/ EventBridgeBus: string | undefined; @@ -264,7 +263,7 @@ export interface GetEventIntegrationResponse { EventIntegrationArn?: string; /** - *The Eventbridge bus.
+ *The EventBridge bus.
*/ EventBridgeBus?: string; @@ -316,8 +315,7 @@ export namespace ListEventIntegrationAssociationsRequest { } /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *The event integration association.
+ *The event integration association.
*/ export interface EventIntegrationAssociation { /** @@ -341,7 +339,7 @@ export interface EventIntegrationAssociation { ClientId?: string; /** - *The name of the Eventbridge rule.
+ *The name of the EventBridge rule.
*/ EventBridgeRuleName?: string; @@ -404,8 +402,7 @@ export namespace ListEventIntegrationsRequest { } /** - *The Amazon AppIntegrations APIs are in preview release and are subject to change.
- *The event integration.
+ *The event integration.
*/ export interface EventIntegration { /** @@ -429,7 +426,7 @@ export interface EventIntegration { EventFilter?: EventFilter; /** - *The Amazon Eventbridge bus for the event integration.
+ *The Amazon EventBridge bus for the event integration.
*/ EventBridgeBus?: string; diff --git a/clients/client-auditmanager/AuditManager.ts b/clients/client-auditmanager/AuditManager.ts index 35b27cc849d2d..8889896c2d514 100644 --- a/clients/client-auditmanager/AuditManager.ts +++ b/clients/client-auditmanager/AuditManager.ts @@ -241,25 +241,25 @@ import { import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; /** - *Welcome to the AWS Audit Manager API reference. This guide is for developers who need detailed information about the AWS Audit Manager API operations, data types, and errors.
- *AWS Audit Manager is a service that provides automated evidence collection so that you - * can continuously audit your AWS usage, and assess the effectiveness of your controls to + *
Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors.
+ *Audit Manager is a service that provides automated evidence collection so that you + * can continuously audit your Amazon Web Services usage, and assess the effectiveness of your controls to * better manage risk and simplify compliance.
- *AWS Audit Manager provides pre-built frameworks that structure and automate assessments + *
Audit Manager provides pre-built frameworks that structure and automate assessments * for a given compliance standard. Frameworks include a pre-built collection of controls with * descriptions and testing procedures, which are grouped according to the requirements of the * specified compliance standard or regulation. You can also customize frameworks and controls * to support internal audits with unique requirements.
* - *Use the following links to get started with the AWS Audit Manager API:
+ *Use the following links to get started with the Audit Manager API:
*- * Actions: An alphabetical list of all AWS Audit Manager API operations.
+ * Actions: An alphabetical list of all Audit Manager API operations. *- * Data types: An alphabetical list of all AWS Audit Manager data types.
+ * Data types: An alphabetical list of all Audit Manager data types. *@@ -271,12 +271,12 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; *
If you're new to AWS Audit Manager, we recommend that you review the AWS Audit Manager User Guide.
+ *If you're new to Audit Manager, we recommend that you review the Audit Manager User Guide.
*/ export class AuditManager extends AuditManagerClient { /** *- * Associates an evidence folder to the specified assessment report in AWS Audit Manager. + * Associates an evidence folder to the specified assessment report in Audit Manager. *
*/ public associateAssessmentReportEvidenceFolder( @@ -312,7 +312,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Associates a list of evidence to an assessment report in an AWS Audit Manager assessment. + * Associates a list of evidence to an assessment report in an Audit Manager assessment. *
*/ public batchAssociateAssessmentReportEvidence( @@ -348,7 +348,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Create a batch of delegations for a specified assessment in AWS Audit Manager. + * Create a batch of delegations for a specified assessment in Audit Manager. *
*/ public batchCreateDelegationByAssessment( @@ -382,7 +382,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Deletes the delegations in the specified AWS Audit Manager assessment. + * Deletes the delegations in the specified Audit Manager assessment. *
*/ public batchDeleteDelegationByAssessment( @@ -416,7 +416,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Disassociates a list of evidence from the specified assessment report in AWS Audit Manager. + * Disassociates a list of evidence from the specified assessment report in Audit Manager. *
*/ public batchDisassociateAssessmentReportEvidence( @@ -452,7 +452,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Uploads one or more pieces of evidence to the specified control in the assessment in AWS Audit Manager. + * Uploads one or more pieces of evidence to the specified control in the assessment in Audit Manager. *
*/ public batchImportEvidenceToAssessmentControl( @@ -488,7 +488,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Creates an assessment in AWS Audit Manager. + * Creates an assessment in Audit Manager. *
*/ public createAssessment( @@ -522,7 +522,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Creates a custom framework in AWS Audit Manager. + * Creates a custom framework in Audit Manager. *
*/ public createAssessmentFramework( @@ -590,7 +590,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Creates a new custom control in AWS Audit Manager. + * Creates a new custom control in Audit Manager. *
*/ public createControl( @@ -624,7 +624,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Deletes an assessment in AWS Audit Manager. + * Deletes an assessment in Audit Manager. *
*/ public deleteAssessment( @@ -658,7 +658,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Deletes a custom framework in AWS Audit Manager. + * Deletes a custom framework in Audit Manager. *
*/ public deleteAssessmentFramework( @@ -692,7 +692,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Deletes an assessment report from an assessment in AWS Audit Manager. + * Deletes an assessment report from an assessment in Audit Manager. *
*/ public deleteAssessmentReport( @@ -726,7 +726,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Deletes a custom control in AWS Audit Manager. + * Deletes a custom control in Audit Manager. *
*/ public deleteControl( @@ -760,7 +760,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Deregisters an account in AWS Audit Manager. + * Deregisters an account in Audit Manager. *
*/ public deregisterAccount( @@ -793,9 +793,14 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Deregisters the delegated AWS administrator account from the AWS organization. - *
+ *Removes the specified member account as a delegated administrator for Audit Manager.
+ *When you remove a delegated administrator from your Audit Manager settings, or when you + * deregister a delegated administrator from Organizations, you continue to have access + * to the evidence that you previously collected under that account. However, Audit Manager + * will stop collecting and attaching evidence to that delegated administrator account + * moving forward.
+ *- * Disassociates an evidence folder from the specified assessment report in AWS Audit Manager. + * Disassociates an evidence folder from the specified assessment report in Audit Manager. *
*/ public disassociateAssessmentReportEvidenceFolder( @@ -864,7 +869,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns the registration status of an account in AWS Audit Manager. + * Returns the registration status of an account in Audit Manager. *
*/ public getAccountStatus( @@ -898,7 +903,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns an assessment from AWS Audit Manager. + * Returns an assessment from Audit Manager. *
*/ public getAssessment( @@ -932,7 +937,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns a framework from AWS Audit Manager. + * Returns a framework from Audit Manager. *
*/ public getAssessmentFramework( @@ -966,7 +971,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns the URL of a specified assessment report in AWS Audit Manager. + * Returns the URL of a specified assessment report in Audit Manager. *
*/ public getAssessmentReportUrl( @@ -1000,7 +1005,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns a list of changelogs from AWS Audit Manager. + * Returns a list of changelogs from Audit Manager. *
*/ public getChangeLogs( @@ -1034,7 +1039,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns a control from AWS Audit Manager. + * Returns a control from Audit Manager. *
*/ public getControl(args: GetControlCommandInput, options?: __HttpHandlerOptions): Promise- * Returns evidence from AWS Audit Manager. + * Returns evidence from Audit Manager. *
*/ public getEvidence(args: GetEvidenceCommandInput, options?: __HttpHandlerOptions): Promise- * Returns all evidence from a specified evidence folder in AWS Audit Manager. + * Returns all evidence from a specified evidence folder in Audit Manager. *
*/ public getEvidenceByEvidenceFolder( @@ -1158,7 +1163,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns an evidence folder from the specified assessment in AWS Audit Manager. + * Returns an evidence folder from the specified assessment in Audit Manager. *
*/ public getEvidenceFolder( @@ -1192,7 +1197,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns the evidence folders from a specified assessment in AWS Audit Manager. + * Returns the evidence folders from a specified assessment in Audit Manager. *
*/ public getEvidenceFoldersByAssessment( @@ -1226,7 +1231,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns a list of evidence folders associated with a specified control of an assessment in AWS Audit Manager. + * Returns a list of evidence folders associated with a specified control of an assessment in Audit Manager. *
*/ public getEvidenceFoldersByAssessmentControl( @@ -1262,7 +1267,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns the name of the delegated AWS administrator account for the AWS organization. + * Returns the name of the delegated Amazon Web Services administrator account for the organization. *
*/ public getOrganizationAdminAccount( @@ -1296,7 +1301,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns a list of the in-scope AWS services for the specified assessment. + * Returns a list of the in-scope Amazon Web Services services for the specified assessment. *
*/ public getServicesInScope( @@ -1330,7 +1335,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns the settings for the specified AWS account. + * Returns the settings for the specified account. *
*/ public getSettings(args: GetSettingsCommandInput, options?: __HttpHandlerOptions): Promise- * Returns a list of the frameworks available in the AWS Audit Manager framework library. + * Returns a list of the frameworks available in the Audit Manager framework library. *
*/ public listAssessmentFrameworks( @@ -1392,7 +1397,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns a list of assessment reports created in AWS Audit Manager. + * Returns a list of assessment reports created in Audit Manager. *
*/ public listAssessmentReports( @@ -1426,7 +1431,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns a list of current and past assessments from AWS Audit Manager. + * Returns a list of current and past assessments from Audit Manager. *
*/ public listAssessments( @@ -1460,7 +1465,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns a list of controls from AWS Audit Manager. + * Returns a list of controls from Audit Manager. *
*/ public listControls( @@ -1525,7 +1530,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns a list of all AWS Audit Manager notifications. + * Returns a list of all Audit Manager notifications. *
*/ public listNotifications( @@ -1559,7 +1564,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Returns a list of tags for the specified resource in AWS Audit Manager. + * Returns a list of tags for the specified resource in Audit Manager. *
*/ public listTagsForResource( @@ -1593,7 +1598,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Enables AWS Audit Manager for the specified AWS account. + * Enables Audit Manager for the specified account. *
*/ public registerAccount( @@ -1627,7 +1632,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Enables an AWS account within the organization as the delegated administrator for AWS Audit Manager. + * Enables an account within the organization as the delegated administrator for Audit Manager. *
*/ public registerOrganizationAdminAccount( @@ -1661,7 +1666,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Tags the specified resource in AWS Audit Manager. + * Tags the specified resource in Audit Manager. *
*/ public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise- * Removes a tag from a resource in AWS Audit Manager. + * Removes a tag from a resource in Audit Manager. *
*/ public untagResource( @@ -1723,7 +1728,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Edits an AWS Audit Manager assessment. + * Edits an Audit Manager assessment. *
*/ public updateAssessment( @@ -1757,7 +1762,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Updates a control within an assessment in AWS Audit Manager. + * Updates a control within an assessment in Audit Manager. *
*/ public updateAssessmentControl( @@ -1791,7 +1796,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Updates the status of a control set in an AWS Audit Manager assessment. + * Updates the status of a control set in an Audit Manager assessment. *
*/ public updateAssessmentControlSetStatus( @@ -1825,7 +1830,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Updates a custom framework in AWS Audit Manager. + * Updates a custom framework in Audit Manager. *
*/ public updateAssessmentFramework( @@ -1859,7 +1864,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Updates the status of an assessment in AWS Audit Manager. + * Updates the status of an assessment in Audit Manager. *
*/ public updateAssessmentStatus( @@ -1893,7 +1898,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Updates a custom control in AWS Audit Manager. + * Updates a custom control in Audit Manager. *
*/ public updateControl( @@ -1927,7 +1932,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Updates AWS Audit Manager settings for the current user account. + * Updates Audit Manager settings for the current user account. *
*/ public updateSettings( @@ -1961,7 +1966,7 @@ export class AuditManager extends AuditManagerClient { /** *- * Validates the integrity of an assessment report in AWS Audit Manager. + * Validates the integrity of an assessment report in Audit Manager. *
*/ public validateAssessmentReportIntegrity( diff --git a/clients/client-auditmanager/AuditManagerClient.ts b/clients/client-auditmanager/AuditManagerClient.ts index e6d62f40febab..e550387e23de5 100644 --- a/clients/client-auditmanager/AuditManagerClient.ts +++ b/clients/client-auditmanager/AuditManagerClient.ts @@ -437,25 +437,25 @@ type AuditManagerClientResolvedConfigType = __SmithyResolvedConfiguration<__Http export interface AuditManagerClientResolvedConfig extends AuditManagerClientResolvedConfigType {} /** - *Welcome to the AWS Audit Manager API reference. This guide is for developers who need detailed information about the AWS Audit Manager API operations, data types, and errors.
- *AWS Audit Manager is a service that provides automated evidence collection so that you - * can continuously audit your AWS usage, and assess the effectiveness of your controls to + *
Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors.
+ *Audit Manager is a service that provides automated evidence collection so that you + * can continuously audit your Amazon Web Services usage, and assess the effectiveness of your controls to * better manage risk and simplify compliance.
- *AWS Audit Manager provides pre-built frameworks that structure and automate assessments + *
Audit Manager provides pre-built frameworks that structure and automate assessments * for a given compliance standard. Frameworks include a pre-built collection of controls with * descriptions and testing procedures, which are grouped according to the requirements of the * specified compliance standard or regulation. You can also customize frameworks and controls * to support internal audits with unique requirements.
* - *Use the following links to get started with the AWS Audit Manager API:
+ *Use the following links to get started with the Audit Manager API:
*- * Actions: An alphabetical list of all AWS Audit Manager API operations.
+ * Actions: An alphabetical list of all Audit Manager API operations. *- * Data types: An alphabetical list of all AWS Audit Manager data types.
+ * Data types: An alphabetical list of all Audit Manager data types. *@@ -467,7 +467,7 @@ export interface AuditManagerClientResolvedConfig extends AuditManagerClientReso *
If you're new to AWS Audit Manager, we recommend that you review the AWS Audit Manager User Guide.
+ *If you're new to Audit Manager, we recommend that you review the Audit Manager User Guide.
*/ export class AuditManagerClient extends __Client< __HttpHandlerOptions, diff --git a/clients/client-auditmanager/README.md b/clients/client-auditmanager/README.md index b65c813fa2224..465466bdada64 100644 --- a/clients/client-auditmanager/README.md +++ b/clients/client-auditmanager/README.md @@ -7,25 +7,25 @@ AWS SDK for JavaScript AuditManager Client for Node.js, Browser and React Native. -Welcome to the AWS Audit Manager API reference. This guide is for developers who need detailed information about the AWS Audit Manager API operations, data types, and errors.
-AWS Audit Manager is a service that provides automated evidence collection so that you -can continuously audit your AWS usage, and assess the effectiveness of your controls to +
Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors.
+Audit Manager is a service that provides automated evidence collection so that you +can continuously audit your Amazon Web Services usage, and assess the effectiveness of your controls to better manage risk and simplify compliance.
-AWS Audit Manager provides pre-built frameworks that structure and automate assessments +
Audit Manager provides pre-built frameworks that structure and automate assessments for a given compliance standard. Frameworks include a pre-built collection of controls with descriptions and testing procedures, which are grouped according to the requirements of the specified compliance standard or regulation. You can also customize frameworks and controls to support internal audits with unique requirements.
-Use the following links to get started with the AWS Audit Manager API:
+Use the following links to get started with the Audit Manager API:
-Actions: An alphabetical list of all AWS Audit Manager API operations.
+Actions: An alphabetical list of all Audit Manager API operations.-Data types: An alphabetical list of all AWS Audit Manager data types.
+Data types: An alphabetical list of all Audit Manager data types.@@ -37,7 +37,7 @@ to support internal audits with unique requirements.
If you're new to AWS Audit Manager, we recommend that you review the AWS Audit Manager User Guide.
+If you're new to Audit Manager, we recommend that you review the Audit Manager User Guide.
## Installing diff --git a/clients/client-auditmanager/commands/AssociateAssessmentReportEvidenceFolderCommand.ts b/clients/client-auditmanager/commands/AssociateAssessmentReportEvidenceFolderCommand.ts index fe727db93712a..3252eaa5abcaa 100644 --- a/clients/client-auditmanager/commands/AssociateAssessmentReportEvidenceFolderCommand.ts +++ b/clients/client-auditmanager/commands/AssociateAssessmentReportEvidenceFolderCommand.ts @@ -28,7 +28,7 @@ export interface AssociateAssessmentReportEvidenceFolderCommandOutput /** *- * Associates an evidence folder to the specified assessment report in AWS Audit Manager. + * Associates an evidence folder to the specified assessment report in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/BatchAssociateAssessmentReportEvidenceCommand.ts b/clients/client-auditmanager/commands/BatchAssociateAssessmentReportEvidenceCommand.ts index fd961a529aa15..afcc2af5b1a05 100644 --- a/clients/client-auditmanager/commands/BatchAssociateAssessmentReportEvidenceCommand.ts +++ b/clients/client-auditmanager/commands/BatchAssociateAssessmentReportEvidenceCommand.ts @@ -28,7 +28,7 @@ export interface BatchAssociateAssessmentReportEvidenceCommandOutput /** *- * Associates a list of evidence to an assessment report in an AWS Audit Manager assessment. + * Associates a list of evidence to an assessment report in an Audit Manager assessment. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/BatchCreateDelegationByAssessmentCommand.ts b/clients/client-auditmanager/commands/BatchCreateDelegationByAssessmentCommand.ts index ac5b19d8928e9..193b4ff8c6756 100644 --- a/clients/client-auditmanager/commands/BatchCreateDelegationByAssessmentCommand.ts +++ b/clients/client-auditmanager/commands/BatchCreateDelegationByAssessmentCommand.ts @@ -27,7 +27,7 @@ export interface BatchCreateDelegationByAssessmentCommandOutput /** *- * Create a batch of delegations for a specified assessment in AWS Audit Manager. + * Create a batch of delegations for a specified assessment in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/BatchDeleteDelegationByAssessmentCommand.ts b/clients/client-auditmanager/commands/BatchDeleteDelegationByAssessmentCommand.ts index 35152b09c434e..ed30cd46d511c 100644 --- a/clients/client-auditmanager/commands/BatchDeleteDelegationByAssessmentCommand.ts +++ b/clients/client-auditmanager/commands/BatchDeleteDelegationByAssessmentCommand.ts @@ -27,7 +27,7 @@ export interface BatchDeleteDelegationByAssessmentCommandOutput /** *- * Deletes the delegations in the specified AWS Audit Manager assessment. + * Deletes the delegations in the specified Audit Manager assessment. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/BatchDisassociateAssessmentReportEvidenceCommand.ts b/clients/client-auditmanager/commands/BatchDisassociateAssessmentReportEvidenceCommand.ts index ee8d5ea73f6f2..1f583b400a538 100644 --- a/clients/client-auditmanager/commands/BatchDisassociateAssessmentReportEvidenceCommand.ts +++ b/clients/client-auditmanager/commands/BatchDisassociateAssessmentReportEvidenceCommand.ts @@ -28,7 +28,7 @@ export interface BatchDisassociateAssessmentReportEvidenceCommandOutput /** *- * Disassociates a list of evidence from the specified assessment report in AWS Audit Manager. + * Disassociates a list of evidence from the specified assessment report in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/BatchImportEvidenceToAssessmentControlCommand.ts b/clients/client-auditmanager/commands/BatchImportEvidenceToAssessmentControlCommand.ts index 41f279a757ea3..2e84529aaf9b3 100644 --- a/clients/client-auditmanager/commands/BatchImportEvidenceToAssessmentControlCommand.ts +++ b/clients/client-auditmanager/commands/BatchImportEvidenceToAssessmentControlCommand.ts @@ -28,7 +28,7 @@ export interface BatchImportEvidenceToAssessmentControlCommandOutput /** *- * Uploads one or more pieces of evidence to the specified control in the assessment in AWS Audit Manager. + * Uploads one or more pieces of evidence to the specified control in the assessment in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/CreateAssessmentCommand.ts b/clients/client-auditmanager/commands/CreateAssessmentCommand.ts index 5d694ef541061..8a8fbf8ef33b7 100644 --- a/clients/client-auditmanager/commands/CreateAssessmentCommand.ts +++ b/clients/client-auditmanager/commands/CreateAssessmentCommand.ts @@ -22,7 +22,7 @@ export interface CreateAssessmentCommandOutput extends CreateAssessmentResponse, /** *- * Creates an assessment in AWS Audit Manager. + * Creates an assessment in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/CreateAssessmentFrameworkCommand.ts b/clients/client-auditmanager/commands/CreateAssessmentFrameworkCommand.ts index 4bd42ab8cf7ac..7714c395e839f 100644 --- a/clients/client-auditmanager/commands/CreateAssessmentFrameworkCommand.ts +++ b/clients/client-auditmanager/commands/CreateAssessmentFrameworkCommand.ts @@ -22,7 +22,7 @@ export interface CreateAssessmentFrameworkCommandOutput extends CreateAssessment /** *- * Creates a custom framework in AWS Audit Manager. + * Creates a custom framework in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/CreateControlCommand.ts b/clients/client-auditmanager/commands/CreateControlCommand.ts index 43027350b2b26..08ca12c12a819 100644 --- a/clients/client-auditmanager/commands/CreateControlCommand.ts +++ b/clients/client-auditmanager/commands/CreateControlCommand.ts @@ -22,7 +22,7 @@ export interface CreateControlCommandOutput extends CreateControlResponse, __Met /** *- * Creates a new custom control in AWS Audit Manager. + * Creates a new custom control in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/DeleteAssessmentCommand.ts b/clients/client-auditmanager/commands/DeleteAssessmentCommand.ts index d62d61433a50d..2b0991d1124aa 100644 --- a/clients/client-auditmanager/commands/DeleteAssessmentCommand.ts +++ b/clients/client-auditmanager/commands/DeleteAssessmentCommand.ts @@ -22,7 +22,7 @@ export interface DeleteAssessmentCommandOutput extends DeleteAssessmentResponse, /** *- * Deletes an assessment in AWS Audit Manager. + * Deletes an assessment in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/DeleteAssessmentFrameworkCommand.ts b/clients/client-auditmanager/commands/DeleteAssessmentFrameworkCommand.ts index f02997320346b..687b4ccf5d904 100644 --- a/clients/client-auditmanager/commands/DeleteAssessmentFrameworkCommand.ts +++ b/clients/client-auditmanager/commands/DeleteAssessmentFrameworkCommand.ts @@ -22,7 +22,7 @@ export interface DeleteAssessmentFrameworkCommandOutput extends DeleteAssessment /** *- * Deletes a custom framework in AWS Audit Manager. + * Deletes a custom framework in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/DeleteAssessmentReportCommand.ts b/clients/client-auditmanager/commands/DeleteAssessmentReportCommand.ts index 324f5e116e130..9f246dc595f3b 100644 --- a/clients/client-auditmanager/commands/DeleteAssessmentReportCommand.ts +++ b/clients/client-auditmanager/commands/DeleteAssessmentReportCommand.ts @@ -22,7 +22,7 @@ export interface DeleteAssessmentReportCommandOutput extends DeleteAssessmentRep /** *- * Deletes an assessment report from an assessment in AWS Audit Manager. + * Deletes an assessment report from an assessment in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/DeleteControlCommand.ts b/clients/client-auditmanager/commands/DeleteControlCommand.ts index bec0750903fac..d9e81dc4f2e05 100644 --- a/clients/client-auditmanager/commands/DeleteControlCommand.ts +++ b/clients/client-auditmanager/commands/DeleteControlCommand.ts @@ -22,7 +22,7 @@ export interface DeleteControlCommandOutput extends DeleteControlResponse, __Met /** *- * Deletes a custom control in AWS Audit Manager. + * Deletes a custom control in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/DeregisterAccountCommand.ts b/clients/client-auditmanager/commands/DeregisterAccountCommand.ts index 08bbdc5bba45d..c5fb23f66fb6b 100644 --- a/clients/client-auditmanager/commands/DeregisterAccountCommand.ts +++ b/clients/client-auditmanager/commands/DeregisterAccountCommand.ts @@ -22,7 +22,7 @@ export interface DeregisterAccountCommandOutput extends DeregisterAccountRespons /** *- * Deregisters an account in AWS Audit Manager. + * Deregisters an account in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/DeregisterOrganizationAdminAccountCommand.ts b/clients/client-auditmanager/commands/DeregisterOrganizationAdminAccountCommand.ts index c2e0fc2ecb3bb..e17a92e98fa84 100644 --- a/clients/client-auditmanager/commands/DeregisterOrganizationAdminAccountCommand.ts +++ b/clients/client-auditmanager/commands/DeregisterOrganizationAdminAccountCommand.ts @@ -26,9 +26,14 @@ export interface DeregisterOrganizationAdminAccountCommandOutput __MetadataBearer {} /** - *- * Deregisters the delegated AWS administrator account from the AWS organization. - *
+ *Removes the specified member account as a delegated administrator for Audit Manager.
+ *When you remove a delegated administrator from your Audit Manager settings, or when you + * deregister a delegated administrator from Organizations, you continue to have access + * to the evidence that you previously collected under that account. However, Audit Manager + * will stop collecting and attaching evidence to that delegated administrator account + * moving forward.
+ *- * Disassociates an evidence folder from the specified assessment report in AWS Audit Manager. + * Disassociates an evidence folder from the specified assessment report in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/GetAccountStatusCommand.ts b/clients/client-auditmanager/commands/GetAccountStatusCommand.ts index 6d60e660c46a4..36c85d5e38906 100644 --- a/clients/client-auditmanager/commands/GetAccountStatusCommand.ts +++ b/clients/client-auditmanager/commands/GetAccountStatusCommand.ts @@ -22,7 +22,7 @@ export interface GetAccountStatusCommandOutput extends GetAccountStatusResponse, /** *- * Returns the registration status of an account in AWS Audit Manager. + * Returns the registration status of an account in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/GetAssessmentCommand.ts b/clients/client-auditmanager/commands/GetAssessmentCommand.ts index 74e36da6c1fad..d4852b2a58af2 100644 --- a/clients/client-auditmanager/commands/GetAssessmentCommand.ts +++ b/clients/client-auditmanager/commands/GetAssessmentCommand.ts @@ -22,7 +22,7 @@ export interface GetAssessmentCommandOutput extends GetAssessmentResponse, __Met /** *- * Returns an assessment from AWS Audit Manager. + * Returns an assessment from Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/GetAssessmentFrameworkCommand.ts b/clients/client-auditmanager/commands/GetAssessmentFrameworkCommand.ts index aacb8e16b4fd9..bf5ddd2ab26ff 100644 --- a/clients/client-auditmanager/commands/GetAssessmentFrameworkCommand.ts +++ b/clients/client-auditmanager/commands/GetAssessmentFrameworkCommand.ts @@ -22,7 +22,7 @@ export interface GetAssessmentFrameworkCommandOutput extends GetAssessmentFramew /** *- * Returns a framework from AWS Audit Manager. + * Returns a framework from Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/GetAssessmentReportUrlCommand.ts b/clients/client-auditmanager/commands/GetAssessmentReportUrlCommand.ts index b755476d7f5ae..0f8c28004b6b6 100644 --- a/clients/client-auditmanager/commands/GetAssessmentReportUrlCommand.ts +++ b/clients/client-auditmanager/commands/GetAssessmentReportUrlCommand.ts @@ -22,7 +22,7 @@ export interface GetAssessmentReportUrlCommandOutput extends GetAssessmentReport /** *- * Returns the URL of a specified assessment report in AWS Audit Manager. + * Returns the URL of a specified assessment report in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/GetChangeLogsCommand.ts b/clients/client-auditmanager/commands/GetChangeLogsCommand.ts index 656ee8e2923f2..9634ca60449e6 100644 --- a/clients/client-auditmanager/commands/GetChangeLogsCommand.ts +++ b/clients/client-auditmanager/commands/GetChangeLogsCommand.ts @@ -22,7 +22,7 @@ export interface GetChangeLogsCommandOutput extends GetChangeLogsResponse, __Met /** *- * Returns a list of changelogs from AWS Audit Manager. + * Returns a list of changelogs from Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/GetControlCommand.ts b/clients/client-auditmanager/commands/GetControlCommand.ts index 94fa98f24a4b7..873bd3b5a53bd 100644 --- a/clients/client-auditmanager/commands/GetControlCommand.ts +++ b/clients/client-auditmanager/commands/GetControlCommand.ts @@ -22,7 +22,7 @@ export interface GetControlCommandOutput extends GetControlResponse, __MetadataB /** *- * Returns a control from AWS Audit Manager. + * Returns a control from Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/GetEvidenceByEvidenceFolderCommand.ts b/clients/client-auditmanager/commands/GetEvidenceByEvidenceFolderCommand.ts index 3788eff5b82f4..49fee4483deaa 100644 --- a/clients/client-auditmanager/commands/GetEvidenceByEvidenceFolderCommand.ts +++ b/clients/client-auditmanager/commands/GetEvidenceByEvidenceFolderCommand.ts @@ -24,7 +24,7 @@ export interface GetEvidenceByEvidenceFolderCommandOutput /** *- * Returns all evidence from a specified evidence folder in AWS Audit Manager. + * Returns all evidence from a specified evidence folder in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/GetEvidenceCommand.ts b/clients/client-auditmanager/commands/GetEvidenceCommand.ts index a21365b76b695..4ad50f6ab3b81 100644 --- a/clients/client-auditmanager/commands/GetEvidenceCommand.ts +++ b/clients/client-auditmanager/commands/GetEvidenceCommand.ts @@ -22,7 +22,7 @@ export interface GetEvidenceCommandOutput extends GetEvidenceResponse, __Metadat /** *- * Returns evidence from AWS Audit Manager. + * Returns evidence from Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/GetEvidenceFolderCommand.ts b/clients/client-auditmanager/commands/GetEvidenceFolderCommand.ts index 055820893ac20..4b9c4cd0aee25 100644 --- a/clients/client-auditmanager/commands/GetEvidenceFolderCommand.ts +++ b/clients/client-auditmanager/commands/GetEvidenceFolderCommand.ts @@ -22,7 +22,7 @@ export interface GetEvidenceFolderCommandOutput extends GetEvidenceFolderRespons /** *- * Returns an evidence folder from the specified assessment in AWS Audit Manager. + * Returns an evidence folder from the specified assessment in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentCommand.ts b/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentCommand.ts index 238b528bff0d3..5ca5bd05241a5 100644 --- a/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentCommand.ts +++ b/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentCommand.ts @@ -24,7 +24,7 @@ export interface GetEvidenceFoldersByAssessmentCommandOutput /** *- * Returns the evidence folders from a specified assessment in AWS Audit Manager. + * Returns the evidence folders from a specified assessment in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentControlCommand.ts b/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentControlCommand.ts index 1427b87a16d42..f67aead74b7f5 100644 --- a/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentControlCommand.ts +++ b/clients/client-auditmanager/commands/GetEvidenceFoldersByAssessmentControlCommand.ts @@ -28,7 +28,7 @@ export interface GetEvidenceFoldersByAssessmentControlCommandOutput /** *- * Returns a list of evidence folders associated with a specified control of an assessment in AWS Audit Manager. + * Returns a list of evidence folders associated with a specified control of an assessment in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/GetOrganizationAdminAccountCommand.ts b/clients/client-auditmanager/commands/GetOrganizationAdminAccountCommand.ts index 770df1349dfe1..7375ff347d311 100644 --- a/clients/client-auditmanager/commands/GetOrganizationAdminAccountCommand.ts +++ b/clients/client-auditmanager/commands/GetOrganizationAdminAccountCommand.ts @@ -24,7 +24,7 @@ export interface GetOrganizationAdminAccountCommandOutput /** *- * Returns the name of the delegated AWS administrator account for the AWS organization. + * Returns the name of the delegated Amazon Web Services administrator account for the organization. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/GetServicesInScopeCommand.ts b/clients/client-auditmanager/commands/GetServicesInScopeCommand.ts index f14f9889adcf6..408b07f40ab20 100644 --- a/clients/client-auditmanager/commands/GetServicesInScopeCommand.ts +++ b/clients/client-auditmanager/commands/GetServicesInScopeCommand.ts @@ -22,7 +22,7 @@ export interface GetServicesInScopeCommandOutput extends GetServicesInScopeRespo /** *- * Returns a list of the in-scope AWS services for the specified assessment. + * Returns a list of the in-scope Amazon Web Services services for the specified assessment. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/GetSettingsCommand.ts b/clients/client-auditmanager/commands/GetSettingsCommand.ts index 16e8191b12843..db9e0b9fd9951 100644 --- a/clients/client-auditmanager/commands/GetSettingsCommand.ts +++ b/clients/client-auditmanager/commands/GetSettingsCommand.ts @@ -22,7 +22,7 @@ export interface GetSettingsCommandOutput extends GetSettingsResponse, __Metadat /** *- * Returns the settings for the specified AWS account. + * Returns the settings for the specified account. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/ListAssessmentFrameworksCommand.ts b/clients/client-auditmanager/commands/ListAssessmentFrameworksCommand.ts index fdb944f43e048..66e6640e76108 100644 --- a/clients/client-auditmanager/commands/ListAssessmentFrameworksCommand.ts +++ b/clients/client-auditmanager/commands/ListAssessmentFrameworksCommand.ts @@ -22,7 +22,7 @@ export interface ListAssessmentFrameworksCommandOutput extends ListAssessmentFra /** *- * Returns a list of the frameworks available in the AWS Audit Manager framework library. + * Returns a list of the frameworks available in the Audit Manager framework library. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/ListAssessmentReportsCommand.ts b/clients/client-auditmanager/commands/ListAssessmentReportsCommand.ts index c4d1f1c9d6f39..13e91896d1d9a 100644 --- a/clients/client-auditmanager/commands/ListAssessmentReportsCommand.ts +++ b/clients/client-auditmanager/commands/ListAssessmentReportsCommand.ts @@ -22,7 +22,7 @@ export interface ListAssessmentReportsCommandOutput extends ListAssessmentReport /** *- * Returns a list of assessment reports created in AWS Audit Manager. + * Returns a list of assessment reports created in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/ListAssessmentsCommand.ts b/clients/client-auditmanager/commands/ListAssessmentsCommand.ts index aaae9aa6450af..f385cf5420e7a 100644 --- a/clients/client-auditmanager/commands/ListAssessmentsCommand.ts +++ b/clients/client-auditmanager/commands/ListAssessmentsCommand.ts @@ -22,7 +22,7 @@ export interface ListAssessmentsCommandOutput extends ListAssessmentsResponse, _ /** *- * Returns a list of current and past assessments from AWS Audit Manager. + * Returns a list of current and past assessments from Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/ListControlsCommand.ts b/clients/client-auditmanager/commands/ListControlsCommand.ts index c4e84cd0f92cc..853c1017c4e53 100644 --- a/clients/client-auditmanager/commands/ListControlsCommand.ts +++ b/clients/client-auditmanager/commands/ListControlsCommand.ts @@ -22,7 +22,7 @@ export interface ListControlsCommandOutput extends ListControlsResponse, __Metad /** *- * Returns a list of controls from AWS Audit Manager. + * Returns a list of controls from Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/ListNotificationsCommand.ts b/clients/client-auditmanager/commands/ListNotificationsCommand.ts index d531a432b05f8..f8d1ff1d9df81 100644 --- a/clients/client-auditmanager/commands/ListNotificationsCommand.ts +++ b/clients/client-auditmanager/commands/ListNotificationsCommand.ts @@ -22,7 +22,7 @@ export interface ListNotificationsCommandOutput extends ListNotificationsRespons /** *- * Returns a list of all AWS Audit Manager notifications. + * Returns a list of all Audit Manager notifications. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/ListTagsForResourceCommand.ts b/clients/client-auditmanager/commands/ListTagsForResourceCommand.ts index f4ddb487e8cce..36c42e49ef80b 100644 --- a/clients/client-auditmanager/commands/ListTagsForResourceCommand.ts +++ b/clients/client-auditmanager/commands/ListTagsForResourceCommand.ts @@ -22,7 +22,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** *- * Returns a list of tags for the specified resource in AWS Audit Manager. + * Returns a list of tags for the specified resource in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/RegisterAccountCommand.ts b/clients/client-auditmanager/commands/RegisterAccountCommand.ts index 2086bfa276fc0..8044430a87ac0 100644 --- a/clients/client-auditmanager/commands/RegisterAccountCommand.ts +++ b/clients/client-auditmanager/commands/RegisterAccountCommand.ts @@ -22,7 +22,7 @@ export interface RegisterAccountCommandOutput extends RegisterAccountResponse, _ /** *- * Enables AWS Audit Manager for the specified AWS account. + * Enables Audit Manager for the specified account. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/RegisterOrganizationAdminAccountCommand.ts b/clients/client-auditmanager/commands/RegisterOrganizationAdminAccountCommand.ts index a05e190c1001f..6fdc116a24c17 100644 --- a/clients/client-auditmanager/commands/RegisterOrganizationAdminAccountCommand.ts +++ b/clients/client-auditmanager/commands/RegisterOrganizationAdminAccountCommand.ts @@ -24,7 +24,7 @@ export interface RegisterOrganizationAdminAccountCommandOutput /** *- * Enables an AWS account within the organization as the delegated administrator for AWS Audit Manager. + * Enables an account within the organization as the delegated administrator for Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/TagResourceCommand.ts b/clients/client-auditmanager/commands/TagResourceCommand.ts index fa3c53c13d099..bfdf8902bd9f0 100644 --- a/clients/client-auditmanager/commands/TagResourceCommand.ts +++ b/clients/client-auditmanager/commands/TagResourceCommand.ts @@ -22,7 +22,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** *- * Tags the specified resource in AWS Audit Manager. + * Tags the specified resource in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/UntagResourceCommand.ts b/clients/client-auditmanager/commands/UntagResourceCommand.ts index a92a20cd976ac..1463639cfa537 100644 --- a/clients/client-auditmanager/commands/UntagResourceCommand.ts +++ b/clients/client-auditmanager/commands/UntagResourceCommand.ts @@ -22,7 +22,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** *- * Removes a tag from a resource in AWS Audit Manager. + * Removes a tag from a resource in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/UpdateAssessmentCommand.ts b/clients/client-auditmanager/commands/UpdateAssessmentCommand.ts index 156f3fea1785b..176ba2b0ca9b4 100644 --- a/clients/client-auditmanager/commands/UpdateAssessmentCommand.ts +++ b/clients/client-auditmanager/commands/UpdateAssessmentCommand.ts @@ -22,7 +22,7 @@ export interface UpdateAssessmentCommandOutput extends UpdateAssessmentResponse, /** *- * Edits an AWS Audit Manager assessment. + * Edits an Audit Manager assessment. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/UpdateAssessmentControlCommand.ts b/clients/client-auditmanager/commands/UpdateAssessmentControlCommand.ts index 90e0815a99ca6..7fa1c3005b38a 100644 --- a/clients/client-auditmanager/commands/UpdateAssessmentControlCommand.ts +++ b/clients/client-auditmanager/commands/UpdateAssessmentControlCommand.ts @@ -22,7 +22,7 @@ export interface UpdateAssessmentControlCommandOutput extends UpdateAssessmentCo /** *- * Updates a control within an assessment in AWS Audit Manager. + * Updates a control within an assessment in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/UpdateAssessmentControlSetStatusCommand.ts b/clients/client-auditmanager/commands/UpdateAssessmentControlSetStatusCommand.ts index 9922eac5a4a19..9f1b832b06e98 100644 --- a/clients/client-auditmanager/commands/UpdateAssessmentControlSetStatusCommand.ts +++ b/clients/client-auditmanager/commands/UpdateAssessmentControlSetStatusCommand.ts @@ -24,7 +24,7 @@ export interface UpdateAssessmentControlSetStatusCommandOutput /** *- * Updates the status of a control set in an AWS Audit Manager assessment. + * Updates the status of a control set in an Audit Manager assessment. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/UpdateAssessmentFrameworkCommand.ts b/clients/client-auditmanager/commands/UpdateAssessmentFrameworkCommand.ts index ae8f655da36de..28dfd403cc10e 100644 --- a/clients/client-auditmanager/commands/UpdateAssessmentFrameworkCommand.ts +++ b/clients/client-auditmanager/commands/UpdateAssessmentFrameworkCommand.ts @@ -22,7 +22,7 @@ export interface UpdateAssessmentFrameworkCommandOutput extends UpdateAssessment /** *- * Updates a custom framework in AWS Audit Manager. + * Updates a custom framework in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/UpdateAssessmentStatusCommand.ts b/clients/client-auditmanager/commands/UpdateAssessmentStatusCommand.ts index c59d5c5b0208c..eb69fffd99a83 100644 --- a/clients/client-auditmanager/commands/UpdateAssessmentStatusCommand.ts +++ b/clients/client-auditmanager/commands/UpdateAssessmentStatusCommand.ts @@ -22,7 +22,7 @@ export interface UpdateAssessmentStatusCommandOutput extends UpdateAssessmentSta /** *- * Updates the status of an assessment in AWS Audit Manager. + * Updates the status of an assessment in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/UpdateControlCommand.ts b/clients/client-auditmanager/commands/UpdateControlCommand.ts index fbab9b262b785..458a4c43a721a 100644 --- a/clients/client-auditmanager/commands/UpdateControlCommand.ts +++ b/clients/client-auditmanager/commands/UpdateControlCommand.ts @@ -22,7 +22,7 @@ export interface UpdateControlCommandOutput extends UpdateControlResponse, __Met /** *- * Updates a custom control in AWS Audit Manager. + * Updates a custom control in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/UpdateSettingsCommand.ts b/clients/client-auditmanager/commands/UpdateSettingsCommand.ts index 1211b671728aa..c405a7d739e44 100644 --- a/clients/client-auditmanager/commands/UpdateSettingsCommand.ts +++ b/clients/client-auditmanager/commands/UpdateSettingsCommand.ts @@ -22,7 +22,7 @@ export interface UpdateSettingsCommandOutput extends UpdateSettingsResponse, __M /** *- * Updates AWS Audit Manager settings for the current user account. + * Updates Audit Manager settings for the current user account. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/commands/ValidateAssessmentReportIntegrityCommand.ts b/clients/client-auditmanager/commands/ValidateAssessmentReportIntegrityCommand.ts index fbb21a0adedb0..d29e9f8e7b4f0 100644 --- a/clients/client-auditmanager/commands/ValidateAssessmentReportIntegrityCommand.ts +++ b/clients/client-auditmanager/commands/ValidateAssessmentReportIntegrityCommand.ts @@ -27,7 +27,7 @@ export interface ValidateAssessmentReportIntegrityCommandOutput /** *- * Validates the integrity of an assessment report in AWS Audit Manager. + * Validates the integrity of an assessment report in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/models/models_0.ts b/clients/client-auditmanager/models/models_0.ts index 382addf69d5b1..ee67b88208a48 100644 --- a/clients/client-auditmanager/models/models_0.ts +++ b/clients/client-auditmanager/models/models_0.ts @@ -2,7 +2,7 @@ import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException /** *- * Your account is not registered with AWS Audit Manager. Check the delegated administrator setup on the AWS Audit Manager settings page, and try again. + * Your account is not registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. *
*/ export interface AccessDeniedException extends __SmithyException, $MetadataBearer { @@ -39,27 +39,27 @@ export enum ActionEnum { /** *- * The wrapper of AWS account details, such as account ID, email address, and so on. + * The wrapper of account details, such as account ID, email address, and so on. *
*/ export interface AWSAccount { /** *- * The identifier for the specified AWS account. + * The identifier for the specified account. *
*/ id?: string; /** *- * The email address associated with the specified AWS account. + * The email address associated with the specified account. *
*/ emailAddress?: string; /** *- * The name of the specified AWS account. + * The name of the specified account. *
*/ name?: string; @@ -126,7 +126,7 @@ export enum ControlStatus { /** *- * The control entity that represents a standard or custom control used in an AWS Audit Manager assessment. + * The control entity that represents a standard or custom control used in an Audit Manager assessment. *
*/ export interface AssessmentControl { @@ -310,7 +310,7 @@ export namespace Delegation { /** *- * The wrapper that contains the AWS Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN). + * The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN). *
*/ export interface Role { @@ -351,7 +351,7 @@ export enum ControlSetStatus { /** *- * Represents a set of controls in an AWS Audit Manager assessment. + * Represents a set of controls in an Audit Manager assessment. *
*/ export interface AssessmentControlSet { @@ -467,7 +467,7 @@ export namespace FrameworkMetadata { /** *- * The file used to structure and automate AWS Audit Manager assessments for a given compliance standard. + * The file used to structure and automate Audit Manager assessments for a given compliance standard. *
*/ export interface AssessmentFramework { @@ -515,7 +515,7 @@ export enum AssessmentReportDestinationType { /** *- * The location in which AWS Audit Manager saves assessment reports for the given assessment. + * The location in which Audit Manager saves assessment reports for the given assessment. *
*/ export interface AssessmentReportsDestination { @@ -545,13 +545,13 @@ export namespace AssessmentReportsDestination { /** *- * An AWS service such as Amazon S3, AWS CloudTrail, and so on. + * An Amazon Web Service such as Amazon S3, CloudTrail, and so on. *
*/ export interface AWSService { /** *- * The name of the AWS service. + * The name of the Amazon Web Service. *
*/ serviceName?: string; @@ -568,20 +568,20 @@ export namespace AWSService { /** *- * The wrapper that contains the AWS accounts and AWS services in scope for the assessment. + * The wrapper that contains the accounts and services in scope for the assessment. *
*/ export interface Scope { /** *- * The AWS accounts included in the scope of the assessment. + * The accounts included in the scope of the assessment. *
*/ awsAccounts?: AWSAccount[]; /** *- * The AWS services included in the scope of the assessment. + * The Amazon Web Services services included in the scope of the assessment. *
*/ awsServices?: AWSService[]; @@ -651,7 +651,7 @@ export interface AssessmentMetadata { /** *- * The wrapper of AWS accounts and services in scope for the assessment. + * The wrapper of accounts and services in scope for the assessment. *
*/ scope?: Scope; @@ -696,7 +696,7 @@ export namespace AssessmentMetadata { /** *- * An entity that defines the scope of audit evidence collected by AWS Audit Manager. An AWS Audit Manager assessment is an implementation of an AWS Audit Manager framework. + * An entity that defines the scope of audit evidence collected by Audit Manager. An Audit Manager assessment is an implementation of an Audit Manager framework. *
*/ export interface Assessment { @@ -709,7 +709,7 @@ export interface Assessment { /** *- * The AWS account associated with the assessment. + * The account associated with the assessment. *
*/ awsAccount?: AWSAccount; @@ -747,7 +747,7 @@ export namespace Assessment { /** *- * The folder in which AWS Audit Manager stores evidence for an assessment. + * The folder in which Audit Manager stores evidence for an assessment. *
*/ export interface AssessmentEvidenceFolder { @@ -796,7 +796,7 @@ export interface AssessmentEvidenceFolder { /** *- * The AWS service from which the evidence was collected. + * The Amazon Web Service from which the evidence was collected. *
*/ dataSource?: string; @@ -838,7 +838,7 @@ export interface AssessmentEvidenceFolder { /** *- * The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other AWS services such as Amazon EC2, Amazon S3, or IAM. + * The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other Amazon Web Services services such as Amazon EC2, Amazon S3, or IAM. *
*/ evidenceByTypeConfigurationDataCount?: number; @@ -852,29 +852,28 @@ export interface AssessmentEvidenceFolder { /** *- * The number of evidence that falls under the compliance check category. This evidence is collected from AWS Config or AWS Security Hub. + * The number of evidence that falls under the compliance check category. This evidence is collected from Config or Security Hub. *
*/ evidenceByTypeComplianceCheckCount?: number; /** *- * The total number of issues that were reported directly from AWS Security - * Hub, AWS Config, or both. + * The total number of issues that were reported directly from Security Hub, Config, or both. *
*/ evidenceByTypeComplianceCheckIssuesCount?: number; /** *- * The number of evidence that falls under the user activity category. This evidence is collected from AWS CloudTrail logs. + * The number of evidence that falls under the user activity category. This evidence is collected from CloudTrail logs. *
*/ evidenceByTypeUserActivityCount?: number; /** *- * The total number of AWS resources assessed to generate the evidence. + * The total number of Amazon Web Services resources assessed to generate the evidence. *
*/ evidenceAwsServiceSourceCount?: number; @@ -989,7 +988,7 @@ export namespace AssessmentFrameworkMetadata { /** *- * A metadata object associated with an assessment in AWS Audit Manager. + * A metadata object associated with an assessment in Audit Manager. *
*/ export interface AssessmentMetadataItem { @@ -1067,7 +1066,7 @@ export enum AssessmentReportStatus { /** *- * A finalized document generated from an AWS Audit Manager assessment. These reports summarize the relevant evidence collected for your audit, and link to the relevant evidence folders which are named and organized according to the controls specified in your assessment. + * A finalized document generated from an Audit Manager assessment. These reports summarize the relevant evidence collected for your audit, and link to the relevant evidence folders which are named and organized according to the controls specified in your assessment. *
*/ export interface AssessmentReport { @@ -1094,7 +1093,7 @@ export interface AssessmentReport { /** *- * The identifier for the specified AWS account. + * The identifier for the specified account. *
*/ awsAccountId?: string; @@ -1470,7 +1469,7 @@ export namespace BatchAssociateAssessmentReportEvidenceResponse { /** *- * A collection of attributes used to create a delegation for an assessment in AWS Audit Manager. + * A collection of attributes used to create a delegation for an assessment in Audit Manager. *
*/ export interface CreateDelegationRequest { @@ -1520,7 +1519,7 @@ export namespace CreateDelegationRequest { export interface BatchCreateDelegationByAssessmentRequest { /** *- * The API request to batch create delegations in AWS Audit Manager. + * The API request to batch create delegations in Audit Manager. *
*/ createDelegationRequests: CreateDelegationRequest[] | undefined; @@ -1550,7 +1549,7 @@ export namespace BatchCreateDelegationByAssessmentRequest { export interface BatchCreateDelegationByAssessmentError { /** *- * The API request to batch create delegations in AWS Audit Manager. + * The API request to batch create delegations in Audit Manager. *
*/ createDelegationRequest?: CreateDelegationRequest; @@ -1743,7 +1742,7 @@ export namespace BatchDisassociateAssessmentReportEvidenceResponse { /** *- * Evidence that is uploaded to AWS Audit Manager manually. + * Evidence that is uploaded to Audit Manager manually. *
*/ export interface ManualEvidence { @@ -1812,7 +1811,7 @@ export namespace BatchImportEvidenceToAssessmentControlRequest { export interface BatchImportEvidenceToAssessmentControlError { /** *- * Manual evidence that cannot be collected automatically by AWS Audit Manager. + * Manual evidence that cannot be collected automatically by Audit Manager. *
*/ manualEvidence?: ManualEvidence; @@ -1883,7 +1882,7 @@ export interface CreateAssessmentRequest { /** *- * The wrapper that contains the AWS accounts and AWS services in scope for the assessment. + * The wrapper that contains the accounts and services in scope for the assessment. *
*/ scope: Scope | undefined; @@ -1922,7 +1921,7 @@ export namespace CreateAssessmentRequest { export interface CreateAssessmentResponse { /** *- * An entity that defines the scope of audit evidence collected by AWS Audit Manager. An AWS Audit Manager assessment is an implementation of an AWS Audit Manager framework. + * An entity that defines the scope of audit evidence collected by Audit Manager. An Audit Manager assessment is an implementation of an Audit Manager framework. *
*/ assessment?: Assessment; @@ -1939,7 +1938,7 @@ export namespace CreateAssessmentResponse { /** *- * Control entity attributes that uniquely identify an existing control to be added to a framework in AWS Audit Manager. + * Control entity attributes that uniquely identify an existing control to be added to a framework in Audit Manager. *
*/ export interface CreateAssessmentFrameworkControl { @@ -1962,7 +1961,7 @@ export namespace CreateAssessmentFrameworkControl { /** *
- * A controlSet entity that represents a collection of controls in AWS Audit Manager. This does not contain the control set ID.
+ * A controlSet entity that represents a collection of controls in Audit Manager. This does not contain the control set ID.
*
- * The keyword to search for in AWS CloudTrail logs, AWS Config rules, AWS Security Hub checks, and AWS API names. + * The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names. *
*/ export interface SourceKeyword { @@ -2061,7 +2060,7 @@ export interface SourceKeyword { /** *- * The value of the keyword used to search AWS CloudTrail logs, AWS Config rules, AWS Security Hub checks, and AWS API names when mapping a control data source. + * The value of the keyword used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names when mapping a control data source. *
*/ keywordValue?: string; @@ -2091,7 +2090,7 @@ export enum SourceType { /** *- * The data source that determines from where AWS Audit Manager collects evidence for the control. + * The data source that determines from where Audit Manager collects evidence for the control. *
*/ export interface ControlMappingSource { @@ -2132,7 +2131,7 @@ export interface ControlMappingSource { /** *- * The keyword to search for in AWS CloudTrail logs, AWS Config rules, AWS Security Hub checks, and AWS API names. + * The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names. *
*/ sourceKeyword?: SourceKeyword; @@ -2168,7 +2167,7 @@ export enum ControlType { /** *- * A control in AWS Audit Manager. + * A control in Audit Manager. *
*/ export interface Control { @@ -2231,7 +2230,7 @@ export interface Control { /** *- * The data source that determines from where AWS Audit Manager collects evidence for the control. + * The data source that determines from where Audit Manager collects evidence for the control. *
*/ controlSources?: string; @@ -2290,7 +2289,7 @@ export namespace Control { /** *- * A set of controls in AWS Audit Manager. + * A set of controls in Audit Manager. *
*/ export interface ControlSet { @@ -2327,7 +2326,7 @@ export namespace ControlSet { /** *- * The file used to structure and automate AWS Audit Manager assessments for a given compliance standard. + * The file used to structure and automate Audit Manager assessments for a given compliance standard. *
*/ export interface Framework { @@ -2382,7 +2381,7 @@ export interface Framework { /** *- * The sources from which AWS Audit Manager collects evidence for the control. + * The sources from which Audit Manager collects evidence for the control. *
*/ controlSources?: string; @@ -2522,7 +2521,7 @@ export interface CreateControlMappingSource { /** *- * The description of the data source that determines from where AWS Audit Manager collects evidence for the control. + * The description of the data source that determines from where Audit Manager collects evidence for the control. *
*/ sourceDescription?: string; @@ -2544,7 +2543,7 @@ export interface CreateControlMappingSource { /** *- * The keyword to search for in AWS CloudTrail logs, AWS Config rules, AWS Security Hub checks, and AWS API names. + * The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names. *
*/ sourceKeyword?: SourceKeyword; @@ -2882,7 +2881,7 @@ export namespace GetAccountStatusRequest { export interface GetAccountStatusResponse { /** *- * The status of the specified AWS account. + * The status of the specified account. *
*/ status?: AccountStatus | string; @@ -2918,14 +2917,14 @@ export namespace GetAssessmentRequest { export interface GetAssessmentResponse { /** *- * An entity that defines the scope of audit evidence collected by AWS Audit Manager. An AWS Audit Manager assessment is an implementation of an AWS Audit Manager framework. + * An entity that defines the scope of audit evidence collected by Audit Manager. An Audit Manager assessment is an implementation of an Audit Manager framework. *
*/ assessment?: Assessment; /** *- * The wrapper that contains the AWS Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN). + * The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN). *
*/ userRole?: Role; @@ -3106,7 +3105,7 @@ export enum ObjectTypeEnum { /** *- * The record of a change within AWS Audit Manager, such as a modified assessment, a delegated control set, and so on. + * The record of a change within Audit Manager, such as a modified assessment, a delegated control set, and so on. *
*/ export interface ChangeLog { @@ -3140,7 +3139,7 @@ export interface ChangeLog { /** *- * The IAM user or role that performed the action. + * The IAM user or role that performed the action. *
*/ createdBy?: string; @@ -3373,7 +3372,7 @@ export namespace GetEvidenceRequest { /** *- * A system asset that is evaluated in an AWS Audit Manager assessment. + * A system asset that is evaluated in an Audit Manager assessment. *
*/ export interface Resource { @@ -3416,7 +3415,7 @@ export interface Evidence { /** *- * The identifier for the specified AWS account. + * The identifier for the specified account. *
*/ evidenceAwsAccountId?: string; @@ -3430,7 +3429,7 @@ export interface Evidence { /** *- * The AWS service from which the evidence is collected. + * The Amazon Web Service from which the evidence is collected. *
*/ eventSource?: string; @@ -3472,22 +3471,22 @@ export interface Evidence { /** *The evaluation status for evidence that falls under the compliance check category. For - * evidence collected from AWS Security Hub, a Pass or - * Fail result is shown. For evidence collected from AWS Config, a + * evidence collected from Security Hub, a Pass or + * Fail result is shown. For evidence collected from Config, a * Compliant or Noncompliant result is shown.
*/ complianceCheck?: string; /** *- * The AWS account from which the evidence is collected, and its AWS organization path. + * The account from which the evidence is collected, and its organization path. *
*/ awsOrganization?: string; /** *- * The identifier for the specified AWS account. + * The identifier for the specified account. *
*/ awsAccountId?: string; @@ -3838,34 +3837,34 @@ export namespace GetServicesInScopeRequest { /** *- * The metadata associated with the specified AWS service. + * The metadata associated with the specified Amazon Web Service. *
*/ export interface ServiceMetadata { /** *- * The name of the AWS service. + * The name of the Amazon Web Service. *
*/ name?: string; /** *- * The display name of the AWS service. + * The display name of the Amazon Web Service. *
*/ displayName?: string; /** *- * The description of the specified AWS service. + * The description of the specified Amazon Web Service. *
*/ description?: string; /** *- * The category in which the AWS service belongs, such as compute, storage, database, and so on. + * The category in which the Amazon Web Service belongs, such as compute, storage, database, and so on. *
*/ category?: string; @@ -3883,7 +3882,7 @@ export namespace ServiceMetadata { export interface GetServicesInScopeResponse { /** *- * The metadata associated with the aAWS service. + * The metadata associated with the Amazon Web Service. *
*/ serviceMetadata?: ServiceMetadata[]; @@ -3926,20 +3925,20 @@ export namespace GetSettingsRequest { /** *- * The settings object that holds all supported AWS Audit Manager settings. + * The settings object that holds all supported Audit Manager settings. *
*/ export interface Settings { /** *- * Specifies whether AWS Organizations is enabled. + * Specifies whether Organizations is enabled. *
*/ isAwsOrgEnabled?: boolean; /** *- * The designated Amazon Simple Notification Service (Amazon SNS) topic. + * The designated Amazon Simple Notification Service (Amazon SNS) topic. *
*/ snsTopic?: string; @@ -3960,7 +3959,7 @@ export interface Settings { /** *- * The AWS KMS key details. + * The KMS key details. *
*/ kmsKey?: string; @@ -3978,7 +3977,7 @@ export namespace Settings { export interface GetSettingsResponse { /** *- * The settings object that holds all supported AWS Audit Manager settings. + * The settings object that holds all supported Audit Manager settings. *
*/ settings?: Settings; @@ -4211,7 +4210,7 @@ export interface ControlMetadata { /** *- * The data source that determines from where AWS Audit Manager collects evidence for the control. + * The data source that determines from where Audit Manager collects evidence for the control. *
*/ controlSources?: string; @@ -4349,7 +4348,7 @@ export namespace ListNotificationsRequest { /** *- * The notification used to inform a user of an update in AWS Audit Manager. For example, this includes the notification that is sent when a control set is delegated for review. + * The notification used to inform a user of an update in Audit Manager. For example, this includes the notification that is sent when a control set is delegated for review. *
*/ export interface Notification { @@ -4483,14 +4482,14 @@ export namespace ListTagsForResourceResponse { export interface RegisterAccountRequest { /** *- * The AWS KMS key details. + * The KMS key details. *
*/ kmsKey?: string; /** *- * The delegated administrator account for AWS Audit Manager. + * The delegated administrator account for Audit Manager. *
*/ delegatedAdminAccount?: string; @@ -4551,7 +4550,7 @@ export interface RegisterOrganizationAdminAccountResponse { /** *- * The identifier for the specified AWS organization. + * The identifier for the specified organization. *
*/ organizationId?: string; @@ -4833,7 +4832,7 @@ export namespace UpdateAssessmentControlSetStatusResponse { /** *
- * A controlSet entity that represents a collection of controls in AWS Audit Manager. This does not contain the control set ID.
+ * A controlSet entity that represents a collection of controls in Audit Manager. This does not contain the control set ID.
*
- * The Amazon Simple Notification Service (Amazon SNS) topic to which AWS Audit Manager sends notifications. + * The Amazon Simple Notification Service (Amazon SNS) topic to which Audit Manager sends notifications. *
*/ snsTopic?: string; @@ -5078,7 +5077,7 @@ export interface UpdateSettingsRequest { /** *- * The AWS KMS key details. + * The KMS key details. *
*/ kmsKey?: string; diff --git a/clients/client-chime/commands/GetVoiceConnectorLoggingConfigurationCommand.ts b/clients/client-chime/commands/GetVoiceConnectorLoggingConfigurationCommand.ts index 052280ba7cfc5..992d72be2f8ff 100644 --- a/clients/client-chime/commands/GetVoiceConnectorLoggingConfigurationCommand.ts +++ b/clients/client-chime/commands/GetVoiceConnectorLoggingConfigurationCommand.ts @@ -1,8 +1,6 @@ import { ChimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeClient"; -import { - GetVoiceConnectorLoggingConfigurationRequest, - GetVoiceConnectorLoggingConfigurationResponse, -} from "../models/models_0"; +import { GetVoiceConnectorLoggingConfigurationRequest } from "../models/models_0"; +import { GetVoiceConnectorLoggingConfigurationResponse } from "../models/models_1"; import { deserializeAws_restJson1GetVoiceConnectorLoggingConfigurationCommand, serializeAws_restJson1GetVoiceConnectorLoggingConfigurationCommand, diff --git a/clients/client-chime/models/models_0.ts b/clients/client-chime/models/models_0.ts index 0606d5149b7fc..f8734a305cd35 100644 --- a/clients/client-chime/models/models_0.ts +++ b/clients/client-chime/models/models_0.ts @@ -38,6 +38,11 @@ export namespace AccessDeniedException { }); } +export enum AccountStatus { + Active = "Active", + Suspended = "Suspended", +} + export enum AccountType { EnterpriseDirectory = "EnterpriseDirectory", EnterpriseLWA = "EnterpriseLWA", @@ -112,6 +117,11 @@ export interface Account { */ SupportedLicenses?: (License | string)[]; + /** + *The status of the account, Suspended or Active.
The sign-in delegate groups associated with the account.
*/ @@ -6882,19 +6892,3 @@ export namespace LoggingConfiguration { ...obj, }); } - -export interface GetVoiceConnectorLoggingConfigurationResponse { - /** - *The logging configuration details.
- */ - LoggingConfiguration?: LoggingConfiguration; -} - -export namespace GetVoiceConnectorLoggingConfigurationResponse { - /** - * @internal - */ - export const filterSensitiveLog = (obj: GetVoiceConnectorLoggingConfigurationResponse): any => ({ - ...obj, - }); -} diff --git a/clients/client-chime/models/models_1.ts b/clients/client-chime/models/models_1.ts index 0fced29a6e0d5..a79e1fa30861b 100644 --- a/clients/client-chime/models/models_1.ts +++ b/clients/client-chime/models/models_1.ts @@ -61,6 +61,22 @@ import { } from "./models_0"; import { SENSITIVE_STRING } from "@aws-sdk/smithy-client"; +export interface GetVoiceConnectorLoggingConfigurationResponse { + /** + *The logging configuration details.
+ */ + LoggingConfiguration?: LoggingConfiguration; +} + +export namespace GetVoiceConnectorLoggingConfigurationResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetVoiceConnectorLoggingConfigurationResponse): any => ({ + ...obj, + }); +} + export interface GetVoiceConnectorOriginationRequest { /** *The Amazon Chime Voice Connector ID.
diff --git a/clients/client-chime/protocols/Aws_restJson1.ts b/clients/client-chime/protocols/Aws_restJson1.ts index 713c671441a39..3902152c4e953 100644 --- a/clients/client-chime/protocols/Aws_restJson1.ts +++ b/clients/client-chime/protocols/Aws_restJson1.ts @@ -27972,6 +27972,7 @@ const serializeAws_restJson1VoiceConnectorSettings = (input: VoiceConnectorSetti const deserializeAws_restJson1Account = (output: any, context: __SerdeContext): Account => { return { AccountId: __expectString(output.AccountId), + AccountStatus: __expectString(output.AccountStatus), AccountType: __expectString(output.AccountType), AwsAccountId: __expectString(output.AwsAccountId), CreatedTimestamp: diff --git a/clients/client-cognito-identity-provider/CognitoIdentityProvider.ts b/clients/client-cognito-identity-provider/CognitoIdentityProvider.ts index 182e118f4a630..a8e74d99e455a 100644 --- a/clients/client-cognito-identity-provider/CognitoIdentityProvider.ts +++ b/clients/client-cognito-identity-provider/CognitoIdentityProvider.ts @@ -576,8 +576,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in. - *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages @@ -926,8 +925,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages @@ -1172,8 +1170,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages @@ -1224,8 +1221,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages @@ -1460,8 +1456,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages @@ -1842,8 +1837,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages @@ -2464,8 +2458,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages @@ -2722,8 +2715,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages @@ -2838,8 +2830,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages @@ -3091,7 +3082,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { } /** - *
Lists the user pools associated with an AWS account.
+ *Lists the user pools associated with an account.
*/ public listUserPools( args: ListUserPoolsCommandInput, @@ -3193,8 +3184,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in. - *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages @@ -3243,8 +3233,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages @@ -3439,8 +3428,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages @@ -3525,8 +3513,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages @@ -3763,10 +3750,6 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { /** *
Updates the specified group with the specified attributes.
*Calling this action requires developer credentials.
- *If you don't provide a value for an attribute, it will be set to the default - * value.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages @@ -3922,8 +3904,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages @@ -4008,7 +3989,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * pool.
*A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up * and sign-in pages for your application. When you set up a custom domain, you provide a - * certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can + * certificate that you manage with Certificate Manager (ACM). When necessary, you can * use this operation to change the certificate that you applied to your custom * domain.
*Usually, this is unnecessary following routine certificate renewal with ACM. When you @@ -4018,7 +3999,7 @@ export class CognitoIdentityProvider extends CognitoIdentityProviderClient { * certificate a new ARN. To apply the new certificate to your custom domain, you must * provide this ARN to Amazon Cognito.
*When you add your new certificate in ACM, you must choose US East (N. Virginia) as the - * AWS Region.
+ * Region. *After you submit your request, Amazon Cognito requires up to 1 hour to distribute your * new certificate to your custom domain.
*For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
diff --git a/clients/client-cognito-identity-provider/commands/AdminCreateUserCommand.ts b/clients/client-cognito-identity-provider/commands/AdminCreateUserCommand.ts index ccd8a7be1541b..9ac8d5b806169 100644 --- a/clients/client-cognito-identity-provider/commands/AdminCreateUserCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminCreateUserCommand.ts @@ -38,8 +38,7 @@ export interface AdminCreateUserCommandOutput extends AdminCreateUserResponse, _ * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in. - *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages diff --git a/clients/client-cognito-identity-provider/commands/AdminInitiateAuthCommand.ts b/clients/client-cognito-identity-provider/commands/AdminInitiateAuthCommand.ts index 1ccb1a8795c08..daf11f8a89c52 100644 --- a/clients/client-cognito-identity-provider/commands/AdminInitiateAuthCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminInitiateAuthCommand.ts @@ -37,8 +37,7 @@ export interface AdminInitiateAuthCommandOutput extends AdminInitiateAuthRespons * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages diff --git a/clients/client-cognito-identity-provider/commands/AdminResetUserPasswordCommand.ts b/clients/client-cognito-identity-provider/commands/AdminResetUserPasswordCommand.ts index fa08accf189c3..070935ec29af4 100644 --- a/clients/client-cognito-identity-provider/commands/AdminResetUserPasswordCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminResetUserPasswordCommand.ts @@ -46,8 +46,7 @@ export interface AdminResetUserPasswordCommandOutput extends AdminResetUserPassw * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages diff --git a/clients/client-cognito-identity-provider/commands/AdminRespondToAuthChallengeCommand.ts b/clients/client-cognito-identity-provider/commands/AdminRespondToAuthChallengeCommand.ts index 6ceeeb52fabed..6ea9fbfb8b423 100644 --- a/clients/client-cognito-identity-provider/commands/AdminRespondToAuthChallengeCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminRespondToAuthChallengeCommand.ts @@ -38,8 +38,7 @@ export interface AdminRespondToAuthChallengeCommandOutput * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages diff --git a/clients/client-cognito-identity-provider/commands/AdminUpdateUserAttributesCommand.ts b/clients/client-cognito-identity-provider/commands/AdminUpdateUserAttributesCommand.ts index 3c1e073f052da..47af8cee497fd 100644 --- a/clients/client-cognito-identity-provider/commands/AdminUpdateUserAttributesCommand.ts +++ b/clients/client-cognito-identity-provider/commands/AdminUpdateUserAttributesCommand.ts @@ -41,8 +41,7 @@ export interface AdminUpdateUserAttributesCommandOutput extends AdminUpdateUserA * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages diff --git a/clients/client-cognito-identity-provider/commands/CreateUserPoolCommand.ts b/clients/client-cognito-identity-provider/commands/CreateUserPoolCommand.ts index e8794193676ea..1a494d83d5d56 100644 --- a/clients/client-cognito-identity-provider/commands/CreateUserPoolCommand.ts +++ b/clients/client-cognito-identity-provider/commands/CreateUserPoolCommand.ts @@ -37,8 +37,7 @@ export interface CreateUserPoolCommandOutput extends CreateUserPoolResponse, __M * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages diff --git a/clients/client-cognito-identity-provider/commands/ForgotPasswordCommand.ts b/clients/client-cognito-identity-provider/commands/ForgotPasswordCommand.ts index 4cb05342944b6..fd40136d2ceb1 100644 --- a/clients/client-cognito-identity-provider/commands/ForgotPasswordCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ForgotPasswordCommand.ts @@ -42,8 +42,7 @@ export interface ForgotPasswordCommandOutput extends ForgotPasswordResponse, __M * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages diff --git a/clients/client-cognito-identity-provider/commands/GetUserAttributeVerificationCodeCommand.ts b/clients/client-cognito-identity-provider/commands/GetUserAttributeVerificationCodeCommand.ts index 4b34f306e19b8..0ec1fcca086d5 100644 --- a/clients/client-cognito-identity-provider/commands/GetUserAttributeVerificationCodeCommand.ts +++ b/clients/client-cognito-identity-provider/commands/GetUserAttributeVerificationCodeCommand.ts @@ -37,8 +37,7 @@ export interface GetUserAttributeVerificationCodeCommandOutput * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages diff --git a/clients/client-cognito-identity-provider/commands/InitiateAuthCommand.ts b/clients/client-cognito-identity-provider/commands/InitiateAuthCommand.ts index 9aff0cc349747..7339c88f78da3 100644 --- a/clients/client-cognito-identity-provider/commands/InitiateAuthCommand.ts +++ b/clients/client-cognito-identity-provider/commands/InitiateAuthCommand.ts @@ -35,8 +35,7 @@ export interface InitiateAuthCommandOutput extends InitiateAuthResponse, __Metad * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages diff --git a/clients/client-cognito-identity-provider/commands/ListUserPoolsCommand.ts b/clients/client-cognito-identity-provider/commands/ListUserPoolsCommand.ts index dbc9953f905a7..daf59a0e5bb86 100644 --- a/clients/client-cognito-identity-provider/commands/ListUserPoolsCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ListUserPoolsCommand.ts @@ -26,7 +26,7 @@ export interface ListUserPoolsCommandInput extends ListUserPoolsRequest {} export interface ListUserPoolsCommandOutput extends ListUserPoolsResponse, __MetadataBearer {} /** - *
Lists the user pools associated with an AWS account.
+ *Lists the user pools associated with an account.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cognito-identity-provider/commands/ResendConfirmationCodeCommand.ts b/clients/client-cognito-identity-provider/commands/ResendConfirmationCodeCommand.ts index cf1471312e8f6..8b3a873938bcc 100644 --- a/clients/client-cognito-identity-provider/commands/ResendConfirmationCodeCommand.ts +++ b/clients/client-cognito-identity-provider/commands/ResendConfirmationCodeCommand.ts @@ -36,8 +36,7 @@ export interface ResendConfirmationCodeCommandOutput extends ResendConfirmationC * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in. - *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages diff --git a/clients/client-cognito-identity-provider/commands/RespondToAuthChallengeCommand.ts b/clients/client-cognito-identity-provider/commands/RespondToAuthChallengeCommand.ts index abdd03a50ffab..96164076cfdcb 100644 --- a/clients/client-cognito-identity-provider/commands/RespondToAuthChallengeCommand.ts +++ b/clients/client-cognito-identity-provider/commands/RespondToAuthChallengeCommand.ts @@ -35,8 +35,7 @@ export interface RespondToAuthChallengeCommandOutput extends RespondToAuthChalle * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages diff --git a/clients/client-cognito-identity-provider/commands/SetUserPoolMfaConfigCommand.ts b/clients/client-cognito-identity-provider/commands/SetUserPoolMfaConfigCommand.ts index 1c737953e0a6a..0e8c133ddf64c 100644 --- a/clients/client-cognito-identity-provider/commands/SetUserPoolMfaConfigCommand.ts +++ b/clients/client-cognito-identity-provider/commands/SetUserPoolMfaConfigCommand.ts @@ -36,8 +36,7 @@ export interface SetUserPoolMfaConfigCommandOutput extends SetUserPoolMfaConfigR * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages diff --git a/clients/client-cognito-identity-provider/commands/SignUpCommand.ts b/clients/client-cognito-identity-provider/commands/SignUpCommand.ts index fe9f3cccc0525..913e92b5cd784 100644 --- a/clients/client-cognito-identity-provider/commands/SignUpCommand.ts +++ b/clients/client-cognito-identity-provider/commands/SignUpCommand.ts @@ -33,8 +33,7 @@ export interface SignUpCommandOutput extends SignUpResponse, __MetadataBearer {} * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages diff --git a/clients/client-cognito-identity-provider/commands/UpdateGroupCommand.ts b/clients/client-cognito-identity-provider/commands/UpdateGroupCommand.ts index dfeee6e88c4aa..cc6b95e51c64b 100644 --- a/clients/client-cognito-identity-provider/commands/UpdateGroupCommand.ts +++ b/clients/client-cognito-identity-provider/commands/UpdateGroupCommand.ts @@ -28,10 +28,6 @@ export interface UpdateGroupCommandOutput extends UpdateGroupResponse, __Metadat /** *
Updates the specified group with the specified attributes.
*Calling this action requires developer credentials.
- *If you don't provide a value for an attribute, it will be set to the default - * value.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages diff --git a/clients/client-cognito-identity-provider/commands/UpdateUserPoolCommand.ts b/clients/client-cognito-identity-provider/commands/UpdateUserPoolCommand.ts index cde844b8985cd..8bbe9d7a1fa93 100644 --- a/clients/client-cognito-identity-provider/commands/UpdateUserPoolCommand.ts +++ b/clients/client-cognito-identity-provider/commands/UpdateUserPoolCommand.ts @@ -38,8 +38,7 @@ export interface UpdateUserPoolCommandOutput extends UpdateUserPoolResponse, __M * Cognito will use the the registered number automatically. Otherwise, Cognito users that must * receive SMS messages might be unable to sign up, activate their accounts, or sign * in.
- *If you have never used SMS text messages with Amazon Cognito or any other AWS - * service, Amazon SNS might place your account in SMS sandbox. In + *
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon SNS might place your account in SMS sandbox. In * sandbox * mode * , you’ll have limitations, such as sending messages diff --git a/clients/client-cognito-identity-provider/commands/UpdateUserPoolDomainCommand.ts b/clients/client-cognito-identity-provider/commands/UpdateUserPoolDomainCommand.ts index 39a505073a68b..2499796013671 100644 --- a/clients/client-cognito-identity-provider/commands/UpdateUserPoolDomainCommand.ts +++ b/clients/client-cognito-identity-provider/commands/UpdateUserPoolDomainCommand.ts @@ -33,7 +33,7 @@ export interface UpdateUserPoolDomainCommandOutput extends UpdateUserPoolDomainR * pool.
*A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up * and sign-in pages for your application. When you set up a custom domain, you provide a - * certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can + * certificate that you manage with Certificate Manager (ACM). When necessary, you can * use this operation to change the certificate that you applied to your custom * domain.
*Usually, this is unnecessary following routine certificate renewal with ACM. When you @@ -43,7 +43,7 @@ export interface UpdateUserPoolDomainCommandOutput extends UpdateUserPoolDomainR * certificate a new ARN. To apply the new certificate to your custom domain, you must * provide this ARN to Amazon Cognito.
*When you add your new certificate in ACM, you must choose US East (N. Virginia) as the - * AWS Region.
+ * Region. *After you submit your request, Amazon Cognito requires up to 1 hour to distribute your * new certificate to your custom domain.
*For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
diff --git a/clients/client-cognito-identity-provider/models/models_0.ts b/clients/client-cognito-identity-provider/models/models_0.ts index 27c0bb58ee750..fbf5063e8c05b 100644 --- a/clients/client-cognito-identity-provider/models/models_0.ts +++ b/clients/client-cognito-identity-provider/models/models_0.ts @@ -590,12 +590,12 @@ export interface AdminConfirmSignUpRequest { *A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
*If your user pool configuration includes triggers, the AdminConfirmSignUp API action
- * invokes the AWS Lambda function that is specified for the post
+ * invokes the Lambda function that is specified for the post
* confirmation trigger. When Amazon Cognito invokes this function, it
* passes a JSON payload, which the function receives as input. In this payload, the
* clientMetadata attribute provides the data that you assigned to the
* ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in
- * AWS Lambda, you can process the ClientMetadata value to enhance your workflow for your
+ * Lambda, you can process the ClientMetadata value to enhance your workflow for your
* specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the * Amazon Cognito Developer Guide.
@@ -605,7 +605,7 @@ export interface AdminConfirmSignUpRequest { *Amazon Cognito does not store the ClientMetadata value. This data is - * available only to AWS Lambda triggers that are assigned to a user pool to + * available only to Lambda triggers that are assigned to a user pool to * support custom workflows. If your user pool configuration does not include * triggers, the ClientMetadata parameter serves no purpose.
*This exception is thrown when the Amazon Cognito service encounters an invalid AWS - * Lambda response.
+ *This exception is thrown when the Amazon Cognito service encounters an invalid Lambda response.
*/ export interface InvalidLambdaResponseException extends __SmithyException, $MetadataBearer { name: "InvalidLambdaResponseException"; $fault: "client"; /** - *The message returned when the Amazon Cognito service throws an invalid AWS Lambda + *
The message returned when the Amazon Cognito service throws an invalid Lambda * response exception.
*/ message?: string; @@ -671,7 +670,7 @@ export namespace InvalidLambdaResponseException { } /** - *This exception is thrown when a user exceeds the limit for a requested AWS + *
This exception is thrown when a user exceeds the limit for a requested Amazon Web Services * resource.
*/ export interface LimitExceededException extends __SmithyException, $MetadataBearer { @@ -717,13 +716,13 @@ export namespace TooManyFailedAttemptsException { /** *This exception is thrown when the Amazon Cognito service encounters an unexpected - * exception with the AWS Lambda service.
+ * exception with the Lambda service. */ export interface UnexpectedLambdaException extends __SmithyException, $MetadataBearer { name: "UnexpectedLambdaException"; $fault: "client"; /** - *The message returned when the Amazon Cognito service returns an unexpected AWS Lambda + *
The message returned when the Amazon Cognito service returns an unexpected Lambda * exception.
*/ message?: string; @@ -740,14 +739,14 @@ export namespace UnexpectedLambdaException { /** *This exception is thrown when the Amazon Cognito service encounters a user validation - * exception with the AWS Lambda service.
+ * exception with the Lambda service. */ export interface UserLambdaValidationException extends __SmithyException, $MetadataBearer { name: "UserLambdaValidationException"; $fault: "client"; /** *The message returned when the Amazon Cognito service returns a user validation - * exception with the AWS Lambda service.
+ * exception with the Lambda service. */ message?: string; } @@ -910,13 +909,13 @@ export interface AdminCreateUserRequest { /** *A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
- *You create custom workflows by assigning AWS Lambda functions to user pool triggers. + *
You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is
* assigned to the pre sign-up trigger. When Amazon Cognito invokes
* this function, it passes a JSON payload, which the function receives as input. This
* payload contains a clientMetadata attribute, which provides the data that
* you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your
- * function code in AWS Lambda, you can process the clientMetadata value to
+ * function code in Lambda, you can process the clientMetadata value to
* enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the * Amazon Cognito Developer Guide.
@@ -926,7 +925,7 @@ export interface AdminCreateUserRequest { *Amazon Cognito does not store the ClientMetadata value. This data is - * available only to AWS Lambda triggers that are assigned to a user pool to + * available only to Lambda triggers that are assigned to a user pool to * support custom workflows. If your user pool configuration does not include * triggers, the ClientMetadata parameter serves no purpose.
*This exception is thrown when the trust relationship is invalid for the role provided
- * for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does
+ * for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does
* not match what is provided in the SMS configuration for the user pool.
A map of custom key-value pairs that you can provide as input for certain custom * workflows that this action triggers.
- *You create custom workflows by assigning AWS Lambda functions to user pool triggers. - * When you use the AdminInitiateAuth API action, Amazon Cognito invokes the AWS Lambda + *
You create custom workflows by assigning Lambda functions to user pool triggers. + * When you use the AdminInitiateAuth API action, Amazon Cognito invokes the Lambda * functions that are specified for various triggers. The ClientMetadata value is passed as * input to the functions for only the following triggers:
*validationData attribute, which provides the data that you assigned to
* the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in
- * AWS Lambda, you can process the validationData value to enhance your
+ * Lambda, you can process the validationData value to enhance your
* workflow for your specific needs.
* When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the * functions for the following triggers, but it does not provide the ClientMetadata value @@ -2086,7 +2085,7 @@ export interface AdminInitiateAuthRequest { *
Amazon Cognito does not store the ClientMetadata value. This data is - * available only to AWS Lambda triggers that are assigned to a user pool to + * available only to Lambda triggers that are assigned to a user pool to * support custom workflows. If your user pool configuration does not include * triggers, the ClientMetadata parameter serves no purpose.
*A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
- *You create custom workflows by assigning AWS Lambda functions to user pool triggers. + *
You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function
* that is assigned to the custom message trigger. When Amazon Cognito
* invokes this function, it passes a JSON payload, which the function receives as input.
* This payload contains a clientMetadata attribute, which provides the data
* that you assigned to the ClientMetadata parameter in your AdminResetUserPassword
- * request. In your function code in AWS Lambda, you can process the
+ * request. In your function code in Lambda, you can process the
* clientMetadata value to enhance your workflow for your specific
* needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the @@ -2995,7 +2994,7 @@ export interface AdminResetUserPasswordRequest { *
Amazon Cognito does not store the ClientMetadata value. This data is - * available only to AWS Lambda triggers that are assigned to a user pool to + * available only to Lambda triggers that are assigned to a user pool to * support custom workflows. If your user pool configuration does not include * triggers, the ClientMetadata parameter serves no purpose.
*A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
- *You create custom workflows by assigning AWS Lambda functions to user pool triggers. + *
You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any
* functions that are assigned to the following triggers: pre sign-up,
* custom message, post authentication,
@@ -3158,7 +3157,7 @@ export interface AdminRespondToAuthChallengeRequest {
* Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
* function receives as input. This payload contains a clientMetadata
* attribute, which provides the data that you assigned to the ClientMetadata parameter in
- * your AdminRespondToAuthChallenge request. In your function code in AWS Lambda, you can
+ * your AdminRespondToAuthChallenge request. In your function code in Lambda, you can
* process the clientMetadata value to enhance your workflow for your specific
* needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the @@ -3169,7 +3168,7 @@ export interface AdminRespondToAuthChallengeRequest { *
Amazon Cognito does not store the ClientMetadata value. This data is - * available only to AWS Lambda triggers that are assigned to a user pool to + * available only to Lambda triggers that are assigned to a user pool to * support custom workflows. If your user pool configuration does not include * triggers, the ClientMetadata parameter serves no purpose.
*A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
- *You create custom workflows by assigning AWS Lambda functions to user pool triggers. + *
You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the
* function that is assigned to the custom message trigger. When
* Amazon Cognito invokes this function, it passes a JSON payload, which the function
* receives as input. This payload contains a clientMetadata attribute, which
* provides the data that you assigned to the ClientMetadata parameter in your
- * AdminUpdateUserAttributes request. In your function code in AWS Lambda, you can process
+ * AdminUpdateUserAttributes request. In your function code in Lambda, you can process
* the clientMetadata value to enhance your workflow for your specific
* needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the @@ -3634,7 +3633,7 @@ export interface AdminUpdateUserAttributesRequest { *
Amazon Cognito does not store the ClientMetadata value. This data is - * available only to AWS Lambda triggers that are assigned to a user pool to + * available only to Lambda triggers that are assigned to a user pool to * support custom workflows. If your user pool configuration does not include * triggers, the ClientMetadata parameter serves no purpose.
*A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
- *You create custom workflows by assigning AWS Lambda functions to user pool triggers. + *
You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function
* that is assigned to the post confirmation trigger. When Amazon
* Cognito invokes this function, it passes a JSON payload, which the function receives as
* input. This payload contains a clientMetadata attribute, which provides the
* data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword
- * request. In your function code in AWS Lambda, you can process the
+ * request. In your function code in Lambda, you can process the
* clientMetadata value to enhance your workflow for your specific
* needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the @@ -4062,7 +4061,7 @@ export interface ConfirmForgotPasswordRequest { *
Amazon Cognito does not store the ClientMetadata value. This data is - * available only to AWS Lambda triggers that are assigned to a user pool to + * available only to Lambda triggers that are assigned to a user pool to * support custom workflows. If your user pool configuration does not include * triggers, the ClientMetadata parameter serves no purpose.
*A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
- *You create custom workflows by assigning AWS Lambda functions to user pool triggers. + *
You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is
* assigned to the post confirmation trigger. When Amazon Cognito
* invokes this function, it passes a JSON payload, which the function receives as input.
* This payload contains a clientMetadata attribute, which provides the data
* that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your
- * function code in AWS Lambda, you can process the clientMetadata value to
+ * function code in Lambda, you can process the clientMetadata value to
* enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the * Amazon Cognito Developer Guide.
@@ -4174,7 +4173,7 @@ export interface ConfirmSignUpRequest { *Amazon Cognito does not store the ClientMetadata value. This data is - * available only to AWS Lambda triggers that are assigned to a user pool to + * available only to Lambda triggers that are assigned to a user pool to * support custom workflows. If your user pool configuration does not include * triggers, the ClientMetadata parameter serves no purpose.
*If you use this option, you must provide the ARN of an Amazon SES verified
* email address for the SourceArn parameter.
Before Amazon Cognito can email your users, it requires additional
* permissions to call Amazon SES on your behalf. When you update your user
* pool with this option, Amazon Cognito creates a service-linked
- * role, which is a type of IAM role, in your AWS account. This
+ * role, which is a type of IAM role, in your account. This
* role contains the permissions that allow Amazon Cognito to access Amazon SES
* and send email messages with your address. For more information about the
* service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon
@@ -5100,7 +5099,7 @@ export interface EmailConfigurationType {
* Event publishing – Amazon SES can track the number of send, delivery, open,
* click, bounce, and complaint events for each email sent. Use event publishing to
- * send information about these events to other AWS services such as SNS and
+ * send information about these events to other Amazon Web Services services such as SNS and
* CloudWatch. Specifies the configuration for AWS Lambda triggers. Specifies the configuration for Lambda triggers. A pre-registration AWS Lambda trigger. A pre-registration Lambda trigger. A custom Message AWS Lambda trigger. A custom Message Lambda trigger. A post-confirmation AWS Lambda trigger. A post-confirmation Lambda trigger. A pre-authentication AWS Lambda trigger. A pre-authentication Lambda trigger. A post-authentication AWS Lambda trigger. A post-authentication Lambda trigger. A custom SMS sender AWS Lambda trigger. A custom SMS sender Lambda trigger. A custom email sender AWS Lambda trigger. A custom email sender Lambda trigger. The SMS configuration type that includes the settings the Cognito User Pool needs to
- * call for the Amazon SNS service to send an SMS message from your AWS account. The
- * Cognito User Pool makes the request to the Amazon SNS Service by using an AWS IAM role
- * that you provide for your AWS account.
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. - * This is the ARN of the IAM role in your AWS account which Cognito will use to send SMS + * This is the ARN of the IAM role in your account which Cognito will use to send SMS * messages. SMS messages are subject to a spending limit.
*/ SnsCallerArn: string | undefined; @@ -5369,7 +5368,7 @@ export interface SmsConfigurationType { * for SMS MFA, Cognito will create a role with the required permissions and a trust policy * that demonstrates use of theExternalId.
* For more information about the ExternalId of a role, see How to use an
- * external ID when granting access to your AWS resources to a third
+ * external ID when granting access to your Amazon Web Services resources to a third
* party
*
For more information on using the Lambda API to add permission, see * AddPermission .
- *For adding permission using the AWS CLI, see add-permission
+ * For adding permission using the CLI, see add-permission
* .
The AWS Lambda triggers associated with the user pool.
+ *The Lambda triggers associated with the user pool.
*/ LambdaConfig?: LambdaConfigType; @@ -5800,10 +5799,10 @@ export interface UserPoolType { * SMS messages is not properly configured. For more information, see SmsConfigurationType. * *SNSSandbox - The AWS account is in SNS Sandbox and messages won’t reach + *
SNSSandbox - The account is in SNS Sandbox and messages won’t reach * unverified end users. This parameter won’t get populated * with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. - * To learn how to move your AWS account out of the sandbox, see Moving out of the SMS sandbox.
+ * To learn how to move your account out of the sandbox, see Moving out of the SMS sandbox. *The allowed OAuth scopes. Possible values provided by OAuth are: phone,
* email, openid, and profile. Possible values
- * provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created
+ * provided by Amazon Web Services are: aws.cognito.signin.user.admin. Custom scopes created
* in Resource Servers are also supported.
The allowed OAuth scopes. Possible values provided by OAuth are: phone,
* email, openid, and profile. Possible values
- * provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created
+ * provided by Amazon Web Services are: aws.cognito.signin.user.admin. Custom scopes created
* in Resource Servers are also supported.
The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use + *
The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use * this certificate for the subdomain of your custom domain.
*/ CertificateArn: string | undefined; @@ -7214,7 +7213,7 @@ export interface DomainDescriptionType { UserPoolId?: string; /** - *The AWS account ID for the user pool owner.
+ *The account ID for the user pool owner.
*/ AWSAccountId?: string; @@ -7337,14 +7336,14 @@ export interface ForgotPasswordRequest { /** *A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
- *You create custom workflows by assigning AWS Lambda functions to user pool triggers. + *
You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the ForgotPassword API action, Amazon Cognito invokes any functions that
* are assigned to the following triggers: pre sign-up,
* custom message, and user migration. When
* Amazon Cognito invokes any of these functions, it passes a JSON payload, which the
* function receives as input. This payload contains a clientMetadata
* attribute, which provides the data that you assigned to the ClientMetadata parameter in
- * your ForgotPassword request. In your function code in AWS Lambda, you can process the
+ * your ForgotPassword request. In your function code in Lambda, you can process the
* clientMetadata value to enhance your workflow for your specific
* needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the @@ -7355,7 +7354,7 @@ export interface ForgotPasswordRequest { *
Amazon Cognito does not store the ClientMetadata value. This data is - * available only to AWS Lambda triggers that are assigned to a user pool to + * available only to Lambda triggers that are assigned to a user pool to * support custom workflows. If your user pool configuration does not include * triggers, the ClientMetadata parameter serves no purpose.
*A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
- *You create custom workflows by assigning AWS Lambda functions to user pool triggers. + *
You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the
* function that is assigned to the custom message trigger. When
* Amazon Cognito invokes this function, it passes a JSON payload, which the function
* receives as input. This payload contains a clientMetadata attribute, which
* provides the data that you assigned to the ClientMetadata parameter in your
- * GetUserAttributeVerificationCode request. In your function code in AWS Lambda, you can
+ * GetUserAttributeVerificationCode request. In your function code in Lambda, you can
* process the clientMetadata value to enhance your workflow for your specific
* needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the @@ -7834,7 +7833,7 @@ export interface GetUserAttributeVerificationCodeRequest { *
Amazon Cognito does not store the ClientMetadata value. This data is - * available only to AWS Lambda triggers that are assigned to a user pool to + * available only to Lambda triggers that are assigned to a user pool to * support custom workflows. If your user pool configuration does not include * triggers, the ClientMetadata parameter serves no purpose.
*A map of custom key-value pairs that you can provide as input for certain custom * workflows that this action triggers.
- *You create custom workflows by assigning AWS Lambda functions to user pool triggers. - * When you use the InitiateAuth API action, Amazon Cognito invokes the AWS Lambda + *
You create custom workflows by assigning Lambda functions to user pool triggers. + * When you use the InitiateAuth API action, Amazon Cognito invokes the Lambda * functions that are specified for various triggers. The ClientMetadata value is passed as * input to the functions for only the following triggers:
*When Amazon Cognito invokes the functions for these triggers, it passes a JSON
* payload, which the function receives as input. This payload contains a
* validationData attribute, which provides the data that you assigned to
- * the ClientMetadata parameter in your InitiateAuth request. In your function code in AWS
- * Lambda, you can process the validationData value to enhance your workflow
+ * the ClientMetadata parameter in your InitiateAuth request. In your function code in Lambda, you can process the validationData value to enhance your workflow
* for your specific needs.
When you use the InitiateAuth API action, Amazon Cognito also invokes the functions * for the following triggers, but it does not provide the ClientMetadata value as @@ -8161,7 +8159,7 @@ export interface InitiateAuthRequest { *
Amazon Cognito does not store the ClientMetadata value. This data is - * available only to AWS Lambda triggers that are assigned to a user pool to + * available only to Lambda triggers that are assigned to a user pool to * support custom workflows. If your user pool configuration does not include * triggers, the ClientMetadata parameter serves no purpose.
*The AWS Lambda configuration information in a user pool description.
+ *The Lambda configuration information in a user pool description.
*/ LambdaConfig?: LambdaConfigType; @@ -9052,13 +9050,13 @@ export interface ResendConfirmationCodeRequest { /** *A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
- *You create custom workflows by assigning AWS Lambda functions to user pool triggers. + *
You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function
* that is assigned to the custom message trigger. When Amazon Cognito
* invokes this function, it passes a JSON payload, which the function receives as input.
* This payload contains a clientMetadata attribute, which provides the data
* that you assigned to the ClientMetadata parameter in your ResendConfirmationCode
- * request. In your function code in AWS Lambda, you can process the
+ * request. In your function code in Lambda, you can process the
* clientMetadata value to enhance your workflow for your specific
* needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the @@ -9069,7 +9067,7 @@ export interface ResendConfirmationCodeRequest { *
Amazon Cognito does not store the ClientMetadata value. This data is - * available only to AWS Lambda triggers that are assigned to a user pool to + * available only to Lambda triggers that are assigned to a user pool to * support custom workflows. If your user pool configuration does not include * triggers, the ClientMetadata parameter serves no purpose.
*A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
- *You create custom workflows by assigning AWS Lambda functions to user pool triggers. + *
You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions
* that are assigned to the following triggers: post authentication,
* pre token generation, define auth
@@ -9219,7 +9217,7 @@ export interface RespondToAuthChallengeRequest {
* functions, it passes a JSON payload, which the function receives as input. This payload
* contains a clientMetadata attribute, which provides the data that you
* assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your
- * function code in AWS Lambda, you can process the clientMetadata value to
+ * function code in Lambda, you can process the clientMetadata value to
* enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the * Amazon Cognito Developer Guide.
@@ -9229,7 +9227,7 @@ export interface RespondToAuthChallengeRequest { *Amazon Cognito does not store the ClientMetadata value. This data is - * available only to AWS Lambda triggers that are assigned to a user pool to + * available only to Lambda triggers that are assigned to a user pool to * support custom workflows. If your user pool configuration does not include * triggers, the ClientMetadata parameter serves no purpose.
*A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
- *You create custom workflows by assigning AWS Lambda functions to user pool triggers. + *
You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the SignUp API action, Amazon Cognito invokes any functions that are
* assigned to the following triggers: pre sign-up, custom
* message, and post confirmation. When Amazon Cognito
* invokes any of these functions, it passes a JSON payload, which the function receives as
* input. This payload contains a clientMetadata attribute, which provides the
* data that you assigned to the ClientMetadata parameter in your SignUp request. In your
- * function code in AWS Lambda, you can process the clientMetadata value to
+ * function code in Lambda, you can process the clientMetadata value to
* enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the * Amazon Cognito Developer Guide.
@@ -9739,7 +9737,7 @@ export interface SignUpRequest { *Amazon Cognito does not store the ClientMetadata value. This data is - * available only to AWS Lambda triggers that are assigned to a user pool to + * available only to Lambda triggers that are assigned to a user pool to * support custom workflows. If your user pool configuration does not include * triggers, the ClientMetadata parameter serves no purpose.
*A map of custom key-value pairs that you can provide as input for any custom workflows * that this action triggers.
- *You create custom workflows by assigning AWS Lambda functions to user pool triggers. + *
You create custom workflows by assigning Lambda functions to user pool triggers.
* When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function
* that is assigned to the custom message trigger. When Amazon Cognito
* invokes this function, it passes a JSON payload, which the function receives as input.
* This payload contains a clientMetadata attribute, which provides the data
* that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request.
- * In your function code in AWS Lambda, you can process the clientMetadata
+ * In your function code in Lambda, you can process the clientMetadata
* value to enhance your workflow for your specific needs.
For more information, see Customizing User Pool Workflows with Lambda Triggers in the * Amazon Cognito Developer Guide.
@@ -441,7 +441,7 @@ export interface UpdateUserAttributesRequest { *Amazon Cognito does not store the ClientMetadata value. This data is - * available only to AWS Lambda triggers that are assigned to a user pool to + * available only to Lambda triggers that are assigned to a user pool to * support custom workflows. If your user pool configuration does not include * triggers, the ClientMetadata parameter serves no purpose.
*The AWS Lambda configuration information from the request to update the user + *
The Lambda configuration information from the request to update the user * pool.
*/ LambdaConfig?: LambdaConfigType; @@ -798,7 +798,7 @@ export interface UpdateUserPoolClientRequest { /** *The allowed OAuth scopes. Possible values provided by OAuth are: phone,
* email, openid, and profile. Possible values
- * provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created
+ * provided by Amazon Web Services are: aws.cognito.signin.user.admin. Custom scopes created
* in Resource Servers are also supported.
AWS Database Migration Service (AWS DMS) can migrate your data to and from the most
+ *
Database Migration Service (DMS) can migrate your data to and from the most * widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL * Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise * (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as * heterogeneous migrations between different database platforms, such as Oracle to MySQL or * SQL Server to PostgreSQL.
- *For more information about AWS DMS, see What Is AWS Database Migration Service? - * in the AWS Database Migration User Guide. + *
For more information about DMS, see What Is Database Migration Service? + * in the Database Migration Service User Guide. *
*/ export class DatabaseMigrationService extends DatabaseMigrationServiceClient { /** - *Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, + *
Adds metadata tags to an DMS resource, including replication instance, endpoint,
* security group, and migration task. These tags can also be used with cost allocation
* reporting to track cost associated with DMS resources, or used in a Condition statement in
* an IAM policy for DMS. For more information, see
@@ -395,6 +395,13 @@ export class DatabaseMigrationService extends DatabaseMigrationServiceClient {
/**
* Creates an endpoint using the provided settings. For a MySQL source or target endpoint, don't explicitly specify the database using
+ * the Creates an AWS DMS event notification subscription. Creates an DMS event notification subscription. You can specify the type of source ( For more information about AWS DMS events, see Working with Events and
- * Notifications in the AWS Database Migration Service User
+ * For more information about DMS events, see Working with Events and
+ * Notifications in the Database Migration Service User
* Guide.
* Creates the replication instance using the specified parameters. AWS DMS requires that your account have certain roles with appropriate permissions
+ * DMS requires that your account have certain roles with appropriate permissions
* before you can create a replication instance. For information on the required roles, see
- * Creating the IAM Roles to Use With the AWS CLI and AWS DMS API. For
+ * Creating the IAM Roles to Use With the CLI and DMS API. For
* information on the required permissions, see
- * IAM Permissions Needed to Use AWS DMS.DatabaseName request parameter on the CreateEndpoint API call.
+ * Specifying DatabaseName when you create a MySQL endpoint replicates all the
+ * task tables to this single database. For MySQL endpoints, you specify the database only when
+ * you specify the schema in the table-mapping rules of the DMS task.SourceType) you want to be notified of,
- * provide a list of AWS DMS source IDs (SourceIds) that triggers the events, and
+ * provide a list of DMS source IDs (SourceIds) that triggers the events, and
* provide a list of event categories (EventCategories) for events you want to be
* notified of. If you specify both the SourceType and SourceIds,
* such as SourceType = replication-instance and SourceIdentifier =
* my-replinstance, you will be notified of all the replication instance events for
* the specified source. If you specify a SourceType but don't specify a
* SourceIdentifier, you receive notice of the events for that source type for
- * all your AWS DMS sources. If you don't specify either SourceType nor
- * SourceIdentifier, you will be notified of events generated from all AWS DMS
+ * all your DMS sources. If you don't specify either SourceType nor
+ * SourceIdentifier, you will be notified of events generated from all DMS
* sources belonging to your customer account.
Deletes an AWS DMS event subscription.
+ *Deletes an DMS event subscription.
*/ public deleteEventSubscription( args: DeleteEventSubscriptionCommandInput, @@ -809,7 +816,7 @@ export class DatabaseMigrationService extends DatabaseMigrationServiceClient { /** *Deletes the record of a single premigration assessment run.
- *This operation removes all metadata that AWS DMS maintains about this assessment run. + *
This operation removes all metadata that DMS maintains about this assessment run. * However, the operation leaves untouched all information about this assessment run that is * stored in your Amazon S3 bucket.
*/ @@ -843,8 +850,8 @@ export class DatabaseMigrationService extends DatabaseMigrationServiceClient { } /** - *Lists all of the AWS DMS attributes for a customer account. These attributes include AWS - * DMS quotas for the account and a unique account identifier in a particular DMS region. DMS + *
Lists all of the DMS attributes for a customer account. These attributes include DMS + * quotas for the account and a unique account identifier in a particular DMS region. DMS * quotas include a list of resource quotas supported by the account, such as the number of * replication instances allowed. The description for each resource quota, includes the quota * name, current usage toward that quota, and the quota's maximum value. DMS uses the unique @@ -1093,7 +1100,7 @@ export class DatabaseMigrationService extends DatabaseMigrationServiceClient { /** *
Lists categories for all event source types, or, if specified, for a specified source * type. You can see a list of the event categories and source types in Working with Events - * and Notifications in the AWS Database Migration Service User + * and Notifications in the Database Migration Service User * Guide. *
*/ @@ -1128,8 +1135,8 @@ export class DatabaseMigrationService extends DatabaseMigrationServiceClient { /** *Lists events for a given source identifier and source type. You can also specify a - * start and end time. For more information on AWS DMS events, see Working with Events and - * Notifications in the AWS Database Migration User + * start and end time. For more information on DMS events, see Working with Events and + * Notifications in the Database Migration Service User * Guide. *
*/ @@ -1396,8 +1403,13 @@ export class DatabaseMigrationService extends DatabaseMigrationServiceClient { } /** - *Returns the task assessment results from Amazon S3. This action always returns the + *
Returns the task assessment results from the Amazon S3 bucket that DMS creates in your + * account. This action always returns the * latest results.
+ *For more information about DMS task assessments, see + * Creating a task assessment report + * in the + * Database Migration Service User Guide.
*/ public describeReplicationTaskAssessmentResults( args: DescribeReplicationTaskAssessmentResultsCommandInput, @@ -1578,7 +1590,7 @@ export class DatabaseMigrationService extends DatabaseMigrationServiceClient { /** *Returns table statistics on the database migration task, including table name, rows * inserted, rows updated, and rows deleted.
- *Note that the "last updated" column the DMS console only indicates the time that AWS DMS + *
Note that the "last updated" column the DMS console only indicates the time that DMS * last updated the table statistics record for a table. It does not indicate the time of the * last update to the table.
*/ @@ -1644,7 +1656,7 @@ export class DatabaseMigrationService extends DatabaseMigrationServiceClient { } /** - *Lists all metadata tags attached to an AWS DMS resource, including + *
Lists all metadata tags attached to an DMS resource, including
* replication instance, endpoint, security group, and migration task.
* For more information, see
* Modifies the specified endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using
+ * the Modifies an existing AWS DMS event notification subscription. Modifies an existing DMS event notification subscription. Modifies the specified replication task. You can't modify the task endpoints. The task must be stopped before you can modify it. For more information about AWS DMS tasks, see Working with Migration Tasks in the
- * AWS Database Migration Service User Guide. For more information about DMS tasks, see Working with Migration Tasks in the
+ * Database Migration Service User Guide. Moves a replication task from its current replication instance to a different target
* replication instance using the specified parameters. The target replication instance must
- * be created with the same or later AWS DMS version as the current replication
+ * be created with the same or later DMS version as the current replication
* instance. Removes metadata tags from an AWS DMS resource, including replication instance,
+ * Removes metadata tags from an DMS resource, including replication instance,
* endpoint, security group, and migration task. For more information, see
*
* Starts the replication task. For more information about AWS DMS tasks, see Working with Migration Tasks in the
- * AWS Database Migration Service User Guide.
+ * For more information about DMS tasks, see Working with Migration Tasks in the
+ * Database Migration Service User Guide.
* AWS Database Migration Service (AWS DMS) can migrate your data to and from the most
+ * Database Migration Service (DMS) can migrate your data to and from the most
* widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL
* Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise
* (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as
* heterogeneous migrations between different database platforms, such as Oracle to MySQL or
* SQL Server to PostgreSQL. For more information about AWS DMS, see What Is AWS Database Migration Service?
- * in the AWS Database Migration User Guide.
+ * For more information about DMS, see What Is Database Migration Service?
+ * in the Database Migration Service User Guide.
* AWS Database Migration Service (AWS DMS) can migrate your data to and from the most
+ Database Migration Service (DMS) can migrate your data to and from the most
widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL
Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise
(ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as
heterogeneous migrations between different database platforms, such as Oracle to MySQL or
SQL Server to PostgreSQL. For more information about AWS DMS, see What Is AWS Database Migration Service?
-in the AWS Database Migration User Guide.
+ For more information about DMS, see What Is Database Migration Service?
+in the Database Migration Service User Guide.
Adds metadata tags to an AWS DMS resource, including replication instance, endpoint,
+ * Adds metadata tags to an DMS resource, including replication instance, endpoint,
* security group, and migration task. These tags can also be used with cost allocation
* reporting to track cost associated with DMS resources, or used in a Condition statement in
* an IAM policy for DMS. For more information, see
diff --git a/clients/client-database-migration-service/commands/CreateEndpointCommand.ts b/clients/client-database-migration-service/commands/CreateEndpointCommand.ts
index 597d121a3fb75..25afefde41d17 100644
--- a/clients/client-database-migration-service/commands/CreateEndpointCommand.ts
+++ b/clients/client-database-migration-service/commands/CreateEndpointCommand.ts
@@ -26,6 +26,13 @@ export interface CreateEndpointCommandOutput extends CreateEndpointResponse, __M
/**
* Creates an endpoint using the provided settings. For a MySQL source or target endpoint, don't explicitly specify the database using
+ * the Creates an AWS DMS event notification subscription. Creates an DMS event notification subscription. You can specify the type of source ( For more information about AWS DMS events, see Working with Events and
- * Notifications in the AWS Database Migration Service User
+ * For more information about DMS events, see Working with Events and
+ * Notifications in the Database Migration Service User
* Guide.
* Creates the replication instance using the specified parameters. AWS DMS requires that your account have certain roles with appropriate permissions
+ * DMS requires that your account have certain roles with appropriate permissions
* before you can create a replication instance. For information on the required roles, see
- * Creating the IAM Roles to Use With the AWS CLI and AWS DMS API. For
+ * Creating the IAM Roles to Use With the CLI and DMS API. For
* information on the required permissions, see
- * IAM Permissions Needed to Use AWS DMS. Deletes an AWS DMS event subscription. Deletes an DMS event subscription. Deletes the record of a single premigration assessment run. This operation removes all metadata that AWS DMS maintains about this assessment run.
+ * This operation removes all metadata that DMS maintains about this assessment run.
* However, the operation leaves untouched all information about this assessment run that is
* stored in your Amazon S3 bucket. Lists all of the AWS DMS attributes for a customer account. These attributes include AWS
- * DMS quotas for the account and a unique account identifier in a particular DMS region. DMS
+ * Lists all of the DMS attributes for a customer account. These attributes include DMS
+ * quotas for the account and a unique account identifier in a particular DMS region. DMS
* quotas include a list of resource quotas supported by the account, such as the number of
* replication instances allowed. The description for each resource quota, includes the quota
* name, current usage toward that quota, and the quota's maximum value. DMS uses the unique
diff --git a/clients/client-database-migration-service/commands/DescribeEventCategoriesCommand.ts b/clients/client-database-migration-service/commands/DescribeEventCategoriesCommand.ts
index 8d457f8614dbf..0c88db3005181 100644
--- a/clients/client-database-migration-service/commands/DescribeEventCategoriesCommand.ts
+++ b/clients/client-database-migration-service/commands/DescribeEventCategoriesCommand.ts
@@ -27,7 +27,7 @@ export interface DescribeEventCategoriesCommandOutput extends DescribeEventCateg
/**
* Lists categories for all event source types, or, if specified, for a specified source
* type. You can see a list of the event categories and source types in Working with Events
- * and Notifications in the AWS Database Migration Service User
+ * and Notifications Lists events for a given source identifier and source type. You can also specify a
- * start and end time. For more information on AWS DMS events, see Working with Events and
- * Notifications in the AWS Database Migration User
+ * start and end time. For more information on DMS events, see Working with Events and
+ * Notifications in the Database Migration Service User
* Guide.
* Returns the task assessment results from Amazon S3. This action always returns the
+ * Returns the task assessment results from the Amazon S3 bucket that DMS creates in your
+ * account. This action always returns the
* latest results. For more information about DMS task assessments, see
+ * Creating a task assessment report
+ * in the
+ * Database Migration Service User Guide. Returns table statistics on the database migration task, including table name, rows
* inserted, rows updated, and rows deleted. Note that the "last updated" column the DMS console only indicates the time that AWS DMS
+ * Note that the "last updated" column the DMS console only indicates the time that DMS
* last updated the table statistics record for a table. It does not indicate the time of the
* last update to the table. Lists all metadata tags attached to an AWS DMS resource, including
+ * Lists all metadata tags attached to an DMS resource, including
* replication instance, endpoint, security group, and migration task.
* For more information, see
* Modifies the specified endpoint. For a MySQL source or target endpoint, don't explicitly specify the database using
+ * the Modifies an existing AWS DMS event notification subscription. Modifies an existing DMS event notification subscription. Modifies the specified replication task. You can't modify the task endpoints. The task must be stopped before you can modify it. For more information about AWS DMS tasks, see Working with Migration Tasks in the
- * AWS Database Migration Service User Guide. For more information about DMS tasks, see Working with Migration Tasks in the
+ * Database Migration Service User Guide. Moves a replication task from its current replication instance to a different target
* replication instance using the specified parameters. The target replication instance must
- * be created with the same or later AWS DMS version as the current replication
+ * be created with the same or later DMS version as the current replication
* instance. Removes metadata tags from an AWS DMS resource, including replication instance,
+ * Removes metadata tags from an DMS resource, including replication instance,
* endpoint, security group, and migration task. For more information, see
*
* Starts the replication task. For more information about AWS DMS tasks, see Working with Migration Tasks in the
- * AWS Database Migration Service User Guide.
+ * For more information about DMS tasks, see Working with Migration Tasks in the
+ * Database Migration Service User Guide.
* AWS DMS was denied access to the endpoint. Check that the
+ * DMS was denied access to the endpoint. Check that the
* role is correctly configured. Describes a quota for an AWS account, for example, the number of replication instances
+ * Describes a quota for an account, for example the number of replication instances
* allowed. The name of the AWS DMS quota for this AWS account. The name of the DMS quota for this account. A user-defined key-value pair that describes metadata added to an AWS DMS resource and
+ * A user-defined key-value pair that describes metadata added to an DMS resource and
* that is used by operations such as the following: Associates a set of tags with an AWS DMS resource. Associates a set of tags with an DMS resource. Identifies the AWS DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN). For AWS DMS, you can tag a replication instance, an endpoint, or a replication task. Identifies the DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN). For DMS, you can tag a replication instance, an endpoint, or a replication task. The Amazon Resource Name (ARN) of the AWS DMS resource that the pending maintenance
+ * The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance
* action applies to. Describes a maintenance action pending for an AWS DMS resource, including when and how
+ * Describes a maintenance action pending for an DMS resource, including when and how
* it will be applied. This data type is a response element to the
* Identifies an AWS DMS resource and any pending actions for it. Identifies an DMS resource and any pending actions for it. The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action
* applies to. For information about creating an ARN, see Constructing an Amazon
- * Resource Name (ARN) for AWS DMS in the DMS documentation. The AWS DMS resource that the pending maintenance action will be applied to. The DMS resource that the pending maintenance action will be applied to. ARN of the service role used to start the assessment run using the
- * Amazon S3 bucket where AWS DMS stores the results of this assessment run. Amazon S3 bucket where DMS stores the results of this assessment run. Folder in an Amazon S3 bucket where AWS DMS stores the results of this assessment
+ * Folder in an Amazon S3 bucket where DMS stores the results of this assessment
* run. ARN of the AWS KMS encryption key used to encrypt the assessment run results. ARN of the KMS encryption key used to encrypt the assessment run results. The IAM role that has permission to access the Amazon S3 bucket. The IAM role that has permission to access the Amazon S3 bucket. When specified as part of request syntax,
+ * such as for the The AWS KMS key identifier that is used to encrypt the content on the replication
+ * The KMS key identifier that is used to encrypt the content on the replication
* instance. If you don't specify a value for the Tag
@@ -1681,6 +1693,13 @@ export class DatabaseMigrationService extends DatabaseMigrationServiceClient {
/**
* DatabaseName request parameter on the ModifyEndpoint API call.
+ * Specifying DatabaseName when you modify a MySQL endpoint replicates all the
+ * task tables to this single database. For MySQL endpoints, you specify the database only when
+ * you specify the schema in the table-mapping rules of the DMS task.Tag
@@ -2016,8 +2035,8 @@ export class DatabaseMigrationService extends DatabaseMigrationServiceClient {
/**
* DatabaseName request parameter on the CreateEndpoint API call.
+ * Specifying DatabaseName when you create a MySQL endpoint replicates all the
+ * task tables to this single database. For MySQL endpoints, you specify the database only when
+ * you specify the schema in the table-mapping rules of the DMS task.SourceType) you want to be notified of,
- * provide a list of AWS DMS source IDs (SourceIds) that triggers the events, and
+ * provide a list of DMS source IDs (SourceIds) that triggers the events, and
* provide a list of event categories (EventCategories) for events you want to be
* notified of. If you specify both the SourceType and SourceIds,
* such as SourceType = replication-instance and SourceIdentifier =
* my-replinstance, you will be notified of all the replication instance events for
* the specified source. If you specify a SourceType but don't specify a
* SourceIdentifier, you receive notice of the events for that source type for
- * all your AWS DMS sources. If you don't specify either SourceType nor
- * SourceIdentifier, you will be notified of events generated from all AWS DMS
+ * all your DMS sources. If you don't specify either SourceType nor
+ * SourceIdentifier, you will be notified of events generated from all DMS
* sources belonging to your customer account.Tag
diff --git a/clients/client-database-migration-service/commands/ModifyEndpointCommand.ts b/clients/client-database-migration-service/commands/ModifyEndpointCommand.ts
index 80e9fc00b7d31..24c53fb2110a3 100644
--- a/clients/client-database-migration-service/commands/ModifyEndpointCommand.ts
+++ b/clients/client-database-migration-service/commands/ModifyEndpointCommand.ts
@@ -26,6 +26,13 @@ export interface ModifyEndpointCommandOutput extends ModifyEndpointResponse, __M
/**
* DatabaseName request parameter on the ModifyEndpoint API call.
+ * Specifying DatabaseName when you modify a MySQL endpoint replicates all the
+ * task tables to this single database. For MySQL endpoints, you specify the database only when
+ * you specify the schema in the table-mapping rules of the DMS task.Tag
diff --git a/clients/client-database-migration-service/commands/StartReplicationTaskCommand.ts b/clients/client-database-migration-service/commands/StartReplicationTaskCommand.ts
index f0c870dae5821..0126aac80be4e 100644
--- a/clients/client-database-migration-service/commands/StartReplicationTaskCommand.ts
+++ b/clients/client-database-migration-service/commands/StartReplicationTaskCommand.ts
@@ -26,8 +26,8 @@ export interface StartReplicationTaskCommandOutput extends StartReplicationTaskR
/**
*
*
in the DMS documentation.DescribePendingMaintenanceActions operation.StartReplicationTaskAssessmentRun operation.StartReplicationTaskAssessmentRun operation. The role must allow the iam:PassRole action.CreateEndpoint and ModifyEndpoint actions,
+ * the role must allow the iam:PassRole action.KmsKeyId parameter, then
- * AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for
- * your AWS account. Your AWS account has a different default encryption key for each AWS
- * Region.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the + *
The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
* trusted entity and grants the required permissions to access the value in
- * SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets
- * Manager secret that allows access to the DocumentDB endpoint.
SecretsManagerSecret. The role must allow the iam:PassRole action.
+ * SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the DocumentDB endpoint.
* You can specify one of two sets of values for these permissions. You can specify the
* values for this setting and SecretsManagerSecretId. Or you can specify
@@ -631,8 +632,8 @@ export interface DocDbSettings {
* ServerName, and Port. You can't specify both. For more
* information on creating this SecretsManagerSecret and the
* SecretsManagerAccessRoleArn and SecretsManagerSecretId
- * required to access it, see Using secrets to access AWS Database Migration Service
- * resources in the AWS Database Migration Service User
+ * required to access it, see Using secrets to access Database Migration Service
+ * resources in the Database Migration Service User
* Guide.
Provides the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) + *
Provides the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) * role used to define an Amazon DynamoDB target endpoint.
*/ export interface DynamoDbSettings { /** - *The Amazon Resource Name (ARN) used by the service access IAM role.
+ * The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
The Amazon Resource Name (ARN) used by service to access the IAM role.
+ *The Amazon Resource Name (ARN) used by the service to access the IAM role.
+ * The role must allow the iam:PassRole action.
The endpoint for the Elasticsearch cluster. AWS DMS uses HTTPS if a transport + *
The endpoint for the Elasticsearch cluster. DMS uses HTTPS if a transport * protocol (http/https) is not specified.
*/ EndpointUri: string | undefined; @@ -736,7 +738,7 @@ export interface IBMDb2Settings { Password?: string; /** - *Endpoint TCP port.
+ *Endpoint TCP port. The default value is 50000.
*/ Port?: number; @@ -770,10 +772,11 @@ export interface IBMDb2Settings { Username?: string; /** - *The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the + *
The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
* trusted entity and grants the required permissions to access the value in
- * SecretsManagerSecret. SecretsManagerSecret has the value of
- * the AWS Secrets Manager secret that allows access to the Db2 LUW endpoint.
SecretsManagerSecret. The role must allow the iam:PassRole action.
+ * SecretsManagerSecret has the value of
+ * the Amazon Web Services Secrets Manager secret that allows access to the Db2 LUW endpoint.
* You can specify one of two sets of values for these permissions. You can specify the
* values for this setting and SecretsManagerSecretId. Or you can specify
@@ -781,8 +784,8 @@ export interface IBMDb2Settings {
* ServerName, and Port. You can't specify both. For more
* information on creating this SecretsManagerSecret and the
* SecretsManagerAccessRoleArn and SecretsManagerSecretId
- * required to access it, see Using secrets to access AWS Database Migration Service
- * resources in the AWS Database Migration Service User
+ * required to access it, see Using secrets to access Database Migration Service
+ * resources in the Database Migration Service User
* Guide.
"ec2-12-345-678-901.compute-1.amazonaws.com:2345".
* For more information and examples of specifying a list of broker locations,
- * see Using Apache Kafka as a target for AWS Database Migration Service
- * in the AWS Data Migration Service User Guide.
+ * see Using Apache Kafka as a target for Database Migration Service
+ * in the Database Migration Service User Guide.
*
*/
Broker?: string;
/**
- * The topic to which you migrate the data. If you don't specify a topic, AWS DMS + *
The topic to which you migrate the data. If you don't specify a topic, DMS
* specifies "kafka-default-topic" as the migration topic.
Shows the partition value within the Kafka message output, unless the partition type is + *
Shows the partition value within the Kafka message output unless the partition type is
* schema-table-type. The default is false.
The Amazon Resource Name (ARN) for the private Certification Authority (CA) cert that AWS DMS uses + *
The Amazon Resource Name (ARN) for the private Certification Authority (CA) cert that DMS uses * to securely connect to your Kafka target endpoint.
*/ SslCaCertificateArn?: string; /** - *The secure username you created when you first set up your MSK cluster to validate a client identity and - * make an encrypted connection between server and client using SASL-SSL authentication.
+ *The secure user name you created when you first set up your MSK cluster to validate a + * client identity and make an encrypted connection between server and client using SASL-SSL + * authentication.
*/ SaslUsername?: string; @@ -934,6 +938,13 @@ export interface KafkaSettings { * make an encrypted connection between server and client using SASL-SSL authentication. */ SaslPassword?: string; + + /** + *If this attribute is Y, it allows hexadecimal values that don't have the
+ * 0x prefix when migrated to a Kafka target. If this attribute is N, all
+ * hexadecimal values include this prefix when migrated to Kafka.
The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role - * that AWS DMS uses to write to the Kinesis data stream.
+ *The Amazon Resource Name (ARN) for the IAM role
+ * that DMS uses to write to the Kinesis data stream.
+ * The role must allow the iam:PassRole action.
Include NULL and empty columns for records migrated to the endpoint. The default is false.
If this attribute is Y, it allows hexadecimal values that don't have the
+ * 0x prefix when migrated to a Kinesis target. If this attribute is N, all
+ * hexadecimal values include this prefix when migrated to Kinesis.
Specifies a file group for the AWS DMS internal tables. When the replication task - * starts, all the internal AWS DMS control tables (awsdms_ apply_exception, awsdms_apply, + *
Specifies a file group for the DMS internal tables. When the replication task + * starts, all the internal DMS control tables (awsdms_ apply_exception, awsdms_apply, * awsdms_changes) are created for the specified file group.
*/ ControlTablesFileGroup?: string; @@ -1069,7 +1088,7 @@ export interface MicrosoftSQLServerSettings { QuerySingleAlwaysOnNode?: boolean; /** - *When this attribute is set to Y, AWS DMS only reads changes
+ *
When this attribute is set to Y, DMS only reads changes
* from transaction log backups and doesn't read from the
* active transaction log file during ongoing replication. Setting
* this parameter to Y enables you to control active transaction
@@ -1081,11 +1100,11 @@ export interface MicrosoftSQLServerSettings {
/**
*
Use this attribute to minimize the need to access the - * backup log and enable AWS DMS to prevent truncation using one of the + * backup log and enable DMS to prevent truncation using one of the * following two methods.
** Start transactions in the database: This is the default - * method. When this method is used, AWS DMS prevents + * method. When this method is used, DMS prevents * TLOG truncation by mimicking a transaction in the database. * As long as such a transaction is open, changes that appear * after the transaction started aren't truncated. If you need @@ -1093,13 +1112,13 @@ export interface MicrosoftSQLServerSettings { * you must choose this method.
** Exclusively use sp_repldone within a single task: When - * this method is used, AWS DMS reads the changes and then + * this method is used, DMS reads the changes and then * uses sp_repldone to mark the TLOG transactions as ready * for truncation. Although this method doesn't involve any * transactional activities, it can only be used when Microsoft * Replication isn't running. Also, when using this method, only - * one AWS DMS task can access the database at any given - * time. Therefore, if you need to run parallel AWS DMS tasks + * one DMS task can access the database at any given + * time. Therefore, if you need to run parallel DMS tasks * against the same database, use the default method.
*/ SafeguardPolicy?: SafeguardPolicy | string; @@ -1129,10 +1148,11 @@ export interface MicrosoftSQLServerSettings { UseThirdPartyBackupDevice?: boolean; /** - *The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the + *
The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
* trusted entity and grants the required permissions to access the value in
- * SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets
- * Manager secret that allows access to the SQL Server endpoint.
SecretsManagerSecret. The role must allow the iam:PassRole action.
+ * SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager
+ * secret that allows access to the SQL Server endpoint.
* You can specify one of two sets of values for these permissions. You can specify the
* values for this setting and SecretsManagerSecretId. Or you can specify
@@ -1140,8 +1160,8 @@ export interface MicrosoftSQLServerSettings {
* ServerName, and Port. You can't specify both. For more
* information on creating this SecretsManagerSecret and the
* SecretsManagerAccessRoleArn and SecretsManagerSecretId
- * required to access it, see Using secrets to access AWS Database Migration Service
- * resources in the AWS Database Migration Service User
+ * required to access it, see Using secrets to access Database Migration Service
+ * resources in the Database Migration Service User
* Guide.
The AWS KMS key identifier that is used to encrypt the content on the replication + *
The KMS key identifier that is used to encrypt the content on the replication
* instance. If you don't specify a value for the KmsKeyId parameter, then
- * AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for
- * your AWS account. Your AWS account has a different default encryption key for each AWS
- * Region.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the + *
The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
* trusted entity and grants the required permissions to access the value in
- * SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets
- * Manager secret that allows access to the MongoDB endpoint.
SecretsManagerSecret. The role must allow the iam:PassRole action.
+ * SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the MongoDB endpoint.
* You can specify one of two sets of values for these permissions. You can specify the
* values for this setting and SecretsManagerSecretId. Or you can specify
@@ -1270,8 +1289,8 @@ export interface MongoDbSettings {
* ServerName, and Port. You can't specify both. For more
* information on creating this SecretsManagerSecret and the
* SecretsManagerAccessRoleArn and SecretsManagerSecretId
- * required to access it, see Using secrets to access AWS Database Migration Service
- * resources in the AWS Database Migration Service User
+ * required to access it, see Using secrets to access Database Migration Service
+ * resources in the Database Migration Service User
* Guide.
Specifies a script to run immediately after AWS DMS + *
Specifies a script to run immediately after DMS * connects to the endpoint. The migration task continues * running regardless if the SQL statement succeeds or fails.
+ *For this parameter, provide the code of the script itself, not the name of a file + * containing the script.
*/ AfterConnectScript?: string; @@ -1318,7 +1339,12 @@ export interface MySQLSettings { CleanSourceMetadataOnMismatch?: boolean; /** - *Database name for the endpoint.
+ *Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly
+ * specify the database using the DatabaseName request parameter on either the
+ * CreateEndpoint or ModifyEndpoint API call. Specifying
+ * DatabaseName when you create or modify a MySQL endpoint replicates all the
+ * task tables to this single database. For MySQL endpoints, you specify the database only when
+ * you specify the schema in the table-mapping rules of the DMS task.
Example: eventsPollInterval=5;
*
In the example, AWS DMS checks for changes in the binary + *
In the example, DMS checks for changes in the binary * logs every five seconds.
*/ EventsPollInterval?: number; @@ -1387,10 +1413,11 @@ export interface MySQLSettings { Username?: string; /** - *The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the + *
The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
* trusted entity and grants the required permissions to access the value in
- * SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets
- * Manager secret that allows access to the MySQL endpoint.
SecretsManagerSecret. The role must allow the iam:PassRole action.
+ * SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager
+ * secret that allows access to the MySQL endpoint.
* You can specify one of two sets of values for these permissions. You can specify the
* values for this setting and SecretsManagerSecretId. Or you can specify
@@ -1398,8 +1425,8 @@ export interface MySQLSettings {
* ServerName, and Port. You can't specify both. For more
* information on creating this SecretsManagerSecret and the
* SecretsManagerAccessRoleArn and SecretsManagerSecretId
- * required to access it, see Using secrets to access AWS Database Migration Service
- * resources in the AWS Database Migration Service User
+ * required to access it, see Using secrets to access Database Migration Service
+ * resources in the Database Migration Service User
* Guide.
The Amazon Resource Name (ARN) of the service role that you created for the Neptune
- * target endpoint.
- * For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the AWS Database Migration Service User
+ * target endpoint. The role must allow the iam:PassRole action.
+ * For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the Database Migration Service User
* Guide.
*
The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data - * in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL + *
The name of the Amazon S3 bucket where DMS can temporarily store migrated graph data + * in .csv files before bulk-loading it to the Neptune target database. DMS maps the SQL * source data to graph data before storing it in these .csv files.
*/ S3BucketName: string | undefined; /** - *A folder path where you want AWS DMS to store migrated graph data in the S3 bucket + *
A folder path where you want DMS to store migrated graph data in the S3 bucket
* specified by S3BucketName
*
The number of milliseconds for AWS DMS to wait to retry a bulk-load of migrated graph + *
The number of milliseconds for DMS to wait to retry a bulk-load of migrated graph * data to the Neptune target database before raising an error. The default is 250.
*/ ErrorRetryDuration?: number; /** - *The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS - * DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the - * bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of + *
The maximum size in kilobytes of migrated graph data stored in a .csv file before DMS + * bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the + * bulk load is successful, DMS clears the bucket, ready to store the next batch of * migrated graph data.
*/ MaxFileSize?: number; /** - *The number of times for AWS DMS to retry a bulk load of migrated graph data to the + *
The number of times for DMS to retry a bulk load of migrated graph data to the * Neptune target database before raising an error. The default is 5.
*/ MaxRetryCount?: number; /** - *If you want AWS Identity and Access Management (IAM) authorization enabled for this + *
If you want Identity and Access Management (IAM) authorization enabled for this
* endpoint, set this parameter to true. Then attach the appropriate IAM policy
* document to your service role specified by ServiceAccessRoleArn. The default
* is false.
Specifies the destination of the archived redo logs. The - * value should be the same as the DEST_ID number in the - * v$archived_log table. When working with multiple log - * destinations (DEST_ID), we recommend that you to specify - * an archived redo logs location identifier. Doing this improves - * performance by ensuring that the correct logs are accessed - * from the outset.
+ *Specifies the ID of the destination for the archived redo logs. This value
+ * should be the same as a number in the dest_id column of the v$archived_log
+ * view. If you work with an additional redo log destination, use the
+ * AdditionalArchivedLogDestId option to specify the additional
+ * destination ID. Doing this improves performance by ensuring that the correct
+ * logs are accessed from the outset.
Set this attribute with archivedLogDestId in a primary/
+ *
Set this attribute with ArchivedLogDestId in a primary/
* standby setup. This attribute is useful in the case of a
- * switchover. In this case, AWS DMS needs to know which
+ * switchover. In this case, DMS needs to know which
* destination to get archive redo logs from to read changes.
* This need arises because the previous primary instance is
* now a standby instance after switchover.
Although DMS supports the use of the Oracle
+ * RESETLOGS option to open the database, never
+ * use RESETLOGS unless necessary. For additional
+ * information about RESETLOGS, see RMAN Data Repair Concepts in the
+ * Oracle Database Backup and Recovery User's Guide.
Set this attribute to change the number of threads that
- * DMS configures to perform a Change Data Capture (CDC)
- * load using Oracle Automatic Storage Management (ASM).
- * You can specify an integer value between 2 (the default)
- * and 8 (the maximum). Use this attribute together with the
- * readAheadBlocks attribute.
Set this attribute to change the number of threads that DMS configures to perform a
+ * change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can
+ * specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute
+ * together with the readAheadBlocks attribute.
Set this attribute to change the number of read-ahead - * blocks that DMS configures to perform a Change Data - * Capture (CDC) load using Oracle Automatic Storage - * Management (ASM). You can specify an integer value - * between 1000 (the default) and 200,000 (the maximum).
+ *Set this attribute to change the number of read-ahead blocks that DMS configures to + * perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). + * You can specify an integer value between 1000 (the default) and 200,000 (the + * maximum).
*/ ReadAheadBlocks?: number; @@ -1611,9 +1639,9 @@ export interface OracleSettings { DirectPathNoLog?: boolean; /** - *When this field is set to Y, AWS DMS only accesses the
+ *
When this field is set to Y, DMS only accesses the
* archived redo logs. If the archived redo logs are stored on
- * Oracle ASM only, the AWS DMS user account needs to be
+ * Oracle ASM only, the DMS user account needs to be
* granted ASM privileges.
When set to true, this attribute specifies a parallel load
* when useDirectPathFullLoad is set to Y. This attribute
- * also only applies when you use the AWS DMS parallel load
+ * also only applies when you use the DMS parallel load
* feature. Note that the target table cannot have any constraints or indexes.
Password request parameter when you create the endpoint. The
* SecurityDbEncryptian setting is related to this
- * SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for AWS
- * DMS in the AWS Database Migration Service User Guide.
+ * SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for DMS
+ * in the Database Migration Service User Guide.
*/
SecurityDbEncryption?: string;
@@ -1732,8 +1760,8 @@ export interface OracleSettings {
* encrypted using TDE. The key value is the value of the SecurityDbEncryption
* setting. For more information on setting the key name value of
* SecurityDbEncryptionName, see the information and example for setting the
- * securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for AWS
- * DMS in the AWS Database Migration Service User
+ * securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for DMS
+ * in the Database Migration Service User
* Guide.
*/
SecurityDbEncryptionName?: string;
@@ -1753,16 +1781,52 @@ export interface OracleSettings {
*/
SpatialDataOptionToGeoJsonFunctionName?: string;
+ /**
+ * Use this attribute to specify a time in minutes for the delay in standby sync. If the + * source is an Oracle Active Data Guard standby database, use this attribute to specify the + * time lag between primary and standby databases.
+ *In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby + * instance as a source for replicating ongoing changes. Doing this eliminates the need to connect + * to an active database that might be in production.
+ */ + StandbyDelayTime?: number; + /** *Endpoint connection user name.
*/ Username?: string; /** - *The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the + *
Set this attribute to Y to capture change data using the Binary Reader utility. Set
+ * UseLogminerReader to N to set this attribute to Y. To use Binary Reader
+ * with Amazon RDS for Oracle as the source, you set additional attributes. For more information
+ * about using this setting with Oracle Automatic Storage Management (ASM), see Using Oracle LogMiner or DMS Binary Reader for
+ * CDC.
Set this attribute to Y to have DMS use a direct path full load. + * Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). + * By using this OCI protocol, you can bulk-load Oracle target tables during a full load.
+ */ + UseDirectPathFullLoad?: boolean; + + /** + *Set this attribute to Y to capture change data using the Oracle LogMiner utility (the
+ * default). Set this attribute to N if you want to access the redo logs as a binary file.
+ * When you set UseLogminerReader to N, also set UseBfile to Y. For
+ * more information on this setting and using Oracle ASM, see Using Oracle LogMiner or DMS Binary Reader for CDC in
+ * the DMS User Guide.
The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
* trusted entity and grants the required permissions to access the value in
- * SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets
- * Manager secret that allows access to the Oracle endpoint.
SecretsManagerSecret. The role must allow the iam:PassRole action.
+ * SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager
+ * secret that allows access to the Oracle endpoint.
* You can specify one of two sets of values for these permissions. You can specify the
* values for this setting and SecretsManagerSecretId. Or you can specify
@@ -1770,8 +1834,8 @@ export interface OracleSettings {
* ServerName, and Port. You can't specify both. For more
* information on creating this SecretsManagerSecret and the
* SecretsManagerAccessRoleArn and SecretsManagerSecretId
- * required to access it, see Using secrets to access AWS Database Migration Service
- * resources in the AWS Database Migration Service User
+ * required to access it, see Using secrets to access Database Migration Service
+ * resources in the Database Migration Service User
* Guide.
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN
- * of the IAM role that specifies AWS DMS as the trusted entity and grants the required
+ * of the IAM role that specifies DMS as the trusted entity and grants the required
* permissions to access the SecretsManagerOracleAsmSecret. This
* SecretsManagerOracleAsmSecret has the secret value that allows access to
* the Oracle ASM of the endpoint.
AsmServerName. You can't specify both. For more information on
* creating this SecretsManagerOracleAsmSecret and the
* SecretsManagerOracleAsmAccessRoleArn and
- * SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access AWS Database Migration Service
- * resources in the AWS Database Migration Service User
+ * SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access Database Migration Service
+ * resources in the Database Migration Service User
* Guide.
* Provides information that defines a PostgreSQL endpoint.
*/ export interface PostgreSQLSettings { /** *For use with change data capture (CDC) only, this attribute - * has AWS DMS bypass foreign keys and user triggers to + * has DMS bypass foreign keys and user triggers to * reduce the time it takes to bulk load data.
*Example: afterConnectScript=SET
* session_replication_role='replica'
@@ -1836,7 +1906,7 @@ export interface PostgreSQLSettings {
AfterConnectScript?: string;
/**
- *
To capture DDL events, AWS DMS creates various artifacts in + *
To capture DDL events, DMS creates various artifacts in * the PostgreSQL database when the task starts. You can later * remove these artifacts.
*If this value is set to N, you don't have to create tables or
@@ -1882,6 +1952,26 @@ export interface PostgreSQLSettings {
*/
FailTasksOnLobTruncation?: boolean;
+ /**
+ *
If this attribute is set to true, the write-ahead log (WAL) heartbeat keeps
+ * restart_lsn moving and prevents storage full scenarios.
+ * The WAL heartbeat mimics a dummy transaction, so that idle
+ * logical replication slots don't hold onto old WAL logs that result in storage full
+ * situations on the source.
+ *
Sets the schema in which the heartbeat artifacts are created.
+ */ + HeartbeatSchema?: string; + + /** + *Sets the WAL heartbeat frequency (in minutes).
+ */ + HeartbeatFrequency?: number; + /** *Endpoint connection password.
*/ @@ -1905,17 +1995,23 @@ export interface PostgreSQLSettings { /** *Sets the name of a previously created logical replication slot * for a CDC load of the PostgreSQL source instance.
- *When used with the AWS DMS API CdcStartPosition
+ *
When used with the DMS API CdcStartPosition
* request parameter, this attribute also enables using native
* CDC start points.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the + *
Specifies the plugin to use to create a replication slot.
+ */ + PluginName?: PluginNameValue | string; + + /** + *The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
* trusted entity and grants the required permissions to access the value in
- * SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets
- * Manager secret that allows access to the PostgreSQL endpoint.
SecretsManagerSecret. The role must allow the iam:PassRole action.
+ * SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager
+ * secret that allows access to the PostgreSQL endpoint.
* You can specify one of two sets of values for these permissions. You can specify the
* values for this setting and SecretsManagerSecretId. Or you can specify
@@ -1923,8 +2019,8 @@ export interface PostgreSQLSettings {
* ServerName, and Port. You can't specify both. For more
* information on creating this SecretsManagerSecret and the
* SecretsManagerAccessRoleArn and SecretsManagerSecretId
- * required to access it, see Using secrets to access AWS Database Migration Service
- * resources in the AWS Database Migration Service User
+ * required to access it, see Using secrets to access Database Migration Service
+ * resources in the Database Migration Service User
* Guide.
An S3 folder where the comma-separated-value (.csv) files are stored before being * uploaded to the target Redshift cluster.
- *For full load mode, AWS DMS converts source records into .csv files and loads them to - * the BucketFolder/TableID path. AWS DMS uses the Redshift + *
For full load mode, DMS converts source records into .csv files and loads them to
+ * the BucketFolder/TableID path. DMS uses the Redshift
* COPY command to upload the .csv files to the target table. The files are
* deleted once the COPY operation has finished. For more information, see COPY in the
* Amazon Redshift Database Developer Guide.
For change-data-capture (CDC) mode, AWS DMS creates a NetChanges table, + *
For change-data-capture (CDC) mode, DMS creates a NetChanges table, * and loads the .csv files to this BucketFolder/NetChangesTableID path.
*/ BucketFolder?: string; @@ -2028,7 +2124,7 @@ export interface RedshiftSettings { DateFormat?: string; /** - *A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as + *
A value that specifies whether DMS should migrate empty CHAR and VARCHAR fields as
* NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default
* is false.
SSE_S3. But you can’t change the existing value from SSE_S3
* to SSE_KMS.
*
- * To use SSE_S3, create an AWS Identity and Access Management (IAM) role with
+ *
To use SSE_S3, create an Identity and Access Management (IAM) role with
* a policy that allows "arn:aws:s3:::*" to use the following actions:
* "s3:PutObject", "s3:ListBucket"
*
The amount of time to wait (in milliseconds) before timing out of operations performed - * by AWS DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE.
+ * by DMS on a Redshift cluster, such as Redshift COPY, INSERT, DELETE, and UPDATE. */ LoadTimeout?: number; @@ -2121,12 +2217,12 @@ export interface RedshiftSettings { /** *The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift - * service.
+ * service. The role must allow theiam:PassRole action.
*/
ServiceAccessRoleArn?: string;
/**
- * The AWS KMS key ID. If you are using SSE_KMS for the EncryptionMode,
+ *
The KMS key ID. If you are using SSE_KMS for the EncryptionMode,
* provide this key ID. The key that you use needs an attached policy that enables IAM user
* permissions and allows use of the key.
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the + *
The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
* trusted entity and grants the required permissions to access the value in
- * SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets
- * Manager secret that allows access to the Amazon Redshift endpoint.
SecretsManagerSecret. The role must allow the iam:PassRole action.
+ * SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the Amazon Redshift endpoint.
* You can specify one of two sets of values for these permissions. You can specify the
* values for this setting and SecretsManagerSecretId. Or you can specify
@@ -2182,8 +2278,8 @@ export interface RedshiftSettings {
* ServerName, and Port. You can't specify both. For more
* information on creating this SecretsManagerSecret and the
* SecretsManagerAccessRoleArn and SecretsManagerSecretId
- * required to access it, see Using secrets to access AWS Database Migration Service
- * resources in the AWS Database Migration Service User
+ * required to access it, see Using secrets to access Database Migration Service
+ * resources in the Database Migration Service User
* Guide.
The Amazon Resource Name (ARN) used by the service access IAM role. It is a required + *
The Amazon Resource Name (ARN) used by the service to access the IAM role.
+ * The role must allow the iam:PassRole action. It is a required
* parameter that enables DMS to write and read objects from an S3 bucket.
SSE_S3. But you can’t change the existing value from SSE_S3
* to SSE_KMS.
*
- * To use SSE_S3, you need an AWS Identity and Access Management (IAM) role
+ *
To use SSE_S3, you need an Identity and Access Management (IAM) role
* with permission to allow "arn:aws:s3:::dms-*" to use the following
* actions:
If you are using SSE_KMS for the EncryptionMode, provide the
- * AWS KMS key ID. The key that you use needs an attached policy that enables AWS Identity and
- * Access Management (IAM) user permissions and allows use of the key.
Here is a CLI example: A value that enables a full load to write INSERT operations to the comma-separated value
* (.csv) output files only to indicate how the rows were added to the source database. AWS DMS supports the DMS supports the For full load, records can only be inserted. By default (the This setting works together with the aws dms create-endpoint --endpoint-identifier
* value --endpoint-type target --engine-name s3 --s3-settings
* ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value
@@ -2460,7 +2557,7 @@ export interface S3Settings {
* IncludeOpForFullLoad parameter in versions 3.1.4 and
+ * IncludeOpForFullLoad parameter in versions 3.1.4 and
* later.false
@@ -2472,8 +2569,8 @@ export interface S3Settings {
* CdcInsertsOnly and the
* CdcInsertsAndUpdates parameters for output to .csv files only. For more
- * information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the AWS
- * Database Migration Service User Guide..IncludeOpForFullLoad is set to
* false, every CDC record is written without a first field to indicate the
* INSERT operation at the source. For more information about how these settings work
- * together, see Indicating Source DB Operations in Migrated S3 Data in the AWS
- * Database Migration Service User Guide..
AWS DMS supports the interaction described preceding between the + *
DMS supports the interaction described preceding between the
* CdcInsertsOnly and IncludeOpForFullLoad parameters in
* versions 3.1.4 and later.
A value that when nonblank causes AWS DMS to add a column with timestamp information to + *
A value that when nonblank causes DMS to add a column with timestamp information to * the endpoint data for an Amazon S3 target.
*AWS DMS supports the TimestampColumnName parameter in versions 3.1.4 and later.
DMS supports the TimestampColumnName parameter in versions 3.1.4 and later.
DMS includes an additional STRING column in the
* .csv or .parquet object files of your migrated data when you set
@@ -2541,20 +2637,20 @@ export interface S3Settings {
*
A value that specifies the precision of any TIMESTAMP column values that
* are written to an Amazon S3 object file in .parquet format.
AWS DMS supports the ParquetTimestampInMillisecond parameter in versions
+ *
DMS supports the ParquetTimestampInMillisecond parameter in versions
* 3.1.4 and later.
When ParquetTimestampInMillisecond is set to true or
- * y, AWS DMS writes all TIMESTAMP columns in a .parquet
+ * y, DMS writes all TIMESTAMP columns in a .parquet
* formatted file with millisecond precision. Otherwise, DMS writes them with microsecond
* precision.
Currently, Amazon Athena and AWS Glue can handle only + *
Currently, Amazon Athena and Glue can handle only
* millisecond precision for TIMESTAMP values. Set
* this parameter to true for S3 endpoint object
- * files that are .parquet formatted only if you plan to query or process the data with Athena or AWS Glue.
AWS DMS writes any TIMESTAMP column
+ *
DMS writes any TIMESTAMP column
* values written to an S3 file in .csv format with
* microsecond precision.
IncludeOpForFullLoad is set to
* false, CDC records are written without an indication of INSERT or UPDATE
* operations at the source. For more information about how these settings work together, see
- * Indicating Source DB Operations in Migrated S3 Data in the AWS
- * Database Migration Service User Guide..
+ * Indicating Source DB Operations in Migrated S3 Data in the Database Migration Service User Guide..
* AWS DMS supports the use of the CdcInsertsAndUpdates parameter in
+ *
DMS supports the use of the CdcInsertsAndUpdates parameter in
* versions 3.3.1 and later.
@@ -2597,9 +2692,9 @@ export interface S3Settings { CdcInsertsAndUpdates?: boolean; /** - *
When set to true, this parameter partitions S3 bucket folders based on transaction commit
- * dates. The default value is false. For more information about date-based folder partitoning,
- * see Using date-based folder partitioning.
When set to true, this parameter partitions S3 bucket folders based on
+ * transaction commit dates. The default value is false. For more information
+ * about date-based folder partitioning, see Using date-based folder partitioning.
This setting applies if the S3 output files during a change data capture (CDC) load are
* written in .csv format. If set to true for columns not included in the
- * supplemental log, AWS DMS uses the value specified by
+ * supplemental log, DMS uses the value specified by
* CsvNoSupValue
* . If not set or set to
- * false, AWS DMS uses the null value for these columns.
false, DMS uses the null value for these columns.
* This setting is supported in AWS DMS versions 3.4.1 and later.
+ *This setting is supported in DMS versions 3.4.1 and later.
*UseCsvNoSupValue
* is set to true, specify a
- * string value that you want AWS DMS to use for all columns not included in the supplemental
- * log. If you do not specify a string value, AWS DMS uses the null value for these columns
+ * string value that you want DMS to use for all columns not included in the supplemental
+ * log. If you do not specify a string value, DMS uses the null value for these columns
* regardless of the UseCsvNoSupValue setting.
* This setting is supported in AWS DMS versions 3.4.1 and later.
+ *This setting is supported in DMS versions 3.4.1 and later.
*If set to true, AWS DMS saves the transaction order for a change data
+ *
If set to true, DMS saves the transaction order for a change data
* capture (CDC) load on the Amazon S3 target specified by
* CdcPath
* . For more information, see Capturing data changes (CDC) including transaction order on the S3
* target.
This setting is supported in AWS DMS versions 3.4.2 and later.
+ *This setting is supported in DMS versions 3.4.2 and later.
*Specifies the folder path of CDC files. For an S3 source, this setting is required if a
- * task captures change data; otherwise, it's optional. If CdcPath is set, AWS
- * DMS reads CDC files from this path and replicates the data changes to the target endpoint.
+ * task captures change data; otherwise, it's optional. If CdcPath is set, DMS
+ * reads CDC files from this path and replicates the data changes to the target endpoint.
* For an S3 target if you set
* PreserveTransactions
- * to true, AWS
- * DMS verifies that you have set this parameter to a folder path on your S3 target where AWS
- * DMS can save the transaction order for the CDC load. AWS DMS creates this CDC folder path
+ * to true, DMS
+ * verifies that you have set this parameter to a folder path on your S3 target where DMS
+ * can save the transaction order for the CDC load. DMS creates this CDC folder path
* in either your S3 target working directory or the S3 target location specified by
* BucketFolder
* and
@@ -2670,16 +2765,16 @@ export interface S3Settings {
* .
For example, if you specify CdcPath as MyChangedData, and you
* specify BucketName as MyTargetBucket but do not specify
- * BucketFolder, AWS DMS creates the CDC folder path following:
+ * BucketFolder, DMS creates the CDC folder path following:
* MyTargetBucket/MyChangedData.
If you specify the same CdcPath, and you specify BucketName as
* MyTargetBucket and BucketFolder as MyTargetData,
- * AWS DMS creates the CDC folder path following:
+ * DMS creates the CDC folder path following:
* MyTargetBucket/MyTargetData/MyChangedData.
For more information on CDC including transaction order on an S3 target, see Capturing data changes (CDC) including transaction order on the S3 * target.
*This setting is supported in AWS DMS versions 3.4.2 and later.
+ *This setting is supported in DMS versions 3.4.2 and later.
*The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the + *
The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the
* trusted entity and grants the required permissions to access the value in
- * SecretsManagerSecret. SecretsManagerSecret has the value of the AWS Secrets
- * Manager secret that allows access to the SAP ASE endpoint.
SecretsManagerSecret. The role must allow the iam:PassRole action.
+ * SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager
+ * secret that allows access to the SAP ASE endpoint.
* You can specify one of two sets of values for these permissions. You can specify the
* values for this setting and SecretsManagerSecretId. Or you can specify
@@ -2742,8 +2838,8 @@ export interface SybaseSettings {
* ServerName, and Port. You can't specify both. For more
* information on creating this SecretsManagerSecret and the
* SecretsManagerAccessRoleArn and SecretsManagerSecretId
- * required to access it, see Using secrets to access AWS Database Migration Service
- * resources in the AWS Database Migration Service User
+ * required to access it, see Using secrets to access Database Migration Service
+ * resources in the Database Migration Service User
* Guide.
The name of the endpoint database.
+ *The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.
*/ DatabaseName?: string; @@ -2822,18 +2918,18 @@ export interface CreateEndpointMessage { * name-value pair associated by an equal sign (=). Multiple attributes are separated by a * semicolon (;) with no additional white space. For information on the attributes available * for connecting your source or target endpoint, see Working with - * AWS DMS Endpoints in the AWS Database Migration Service User + * DMS Endpoints in the Database Migration Service User * Guide. * */ ExtraConnectionAttributes?: string; /** - *An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
+ *An KMS key identifier that is used to encrypt the connection parameters for the endpoint.
*If you don't specify a value for the KmsKeyId parameter, then
- * AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a - * different default encryption key for each AWS Region.
+ * DMS uses your default encryption key. + *KMS creates the default encryption key for your account. Your account has a + * different default encryption key for each Region.
*/ KmsKeyId?: string; @@ -2855,7 +2951,7 @@ export interface CreateEndpointMessage { /** *The Amazon Resource Name (ARN) for the service access role that you want to use to - * create the endpoint.
+ * create the endpoint. The role must allow theiam:PassRole action.
*/
ServiceAccessRoleArn?: string;
@@ -2866,8 +2962,8 @@ export interface CreateEndpointMessage {
/**
* Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other - * available settings, see Using Object Mapping to Migrate - * Data to DynamoDB in the AWS Database Migration Service User + * available settings, see Using Object Mapping to Migrate + * Data to DynamoDB in the Database Migration Service User * Guide. *
*/ @@ -2876,8 +2972,8 @@ export interface CreateEndpointMessage { /** *Settings in JSON format for the target Amazon S3 endpoint. For more information about * the available settings, see Extra - * Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the - * AWS Database Migration Service User Guide. + * Connection Attributes When Using Amazon S3 as a Target for DMS in the + * Database Migration Service User Guide. *
*/ S3Settings?: S3Settings; @@ -2889,49 +2985,43 @@ export interface CreateEndpointMessage { *
* ServiceAccessRoleArn - The IAM role that has permission to access the
- * Amazon S3 bucket.
iam:PassRole action.
*
* BucketName - The name of the S3 bucket to use.
- * CompressionType - An optional parameter to use GZIP to compress the
- * target files. To use GZIP, set this value to NONE (the default). To keep
- * the files uncompressed, don't use this value.
Shorthand syntax for these settings is as follows:
- * ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
+ * ServiceAccessRoleArn=string,BucketName=string
*
JSON syntax for these settings is as follows: { "ServiceAccessRoleArn":
- * "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
+ * "string", "BucketName": "string", }
*
Settings in JSON format for the source MongoDB endpoint. For more information about the - * available settings, see Using MongoDB as a Target for AWS Database Migration Service in the - * AWS Database Migration Service User Guide. + * available settings, see Endpoint configuration settings + * when using MongoDB as a source for Database Migration Service in the + * Database Migration Service User Guide. *
*/ MongoDbSettings?: MongoDbSettings; /** *Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For - * more information about the available settings, see Using Amazon Kinesis Data Streams - * as a Target for AWS Database Migration Service in the AWS Database Migration Service User - * Guide. + * more information about the available settings, see Using object mapping to + * migrate data to a Kinesis data stream in the Database Migration Service User Guide. *
*/ KinesisSettings?: KinesisSettings; /** *Settings in JSON format for the target Apache Kafka endpoint. For more information about - * the available settings, see Using Apache Kafka as a Target for - * AWS Database Migration Service in the AWS Database Migration Service User + * the available settings, see Using object mapping + * to migrate data to a Kafka topic in the Database Migration Service User * Guide. *
*/ @@ -2939,16 +3029,16 @@ export interface CreateEndpointMessage { /** *Settings in JSON format for the target Elasticsearch endpoint. For more information - * about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in - * the AWS Database Migration Service User Guide.
+ * about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for DMS in + * the Database Migration Service User Guide. */ ElasticsearchSettings?: ElasticsearchSettings; /** *Settings in JSON format for the target Amazon Neptune endpoint. * For more information - * about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target - * in the AWS Database Migration Service User Guide. + * about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target + * in the Database Migration Service User Guide. *
*/ NeptuneSettings?: NeptuneSettings; @@ -2960,59 +3050,59 @@ export interface CreateEndpointMessage { /** *Settings in JSON format for the source and target PostgreSQL endpoint. For information - * about other available settings, see Extra connection - * attributes when using PostgreSQL as a source for AWS DMS and - * Extra connection attributes when using PostgreSQL as a target for AWS DMS in the - * AWS Database Migration Service User Guide. + * about other available settings, see Extra connection + * attributes when using PostgreSQL as a source for DMS and + * Extra connection attributes when using PostgreSQL as a target for DMS in the + * Database Migration Service User Guide. *
*/ PostgreSQLSettings?: PostgreSQLSettings; /** *Settings in JSON format for the source and target MySQL endpoint. For information about - * other available settings, see Extra connection attributes - * when using MySQL as a source for AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in - * the AWS Database Migration Service User Guide. + * other available settings, see Extra connection attributes + * when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in + * the Database Migration Service User Guide. *
*/ MySQLSettings?: MySQLSettings; /** *Settings in JSON format for the source and target Oracle endpoint. For information about - * other available settings, see Extra connection attributes - * when using Oracle as a source for AWS DMS and - * - * Extra connection attributes when using Oracle as a target for AWS DMS - * in the AWS Database Migration Service User Guide. + * other available settings, see Extra connection attributes + * when using Oracle as a source for DMS and + * + * Extra connection attributes when using Oracle as a target for DMS + * in the Database Migration Service User Guide. *
*/ OracleSettings?: OracleSettings; /** *Settings in JSON format for the source and target SAP ASE endpoint. For information - * about other available settings, see Extra connection attributes - * when using SAP ASE as a source for AWS DMS and Extra connection attributes - * when using SAP ASE as a target for AWS DMS in the AWS Database - * Migration Service User Guide. + * about other available settings, see Extra connection attributes + * when using SAP ASE as a source for DMS and Extra connection attributes + * when using SAP ASE as a target for DMS in the Database Migration Service + * User Guide. *
*/ SybaseSettings?: SybaseSettings; /** *Settings in JSON format for the source and target Microsoft SQL Server endpoint. For - * information about other available settings, see Extra connection - * attributes when using SQL Server as a source for AWS DMS and - * Extra connection attributes when using SQL Server as a target for AWS DMS in the - * AWS Database Migration Service User Guide. + * information about other available settings, see Extra connection + * attributes when using SQL Server as a source for DMS and + * Extra connection attributes when using SQL Server as a target for DMS in the + * Database Migration Service User Guide. *
*/ MicrosoftSQLServerSettings?: MicrosoftSQLServerSettings; /** *Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other - * available settings, see Extra connection attributes - * when using Db2 LUW as a source for AWS DMS in the AWS Database - * Migration Service User Guide. + * available settings, see Extra connection attributes + * when using Db2 LUW as a source for DMS in the Database Migration Service + * User Guide. *
*/ IBMDb2Settings?: IBMDb2Settings; @@ -3025,7 +3115,7 @@ export interface CreateEndpointMessage { * and can only begin with a letter, such asExample-App-ARN1. For example, this
* value might result in the EndpointArn value
* arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't
- * specify a ResourceIdentifier value, AWS DMS generates a default identifier
+ * specify a ResourceIdentifier value, DMS generates a default identifier
* value for the end of EndpointArn.
*/
ResourceIdentifier?: string;
@@ -3076,11 +3166,6 @@ export namespace CreateEndpointMessage {
*
*
- * DescribeEndpointTypes
- *
* ModifyEndpoint
*
An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
+ *An KMS key identifier that is used to encrypt the connection parameters for the endpoint.
*If you don't specify a value for the KmsKeyId parameter, then
- * AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a - * different default encryption key for each AWS Region.
+ * DMS uses your default encryption key. + *KMS creates the default encryption key for your account. Your account has a + * different default encryption key for each Region.
*/ KmsKeyId?: string; @@ -3171,7 +3256,8 @@ export interface Endpoint { SslMode?: DmsSslModeValue | string; /** - *The Amazon Resource Name (ARN) used by the service access IAM role.
+ *The Amazon Resource Name (ARN) used by the service to access the IAM role.
+ * The role must allow the iam:PassRole action.
* ServiceAccessRoleArn - The IAM role that has permission to access the
- * Amazon S3 bucket.
iam:PassRole action.
*
* BucketName - The name of the S3 bucket to use.
- * CompressionType - An optional parameter to use GZIP to compress the
- * target files. To use GZIP, set this value to NONE (the default). To keep
- * the files uncompressed, don't use this value.
Shorthand syntax for these settings is as follows:
- * ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
+ * ServiceAccessRoleArn=string,BucketName=string,
*
JSON syntax for these settings is as follows: { "ServiceAccessRoleArn":
- * "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
+ * "string", "BucketName": "string"}
*
AWS DMS cannot access the AWS KMS key.
+ *DMS cannot access the KMS key.
*/ export interface KMSKeyNotAccessibleFault extends __SmithyException, $MetadataBearer { name: "KMSKeyNotAccessibleFault"; @@ -3437,7 +3517,7 @@ export namespace S3AccessDeniedFault { */ export interface CreateEventSubscriptionMessage { /** - *The name of the AWS DMS event notification subscription. This name must be less than 255 characters.
+ *The name of the DMS event notification subscription. This name must be less than 255 characters.
*/ SubscriptionName: string | undefined; @@ -3448,7 +3528,7 @@ export interface CreateEventSubscriptionMessage { SnsTopicArn: string | undefined; /** - *The type of AWS DMS resource that generates the events. For example, if you want to be + *
The type of DMS resource that generates the events. For example, if you want to be
* notified of events generated by a replication instance, you set this parameter to
* replication-instance. If this value isn't specified, all events are
* returned.
A list of event categories for a source type that you want to subscribe to. For more * information, see Working with Events and - * Notifications in the AWS Database Migration Service User + * Notifications in the Database Migration Service User * Guide. *
*/ EventCategories?: string[]; /** - *A list of identifiers for which AWS DMS provides notification events.
+ *A list of identifiers for which DMS provides notification events.
*If you don't specify a value, notifications are provided for all sources.
*If you specify multiple values, they must be of the same type. For example, if you * specify a database instance ID, then all of the other values must be database instance @@ -3502,39 +3582,39 @@ export namespace CreateEventSubscriptionMessage { */ export interface EventSubscription { /** - *
The AWS customer account associated with the AWS DMS event notification + *
The Amazon Web Services customer account associated with the DMS event notification * subscription.
*/ CustomerAwsId?: string; /** - *The AWS DMS event notification subscription Id.
+ *The DMS event notification subscription Id.
*/ CustSubscriptionId?: string; /** - *The topic ARN of the AWS DMS event notification subscription.
+ *The topic ARN of the DMS event notification subscription.
*/ SnsTopicArn?: string; /** - *The status of the AWS DMS event notification subscription.
+ *The status of the DMS event notification subscription.
*Constraints:
*Can be one of the following: creating | modifying | deleting | active | no-permission | * topic-not-exist
- *The status "no-permission" indicates that AWS DMS no longer has permission to post to + *
The status "no-permission" indicates that DMS no longer has permission to post to * the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the * subscription was created.
*/ Status?: string; /** - *The time the AWS DMS event notification subscription was created.
+ *The time the DMS event notification subscription was created.
*/ SubscriptionCreationTime?: string; /** - *The type of AWS DMS resource that generates events.
+ *The type of DMS resource that generates events.
*Valid values: replication-instance | replication-server | security-group | * replication-task
*/ @@ -3621,7 +3701,7 @@ export namespace KMSDisabledFault { } /** - *The state of the specified AWS KMS resource isn't valid for this request.
+ *The state of the specified KMS resource isn't valid for this request.
*/ export interface KMSInvalidStateFault extends __SmithyException, $MetadataBearer { name: "KMSInvalidStateFault"; @@ -3639,7 +3719,7 @@ export namespace KMSInvalidStateFault { } /** - *The specified AWS KMS entity or resource can't be found.
+ *The specified KMS entity or resource can't be found.
*/ export interface KMSNotFoundFault extends __SmithyException, $MetadataBearer { name: "KMSNotFoundFault"; @@ -3657,7 +3737,7 @@ export namespace KMSNotFoundFault { } /** - *This request triggered AWS KMS request throttling.
+ *This request triggered KMS request throttling.
*/ export interface KMSThrottlingFault extends __SmithyException, $MetadataBearer { name: "KMSThrottlingFault"; @@ -3751,7 +3831,7 @@ export interface CreateReplicationInstanceMessage { * replication instance class. For example to specify the instance class dms.c4.large, set this parameter to"dms.c4.large".
* For more information on the settings and capacities for the available replication instance classes, see * - * Selecting the right AWS DMS replication instance for your migration. + * Selecting the right DMS replication instance for your migration. *
*/ ReplicationInstanceClass: string | undefined; @@ -3764,7 +3844,7 @@ export interface CreateReplicationInstanceMessage { /** *The Availability Zone where the replication instance will be created. The default
- * value is a random, system-chosen Availability Zone in the endpoint's AWS Region, for
+ * value is a random, system-chosen Availability Zone in the endpoint's Region, for
* example: us-east-1d
*
Format: ddd:hh24:mi-ddd:hh24:mi
*
Default: A 30-minute window selected at random from an 8-hour block of time per AWS - * Region, occurring on a random day of the week.
+ *Default: A 30-minute window selected at random from an 8-hour block of time per Region, + * occurring on a random day of the week.
*Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
*Constraints: Minimum 30-minute window.
*/ @@ -3816,12 +3896,12 @@ export interface CreateReplicationInstanceMessage { Tags?: Tag[]; /** - *An AWS KMS key identifier that is used to encrypt the data on the replication + *
An KMS key identifier that is used to encrypt the data on the replication * instance.
*If you don't specify a value for the KmsKeyId parameter, then
- * AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a - * different default encryption key for each AWS Region.
+ * DMS uses your default encryption key. + *KMS creates the default encryption key for your account. Your account has a + * different default encryption key for each Region.
*/ KmsKeyId?: string; @@ -3851,7 +3931,7 @@ export interface CreateReplicationInstanceMessage { * and can only begin with a letter, such asExample-App-ARN1. For example, this
* value might result in the EndpointArn value
* arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't
- * specify a ResourceIdentifier value, AWS DMS generates a default identifier
+ * specify a ResourceIdentifier value, DMS generates a default identifier
* value for the end of EndpointArn.
*/
ResourceIdentifier?: string;
@@ -3880,7 +3960,7 @@ export interface ReplicationPendingModifiedValues {
* replication instance class.
* For more information on the settings and capacities for the available replication instance classes, see * - * Selecting the right AWS DMS replication instance for your migration. + * Selecting the right DMS replication instance for your migration. *
*/ ReplicationInstanceClass?: string; @@ -3918,7 +3998,7 @@ export namespace ReplicationPendingModifiedValues { *AvailabilityZone is an optional parameter to the
* CreateReplicationInstance
* operation, and it’s value relates to
- * the AWS Region of an endpoint. For example, the availability zone of an endpoint in the
+ * the Region of an endpoint. For example, the availability zone of an endpoint in the
* us-east-1 region might be us-east-1a, us-east-1b, us-east-1c, or us-east-1d.
*/
export interface AvailabilityZone {
@@ -4059,11 +4139,11 @@ export interface ReplicationInstance {
/**
* The compute and memory capacity of the replication instance as defined for the specified - * replication instance class. It is a required parameter, although a defualt value is + * replication instance class. It is a required parameter, although a default value is * pre-selected in the DMS console.
*For more information on the settings and capacities for the available replication instance classes, see * - * Selecting the right AWS DMS replication instance for your migration. + * Selecting the right DMS replication instance for your migration. *
*/ ReplicationInstanceClass?: string; @@ -4201,12 +4281,12 @@ export interface ReplicationInstance { AutoMinorVersionUpgrade?: boolean; /** - *An AWS KMS key identifier that is used to encrypt the data on the replication + *
An KMS key identifier that is used to encrypt the data on the replication * instance.
*If you don't specify a value for the KmsKeyId parameter, then
- * AWS DMS uses your default encryption key.
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a - * different default encryption key for each AWS Region.
+ * DMS uses your default encryption key. + *KMS creates the default encryption key for your account. Your account has a + * different default encryption key for each Region.
*/ KmsKeyId?: string; @@ -4485,7 +4565,7 @@ export interface CreateReplicationTaskMessage { /** *The table mappings for the task, in JSON format. For more information, see Using Table - * Mapping to Specify Task Settings in the AWS Database Migration Service User + * Mapping to Specify Task Settings in the Database Migration Service User * Guide. *
*/ @@ -4493,8 +4573,7 @@ export interface CreateReplicationTaskMessage { /** *Overall settings for the task, in JSON format. For more information, see Specifying Task - * Settings for AWS Database Migration Service Tasks in the AWS Database - * Migration User Guide. + * Settings for Database Migration Service Tasks in the Database Migration Service User Guide. *
*/ ReplicationTaskSettings?: string; @@ -4521,7 +4600,7 @@ export interface CreateReplicationTaskMessage { * replication slot should already be created and associated with the source endpoint. You * can verify this by setting theslotName extra connection attribute to the
* name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source
- * for AWS DMS.
+ * for DMS.
*
*/
CdcStartPosition?: string;
@@ -4542,7 +4621,7 @@ export interface CreateReplicationTaskMessage {
/**
* Supplemental information that the task requires to migrate the data for certain source and target endpoints. * For more information, see Specifying Supplemental Data for Task Settings in the - * AWS Database Migration Service User Guide. + * Database Migration Service User Guide. *
*/ TaskData?: string; @@ -4555,7 +4634,7 @@ export interface CreateReplicationTaskMessage { * and can only begin with a letter, such asExample-App-ARN1. For example, this
* value might result in the EndpointArn value
* arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't
- * specify a ResourceIdentifier value, AWS DMS generates a default identifier
+ * specify a ResourceIdentifier value, DMS generates a default identifier
* value for the end of EndpointArn.
*/
ResourceIdentifier?: string;
@@ -4892,7 +4971,7 @@ export interface ReplicationTask {
/**
* Supplemental information that the task requires to migrate the data for certain source and target endpoints. * For more information, see Specifying Supplemental Data for Task Settings in the - * AWS Database Migration Service User Guide. + * Database Migration Service User Guide. *
*/ TaskData?: string; @@ -5396,16 +5475,16 @@ export interface DescribeAccountAttributesResponse { AccountQuotas?: AccountQuota[]; /** - *A unique AWS DMS identifier for an account in a particular AWS Region. The value of this + *
A unique DMS identifier for an account in a particular Region. The value of this
* identifier has the following format: c99999999999. DMS uses this identifier to
* name artifacts. For example, DMS uses this identifier to name the default Amazon S3 bucket
- * for storing task assessment reports in a given AWS Region. The format of this S3 bucket
+ * for storing task assessment reports in a given Region. The format of this S3 bucket
* name is the following:
* dms-AccountNumber-UniqueAccountIdentifier.
* Here is an example name for this default S3 bucket:
* dms-111122223333-c44445555666.
AWS DMS supports the UniqueAccountIdentifier parameter in
+ *
DMS supports the UniqueAccountIdentifier parameter in
* versions 3.1.4 and later.
Identifies the name and value of a filter object. This filter is used to limit the
- * number and type of AWS DMS objects that are returned for a particular
+ * number and type of DMS objects that are returned for a particular
* Describe* call or similar operation. Filters are used as an optional
* parameter for certain API operations.
The maximum value of an endpoint setting that is of type int.
The default value of the endpoint setting if no value is specified using CreateEndpoint or ModifyEndpoint.
Indicates if Change Data Capture (CDC) is supported.
+ *Indicates if change data capture (CDC) is supported.
*/ SupportsCDC?: boolean; @@ -5891,7 +5975,7 @@ export interface SupportedEndpointType { EndpointType?: ReplicationEndpointTypeValue | string; /** - *The earliest AWS DMS engine version that supports this endpoint engine. Note that endpoint engines released with AWS DMS versions earlier than 3.1.1 do not return a value for this parameter.
+ *The earliest DMS engine version that supports this endpoint engine. Note that endpoint engines released with DMS versions earlier than 3.1.1 do not return a value for this parameter.
*/ ReplicationInstanceEngineMinimumVersion?: string; @@ -5942,7 +6026,7 @@ export namespace DescribeEndpointTypesResponse { */ export interface DescribeEventCategoriesMessage { /** - *The type of AWS DMS resource that generates events.
+ *The type of DMS resource that generates events.
*Valid values: replication-instance | replication-task
*/ SourceType?: string; @@ -5963,7 +6047,7 @@ export namespace DescribeEventCategoriesMessage { } /** - *Lists categories of events subscribed to, and generated by, the applicable AWS DMS + *
Lists categories of events subscribed to, and generated by, the applicable DMS
* resource type. This data type appears in response to the
*
* The type of AWS DMS resource that generates events. The type of DMS resource that generates events. Valid values: replication-instance | replication-server | security-group |
* replication-task The type of AWS DMS resource that generates events. The type of DMS resource that generates events. Valid values: replication-instance | replication-task Describes an identifiable significant activity that affects a replication instance or
* task. This object can provide the message, the available event categories, the date and
- * source of the event, and the AWS DMS resource type.DescribeEventCategories
@@ -5972,7 +6056,7 @@ export namespace DescribeEventCategoriesMessage {
*/
export interface EventCategoryGroup {
/**
- *
The type of AWS DMS resource that generates events.
+ *The type of DMS resource that generates events.
*Valid values: replication-instance | endpoint | replication-task
*/ SourceType?: SourceType | string; @@ -6153,7 +6237,7 @@ export namespace DescribeEventsResponse { */ export interface DescribeEventSubscriptionsMessage { /** - *The name of the AWS DMS event subscription to be described.
+ *The name of the DMS event subscription to be described.
*/ SubscriptionName?: string; @@ -6264,7 +6348,7 @@ export interface OrderableReplicationInstance { * replication instance class. For example to specify the instance class dms.c4.large, set this parameter to"dms.c4.large".
* For more information on the settings and capacities for the available replication instance classes, see * - * Selecting the right AWS DMS replication instance for your migration. + * Selecting the right DMS replication instance for your migration. *
*/ ReplicationInstanceClass?: string; @@ -6307,7 +6391,7 @@ export interface OrderableReplicationInstance { *The value returned when the specified EngineVersion of the replication
* instance is in Beta or test mode. This indicates some features might not work as expected.
AWS DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.
DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.
The task assessment results in JSON format.
+ *The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn + * in the request.
*/ AssessmentResults?: string; /** *The URL of the S3 object containing the task assessment results.
+ *The response object only contains this field if you provide DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn + * in the request.
*/ S3ObjectUrl?: string; } @@ -7409,7 +7497,9 @@ export interface ImportCertificateMessage { CertificatePem?: string; /** - *The location of an imported Oracle Wallet certificate for use with SSL.
+ *The location of an imported Oracle Wallet certificate for use with SSL. Provide the name of a .sso file
+ * using the fileb:// prefix. You can't provide the certificate inline.
+ *
The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS + *
The Amazon Resource Name (ARN) string that uniquely identifies the DMS * resource.
*/ ResourceArn: string | undefined; @@ -7556,7 +7646,7 @@ export interface ModifyEndpointMessage { Port?: number; /** - *The name of the endpoint database.
+ *The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.
*/ DatabaseName?: string; @@ -7577,8 +7667,8 @@ export interface ModifyEndpointMessage { SslMode?: DmsSslModeValue | string; /** - *The Amazon Resource Name (ARN) for the service access role you want to use to modify - * the endpoint.
+ * The Amazon Resource Name (ARN) for the IAM role you want to use to modify
+ * the endpoint. The role must allow the iam:PassRole action.
Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other - * available settings, see Using Object Mapping to Migrate - * Data to DynamoDB in the AWS Database Migration Service User + * available settings, see Using Object Mapping to Migrate + * Data to DynamoDB in the Database Migration Service User * Guide. *
*/ @@ -7599,8 +7689,8 @@ export interface ModifyEndpointMessage { /** *Settings in JSON format for the target Amazon S3 endpoint. For more information about * the available settings, see Extra - * Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the - * AWS Database Migration Service User Guide. + * Connection Attributes When Using Amazon S3 as a Target for DMS in the + * Database Migration Service User Guide. *
*/ S3Settings?: S3Settings; @@ -7610,66 +7700,59 @@ export interface ModifyEndpointMessage { *Attributes include the following:
*serviceAccessRoleArn - The AWS Identity and Access Management (IAM) role that has - * permission to access the Amazon S3 bucket.
+ *serviceAccessRoleArn - The Identity and Access Management (IAM) role that has
+ * permission to access the Amazon S3 bucket. The role must allow the iam:PassRole action.
BucketName - The name of the S3 bucket to use.
*compressionType - An optional parameter to use GZIP to compress the target files. - * Either set this parameter to NONE (the default) or don't use it to leave the - * files uncompressed.
- *Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string
- * ,BucketName=string,CompressionType=string
+ * ,BucketName=string
*
JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string",
- * "BucketName": "string", "CompressionType": "none"|"gzip" }
+ * "BucketName": "string"}
*
Settings in JSON format for the source MongoDB endpoint. For more information about the - * available settings, see the configuration properties section in Using MongoDB as a Target for AWS - * Database Migration Service in the AWS Database Migration Service User - * Guide. + * available settings, see the configuration properties section in Endpoint configuration settings + * when using MongoDB as a source for Database Migration Service in the + * Database Migration Service User Guide. *
*/ MongoDbSettings?: MongoDbSettings; /** *Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For - * more information about the available settings, see Using Amazon Kinesis Data Streams - * as a Target for AWS Database Migration Service in the AWS Database Migration Service User - * Guide. + * more information about the available settings, see Using object mapping to + * migrate data to a Kinesis data stream in the Database Migration Service User Guide. *
*/ KinesisSettings?: KinesisSettings; /** *Settings in JSON format for the target Apache Kafka endpoint. For more information about - * the available settings, see Using Apache Kafka as a Target for AWS - * Database Migration Service in the AWS Database Migration Service User - * Guide. + * the available settings, see Using object mapping + * to migrate data to a Kafka topic in the Database Migration Service User Guide. *
*/ KafkaSettings?: KafkaSettings; /** *Settings in JSON format for the target Elasticsearch endpoint. For more information - * about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in - * the AWS Database Migration Service User Guide. + * about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for DMS in + * the Database Migration Service User Guide. *
*/ ElasticsearchSettings?: ElasticsearchSettings; /** *Settings in JSON format for the target Amazon Neptune endpoint. For more information - * about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target - * in the AWS Database Migration Service User Guide. + * about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target + * in the Database Migration Service User Guide. *
*/ NeptuneSettings?: NeptuneSettings; @@ -7681,20 +7764,19 @@ export interface ModifyEndpointMessage { /** *Settings in JSON format for the source and target PostgreSQL endpoint. For information - * about other available settings, see Extra connection - * attributes when using PostgreSQL as a source for AWS DMS and - * Extra connection attributes when using PostgreSQL as a target for AWS DMS in the - * AWS Database Migration Service User Guide. + * about other available settings, see Extra connection + * attributes when using PostgreSQL as a source for DMS and + * Extra connection attributes when using PostgreSQL as a target for DMS in the + * Database Migration Service User Guide. *
*/ PostgreSQLSettings?: PostgreSQLSettings; /** *Settings in JSON format for the source and target MySQL endpoint. For information about - * other available settings, see Extra connection - * attributes when using MySQL as a source for AWS DMS and Extra - * connection attributes when using a MySQL-compatible database as a target for AWS - * DMS in the AWS Database Migration Service User + * other available settings, see Extra connection + * attributes when using MySQL as a source for DMS and Extra + * connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User * Guide. *
*/ @@ -7702,51 +7784,76 @@ export interface ModifyEndpointMessage { /** *Settings in JSON format for the source and target Oracle endpoint. For information about - * other available settings, see Extra connection - * attributes when using Oracle as a source for AWS DMS and - * Extra connection attributes when using Oracle as a target for AWS DMS in the - * AWS Database Migration Service User Guide. + * other available settings, see Extra connection + * attributes when using Oracle as a source for DMS and + * Extra connection attributes when using Oracle as a target for DMS in the + * Database Migration Service User Guide. *
*/ OracleSettings?: OracleSettings; /** *Settings in JSON format for the source and target SAP ASE endpoint. For information - * about other available settings, see Extra connection attributes - * when using SAP ASE as a source for AWS DMS and Extra connection attributes - * when using SAP ASE as a target for AWS DMS in the AWS Database - * Migration Service User Guide. + * about other available settings, see Extra connection attributes + * when using SAP ASE as a source for DMS and Extra connection attributes + * when using SAP ASE as a target for DMS in the Database Migration Service + * User Guide. *
*/ SybaseSettings?: SybaseSettings; /** *Settings in JSON format for the source and target Microsoft SQL Server endpoint. For - * information about other available settings, see Extra connection - * attributes when using SQL Server as a source for AWS DMS and - * Extra connection attributes when using SQL Server as a target for AWS DMS in the - * AWS Database Migration Service User Guide. + * information about other available settings, see Extra connection + * attributes when using SQL Server as a source for DMS and + * Extra connection attributes when using SQL Server as a target for DMS in the + * Database Migration Service User Guide. *
*/ MicrosoftSQLServerSettings?: MicrosoftSQLServerSettings; /** *Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other - * available settings, see Extra connection attributes - * when using Db2 LUW as a source for AWS DMS in the AWS Database - * Migration Service User Guide. + * available settings, see Extra connection attributes + * when using Db2 LUW as a source for DMS in the Database Migration Service + * User Guide. *
*/ IBMDb2Settings?: IBMDb2Settings; /** *Settings in JSON format for the source DocumentDB endpoint. For more information about the - * available settings, see the configuration properties section in Using DocumentDB as a Target for AWS - * Database Migration Service in the AWS Database Migration Service User + * available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service + * in the Database Migration Service User * Guide. *
*/ DocDbSettings?: DocDbSettings; + + /** + *If this attribute is Y, the current call to ModifyEndpoint replaces all
+ * existing endpoint settings with the exact settings that you specify in this call. If this
+ * attribute is N, the current call to ModifyEndpoint does two things:
It replaces any endpoint settings that already exist with new values, for settings with the + * same names.
+ *It creates new endpoint settings that you specify in the call, for settings with different + * names.
+ *For example, if you call create-endpoint ... --endpoint-settings '{"a":1}'
+ * ..., the endpoint has the following endpoint settings: '{"a":1}'. If
+ * you then call modify-endpoint ... --endpoint-settings '{"b":2}' ... for the
+ * same endpoint, the endpoint has the following settings: '{"a":1,"b":2}'.
However, suppose that you follow this with a call to modify-endpoint ...
+ * --endpoint-settings '{"b":2}' --exact-settings ... for that same endpoint again.
+ * Then the endpoint has the following settings: '{"b":2}'. All existing settings
+ * are replaced with the exact settings that you specify.
The name of the AWS DMS event notification subscription to be modified.
+ *The name of the DMS event notification subscription to be modified.
*/ SubscriptionName: string | undefined; @@ -7809,7 +7916,7 @@ export interface ModifyEventSubscriptionMessage { SnsTopicArn?: string; /** - *The type of AWS DMS resource that generates the events you want to subscribe to.
+ *The type of DMS resource that generates the events you want to subscribe to.
*Valid values: replication-instance | replication-task
*/ SourceType?: string; @@ -7881,7 +7988,7 @@ export interface ModifyReplicationInstanceMessage { * replication instance class. For example to specify the instance class dms.c4.large, set this parameter to"dms.c4.large".
* For more information on the settings and capacities for the available replication instance classes, see * - * Selecting the right AWS DMS replication instance for your migration. + * Selecting the right DMS replication instance for your migration. *
*/ ReplicationInstanceClass?: string; @@ -7942,7 +8049,7 @@ export interface ModifyReplicationInstanceMessage { *A newer minor version is available.
* *AWS DMS has enabled automatic patching for the given engine version.
+ *DMS has enabled automatic patching for the given engine version.
*When using the AWS CLI or boto3, provide the path of the JSON file that contains the + *
When using the CLI or boto3, provide the path of the JSON file that contains the
* table mappings. Precede the path with file://. For example,
- * --table-mappings file://mappingfile.json. When working with the DMS API,
+ * --table-mappings file://mappingfile.json. When working with the DMS API,
* provide the JSON as the parameter value.
*
slotName extra connection attribute to the
* name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source
- * for AWS DMS.
+ * for DMS.
*
*/
CdcStartPosition?: string;
@@ -8157,7 +8264,7 @@ export interface ModifyReplicationTaskMessage {
/**
* Supplemental information that the task requires to migrate the data for certain source and target endpoints. * For more information, see Specifying Supplemental Data for Task Settings in the - * AWS Database Migration Service User Guide. + * Database Migration Service User Guide. *
*/ TaskData?: string; @@ -8392,11 +8499,11 @@ export namespace ReloadTablesResponse { } /** - *Removes one or more tags from an AWS DMS resource.
+ *Removes one or more tags from an DMS resource.
*/ export interface RemoveTagsFromResourceMessage { /** - *An AWS DMS resource from which you want to remove tag(s). The value for this parameter is an Amazon Resource Name (ARN).
+ *An DMS resource from which you want to remove tag(s). The value for this parameter is an Amazon Resource Name (ARN).
*/ ResourceArn: string | undefined; @@ -8471,7 +8578,7 @@ export interface StartReplicationTaskMessage { * replication slot should already be created and associated with the source endpoint. You * can verify this by setting theslotName extra connection attribute to the
* name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source
- * for AWS DMS.
+ * for DMS.
*
*/
CdcStartPosition?: string;
@@ -8552,7 +8659,7 @@ export namespace StartReplicationTaskAssessmentResponse {
}
/**
- * An AWS Key Management Service (AWS KMS) error is preventing access to AWS KMS.
+ *An Key Management Service (KMS) error is preventing access to KMS.
*/ export interface KMSFault extends __SmithyException, $MetadataBearer { name: "KMSFault"; @@ -8599,25 +8706,25 @@ export interface StartReplicationTaskAssessmentRunMessage { ReplicationTaskArn: string | undefined; /** - *ARN of a service role needed to start the assessment run.
+ *ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole action.
Amazon S3 bucket where you want AWS DMS to store the results of this assessment + *
Amazon S3 bucket where you want DMS to store the results of this assessment * run.
*/ ResultLocationBucket: string | undefined; /** - *Folder within an Amazon S3 bucket where you want AWS DMS to store the results of this assessment + *
Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment * run.
*/ ResultLocationFolder?: string; /** *Encryption mode that you can specify to encrypt the results of this assessment run. If - * you don't specify this request parameter, AWS DMS stores the assessment run results + * you don't specify this request parameter, DMS stores the assessment run results * without encryption. You can specify one of the options following:
*
- * "SSE_KMS" – AWS Key Management Service (AWS KMS) encryption.
+ * "SSE_KMS" – Key Management Service (KMS) encryption.
* This encryption can use either a custom KMS encryption key that you specify or the
* default KMS encryption key that DMS provides.
Space-separated list of names for specific individual assessments that you want to
- * include. These names come from the default list of individual assessments that AWS DMS
+ * include. These names come from the default list of individual assessments that DMS
* supports for the associated migration task. This task is specified by
* ReplicationTaskArn.
You can't set a value for IncludeOnly if you also set a value for
* Exclude in the API operation.
To identify the names of the default individual assessments that AWS DMS + *
To identify the names of the default individual assessments that DMS
* supports for the associated migration task, run the
* DescribeApplicableIndividualAssessments operation using its own
* ReplicationTaskArn request parameter.
Space-separated list of names for specific individual assessments that you want to
- * exclude. These names come from the default list of individual assessments that AWS DMS
+ * exclude. These names come from the default list of individual assessments that DMS
* supports for the associated migration task. This task is specified by
* ReplicationTaskArn.
You can't set a value for Exclude if you also set a value for
* IncludeOnly in the API operation.
To identify the names of the default individual assessments that AWS DMS + *
To identify the names of the default individual assessments that DMS
* supports for the associated migration task, run the
* DescribeApplicableIndividualAssessments operation using its own
* ReplicationTaskArn request parameter.
AWS Direct Connect links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. - * One end of the cable is connected to your router, the other to an AWS Direct Connect router. With this connection - * in place, you can create virtual interfaces directly to the AWS cloud (for example, to Amazon EC2 + *
Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. + * One end of the cable is connected to your router, the other to an Direct Connect router. With this connection + * in place, you can create virtual interfaces directly to the Cloud (for example, to Amazon EC2 * and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A - * connection provides access to all AWS Regions except the China (Beijing) and (China) Ningxia Regions. - * AWS resources in the China Regions can only be accessed through locations associated with those Regions.
+ * connection provides access to all Regions except the China (Beijing) and (China) Ningxia Regions. + * Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions. */ export class DirectConnect extends DirectConnectClient { /** @@ -326,7 +326,7 @@ export class DirectConnect extends DirectConnectClient { *Creates a hosted connection on an interconnect.
*Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.
*Intended for use by AWS Direct Connect Partners only.
+ *Intended for use by Direct Connect Partners only.
*Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.
- *Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. AWS polices the hosted connection for the specified capacity and the AWS Direct Connect Partner must also police the hosted connection for the specified capacity.
+ *Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. + * Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity.
*Intended for use by AWS Direct Connect Partners only.
+ *Intended for use by Direct Connect Partners only.
*Provisions a private virtual interface to be owned by the specified AWS account.
+ *Provisions a private virtual interface to be owned by the specified account.
*Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface.
* Until then, the virtual interface is in the Confirming state and is not available to handle traffic.
Provisions a public virtual interface to be owned by the specified AWS account.
- *The owner of a connection calls this function to provision a public virtual interface to be owned by the specified AWS account.
+ *Provisions a public virtual interface to be owned by the specified account.
+ *The owner of a connection calls this function to provision a public virtual interface to be owned by the specified account.
*Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface.
* Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.
When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from @@ -466,8 +467,8 @@ export class DirectConnect extends DirectConnectClient { } /** - *
Provisions a transit virtual interface to be owned by the specified AWS account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.
- *The owner of a connection provisions a transit virtual interface to be owned by the specified AWS account.
+ *Provisions a transit virtual interface to be owned by the specified account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.
+ *The owner of a connection provisions a transit virtual interface to be owned by the specified account.
*After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.
Associates an existing connection with a link aggregation group (LAG). The connection - * is interrupted and re-established as a member of the LAG (connectivity to AWS is - * interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its + * is interrupted and re-established as a member of the LAG (connectivity to Amazon Web Services is + * interrupted). The connection must be hosted on the same Direct Connect endpoint as the LAG, and its * bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's * currently associated with a different LAG; however, if removing the connection would cause * the original LAG to fall below its setting for minimum number of operational connections, @@ -548,10 +549,10 @@ export class DirectConnect extends DirectConnectClient { *
Associates a hosted connection and its virtual interfaces with a link aggregation * group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted * connection with a conflicting VLAN number or IP address, the operation fails. This - * action temporarily interrupts the hosted connection's connectivity to AWS as it is being - * migrated.
+ * action temporarily interrupts the hosted connection's connectivity to Amazon Web Services + * as it is being migrated. *Intended for use by AWS Direct Connect Partners only.
+ *Intended for use by Direct Connect Partners only.
*Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an AWS Direct Connect dedicated connection.
+ *Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.
*You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request.
For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the AWS Direct Connect User Guide.
+ *For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the Direct Connect User Guide.
*/ public associateMacSecKey( args: AssociateMacSecKeyCommandInput, @@ -619,7 +620,7 @@ export class DirectConnect extends DirectConnectClient { /** *Associates a virtual interface with a specified link aggregation group (LAG) or - * connection. Connectivity to AWS is temporarily interrupted as the virtual interface is + * connection. Connectivity to Amazon Web Services is temporarily interrupted as the virtual interface is * being migrated. If the target connection or LAG has an associated virtual interface with * a conflicting VLAN number or a conflicting IP address, the operation fails.
*Virtual interfaces associated with a hosted connection cannot be associated with a @@ -693,7 +694,7 @@ export class DirectConnect extends DirectConnectClient { } /** - *
Accepts ownership of a private virtual interface created by another AWS account.
+ *Accepts ownership of a private virtual interface created by another account.
*After the virtual interface owner makes this call, the virtual interface is * created and attached to the specified virtual private gateway or Direct Connect gateway, and is * made available to handle traffic.
@@ -728,7 +729,7 @@ export class DirectConnect extends DirectConnectClient { } /** - *Accepts ownership of a public virtual interface created by another AWS account.
+ *Accepts ownership of a public virtual interface created by another account.
*After the virtual interface owner makes this call, the specified virtual interface is * created and made available to handle traffic.
*/ @@ -762,7 +763,7 @@ export class DirectConnect extends DirectConnectClient { } /** - *Accepts ownership of a transit virtual interface created by another AWS account.
+ *Accepts ownership of a transit virtual interface created by another account.
* *After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.
*/ @@ -797,7 +798,7 @@ export class DirectConnect extends DirectConnectClient { /** *Creates a BGP peer on the specified virtual interface.
- *You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access AWS resources that also use that address family.
+ *You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources that also use that address family.
*If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot * be in the same address family as an existing BGP peer on the virtual interface.
*When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from @@ -834,14 +835,14 @@ export class DirectConnect extends DirectConnectClient { } /** - *
Creates a connection between a customer network and a specific AWS Direct Connect location.
+ *Creates a connection between a customer network and a specific Direct Connect location.
* - *A connection links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic - * cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router.
+ *A connection links your internal network to an Direct Connect location over a standard Ethernet fiber-optic + * cable. One end of the cable is connected to your router, the other to an Direct Connect router.
*To find the locations for your Region, use DescribeLocations.
*You can automatically add the new connection to a link aggregation group (LAG) by * specifying a LAG ID in the request. This ensures that the new connection is allocated on the - * same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, + * same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, * the request fails and no connection is created.
*/ public createConnection( @@ -876,8 +877,8 @@ export class DirectConnect extends DirectConnectClient { /** *Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set * of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any - * AWS Region after it is created. The virtual interfaces and virtual private gateways that - * are connected through a Direct Connect gateway can be in different AWS Regions. This enables you to + * Region after it is created. The virtual interfaces and virtual private gateways that + * are connected through a Direct Connect gateway can be in different Regions. This enables you to * connect to a VPC in any Region, regardless of the Region in which the virtual interfaces * are located, and pass traffic between them.
*/ @@ -947,7 +948,7 @@ export class DirectConnect extends DirectConnectClient { /** *Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
- *You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any AWS account.
+ *You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any account.
*/ public createDirectConnectGatewayAssociationProposal( args: CreateDirectConnectGatewayAssociationProposalCommandInput, @@ -981,21 +982,21 @@ export class DirectConnect extends DirectConnectClient { } /** - *Creates an interconnect between an AWS Direct Connect Partner's network and a specific AWS Direct Connect location.
- *An interconnect is a connection that is capable of hosting other connections. The AWS - * Direct Connect partner can use an interconnect to provide AWS Direct Connect hosted + *
Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location.
+ *An interconnect is a connection that is capable of hosting other connections. The + * Direct Connect Partner can use an interconnect to provide Direct Connect hosted * connections to customers through their own network services. Like a standard connection, an - * interconnect links the partner's network to an AWS Direct Connect location over a standard Ethernet - * fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect + * interconnect links the partner's network to an Direct Connect location over a standard Ethernet + * fiber-optic cable. One end is connected to the partner's router, the other to an Direct Connect * router.
*You can automatically add the new interconnect to a link aggregation group (LAG) by * specifying a LAG ID in the request. This ensures that the new interconnect is allocated on - * the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the + * the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the * endpoint, the request fails and no interconnect is created.
- *For each end customer, the AWS Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. - * The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect Partner.
+ *For each end customer, the Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. + * The end customer can then connect to Amazon Web Services resources by creating a virtual interface on their connection, using the VLAN assigned to them by the Direct Connect Partner.
*Intended for use by AWS Direct Connect Partners only.
+ *Intended for use by Direct Connect Partners only.
*Creates a link aggregation group (LAG) with the specified number of bundled - * physical dedicated connections between the customer network and a specific AWS Direct Connect location. + * physical dedicated connections between the customer network and a specific Direct Connect location. * A LAG is a logical interface that uses the Link Aggregation Control Protocol * (LACP) to aggregate multiple interfaces, enabling you to treat them as a single * interface.
- *All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same AWS Direct Connect endpoint.
+ *All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same Direct Connect endpoint.
*You can have up to 10 dedicated connections per LAG. Regardless of this limit, if you - * request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is + * request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is * created.
*You can specify an existing physical dedicated connection or interconnect to include in * the LAG (which counts towards the total number of connections). Doing so interrupts the * current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG - * will be created on the same AWS Direct Connect endpoint to which the dedicated connection terminates. Any + * will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any * virtual interfaces associated with the dedicated connection are automatically disassociated * and re-associated with the LAG. The connection ID does not change.
- *If the AWS account used to create a LAG is a registered AWS Direct Connect Partner, the LAG is + *
If the account used to create a LAG is a registered Direct Connect Partner, the LAG is * automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual * interfaces cannot be directly configured.
*/ @@ -1071,11 +1072,11 @@ export class DirectConnect extends DirectConnectClient { } /** - *Creates a private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. + *
Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. * A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). * Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple - * VPCs, including VPCs in different AWS Regions. Connecting the private virtual interface to a VGW only - * provides access to a single VPC within the same Region.
+ * VPCs, including VPCs in different Regions. Connecting the private virtual interface + * to a VGW only provides access to a single VPC within the same Region. *Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to * the underlying physical connection if it wasn't updated to support jumbo frames. Updating * the connection disrupts network connectivity for all virtual interfaces associated with @@ -1113,8 +1114,8 @@ export class DirectConnect extends DirectConnectClient { } /** - *
Creates a public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. - * A public virtual interface supports sending traffic to public services of AWS such as Amazon S3.
+ *Creates a public virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. + * A public virtual interface supports sending traffic to public services of Amazon Web Services such as Amazon S3.
*When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer
* and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.
Deletes the specified connection.
- *Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. - * If you are partnering with any third parties to connect with the AWS Direct Connect location, + *
Deleting a connection only stops the Direct Connect port hour and data transfer charges. + * If you are partnering with any third parties to connect with the Direct Connect location, * you must cancel your service with them separately.
*/ public deleteConnection( @@ -1363,7 +1364,7 @@ export class DirectConnect extends DirectConnectClient { *Deletes the specified interconnect.
*Intended for use - * by AWS Direct Connect Partners only.
+ * by Direct Connect Partners only. *Deprecated. Use DescribeLoa instead.
*Gets the LOA-CFA for a connection.
*The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or - * service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, + * service provider uses when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, * see Requesting Cross Connects - * at AWS Direct Connect Locations in the AWS Direct Connect User Guide.
+ * at Direct Connect Locations in the Direct Connect User Guide. */ public describeConnectionLoa( args: DescribeConnectionLoaCommandInput, @@ -1531,7 +1532,7 @@ export class DirectConnect extends DirectConnectClient { *Deprecated. Use DescribeHostedConnections instead.
*Lists the connections that have been provisioned on the specified interconnect.
*Intended for use by AWS Direct Connect Partners only.
+ *Intended for use by Direct Connect Partners only.
*Lists the hosted connections that have been provisioned on the specified * interconnect or link aggregation group (LAG).
*Intended for use by AWS Direct Connect Partners only.
+ *Intended for use by Direct Connect Partners only.
*Deprecated. Use DescribeLoa instead.
*Gets the LOA-CFA for the specified interconnect.
- *The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. - * For more information, see Requesting Cross Connects at AWS Direct Connect Locations - * in the AWS Direct Connect User Guide.
+ *The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. + * For more information, see Requesting Cross Connects at Direct Connect Locations + * in the Direct Connect User Guide.
*/ public describeInterconnectLoa( args: DescribeInterconnectLoaCommandInput, @@ -1798,7 +1799,7 @@ export class DirectConnect extends DirectConnectClient { } /** - *Lists the interconnects owned by the AWS account or only the specified interconnect.
+ *Lists the interconnects owned by the account or only the specified interconnect.
*/ public describeInterconnects( args: DescribeInterconnectsCommandInput, @@ -1861,8 +1862,8 @@ export class DirectConnect extends DirectConnectClient { /** *Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).
*The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing - * your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations - * in the AWS Direct Connect User Guide.
+ * your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations + * in the Direct Connect User Guide. */ public describeLoa(args: DescribeLoaCommandInput, options?: __HttpHandlerOptions): PromiseLists the AWS Direct Connect locations in the current AWS Region. These are the locations that can be selected when calling + *
Lists the Direct Connect locations in the current Region. These are the locations that can be selected when calling * CreateConnection or CreateInterconnect.
*/ public describeLocations( @@ -1921,7 +1922,7 @@ export class DirectConnect extends DirectConnectClient { } /** - *Describes the tags associated with the specified AWS Direct Connect resources.
+ *Describes the tags associated with the specified Direct Connect resources.
*/ public describeTags( args: DescribeTagsCommandInput, @@ -1950,8 +1951,8 @@ export class DirectConnect extends DirectConnectClient { } /** - *Lists the virtual private gateways owned by the AWS account.
- *You can create one or more AWS Direct Connect private virtual interfaces linked to a virtual private gateway.
+ *Lists the virtual private gateways owned by the account.
+ *You can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.
*/ public describeVirtualGateways( args: DescribeVirtualGatewaysCommandInput, @@ -1983,11 +1984,11 @@ export class DirectConnect extends DirectConnectClient { } /** - *Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer + *
Displays all virtual interfaces for an account. Virtual interfaces deleted fewer * than 15 minutes before you make the request are also returned. If you specify a * connection ID, only the virtual interfaces associated with the connection are returned. * If you specify a virtual interface ID, then only a single virtual interface is returned.
- *A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer network.
+ *A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.
*/ public describeVirtualInterfaces( args: DescribeVirtualInterfacesCommandInput, @@ -2023,7 +2024,7 @@ export class DirectConnect extends DirectConnectClient { * interrupted and re-established as a standalone connection (the connection is not * deleted; to delete the connection, use the DeleteConnection request). * If the LAG has associated virtual interfaces or hosted connections, they remain - * associated with the LAG. A disassociated connection owned by an AWS Direct Connect Partner is + * associated with the LAG. A disassociated connection owned by an Direct Connect Partner is * automatically converted to an interconnect. *If disassociating the connection would cause the LAG to fall below its setting for * minimum number of operational connections, the request fails, except when it's the last @@ -2060,7 +2061,7 @@ export class DirectConnect extends DirectConnectClient { } /** - *
Removes the association between a MAC Security (MACsec) security key and an AWS Direct Connect dedicated connection.
+ *Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.
*/ public disassociateMacSecKey( args: DisassociateMacSecKeyCommandInput, @@ -2191,7 +2192,7 @@ export class DirectConnect extends DirectConnectClient { } /** - *Adds the specified tags to the specified AWS Direct Connect resource. Each resource can have a maximum of 50 tags.
+ *Adds the specified tags to the specified Direct Connect resource. Each resource can have a maximum of 50 tags.
*Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.
*/ public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): PromiseRemoves one or more tags from the specified AWS Direct Connect resource.
+ *Removes one or more tags from the specified Direct Connect resource.
*/ public untagResource( args: UntagResourceCommandInput, @@ -2250,7 +2251,7 @@ export class DirectConnect extends DirectConnectClient { } /** - *Updates the AWS Direct Connect dedicated connection configuration.
+ *Updates the Direct Connect dedicated connection configuration.
*You can update the following parameters for a connection:
*The LAG's MACsec encryption mode.
- *AWS assigns this value to each connection which is part of the LAG.
+ *Amazon Web Services assigns this value to each connection which is part of the LAG.
*The tags
diff --git a/clients/client-direct-connect/DirectConnectClient.ts b/clients/client-direct-connect/DirectConnectClient.ts index a7fe0a41b1067..ae2cc72a8fe7c 100644 --- a/clients/client-direct-connect/DirectConnectClient.ts +++ b/clients/client-direct-connect/DirectConnectClient.ts @@ -494,12 +494,12 @@ type DirectConnectClientResolvedConfigType = __SmithyResolvedConfiguration<__Htt export interface DirectConnectClientResolvedConfig extends DirectConnectClientResolvedConfigType {} /** - *AWS Direct Connect links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. - * One end of the cable is connected to your router, the other to an AWS Direct Connect router. With this connection - * in place, you can create virtual interfaces directly to the AWS cloud (for example, to Amazon EC2 + *
Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. + * One end of the cable is connected to your router, the other to an Direct Connect router. With this connection + * in place, you can create virtual interfaces directly to the Cloud (for example, to Amazon EC2 * and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A - * connection provides access to all AWS Regions except the China (Beijing) and (China) Ningxia Regions. - * AWS resources in the China Regions can only be accessed through locations associated with those Regions.
+ * connection provides access to all Regions except the China (Beijing) and (China) Ningxia Regions. + * Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions. */ export class DirectConnectClient extends __Client< __HttpHandlerOptions, diff --git a/clients/client-direct-connect/README.md b/clients/client-direct-connect/README.md index f95d74e245808..58d30a866dfe0 100644 --- a/clients/client-direct-connect/README.md +++ b/clients/client-direct-connect/README.md @@ -7,12 +7,12 @@ AWS SDK for JavaScript DirectConnect Client for Node.js, Browser and React Native. -AWS Direct Connect links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. -One end of the cable is connected to your router, the other to an AWS Direct Connect router. With this connection -in place, you can create virtual interfaces directly to the AWS cloud (for example, to Amazon EC2 +
Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. +One end of the cable is connected to your router, the other to an Direct Connect router. With this connection +in place, you can create virtual interfaces directly to the Cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A -connection provides access to all AWS Regions except the China (Beijing) and (China) Ningxia Regions. -AWS resources in the China Regions can only be accessed through locations associated with those Regions.
+connection provides access to all Regions except the China (Beijing) and (China) Ningxia Regions. +Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions. ## Installing diff --git a/clients/client-direct-connect/commands/AllocateConnectionOnInterconnectCommand.ts b/clients/client-direct-connect/commands/AllocateConnectionOnInterconnectCommand.ts index bbe873cf9e275..5b36b61b432db 100644 --- a/clients/client-direct-connect/commands/AllocateConnectionOnInterconnectCommand.ts +++ b/clients/client-direct-connect/commands/AllocateConnectionOnInterconnectCommand.ts @@ -27,7 +27,7 @@ export interface AllocateConnectionOnInterconnectCommandOutput extends Connectio *Creates a hosted connection on an interconnect.
*Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.
*Intended for use by AWS Direct Connect Partners only.
+ *Intended for use by Direct Connect Partners only.
*Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.
- *Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. AWS polices the hosted connection for the specified capacity and the AWS Direct Connect Partner must also police the hosted connection for the specified capacity.
+ *Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. + * Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity.
*Intended for use by AWS Direct Connect Partners only.
+ *Intended for use by Direct Connect Partners only.
*Provisions a private virtual interface to be owned by the specified AWS account.
+ *Provisions a private virtual interface to be owned by the specified account.
*Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface.
* Until then, the virtual interface is in the Confirming state and is not available to handle traffic.
Provisions a public virtual interface to be owned by the specified AWS account.
- *The owner of a connection calls this function to provision a public virtual interface to be owned by the specified AWS account.
+ *Provisions a public virtual interface to be owned by the specified account.
+ *The owner of a connection calls this function to provision a public virtual interface to be owned by the specified account.
*Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface.
* Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.
When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from diff --git a/clients/client-direct-connect/commands/AllocateTransitVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/AllocateTransitVirtualInterfaceCommand.ts index f4080728b9538..7690b6ea5d251 100644 --- a/clients/client-direct-connect/commands/AllocateTransitVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/AllocateTransitVirtualInterfaceCommand.ts @@ -23,8 +23,8 @@ export interface AllocateTransitVirtualInterfaceCommandOutput __MetadataBearer {} /** - *
Provisions a transit virtual interface to be owned by the specified AWS account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.
- *The owner of a connection provisions a transit virtual interface to be owned by the specified AWS account.
+ *Provisions a transit virtual interface to be owned by the specified account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.
+ *The owner of a connection provisions a transit virtual interface to be owned by the specified account.
*After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.
Associates an existing connection with a link aggregation group (LAG). The connection - * is interrupted and re-established as a member of the LAG (connectivity to AWS is - * interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its + * is interrupted and re-established as a member of the LAG (connectivity to Amazon Web Services is + * interrupted). The connection must be hosted on the same Direct Connect endpoint as the LAG, and its * bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's * currently associated with a different LAG; however, if removing the connection would cause * the original LAG to fall below its setting for minimum number of operational connections, diff --git a/clients/client-direct-connect/commands/AssociateHostedConnectionCommand.ts b/clients/client-direct-connect/commands/AssociateHostedConnectionCommand.ts index e0f62641829e8..18e44c5a9410f 100644 --- a/clients/client-direct-connect/commands/AssociateHostedConnectionCommand.ts +++ b/clients/client-direct-connect/commands/AssociateHostedConnectionCommand.ts @@ -24,10 +24,10 @@ export interface AssociateHostedConnectionCommandOutput extends Connection, __Me *
Associates a hosted connection and its virtual interfaces with a link aggregation * group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted * connection with a conflicting VLAN number or IP address, the operation fails. This - * action temporarily interrupts the hosted connection's connectivity to AWS as it is being - * migrated.
+ * action temporarily interrupts the hosted connection's connectivity to Amazon Web Services + * as it is being migrated. *Intended for use by AWS Direct Connect Partners only.
+ *Intended for use by Direct Connect Partners only.
*Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an AWS Direct Connect dedicated connection.
+ *Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.
*You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request.
For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the AWS Direct Connect User Guide.
+ *For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the Direct Connect User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-direct-connect/commands/AssociateVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/AssociateVirtualInterfaceCommand.ts index b63bed9171482..411b29df80b16 100644 --- a/clients/client-direct-connect/commands/AssociateVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/AssociateVirtualInterfaceCommand.ts @@ -22,7 +22,7 @@ export interface AssociateVirtualInterfaceCommandOutput extends VirtualInterface /** *Associates a virtual interface with a specified link aggregation group (LAG) or - * connection. Connectivity to AWS is temporarily interrupted as the virtual interface is + * connection. Connectivity to Amazon Web Services is temporarily interrupted as the virtual interface is * being migrated. If the target connection or LAG has an associated virtual interface with * a conflicting VLAN number or a conflicting IP address, the operation fails.
*Virtual interfaces associated with a hosted connection cannot be associated with a diff --git a/clients/client-direct-connect/commands/ConfirmPrivateVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/ConfirmPrivateVirtualInterfaceCommand.ts index 4861168c205a8..7aedda4a5c2fc 100644 --- a/clients/client-direct-connect/commands/ConfirmPrivateVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/ConfirmPrivateVirtualInterfaceCommand.ts @@ -23,7 +23,7 @@ export interface ConfirmPrivateVirtualInterfaceCommandOutput __MetadataBearer {} /** - *
Accepts ownership of a private virtual interface created by another AWS account.
+ *Accepts ownership of a private virtual interface created by another account.
*After the virtual interface owner makes this call, the virtual interface is * created and attached to the specified virtual private gateway or Direct Connect gateway, and is * made available to handle traffic.
diff --git a/clients/client-direct-connect/commands/ConfirmPublicVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/ConfirmPublicVirtualInterfaceCommand.ts index a75541004c5c8..837b5cda82474 100644 --- a/clients/client-direct-connect/commands/ConfirmPublicVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/ConfirmPublicVirtualInterfaceCommand.ts @@ -23,7 +23,7 @@ export interface ConfirmPublicVirtualInterfaceCommandOutput __MetadataBearer {} /** - *Accepts ownership of a public virtual interface created by another AWS account.
+ *Accepts ownership of a public virtual interface created by another account.
*After the virtual interface owner makes this call, the specified virtual interface is * created and made available to handle traffic.
* @example diff --git a/clients/client-direct-connect/commands/ConfirmTransitVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/ConfirmTransitVirtualInterfaceCommand.ts index 3ff361eb03005..2985798009273 100644 --- a/clients/client-direct-connect/commands/ConfirmTransitVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/ConfirmTransitVirtualInterfaceCommand.ts @@ -23,7 +23,7 @@ export interface ConfirmTransitVirtualInterfaceCommandOutput __MetadataBearer {} /** - *Accepts ownership of a transit virtual interface created by another AWS account.
+ *Accepts ownership of a transit virtual interface created by another account.
* *After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.
* @example diff --git a/clients/client-direct-connect/commands/CreateBGPPeerCommand.ts b/clients/client-direct-connect/commands/CreateBGPPeerCommand.ts index 6ff861075dbda..ca09af6d66fd2 100644 --- a/clients/client-direct-connect/commands/CreateBGPPeerCommand.ts +++ b/clients/client-direct-connect/commands/CreateBGPPeerCommand.ts @@ -22,7 +22,7 @@ export interface CreateBGPPeerCommandOutput extends CreateBGPPeerResponse, __Met /** *Creates a BGP peer on the specified virtual interface.
- *You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access AWS resources that also use that address family.
+ *You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources that also use that address family.
*If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot * be in the same address family as an existing BGP peer on the virtual interface.
*When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from diff --git a/clients/client-direct-connect/commands/CreateConnectionCommand.ts b/clients/client-direct-connect/commands/CreateConnectionCommand.ts index f7642a9d4e67d..aeccfb923123c 100644 --- a/clients/client-direct-connect/commands/CreateConnectionCommand.ts +++ b/clients/client-direct-connect/commands/CreateConnectionCommand.ts @@ -21,14 +21,14 @@ export interface CreateConnectionCommandInput extends CreateConnectionRequest {} export interface CreateConnectionCommandOutput extends Connection, __MetadataBearer {} /** - *
Creates a connection between a customer network and a specific AWS Direct Connect location.
+ *Creates a connection between a customer network and a specific Direct Connect location.
* - *A connection links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic - * cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router.
+ *A connection links your internal network to an Direct Connect location over a standard Ethernet fiber-optic + * cable. One end of the cable is connected to your router, the other to an Direct Connect router.
*To find the locations for your Region, use DescribeLocations.
*You can automatically add the new connection to a link aggregation group (LAG) by * specifying a LAG ID in the request. This ensures that the new connection is allocated on the - * same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, + * same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, * the request fails and no connection is created.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-direct-connect/commands/CreateDirectConnectGatewayAssociationProposalCommand.ts b/clients/client-direct-connect/commands/CreateDirectConnectGatewayAssociationProposalCommand.ts index c9894b8c0a794..9ed28c81b72d1 100644 --- a/clients/client-direct-connect/commands/CreateDirectConnectGatewayAssociationProposalCommand.ts +++ b/clients/client-direct-connect/commands/CreateDirectConnectGatewayAssociationProposalCommand.ts @@ -28,7 +28,7 @@ export interface CreateDirectConnectGatewayAssociationProposalCommandOutput /** *Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
- *You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any AWS account.
+ *You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any account.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-direct-connect/commands/CreateDirectConnectGatewayCommand.ts b/clients/client-direct-connect/commands/CreateDirectConnectGatewayCommand.ts index 58e6b2b85993f..a7a024e1becd1 100644 --- a/clients/client-direct-connect/commands/CreateDirectConnectGatewayCommand.ts +++ b/clients/client-direct-connect/commands/CreateDirectConnectGatewayCommand.ts @@ -23,8 +23,8 @@ export interface CreateDirectConnectGatewayCommandOutput extends CreateDirectCon /** *Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set * of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any - * AWS Region after it is created. The virtual interfaces and virtual private gateways that - * are connected through a Direct Connect gateway can be in different AWS Regions. This enables you to + * Region after it is created. The virtual interfaces and virtual private gateways that + * are connected through a Direct Connect gateway can be in different Regions. This enables you to * connect to a VPC in any Region, regardless of the Region in which the virtual interfaces * are located, and pass traffic between them.
* @example diff --git a/clients/client-direct-connect/commands/CreateInterconnectCommand.ts b/clients/client-direct-connect/commands/CreateInterconnectCommand.ts index 5a51ce011681b..c774548c5d182 100644 --- a/clients/client-direct-connect/commands/CreateInterconnectCommand.ts +++ b/clients/client-direct-connect/commands/CreateInterconnectCommand.ts @@ -21,21 +21,21 @@ export interface CreateInterconnectCommandInput extends CreateInterconnectReques export interface CreateInterconnectCommandOutput extends Interconnect, __MetadataBearer {} /** - *Creates an interconnect between an AWS Direct Connect Partner's network and a specific AWS Direct Connect location.
- *An interconnect is a connection that is capable of hosting other connections. The AWS - * Direct Connect partner can use an interconnect to provide AWS Direct Connect hosted + *
Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location.
+ *An interconnect is a connection that is capable of hosting other connections. The + * Direct Connect Partner can use an interconnect to provide Direct Connect hosted * connections to customers through their own network services. Like a standard connection, an - * interconnect links the partner's network to an AWS Direct Connect location over a standard Ethernet - * fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect + * interconnect links the partner's network to an Direct Connect location over a standard Ethernet + * fiber-optic cable. One end is connected to the partner's router, the other to an Direct Connect * router.
*You can automatically add the new interconnect to a link aggregation group (LAG) by * specifying a LAG ID in the request. This ensures that the new interconnect is allocated on - * the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the + * the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the * endpoint, the request fails and no interconnect is created.
- *For each end customer, the AWS Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. - * The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect Partner.
+ *For each end customer, the Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. + * The end customer can then connect to Amazon Web Services resources by creating a virtual interface on their connection, using the VLAN assigned to them by the Direct Connect Partner.
*Intended for use by AWS Direct Connect Partners only.
+ *Intended for use by Direct Connect Partners only.
*Creates a link aggregation group (LAG) with the specified number of bundled - * physical dedicated connections between the customer network and a specific AWS Direct Connect location. + * physical dedicated connections between the customer network and a specific Direct Connect location. * A LAG is a logical interface that uses the Link Aggregation Control Protocol * (LACP) to aggregate multiple interfaces, enabling you to treat them as a single * interface.
- *All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same AWS Direct Connect endpoint.
+ *All connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same Direct Connect endpoint.
*You can have up to 10 dedicated connections per LAG. Regardless of this limit, if you - * request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is + * request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is * created.
*You can specify an existing physical dedicated connection or interconnect to include in * the LAG (which counts towards the total number of connections). Doing so interrupts the * current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG - * will be created on the same AWS Direct Connect endpoint to which the dedicated connection terminates. Any + * will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any * virtual interfaces associated with the dedicated connection are automatically disassociated * and re-associated with the LAG. The connection ID does not change.
- *If the AWS account used to create a LAG is a registered AWS Direct Connect Partner, the LAG is + *
If the account used to create a LAG is a registered Direct Connect Partner, the LAG is * automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual * interfaces cannot be directly configured.
* @example diff --git a/clients/client-direct-connect/commands/CreatePrivateVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/CreatePrivateVirtualInterfaceCommand.ts index b52ed5e020dbd..7bf50fe764979 100644 --- a/clients/client-direct-connect/commands/CreatePrivateVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/CreatePrivateVirtualInterfaceCommand.ts @@ -21,11 +21,11 @@ export interface CreatePrivateVirtualInterfaceCommandInput extends CreatePrivate export interface CreatePrivateVirtualInterfaceCommandOutput extends VirtualInterface, __MetadataBearer {} /** - *Creates a private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. + *
Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. * A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). * Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple - * VPCs, including VPCs in different AWS Regions. Connecting the private virtual interface to a VGW only - * provides access to a single VPC within the same Region.
+ * VPCs, including VPCs in different Regions. Connecting the private virtual interface + * to a VGW only provides access to a single VPC within the same Region. *Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to * the underlying physical connection if it wasn't updated to support jumbo frames. Updating * the connection disrupts network connectivity for all virtual interfaces associated with diff --git a/clients/client-direct-connect/commands/CreatePublicVirtualInterfaceCommand.ts b/clients/client-direct-connect/commands/CreatePublicVirtualInterfaceCommand.ts index 69dd7cbddc4fd..7dd5af651cca7 100644 --- a/clients/client-direct-connect/commands/CreatePublicVirtualInterfaceCommand.ts +++ b/clients/client-direct-connect/commands/CreatePublicVirtualInterfaceCommand.ts @@ -21,8 +21,8 @@ export interface CreatePublicVirtualInterfaceCommandInput extends CreatePublicVi export interface CreatePublicVirtualInterfaceCommandOutput extends VirtualInterface, __MetadataBearer {} /** - *
Creates a public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. - * A public virtual interface supports sending traffic to public services of AWS such as Amazon S3.
+ *Creates a public virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. + * A public virtual interface supports sending traffic to public services of Amazon Web Services such as Amazon S3.
*When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer
* and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.
Deletes the specified connection.
- *Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. - * If you are partnering with any third parties to connect with the AWS Direct Connect location, + *
Deleting a connection only stops the Direct Connect port hour and data transfer charges. + * If you are partnering with any third parties to connect with the Direct Connect location, * you must cancel your service with them separately.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-direct-connect/commands/DeleteInterconnectCommand.ts b/clients/client-direct-connect/commands/DeleteInterconnectCommand.ts index 229cb69f9e035..5473aee5cb004 100644 --- a/clients/client-direct-connect/commands/DeleteInterconnectCommand.ts +++ b/clients/client-direct-connect/commands/DeleteInterconnectCommand.ts @@ -24,7 +24,7 @@ export interface DeleteInterconnectCommandOutput extends DeleteInterconnectRespo *Deletes the specified interconnect.
*Intended for use - * by AWS Direct Connect Partners only.
+ * by Direct Connect Partners only. *Deprecated. Use DescribeLoa instead.
*Gets the LOA-CFA for a connection.
*The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or - * service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, + * service provider uses when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, * see Requesting Cross Connects - * at AWS Direct Connect Locations in the AWS Direct Connect User Guide.
+ * at Direct Connect Locations in the Direct Connect User Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-direct-connect/commands/DescribeConnectionsOnInterconnectCommand.ts b/clients/client-direct-connect/commands/DescribeConnectionsOnInterconnectCommand.ts index b6677680904ea..6fbff84155b03 100644 --- a/clients/client-direct-connect/commands/DescribeConnectionsOnInterconnectCommand.ts +++ b/clients/client-direct-connect/commands/DescribeConnectionsOnInterconnectCommand.ts @@ -26,7 +26,7 @@ export interface DescribeConnectionsOnInterconnectCommandOutput extends Connecti *Deprecated. Use DescribeHostedConnections instead.
*Lists the connections that have been provisioned on the specified interconnect.
*Intended for use by AWS Direct Connect Partners only.
+ *Intended for use by Direct Connect Partners only.
*Lists the hosted connections that have been provisioned on the specified * interconnect or link aggregation group (LAG).
*Intended for use by AWS Direct Connect Partners only.
+ *Intended for use by Direct Connect Partners only.
*Deprecated. Use DescribeLoa instead.
*Gets the LOA-CFA for the specified interconnect.
- *The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. - * For more information, see Requesting Cross Connects at AWS Direct Connect Locations - * in the AWS Direct Connect User Guide.
+ *The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. + * For more information, see Requesting Cross Connects at Direct Connect Locations + * in the Direct Connect User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-direct-connect/commands/DescribeInterconnectsCommand.ts b/clients/client-direct-connect/commands/DescribeInterconnectsCommand.ts index 44f018c27773c..7e933eb1b557b 100644 --- a/clients/client-direct-connect/commands/DescribeInterconnectsCommand.ts +++ b/clients/client-direct-connect/commands/DescribeInterconnectsCommand.ts @@ -21,7 +21,7 @@ export interface DescribeInterconnectsCommandInput extends DescribeInterconnects export interface DescribeInterconnectsCommandOutput extends Interconnects, __MetadataBearer {} /** - *Lists the interconnects owned by the AWS account or only the specified interconnect.
+ *Lists the interconnects owned by the account or only the specified interconnect.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-direct-connect/commands/DescribeLoaCommand.ts b/clients/client-direct-connect/commands/DescribeLoaCommand.ts index a110881ce7526..caf2c916dd083 100644 --- a/clients/client-direct-connect/commands/DescribeLoaCommand.ts +++ b/clients/client-direct-connect/commands/DescribeLoaCommand.ts @@ -23,8 +23,8 @@ export interface DescribeLoaCommandOutput extends Loa, __MetadataBearer {} /** *Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).
*The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing - * your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations - * in the AWS Direct Connect User Guide.
+ * your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations + * in the Direct Connect User Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-direct-connect/commands/DescribeLocationsCommand.ts b/clients/client-direct-connect/commands/DescribeLocationsCommand.ts index b0cbd8aa2932b..bfba932c67782 100644 --- a/clients/client-direct-connect/commands/DescribeLocationsCommand.ts +++ b/clients/client-direct-connect/commands/DescribeLocationsCommand.ts @@ -21,7 +21,7 @@ export interface DescribeLocationsCommandInput {} export interface DescribeLocationsCommandOutput extends Locations, __MetadataBearer {} /** - *Lists the AWS Direct Connect locations in the current AWS Region. These are the locations that can be selected when calling + *
Lists the Direct Connect locations in the current Region. These are the locations that can be selected when calling * CreateConnection or CreateInterconnect.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-direct-connect/commands/DescribeTagsCommand.ts b/clients/client-direct-connect/commands/DescribeTagsCommand.ts index b9579f588687d..36308789dfee7 100644 --- a/clients/client-direct-connect/commands/DescribeTagsCommand.ts +++ b/clients/client-direct-connect/commands/DescribeTagsCommand.ts @@ -21,7 +21,7 @@ export interface DescribeTagsCommandInput extends DescribeTagsRequest {} export interface DescribeTagsCommandOutput extends DescribeTagsResponse, __MetadataBearer {} /** - *Describes the tags associated with the specified AWS Direct Connect resources.
+ *Describes the tags associated with the specified Direct Connect resources.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-direct-connect/commands/DescribeVirtualGatewaysCommand.ts b/clients/client-direct-connect/commands/DescribeVirtualGatewaysCommand.ts index d85eb165aaeec..60903291149aa 100644 --- a/clients/client-direct-connect/commands/DescribeVirtualGatewaysCommand.ts +++ b/clients/client-direct-connect/commands/DescribeVirtualGatewaysCommand.ts @@ -21,8 +21,8 @@ export interface DescribeVirtualGatewaysCommandInput {} export interface DescribeVirtualGatewaysCommandOutput extends VirtualGateways, __MetadataBearer {} /** - *Lists the virtual private gateways owned by the AWS account.
- *You can create one or more AWS Direct Connect private virtual interfaces linked to a virtual private gateway.
+ *Lists the virtual private gateways owned by the account.
+ *You can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-direct-connect/commands/DescribeVirtualInterfacesCommand.ts b/clients/client-direct-connect/commands/DescribeVirtualInterfacesCommand.ts index b2856fbe73f5c..ed1d61f7e01ea 100644 --- a/clients/client-direct-connect/commands/DescribeVirtualInterfacesCommand.ts +++ b/clients/client-direct-connect/commands/DescribeVirtualInterfacesCommand.ts @@ -21,11 +21,11 @@ export interface DescribeVirtualInterfacesCommandInput extends DescribeVirtualIn export interface DescribeVirtualInterfacesCommandOutput extends VirtualInterfaces, __MetadataBearer {} /** - *Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer + *
Displays all virtual interfaces for an account. Virtual interfaces deleted fewer * than 15 minutes before you make the request are also returned. If you specify a * connection ID, only the virtual interfaces associated with the connection are returned. * If you specify a virtual interface ID, then only a single virtual interface is returned.
- *A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer network.
+ *A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-direct-connect/commands/DisassociateConnectionFromLagCommand.ts b/clients/client-direct-connect/commands/DisassociateConnectionFromLagCommand.ts index b955a36e34a8e..690aed5e24472 100644 --- a/clients/client-direct-connect/commands/DisassociateConnectionFromLagCommand.ts +++ b/clients/client-direct-connect/commands/DisassociateConnectionFromLagCommand.ts @@ -25,7 +25,7 @@ export interface DisassociateConnectionFromLagCommandOutput extends Connection, * interrupted and re-established as a standalone connection (the connection is not * deleted; to delete the connection, use the DeleteConnection request). * If the LAG has associated virtual interfaces or hosted connections, they remain - * associated with the LAG. A disassociated connection owned by an AWS Direct Connect Partner is + * associated with the LAG. A disassociated connection owned by an Direct Connect Partner is * automatically converted to an interconnect. *If disassociating the connection would cause the LAG to fall below its setting for * minimum number of operational connections, the request fails, except when it's the last diff --git a/clients/client-direct-connect/commands/DisassociateMacSecKeyCommand.ts b/clients/client-direct-connect/commands/DisassociateMacSecKeyCommand.ts index de0f643e4cd4b..9dd6339c7fc67 100644 --- a/clients/client-direct-connect/commands/DisassociateMacSecKeyCommand.ts +++ b/clients/client-direct-connect/commands/DisassociateMacSecKeyCommand.ts @@ -21,7 +21,7 @@ export interface DisassociateMacSecKeyCommandInput extends DisassociateMacSecKey export interface DisassociateMacSecKeyCommandOutput extends DisassociateMacSecKeyResponse, __MetadataBearer {} /** - *
Removes the association between a MAC Security (MACsec) security key and an AWS Direct Connect dedicated connection.
+ *Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-direct-connect/commands/TagResourceCommand.ts b/clients/client-direct-connect/commands/TagResourceCommand.ts index 41a34a392f159..89139857f640a 100644 --- a/clients/client-direct-connect/commands/TagResourceCommand.ts +++ b/clients/client-direct-connect/commands/TagResourceCommand.ts @@ -21,7 +21,7 @@ export interface TagResourceCommandInput extends TagResourceRequest {} export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {} /** - *Adds the specified tags to the specified AWS Direct Connect resource. Each resource can have a maximum of 50 tags.
+ *Adds the specified tags to the specified Direct Connect resource. Each resource can have a maximum of 50 tags.
*Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-direct-connect/commands/UntagResourceCommand.ts b/clients/client-direct-connect/commands/UntagResourceCommand.ts index c87cd1ca64fec..74f126e85e525 100644 --- a/clients/client-direct-connect/commands/UntagResourceCommand.ts +++ b/clients/client-direct-connect/commands/UntagResourceCommand.ts @@ -21,7 +21,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {} export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {} /** - *Removes one or more tags from the specified AWS Direct Connect resource.
+ *Removes one or more tags from the specified Direct Connect resource.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-direct-connect/commands/UpdateConnectionCommand.ts b/clients/client-direct-connect/commands/UpdateConnectionCommand.ts index 6d7ead04d740d..2078a498d927d 100644 --- a/clients/client-direct-connect/commands/UpdateConnectionCommand.ts +++ b/clients/client-direct-connect/commands/UpdateConnectionCommand.ts @@ -21,7 +21,7 @@ export interface UpdateConnectionCommandInput extends UpdateConnectionRequest {} export interface UpdateConnectionCommandOutput extends Connection, __MetadataBearer {} /** - *Updates the AWS Direct Connect dedicated connection configuration.
+ *Updates the Direct Connect dedicated connection configuration.
*You can update the following parameters for a connection:
*The LAG's MACsec encryption mode.
- *AWS assigns this value to each connection which is part of the LAG.
+ *Amazon Web Services assigns this value to each connection which is part of the LAG.
*The tags
diff --git a/clients/client-direct-connect/models/models_0.ts b/clients/client-direct-connect/models/models_0.ts index cc670917b609f..e38896a3691b2 100644 --- a/clients/client-direct-connect/models/models_0.ts +++ b/clients/client-direct-connect/models/models_0.ts @@ -32,13 +32,13 @@ export interface AcceptDirectConnectGatewayAssociationProposalRequest { proposalId: string | undefined; /** - *The ID of the AWS account that owns the virtual private gateway or transit gateway.
+ *The ID of the account that owns the virtual private gateway or transit gateway.
*/ associatedGatewayOwnerAccount: string | undefined; /** *Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.
- *For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.
+ *For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.
*/ overrideAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefix[]; } @@ -72,7 +72,7 @@ export interface AssociatedGateway { type?: GatewayType | string; /** - *The ID of the AWS account that owns the associated virtual private gateway or transit gateway.
+ *The ID of the account that owns the associated virtual private gateway or transit gateway.
*/ ownerAccount?: string; @@ -108,7 +108,7 @@ export interface DirectConnectGatewayAssociation { directConnectGatewayId?: string; /** - *The ID of the AWS account that owns the associated gateway.
+ *The ID of the account that owns the associated gateway.
*/ directConnectGatewayOwnerAccount?: string; @@ -163,12 +163,12 @@ export interface DirectConnectGatewayAssociation { /** * @deprecated * - *The AWS Region where the virtual private gateway is located.
+ *The Region where the virtual private gateway is located.
*/ virtualGatewayRegion?: string; /** - *The ID of the AWS account that owns the virtual private gateway.
+ *The ID of the account that owns the virtual private gateway.
*/ virtualGatewayOwnerAccount?: string; } @@ -242,7 +242,7 @@ export enum AddressFamily { export interface AllocateConnectionOnInterconnectRequest { /** *The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, - * 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners + * 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners * who have met specific requirements * are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
*/ @@ -254,7 +254,7 @@ export interface AllocateConnectionOnInterconnectRequest { connectionName: string | undefined; /** - *The ID of the AWS account of the customer for whom the connection will be provisioned.
+ *The ID of the account of the customer for whom the connection will be provisioned.
*/ ownerAccount: string | undefined; @@ -373,11 +373,11 @@ export namespace Tag { } /** - *Information about an AWS Direct Connect connection.
+ *Information about an Direct Connect connection.
*/ export interface Connection { /** - *The ID of the AWS account that owns the connection.
+ *The ID of the account that owns the connection.
*/ ownerAccount?: string; @@ -435,7 +435,7 @@ export interface Connection { connectionState?: ConnectionState | string; /** - *The AWS Region where the connection is located.
+ *The Region where the connection is located.
*/ region?: string; @@ -455,7 +455,7 @@ export interface Connection { vlan?: number; /** - *The name of the AWS Direct Connect service provider associated with the connection.
+ *The name of the Direct Connect service provider associated with the connection.
*/ partnerName?: string; @@ -486,6 +486,11 @@ export interface Connection { */ awsDeviceV2?: string; + /** + *The Direct Connect endpoint that terminates a physical connection's BGP sessions.
+ */ + awsLogicalDeviceId?: string; + /** *Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
*/ @@ -540,12 +545,12 @@ export interface AllocateHostedConnectionRequest { connectionId: string | undefined; /** - *The ID of the AWS account ID of the customer for the connection.
+ *The ID of the account ID of the customer for the connection.
*/ ownerAccount: string | undefined; /** - *The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
+ *The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
*/ bandwidth: string | undefined; @@ -677,7 +682,7 @@ export interface AllocatePrivateVirtualInterfaceRequest { connectionId: string | undefined; /** - *The ID of the AWS account that owns the virtual private interface.
+ *The ID of the account that owns the virtual private interface.
*/ ownerAccount: string | undefined; @@ -795,6 +800,8 @@ export interface BGPPeer { *The Direct Connect endpoint on which the BGP peer terminates.
*/ awsDeviceV2?: string; + + awsLogicalDeviceId?: string; } export namespace BGPPeer { @@ -822,7 +829,7 @@ export type VirtualInterfaceState = */ export interface VirtualInterface { /** - *The ID of the AWS account that owns the virtual interface.
+ *The ID of the account that owns the virtual interface.
*/ ownerAccount?: string; @@ -956,7 +963,7 @@ export interface VirtualInterface { directConnectGatewayId?: string; /** - *The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
+ *The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
*/ routeFilterPrefixes?: RouteFilterPrefix[]; @@ -966,16 +973,20 @@ export interface VirtualInterface { bgpPeers?: BGPPeer[]; /** - *The AWS Region where the virtual interface is located.
+ *The Region where the virtual interface is located.
*/ region?: string; /** - *The - * Direct Connect endpoint on which the virtual interface terminates.
+ *The Direct Connect endpoint on which the virtual interface terminates.
*/ awsDeviceV2?: string; + /** + *The Direct Connect endpoint that terminates a physical connection's BGP sessions.
+ */ + awsLogicalDeviceId?: string; + /** *The tags associated with the virtual interface.
*/ @@ -1032,7 +1043,7 @@ export interface NewPublicVirtualInterfaceAllocation { addressFamily?: AddressFamily | string; /** - *The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
+ *The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
*/ routeFilterPrefixes?: RouteFilterPrefix[]; @@ -1058,7 +1069,7 @@ export interface AllocatePublicVirtualInterfaceRequest { connectionId: string | undefined; /** - *The ID of the AWS account that owns the public virtual interface.
+ *The ID of the account that owns the public virtual interface.
*/ ownerAccount: string | undefined; @@ -1144,7 +1155,7 @@ export interface AllocateTransitVirtualInterfaceRequest { connectionId: string | undefined; /** - *The ID of the AWS account that owns the transit virtual interface.
+ *The ID of the account that owns the transit virtual interface.
*/ ownerAccount: string | undefined; @@ -1723,7 +1734,7 @@ export interface CreateConnectionRequest { /** *Indicates whether you want the connection to support MAC Security (MACsec).
- *MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the AWS Direct Connect User Guide.
+ *MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.
*/ requestMACSec?: boolean; } @@ -1782,7 +1793,7 @@ export interface DirectConnectGateway { amazonSideAsn?: number; /** - *The ID of the AWS account that owns the Direct Connect gateway.
+ *The ID of the account that owns the Direct Connect gateway.
*/ ownerAccount?: string; @@ -1854,7 +1865,7 @@ export interface CreateDirectConnectGatewayAssociationRequest { /** *The Amazon VPC prefixes to advertise to the Direct Connect gateway
*This parameter is required when you create an association to a transit gateway.
- *For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.
+ *For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.
*/ addAllowedPrefixesToDirectConnectGateway?: RouteFilterPrefix[]; @@ -1896,7 +1907,7 @@ export interface CreateDirectConnectGatewayAssociationProposalRequest { directConnectGatewayId: string | undefined; /** - *The ID of the AWS account that owns the Direct Connect gateway.
+ *The ID of the account that owns the Direct Connect gateway.
*/ directConnectGatewayOwnerAccount: string | undefined; @@ -1942,7 +1953,7 @@ export interface DirectConnectGatewayAssociationProposal { directConnectGatewayId?: string; /** - *The ID of the AWS account that owns the Direct Connect gateway.
+ *The ID of the account that owns the Direct Connect gateway.
*/ directConnectGatewayOwnerAccount?: string; @@ -2100,7 +2111,7 @@ export interface Interconnect { interconnectState?: InterconnectState | string; /** - *The AWS Region where the connection is located.
+ *The Region where the connection is located.
*/ region?: string; @@ -2141,6 +2152,11 @@ export interface Interconnect { */ awsDeviceV2?: string; + /** + *The Direct Connect endpoint that terminates a physical connection's BGP sessions.
+ */ + awsLogicalDeviceId?: string; + /** *Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).
*/ @@ -2212,7 +2228,7 @@ export interface CreateLagRequest { /** *Indicates whether the connection will support MAC Security (MACsec).
*All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the AWS Direct Connect User Guide.
+ *All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.
*The ID of the AWS account that owns the LAG.
+ *The ID of the account that owns the LAG.
*/ ownerAccount?: string; @@ -2301,7 +2317,7 @@ export interface Lag { location?: string; /** - *The AWS Region where the connection is located.
+ *The Region where the connection is located.
*/ region?: string; @@ -2313,15 +2329,20 @@ export interface Lag { /** * @deprecated * - *The AWS Direct Connect endpoint that hosts the LAG.
+ *The Direct Connect endpoint that hosts the LAG.
*/ awsDevice?: string; /** - *The AWS Direct Connect endpoint that hosts the LAG.
+ *The Direct Connect endpoint that hosts the LAG.
*/ awsDeviceV2?: string; + /** + *The Direct Connect endpoint that terminates a physical connection's BGP sessions.
+ */ + awsLogicalDeviceId?: string; + /** *The connections bundled by the LAG.
*/ @@ -2510,7 +2531,7 @@ export interface NewPublicVirtualInterface { addressFamily?: AddressFamily | string; /** - *The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
+ *The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
*/ routeFilterPrefixes?: RouteFilterPrefix[]; @@ -3251,12 +3272,12 @@ export interface DirectConnectGatewayAttachment { virtualInterfaceId?: string; /** - *The AWS Region where the virtual interface is located.
+ *The Region where the virtual interface is located.
*/ virtualInterfaceRegion?: string; /** - *The ID of the AWS account that owns the virtual interface.
+ *The ID of the account that owns the virtual interface.
*/ virtualInterfaceOwnerAccount?: string; @@ -3524,7 +3545,7 @@ export namespace DescribeLoaRequest { } /** - *Information about an AWS Direct Connect location.
+ *Information about an Direct Connect location.
*/ export interface Location { /** @@ -3538,7 +3559,7 @@ export interface Location { locationName?: string; /** - *The AWS Region for the location.
+ *The Region for the location.
*/ region?: string; @@ -3600,7 +3621,7 @@ export namespace DescribeTagsRequest { } /** - *Information about a tag associated with an AWS Direct Connect resource.
+ *Information about a tag associated with an Direct Connect resource.
*/ export interface ResourceTag { /** @@ -4146,7 +4167,7 @@ export interface UpdateLagRequest { /** *The LAG MAC Security (MACsec) encryption mode.
- *AWS applies the value to all connections which are part of the LAG.
+ *Amazon Web Services applies the value to all connections which are part of the LAG.
*/ encryptionMode?: string; } diff --git a/clients/client-direct-connect/protocols/Aws_json1_1.ts b/clients/client-direct-connect/protocols/Aws_json1_1.ts index e216d53a0f404..15da4898df7a3 100644 --- a/clients/client-direct-connect/protocols/Aws_json1_1.ts +++ b/clients/client-direct-connect/protocols/Aws_json1_1.ts @@ -5976,6 +5976,7 @@ const deserializeAws_json1_1BGPPeer = (output: any, context: __SerdeContext): BG asn: __expectNumber(output.asn), authKey: __expectString(output.authKey), awsDeviceV2: __expectString(output.awsDeviceV2), + awsLogicalDeviceId: __expectString(output.awsLogicalDeviceId), bgpPeerId: __expectString(output.bgpPeerId), bgpPeerState: __expectString(output.bgpPeerState), bgpStatus: __expectString(output.bgpStatus), @@ -6045,6 +6046,7 @@ const deserializeAws_json1_1Connection = (output: any, context: __SerdeContext): return { awsDevice: __expectString(output.awsDevice), awsDeviceV2: __expectString(output.awsDeviceV2), + awsLogicalDeviceId: __expectString(output.awsLogicalDeviceId), bandwidth: __expectString(output.bandwidth), connectionId: __expectString(output.connectionId), connectionName: __expectString(output.connectionName), @@ -6484,6 +6486,7 @@ const deserializeAws_json1_1Interconnect = (output: any, context: __SerdeContext return { awsDevice: __expectString(output.awsDevice), awsDeviceV2: __expectString(output.awsDeviceV2), + awsLogicalDeviceId: __expectString(output.awsLogicalDeviceId), bandwidth: __expectString(output.bandwidth), hasLogicalRedundancy: __expectString(output.hasLogicalRedundancy), interconnectId: __expectString(output.interconnectId), @@ -6530,6 +6533,7 @@ const deserializeAws_json1_1Lag = (output: any, context: __SerdeContext): Lag => allowsHostedConnections: __expectBoolean(output.allowsHostedConnections), awsDevice: __expectString(output.awsDevice), awsDeviceV2: __expectString(output.awsDeviceV2), + awsLogicalDeviceId: __expectString(output.awsLogicalDeviceId), connections: output.connections !== undefined && output.connections !== null ? deserializeAws_json1_1ConnectionList(output.connections, context) @@ -6814,6 +6818,7 @@ const deserializeAws_json1_1VirtualInterface = (output: any, context: __SerdeCon asn: __expectNumber(output.asn), authKey: __expectString(output.authKey), awsDeviceV2: __expectString(output.awsDeviceV2), + awsLogicalDeviceId: __expectString(output.awsLogicalDeviceId), bgpPeers: output.bgpPeers !== undefined && output.bgpPeers !== null ? deserializeAws_json1_1BGPPeerList(output.bgpPeers, context) diff --git a/clients/client-ec2/EC2.ts b/clients/client-ec2/EC2.ts index 6d1c87031e629..e0b4dc00d2342 100644 --- a/clients/client-ec2/EC2.ts +++ b/clients/client-ec2/EC2.ts @@ -84,6 +84,11 @@ import { AssociateIamInstanceProfileCommandInput, AssociateIamInstanceProfileCommandOutput, } from "./commands/AssociateIamInstanceProfileCommand"; +import { + AssociateInstanceEventWindowCommand, + AssociateInstanceEventWindowCommandInput, + AssociateInstanceEventWindowCommandOutput, +} from "./commands/AssociateInstanceEventWindowCommand"; import { AssociateRouteTableCommand, AssociateRouteTableCommandInput, @@ -272,6 +277,11 @@ import { CreateFpgaImageCommandOutput, } from "./commands/CreateFpgaImageCommand"; import { CreateImageCommand, CreateImageCommandInput, CreateImageCommandOutput } from "./commands/CreateImageCommand"; +import { + CreateInstanceEventWindowCommand, + CreateInstanceEventWindowCommandInput, + CreateInstanceEventWindowCommandOutput, +} from "./commands/CreateInstanceEventWindowCommand"; import { CreateInstanceExportTaskCommand, CreateInstanceExportTaskCommandInput, @@ -550,6 +560,11 @@ import { DeleteFpgaImageCommandInput, DeleteFpgaImageCommandOutput, } from "./commands/DeleteFpgaImageCommand"; +import { + DeleteInstanceEventWindowCommand, + DeleteInstanceEventWindowCommandInput, + DeleteInstanceEventWindowCommandOutput, +} from "./commands/DeleteInstanceEventWindowCommand"; import { DeleteInternetGatewayCommand, DeleteInternetGatewayCommandInput, @@ -1003,6 +1018,11 @@ import { DescribeInstanceEventNotificationAttributesCommandInput, DescribeInstanceEventNotificationAttributesCommandOutput, } from "./commands/DescribeInstanceEventNotificationAttributesCommand"; +import { + DescribeInstanceEventWindowsCommand, + DescribeInstanceEventWindowsCommandInput, + DescribeInstanceEventWindowsCommandOutput, +} from "./commands/DescribeInstanceEventWindowsCommand"; import { DescribeInstanceStatusCommand, DescribeInstanceStatusCommandInput, @@ -1493,6 +1513,11 @@ import { DisassociateIamInstanceProfileCommandInput, DisassociateIamInstanceProfileCommandOutput, } from "./commands/DisassociateIamInstanceProfileCommand"; +import { + DisassociateInstanceEventWindowCommand, + DisassociateInstanceEventWindowCommandInput, + DisassociateInstanceEventWindowCommandOutput, +} from "./commands/DisassociateInstanceEventWindowCommand"; import { DisassociateRouteTableCommand, DisassociateRouteTableCommandInput, @@ -1797,6 +1822,11 @@ import { ModifyInstanceEventStartTimeCommandInput, ModifyInstanceEventStartTimeCommandOutput, } from "./commands/ModifyInstanceEventStartTimeCommand"; +import { + ModifyInstanceEventWindowCommand, + ModifyInstanceEventWindowCommandInput, + ModifyInstanceEventWindowCommandOutput, +} from "./commands/ModifyInstanceEventWindowCommand"; import { ModifyInstanceMetadataOptionsCommand, ModifyInstanceMetadataOptionsCommandInput, @@ -2903,6 +2933,41 @@ export class EC2 extends EC2Client { } } + /** + *Associates one or more targets with an event window. Only one type of target (instance IDs, + * Dedicated Host IDs, or tags) can be specified with an event window.
+ *For more information, see Define event windows + * for scheduled events in the Amazon EC2 User Guide.
+ */ + public associateInstanceEventWindow( + args: AssociateInstanceEventWindowCommandInput, + options?: __HttpHandlerOptions + ): PromiseAssociates a subnet in your VPC or an internet gateway or virtual private gateway * attached to your VPC with a route table in your VPC. This association causes traffic @@ -4463,6 +4528,62 @@ export class EC2 extends EC2Client { } } + /** + *
Creates an event window in which scheduled events for the associated Amazon EC2 instances can + * run.
+ *You can define either a set of time ranges or a cron expression when creating the event + * window, but not both. All event window times are in UTC.
+ *You can create up to 200 event windows per Amazon Web Services Region.
+ *When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) + * are not yet associated with it. To ensure that the event window can be used, you must + * associate one or more targets with it by using the AssociateInstanceEventWindow API.
+ * + *Event windows are applicable only for scheduled events that stop, reboot, or + * terminate instances.
+ *Event windows are not applicable for:
+ *Expedited scheduled events and network maintenance events.
+ *Unscheduled maintenance such as AutoRecovery and unplanned reboots.
+ *For more information, see Define event windows + * for scheduled events in the Amazon EC2 User Guide.
+ */ + public createInstanceEventWindow( + args: CreateInstanceEventWindowCommandInput, + options?: __HttpHandlerOptions + ): PromiseExports a running or stopped instance to an Amazon S3 bucket.
*For information about the supported operating systems, image formats, and known limitations @@ -6651,6 +6772,40 @@ export class EC2 extends EC2Client { } } + /** + *
Deletes the specified event window.
+ *For more information, see Define event windows + * for scheduled events in the Amazon EC2 User Guide.
+ */ + public deleteInstanceEventWindow( + args: DeleteInstanceEventWindowCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes the specified internet gateway. You must detach the internet gateway from the * VPC before you can delete it.
@@ -8220,7 +8375,8 @@ export class EC2 extends EC2Client { } /** - *Deregisters tag keys to prevent tags that have the specified tag keys from being included + *
c
+ *Deregisters tag keys to prevent tags that have the specified tag keys from being included * in scheduled event notifications for resources in the Region.
*/ public deregisterInstanceEventNotificationAttributes( @@ -9864,6 +10020,46 @@ export class EC2 extends EC2Client { } } + /** + *Describes the specified event windows or all event windows.
+ *If you specify event window IDs, the output includes information for only the specified + * event windows. If you specify filters, the output includes information for only those event + * windows that meet the filter criteria. If you do not specify event windows IDs or filters, + * the output includes information for all event windows, which can affect performance. We + * recommend that you use pagination to ensure that the operation returns quickly and + * successfully.
+ *For more information, see Define event windows + * for scheduled events in the Amazon EC2 User Guide.
+ */ + public describeInstanceEventWindows( + args: DescribeInstanceEventWindowsCommandInput, + options?: __HttpHandlerOptions + ): PromiseDescribes the specified instances or all instances.
*If you specify instance IDs, the output includes information for only the specified instances. @@ -13332,6 +13528,40 @@ export class EC2 extends EC2Client { } } + /** + *
Disassociates one or more targets from an event window.
+ *For more information, see Define event windows + * for scheduled events in the Amazon EC2 User Guide.
+ */ + public disassociateInstanceEventWindow( + args: DisassociateInstanceEventWindowCommandInput, + options?: __HttpHandlerOptions + ): PromiseDisassociates a subnet or gateway from a route table.
*After you perform this action, the subnet no longer uses the routes in the route table. @@ -15635,6 +15865,45 @@ export class EC2 extends EC2Client { } } + /** + *
Modifies the specified event window.
+ *You can define either a set of time ranges or a cron expression when modifying the event + * window, but not both.
+ *To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.
+ *If Amazon Web Services has already scheduled an event, modifying an event window won't change the time + * of the scheduled event.
+ *For more information, see Define event windows + * for scheduled events in the Amazon EC2 User Guide.
+ */ + public modifyInstanceEventWindow( + args: ModifyInstanceEventWindowCommandInput, + options?: __HttpHandlerOptions + ): PromiseModify the instance metadata parameters on a running or stopped instance. When you * modify the parameters on a stopped instance, they are applied when the instance is diff --git a/clients/client-ec2/EC2Client.ts b/clients/client-ec2/EC2Client.ts index 6814cbd6f1986..1c08b47994e01 100644 --- a/clients/client-ec2/EC2Client.ts +++ b/clients/client-ec2/EC2Client.ts @@ -54,6 +54,10 @@ import { AssociateIamInstanceProfileCommandInput, AssociateIamInstanceProfileCommandOutput, } from "./commands/AssociateIamInstanceProfileCommand"; +import { + AssociateInstanceEventWindowCommandInput, + AssociateInstanceEventWindowCommandOutput, +} from "./commands/AssociateInstanceEventWindowCommand"; import { AssociateRouteTableCommandInput, AssociateRouteTableCommandOutput, @@ -169,6 +173,10 @@ import { CreateFleetCommandInput, CreateFleetCommandOutput } from "./commands/Cr import { CreateFlowLogsCommandInput, CreateFlowLogsCommandOutput } from "./commands/CreateFlowLogsCommand"; import { CreateFpgaImageCommandInput, CreateFpgaImageCommandOutput } from "./commands/CreateFpgaImageCommand"; import { CreateImageCommandInput, CreateImageCommandOutput } from "./commands/CreateImageCommand"; +import { + CreateInstanceEventWindowCommandInput, + CreateInstanceEventWindowCommandOutput, +} from "./commands/CreateInstanceEventWindowCommand"; import { CreateInstanceExportTaskCommandInput, CreateInstanceExportTaskCommandOutput, @@ -350,6 +358,10 @@ import { import { DeleteFleetsCommandInput, DeleteFleetsCommandOutput } from "./commands/DeleteFleetsCommand"; import { DeleteFlowLogsCommandInput, DeleteFlowLogsCommandOutput } from "./commands/DeleteFlowLogsCommand"; import { DeleteFpgaImageCommandInput, DeleteFpgaImageCommandOutput } from "./commands/DeleteFpgaImageCommand"; +import { + DeleteInstanceEventWindowCommandInput, + DeleteInstanceEventWindowCommandOutput, +} from "./commands/DeleteInstanceEventWindowCommand"; import { DeleteInternetGatewayCommandInput, DeleteInternetGatewayCommandOutput, @@ -656,6 +668,10 @@ import { DescribeInstanceEventNotificationAttributesCommandInput, DescribeInstanceEventNotificationAttributesCommandOutput, } from "./commands/DescribeInstanceEventNotificationAttributesCommand"; +import { + DescribeInstanceEventWindowsCommandInput, + DescribeInstanceEventWindowsCommandOutput, +} from "./commands/DescribeInstanceEventWindowsCommand"; import { DescribeInstanceStatusCommandInput, DescribeInstanceStatusCommandOutput, @@ -1015,6 +1031,10 @@ import { DisassociateIamInstanceProfileCommandInput, DisassociateIamInstanceProfileCommandOutput, } from "./commands/DisassociateIamInstanceProfileCommand"; +import { + DisassociateInstanceEventWindowCommandInput, + DisassociateInstanceEventWindowCommandOutput, +} from "./commands/DisassociateInstanceEventWindowCommand"; import { DisassociateRouteTableCommandInput, DisassociateRouteTableCommandOutput, @@ -1232,6 +1252,10 @@ import { ModifyInstanceEventStartTimeCommandInput, ModifyInstanceEventStartTimeCommandOutput, } from "./commands/ModifyInstanceEventStartTimeCommand"; +import { + ModifyInstanceEventWindowCommandInput, + ModifyInstanceEventWindowCommandOutput, +} from "./commands/ModifyInstanceEventWindowCommand"; import { ModifyInstanceMetadataOptionsCommandInput, ModifyInstanceMetadataOptionsCommandOutput, @@ -1589,6 +1613,7 @@ export type ServiceInputTypes = | AssociateDhcpOptionsCommandInput | AssociateEnclaveCertificateIamRoleCommandInput | AssociateIamInstanceProfileCommandInput + | AssociateInstanceEventWindowCommandInput | AssociateRouteTableCommandInput | AssociateSubnetCidrBlockCommandInput | AssociateTransitGatewayMulticastDomainCommandInput @@ -1629,6 +1654,7 @@ export type ServiceInputTypes = | CreateFlowLogsCommandInput | CreateFpgaImageCommandInput | CreateImageCommandInput + | CreateInstanceEventWindowCommandInput | CreateInstanceExportTaskCommandInput | CreateInternetGatewayCommandInput | CreateKeyPairCommandInput @@ -1687,6 +1713,7 @@ export type ServiceInputTypes = | DeleteFleetsCommandInput | DeleteFlowLogsCommandInput | DeleteFpgaImageCommandInput + | DeleteInstanceEventWindowCommandInput | DeleteInternetGatewayCommandInput | DeleteKeyPairCommandInput | DeleteLaunchTemplateCommandInput @@ -1780,6 +1807,7 @@ export type ServiceInputTypes = | DescribeInstanceAttributeCommandInput | DescribeInstanceCreditSpecificationsCommandInput | DescribeInstanceEventNotificationAttributesCommandInput + | DescribeInstanceEventWindowsCommandInput | DescribeInstanceStatusCommandInput | DescribeInstanceTypeOfferingsCommandInput | DescribeInstanceTypesCommandInput @@ -1878,6 +1906,7 @@ export type ServiceInputTypes = | DisassociateClientVpnTargetNetworkCommandInput | DisassociateEnclaveCertificateIamRoleCommandInput | DisassociateIamInstanceProfileCommandInput + | DisassociateInstanceEventWindowCommandInput | DisassociateRouteTableCommandInput | DisassociateSubnetCidrBlockCommandInput | DisassociateTransitGatewayMulticastDomainCommandInput @@ -1942,6 +1971,7 @@ export type ServiceInputTypes = | ModifyInstanceCapacityReservationAttributesCommandInput | ModifyInstanceCreditSpecificationCommandInput | ModifyInstanceEventStartTimeCommandInput + | ModifyInstanceEventWindowCommandInput | ModifyInstanceMetadataOptionsCommandInput | ModifyInstancePlacementCommandInput | ModifyLaunchTemplateCommandInput @@ -2047,6 +2077,7 @@ export type ServiceOutputTypes = | AssociateDhcpOptionsCommandOutput | AssociateEnclaveCertificateIamRoleCommandOutput | AssociateIamInstanceProfileCommandOutput + | AssociateInstanceEventWindowCommandOutput | AssociateRouteTableCommandOutput | AssociateSubnetCidrBlockCommandOutput | AssociateTransitGatewayMulticastDomainCommandOutput @@ -2087,6 +2118,7 @@ export type ServiceOutputTypes = | CreateFlowLogsCommandOutput | CreateFpgaImageCommandOutput | CreateImageCommandOutput + | CreateInstanceEventWindowCommandOutput | CreateInstanceExportTaskCommandOutput | CreateInternetGatewayCommandOutput | CreateKeyPairCommandOutput @@ -2145,6 +2177,7 @@ export type ServiceOutputTypes = | DeleteFleetsCommandOutput | DeleteFlowLogsCommandOutput | DeleteFpgaImageCommandOutput + | DeleteInstanceEventWindowCommandOutput | DeleteInternetGatewayCommandOutput | DeleteKeyPairCommandOutput | DeleteLaunchTemplateCommandOutput @@ -2238,6 +2271,7 @@ export type ServiceOutputTypes = | DescribeInstanceAttributeCommandOutput | DescribeInstanceCreditSpecificationsCommandOutput | DescribeInstanceEventNotificationAttributesCommandOutput + | DescribeInstanceEventWindowsCommandOutput | DescribeInstanceStatusCommandOutput | DescribeInstanceTypeOfferingsCommandOutput | DescribeInstanceTypesCommandOutput @@ -2336,6 +2370,7 @@ export type ServiceOutputTypes = | DisassociateClientVpnTargetNetworkCommandOutput | DisassociateEnclaveCertificateIamRoleCommandOutput | DisassociateIamInstanceProfileCommandOutput + | DisassociateInstanceEventWindowCommandOutput | DisassociateRouteTableCommandOutput | DisassociateSubnetCidrBlockCommandOutput | DisassociateTransitGatewayMulticastDomainCommandOutput @@ -2400,6 +2435,7 @@ export type ServiceOutputTypes = | ModifyInstanceCapacityReservationAttributesCommandOutput | ModifyInstanceCreditSpecificationCommandOutput | ModifyInstanceEventStartTimeCommandOutput + | ModifyInstanceEventWindowCommandOutput | ModifyInstanceMetadataOptionsCommandOutput | ModifyInstancePlacementCommandOutput | ModifyLaunchTemplateCommandOutput diff --git a/clients/client-ec2/commands/AssociateInstanceEventWindowCommand.ts b/clients/client-ec2/commands/AssociateInstanceEventWindowCommand.ts new file mode 100644 index 0000000000000..3f839fcb82d55 --- /dev/null +++ b/clients/client-ec2/commands/AssociateInstanceEventWindowCommand.ts @@ -0,0 +1,102 @@ +import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; +import { AssociateInstanceEventWindowRequest, AssociateInstanceEventWindowResult } from "../models/models_0"; +import { + deserializeAws_ec2AssociateInstanceEventWindowCommand, + serializeAws_ec2AssociateInstanceEventWindowCommand, +} from "../protocols/Aws_ec2"; +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + MiddlewareStack, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +export interface AssociateInstanceEventWindowCommandInput extends AssociateInstanceEventWindowRequest {} +export interface AssociateInstanceEventWindowCommandOutput + extends AssociateInstanceEventWindowResult, + __MetadataBearer {} + +/** + *
Associates one or more targets with an event window. Only one type of target (instance IDs, + * Dedicated Host IDs, or tags) can be specified with an event window.
+ *For more information, see Define event windows + * for scheduled events in the Amazon EC2 User Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, AssociateInstanceEventWindowCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, AssociateInstanceEventWindowCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new AssociateInstanceEventWindowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link AssociateInstanceEventWindowCommandInput} for command's `input` shape. + * @see {@link AssociateInstanceEventWindowCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * + */ +export class AssociateInstanceEventWindowCommand extends $Command< + AssociateInstanceEventWindowCommandInput, + AssociateInstanceEventWindowCommandOutput, + EC2ClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: AssociateInstanceEventWindowCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates an event window in which scheduled events for the associated Amazon EC2 instances can + * run.
+ *You can define either a set of time ranges or a cron expression when creating the event + * window, but not both. All event window times are in UTC.
+ *You can create up to 200 event windows per Amazon Web Services Region.
+ *When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) + * are not yet associated with it. To ensure that the event window can be used, you must + * associate one or more targets with it by using the AssociateInstanceEventWindow API.
+ * + *Event windows are applicable only for scheduled events that stop, reboot, or + * terminate instances.
+ *Event windows are not applicable for:
+ *Expedited scheduled events and network maintenance events.
+ *Unscheduled maintenance such as AutoRecovery and unplanned reboots.
+ *For more information, see Define event windows + * for scheduled events in the Amazon EC2 User Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, CreateInstanceEventWindowCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, CreateInstanceEventWindowCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new CreateInstanceEventWindowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateInstanceEventWindowCommandInput} for command's `input` shape. + * @see {@link CreateInstanceEventWindowCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * + */ +export class CreateInstanceEventWindowCommand extends $Command< + CreateInstanceEventWindowCommandInput, + CreateInstanceEventWindowCommandOutput, + EC2ClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: CreateInstanceEventWindowCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes the specified event window.
+ *For more information, see Define event windows + * for scheduled events in the Amazon EC2 User Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DeleteInstanceEventWindowCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DeleteInstanceEventWindowCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DeleteInstanceEventWindowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteInstanceEventWindowCommandInput} for command's `input` shape. + * @see {@link DeleteInstanceEventWindowCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DeleteInstanceEventWindowCommand extends $Command< + DeleteInstanceEventWindowCommandInput, + DeleteInstanceEventWindowCommandOutput, + EC2ClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeleteInstanceEventWindowCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeregisters tag keys to prevent tags that have the specified tag keys from being included + *
c
+ *Deregisters tag keys to prevent tags that have the specified tag keys from being included * in scheduled event notifications for resources in the Region.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-ec2/commands/DescribeInstanceEventWindowsCommand.ts b/clients/client-ec2/commands/DescribeInstanceEventWindowsCommand.ts new file mode 100644 index 0000000000000..c1ec557c7e0c5 --- /dev/null +++ b/clients/client-ec2/commands/DescribeInstanceEventWindowsCommand.ts @@ -0,0 +1,107 @@ +import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; +import { DescribeInstanceEventWindowsRequest, DescribeInstanceEventWindowsResult } from "../models/models_2"; +import { + deserializeAws_ec2DescribeInstanceEventWindowsCommand, + serializeAws_ec2DescribeInstanceEventWindowsCommand, +} from "../protocols/Aws_ec2"; +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + MiddlewareStack, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +export interface DescribeInstanceEventWindowsCommandInput extends DescribeInstanceEventWindowsRequest {} +export interface DescribeInstanceEventWindowsCommandOutput + extends DescribeInstanceEventWindowsResult, + __MetadataBearer {} + +/** + *Describes the specified event windows or all event windows.
+ *If you specify event window IDs, the output includes information for only the specified + * event windows. If you specify filters, the output includes information for only those event + * windows that meet the filter criteria. If you do not specify event windows IDs or filters, + * the output includes information for all event windows, which can affect performance. We + * recommend that you use pagination to ensure that the operation returns quickly and + * successfully.
+ *For more information, see Define event windows + * for scheduled events in the Amazon EC2 User Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DescribeInstanceEventWindowsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DescribeInstanceEventWindowsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DescribeInstanceEventWindowsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeInstanceEventWindowsCommandInput} for command's `input` shape. + * @see {@link DescribeInstanceEventWindowsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DescribeInstanceEventWindowsCommand extends $Command< + DescribeInstanceEventWindowsCommandInput, + DescribeInstanceEventWindowsCommandOutput, + EC2ClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeInstanceEventWindowsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDisassociates one or more targets from an event window.
+ *For more information, see Define event windows + * for scheduled events in the Amazon EC2 User Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, DisassociateInstanceEventWindowCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, DisassociateInstanceEventWindowCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new DisassociateInstanceEventWindowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DisassociateInstanceEventWindowCommandInput} for command's `input` shape. + * @see {@link DisassociateInstanceEventWindowCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DisassociateInstanceEventWindowCommand extends $Command< + DisassociateInstanceEventWindowCommandInput, + DisassociateInstanceEventWindowCommandOutput, + EC2ClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DisassociateInstanceEventWindowCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackModifies the specified event window.
+ *You can define either a set of time ranges or a cron expression when modifying the event + * window, but not both.
+ *To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.
+ *If Amazon Web Services has already scheduled an event, modifying an event window won't change the time + * of the scheduled event.
+ *For more information, see Define event windows + * for scheduled events in the Amazon EC2 User Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, ModifyInstanceEventWindowCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, ModifyInstanceEventWindowCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new ModifyInstanceEventWindowCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ModifyInstanceEventWindowCommandInput} for command's `input` shape. + * @see {@link ModifyInstanceEventWindowCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * + */ +export class ModifyInstanceEventWindowCommand extends $Command< + ModifyInstanceEventWindowCommandInput, + ModifyInstanceEventWindowCommandOutput, + EC2ClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ModifyInstanceEventWindowCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDetails about the target configuration.
*/ @@ -1231,6 +1229,7 @@ export type ResourceType = | "import-image-task" | "import-snapshot-task" | "instance" + | "instance-event-window" | "internet-gateway" | "key-pair" | "launch-template" @@ -1276,7 +1275,7 @@ export interface TagSpecification { *export-image-task
* | export-instance-task | fleet | fpga-image |
* host-reservation | image| import-image-task |
- * import-snapshot-task | instance |
+ * import-snapshot-task | instance | instance-event-window |
* internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 |
* key-pair | launch-template | local-gateway-route-table-vpc-association | placement-group |
* prefix-list | natgateway | network-acl | network-interface |
@@ -1287,7 +1286,7 @@ export interface TagSpecification {
* transit-gateway-attachment | transit-gateway-multicast-domain | transit-gateway-route-table |
* volume |vpc | vpc-peering-connection |
* vpc-endpoint (for interface and gateway endpoints) |
- * vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log |
+ * vpc-endpoint-service (for PrivateLink) | vpc-flow-log |
* vpn-connection | vpn-gateway.
* To tag a resource after it has been created, see CreateTags.
*/ @@ -2138,6 +2137,214 @@ export namespace AssociateIamInstanceProfileResult { }); } +/** + *One or more targets associated with the specified event window. Only one + * type of target (instance ID, instance tag, or Dedicated Host ID) + * can be associated with an event window.
+ */ +export interface InstanceEventWindowAssociationRequest { + /** + *The IDs of the instances to associate with the event window. If the instance is on a + * Dedicated Host, you can't specify the Instance ID parameter; you must use the Dedicated + * Host ID parameter.
+ */ + InstanceIds?: string[]; + + /** + *The instance tags to associate with the event window. Any instances associated with the + * tags will be associated with the event window.
+ */ + InstanceTags?: Tag[]; + + /** + *The IDs of the Dedicated Hosts to associate with the event window.
+ */ + DedicatedHostIds?: string[]; +} + +export namespace InstanceEventWindowAssociationRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InstanceEventWindowAssociationRequest): any => ({ + ...obj, + }); +} + +export interface AssociateInstanceEventWindowRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the event window.
+ */ + InstanceEventWindowId: string | undefined; + + /** + *One or more targets associated with the specified event window.
+ */ + AssociationTarget: InstanceEventWindowAssociationRequest | undefined; +} + +export namespace AssociateInstanceEventWindowRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AssociateInstanceEventWindowRequest): any => ({ + ...obj, + }); +} + +/** + *One or more targets associated with the event window.
+ */ +export interface InstanceEventWindowAssociationTarget { + /** + *The IDs of the instances associated with the event window.
+ */ + InstanceIds?: string[]; + + /** + *The instance tags associated with the event window. Any instances associated with the tags + * will be associated with the event window.
+ */ + Tags?: Tag[]; + + /** + *The IDs of the Dedicated Hosts associated with the event window.
+ */ + DedicatedHostIds?: string[]; +} + +export namespace InstanceEventWindowAssociationTarget { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InstanceEventWindowAssociationTarget): any => ({ + ...obj, + }); +} + +export enum InstanceEventWindowState { + active = "active", + creating = "creating", + deleted = "deleted", + deleting = "deleting", +} + +export enum WeekDay { + friday = "friday", + monday = "monday", + saturday = "saturday", + sunday = "sunday", + thursday = "thursday", + tuesday = "tuesday", + wednesday = "wednesday", +} + +/** + *The start day and time and the end day and time of the time range, in UTC.
+ */ +export interface InstanceEventWindowTimeRange { + /** + *The day on which the time range begins.
+ */ + StartWeekDay?: WeekDay | string; + + /** + *The hour when the time range begins.
+ */ + StartHour?: number; + + /** + *The day on which the time range ends.
+ */ + EndWeekDay?: WeekDay | string; + + /** + *The hour when the time range ends.
+ */ + EndHour?: number; +} + +export namespace InstanceEventWindowTimeRange { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InstanceEventWindowTimeRange): any => ({ + ...obj, + }); +} + +/** + *The event window.
+ */ +export interface InstanceEventWindow { + /** + *The ID of the event window.
+ */ + InstanceEventWindowId?: string; + + /** + *One or more time ranges defined for the event window.
+ */ + TimeRanges?: InstanceEventWindowTimeRange[]; + + /** + *The name of the event window.
+ */ + Name?: string; + + /** + *The cron expression defined for the event window.
+ */ + CronExpression?: string; + + /** + *One or more targets associated with the event window.
+ */ + AssociationTarget?: InstanceEventWindowAssociationTarget; + + /** + *The current state of the event window.
+ */ + State?: InstanceEventWindowState | string; + + /** + *The instance tags associated with the event window.
+ */ + Tags?: Tag[]; +} + +export namespace InstanceEventWindow { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InstanceEventWindow): any => ({ + ...obj, + }); +} + +export interface AssociateInstanceEventWindowResult { + /** + *Information about the event window.
+ */ + InstanceEventWindow?: InstanceEventWindow; +} + +export namespace AssociateInstanceEventWindowResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AssociateInstanceEventWindowResult): any => ({ + ...obj, + }); +} + export interface AssociateRouteTableRequest { /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -8108,6 +8315,124 @@ export namespace CreateImageResult { }); } +/** + *
The start day and time and the end day and time of the time range, in UTC.
+ */ +export interface InstanceEventWindowTimeRangeRequest { + /** + *The day on which the time range begins.
+ */ + StartWeekDay?: WeekDay | string; + + /** + *The hour when the time range begins.
+ */ + StartHour?: number; + + /** + *The day on which the time range ends.
+ */ + EndWeekDay?: WeekDay | string; + + /** + *The hour when the time range ends.
+ */ + EndHour?: number; +} + +export namespace InstanceEventWindowTimeRangeRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InstanceEventWindowTimeRangeRequest): any => ({ + ...obj, + }); +} + +export interface CreateInstanceEventWindowRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The name of the event window.
+ */ + Name?: string; + + /** + *The time range for the event window. If you specify a time range, you can't specify a cron + * expression.
+ */ + TimeRanges?: InstanceEventWindowTimeRangeRequest[]; + + /** + *The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If
+ * you specify a cron expression, you can't specify a time range.
Constraints:
+ *Only hour and day of the week values are supported.
+ *For day of the week values, you can specify either integers 0 through
+ * 6, or alternative single values SUN through
+ * SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or
+ * 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or
+ * 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event + * window must be >= 4 hours.
+ *For more information about cron expressions, see cron on the Wikipedia + * website.
+ */ + CronExpression?: string; + + /** + *The tags to apply to the event window.
+ */ + TagSpecifications?: TagSpecification[]; +} + +export namespace CreateInstanceEventWindowRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateInstanceEventWindowRequest): any => ({ + ...obj, + }); +} + +export interface CreateInstanceEventWindowResult { + /** + *Information about the event window.
+ */ + InstanceEventWindow?: InstanceEventWindow; +} + +export namespace CreateInstanceEventWindowResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateInstanceEventWindowResult): any => ({ + ...obj, + }); +} + export type ContainerFormat = "ova"; export type DiskImageFormat = "RAW" | "VHD" | "VMDK"; @@ -8372,358 +8697,3 @@ export namespace InternetGateway { ...obj, }); } - -export interface CreateInternetGatewayResult { - /** - *Information about the internet gateway.
- */ - InternetGateway?: InternetGateway; -} - -export namespace CreateInternetGatewayResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: CreateInternetGatewayResult): any => ({ - ...obj, - }); -} - -export interface CreateKeyPairRequest { - /** - *A unique name for the key pair.
- *Constraints: Up to 255 ASCII characters
- */ - KeyName: string | undefined; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The tags to apply to the new key pair.
- */ - TagSpecifications?: TagSpecification[]; -} - -export namespace CreateKeyPairRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: CreateKeyPairRequest): any => ({ - ...obj, - }); -} - -/** - *Describes a key pair.
- */ -export interface KeyPair { - /** - *The SHA-1 digest of the DER encoded private key.
- */ - KeyFingerprint?: string; - - /** - *An unencrypted PEM encoded RSA private key.
- */ - KeyMaterial?: string; - - /** - *The name of the key pair.
- */ - KeyName?: string; - - /** - *The ID of the key pair.
- */ - KeyPairId?: string; - - /** - *Any tags applied to the key pair.
- */ - Tags?: Tag[]; -} - -export namespace KeyPair { - /** - * @internal - */ - export const filterSensitiveLog = (obj: KeyPair): any => ({ - ...obj, - ...(obj.KeyMaterial && { KeyMaterial: SENSITIVE_STRING }), - }); -} - -/** - *The parameters for a block device for an EBS volume.
- */ -export interface LaunchTemplateEbsBlockDeviceRequest { - /** - *Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. - * If you are creating a volume from a snapshot, you can't specify an encryption value.
- */ - Encrypted?: boolean; - - /** - *Indicates whether the EBS volume is deleted on instance termination.
- */ - DeleteOnTermination?: boolean; - - /** - *The number of I/O operations per second (IOPS). For gp3, io1, and io2
- * volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes,
- * this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits
- * for bursting.
The following are the supported values for each volume type:
- *
- * gp3: 3,000-16,000 IOPS
- * io1: 100-64,000 IOPS
- * io2: 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS
- * only for Instances built on the Nitro System. Other instance families guarantee performance up
- * to 32,000 IOPS.
This parameter is supported for io1, io2, and gp3 volumes only. This parameter is not supported for
- * gp2, st1, sc1, or standard volumes.
The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for - * encryption.
- */ - KmsKeyId?: string; - - /** - *The ID of the snapshot.
- */ - SnapshotId?: string; - - /** - *The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following - * are the supported volumes sizes for each volume type:
- *
- * gp2 and gp3: 1-16,384
- * io1 and io2: 4-16,384
- * st1 and sc1: 125-16,384
- * standard: 1-1,024
The volume type. For more information, see Amazon EBS volume types in the - * Amazon Elastic Compute Cloud User Guide.
- */ - VolumeType?: VolumeType | string; - - /** - *The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
- */ - Throughput?: number; -} - -export namespace LaunchTemplateEbsBlockDeviceRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: LaunchTemplateEbsBlockDeviceRequest): any => ({ - ...obj, - }); -} - -/** - *Describes a block device mapping.
- */ -export interface LaunchTemplateBlockDeviceMappingRequest { - /** - *The device name (for example, /dev/sdh or xvdh).
- */ - DeviceName?: string; - - /** - *The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. - * An instance type with 2 available instance store volumes can specify mappings for ephemeral0 - * and ephemeral1. The number of available instance store volumes depends on the instance type. - * After you connect to the instance, you must mount the volume.
- */ - VirtualName?: string; - - /** - *Parameters used to automatically set up EBS volumes when the instance is launched.
- */ - Ebs?: LaunchTemplateEbsBlockDeviceRequest; - - /** - *To omit the device from the block device mapping, specify an empty string.
- */ - NoDevice?: string; -} - -export namespace LaunchTemplateBlockDeviceMappingRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: LaunchTemplateBlockDeviceMappingRequest): any => ({ - ...obj, - }); -} - -export type CapacityReservationPreference = "none" | "open"; - -/** - *Describes a target Capacity Reservation or Capacity Reservation group.
- */ -export interface CapacityReservationTarget { - /** - *The ID of the Capacity Reservation in which to run the instance.
- */ - CapacityReservationId?: string; - - /** - *The ARN of the Capacity Reservation resource group in which to run the instance.
- */ - CapacityReservationResourceGroupArn?: string; -} - -export namespace CapacityReservationTarget { - /** - * @internal - */ - export const filterSensitiveLog = (obj: CapacityReservationTarget): any => ({ - ...obj, - }); -} - -/** - *Describes an instance's Capacity Reservation targeting option. You can specify only one option at a time. Use the
- * CapacityReservationPreference parameter to configure the instance to run in On-Demand capacity or
- * to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
- * Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or
- * a Capacity Reservation group.
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
- *
- * open - The instance can run in any open Capacity Reservation that has matching attributes
- * (instance type, platform, Availability Zone).
- * none - The instance avoids running in a Capacity Reservation even if one is available. The instance
- * runs in On-Demand capacity.
Information about the target Capacity Reservation or Capacity Reservation group.
- */ - CapacityReservationTarget?: CapacityReservationTarget; -} - -export namespace LaunchTemplateCapacityReservationSpecificationRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: LaunchTemplateCapacityReservationSpecificationRequest): any => ({ - ...obj, - }); -} - -/** - *The CPU options for the instance. Both the core count and threads per core - * must be specified in the request.
- */ -export interface LaunchTemplateCpuOptionsRequest { - /** - *The number of CPU cores for the instance.
- */ - CoreCount?: number; - - /** - *The number of threads per CPU core. To disable multithreading - * for the instance, specify a value of 1. Otherwise, specify the default value of 2.
- */ - ThreadsPerCore?: number; -} - -export namespace LaunchTemplateCpuOptionsRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: LaunchTemplateCpuOptionsRequest): any => ({ - ...obj, - }); -} - -/** - *The credit option for CPU usage of a T2, T3, or T3a instance.
- */ -export interface CreditSpecificationRequest { - /** - *The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are
- * standard and unlimited.
A specification for an Elastic Graphics accelerator.
- */ -export interface ElasticGpuSpecification { - /** - *The type of Elastic Graphics accelerator. For more information about the values to specify for
- * Type, see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows
- * Instances.
Information about the internet gateway.
+ */ + InternetGateway?: InternetGateway; +} + +export namespace CreateInternetGatewayResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateInternetGatewayResult): any => ({ + ...obj, + }); +} + +export interface CreateKeyPairRequest { + /** + *A unique name for the key pair.
+ *Constraints: Up to 255 ASCII characters
+ */ + KeyName: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The tags to apply to the new key pair.
+ */ + TagSpecifications?: TagSpecification[]; +} + +export namespace CreateKeyPairRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateKeyPairRequest): any => ({ + ...obj, + }); +} + +/** + *Describes a key pair.
+ */ +export interface KeyPair { + /** + *The SHA-1 digest of the DER encoded private key.
+ */ + KeyFingerprint?: string; + + /** + *An unencrypted PEM encoded RSA private key.
+ */ + KeyMaterial?: string; + + /** + *The name of the key pair.
+ */ + KeyName?: string; + + /** + *The ID of the key pair.
+ */ + KeyPairId?: string; + + /** + *Any tags applied to the key pair.
+ */ + Tags?: Tag[]; +} + +export namespace KeyPair { + /** + * @internal + */ + export const filterSensitiveLog = (obj: KeyPair): any => ({ + ...obj, + ...(obj.KeyMaterial && { KeyMaterial: SENSITIVE_STRING }), + }); +} + +/** + *The parameters for a block device for an EBS volume.
+ */ +export interface LaunchTemplateEbsBlockDeviceRequest { + /** + *Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. + * If you are creating a volume from a snapshot, you can't specify an encryption value.
+ */ + Encrypted?: boolean; + + /** + *Indicates whether the EBS volume is deleted on instance termination.
+ */ + DeleteOnTermination?: boolean; + + /** + *The number of I/O operations per second (IOPS). For gp3, io1, and io2
+ * volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes,
+ * this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits
+ * for bursting.
The following are the supported values for each volume type:
+ *
+ * gp3: 3,000-16,000 IOPS
+ * io1: 100-64,000 IOPS
+ * io2: 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS
+ * only for Instances built on the Nitro System. Other instance families guarantee performance up
+ * to 32,000 IOPS.
This parameter is supported for io1, io2, and gp3 volumes only. This parameter is not supported for
+ * gp2, st1, sc1, or standard volumes.
The ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for + * encryption.
+ */ + KmsKeyId?: string; + + /** + *The ID of the snapshot.
+ */ + SnapshotId?: string; + + /** + *The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following + * are the supported volumes sizes for each volume type:
+ *
+ * gp2 and gp3: 1-16,384
+ * io1 and io2: 4-16,384
+ * st1 and sc1: 125-16,384
+ * standard: 1-1,024
The volume type. For more information, see Amazon EBS volume types in the + * Amazon Elastic Compute Cloud User Guide.
+ */ + VolumeType?: VolumeType | string; + + /** + *The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
+ */ + Throughput?: number; +} + +export namespace LaunchTemplateEbsBlockDeviceRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: LaunchTemplateEbsBlockDeviceRequest): any => ({ + ...obj, + }); +} + +/** + *Describes a block device mapping.
+ */ +export interface LaunchTemplateBlockDeviceMappingRequest { + /** + *The device name (for example, /dev/sdh or xvdh).
+ */ + DeviceName?: string; + + /** + *The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. + * An instance type with 2 available instance store volumes can specify mappings for ephemeral0 + * and ephemeral1. The number of available instance store volumes depends on the instance type. + * After you connect to the instance, you must mount the volume.
+ */ + VirtualName?: string; + + /** + *Parameters used to automatically set up EBS volumes when the instance is launched.
+ */ + Ebs?: LaunchTemplateEbsBlockDeviceRequest; + + /** + *To omit the device from the block device mapping, specify an empty string.
+ */ + NoDevice?: string; +} + +export namespace LaunchTemplateBlockDeviceMappingRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: LaunchTemplateBlockDeviceMappingRequest): any => ({ + ...obj, + }); +} + +export type CapacityReservationPreference = "none" | "open"; + +/** + *Describes a target Capacity Reservation or Capacity Reservation group.
+ */ +export interface CapacityReservationTarget { + /** + *The ID of the Capacity Reservation in which to run the instance.
+ */ + CapacityReservationId?: string; + + /** + *The ARN of the Capacity Reservation resource group in which to run the instance.
+ */ + CapacityReservationResourceGroupArn?: string; +} + +export namespace CapacityReservationTarget { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CapacityReservationTarget): any => ({ + ...obj, + }); +} + +/** + *Describes an instance's Capacity Reservation targeting option. You can specify only one option at a time. Use the
+ * CapacityReservationPreference parameter to configure the instance to run in On-Demand capacity or
+ * to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
+ * Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or
+ * a Capacity Reservation group.
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
+ *
+ * open - The instance can run in any open Capacity Reservation that has matching attributes
+ * (instance type, platform, Availability Zone).
+ * none - The instance avoids running in a Capacity Reservation even if one is available. The instance
+ * runs in On-Demand capacity.
Information about the target Capacity Reservation or Capacity Reservation group.
+ */ + CapacityReservationTarget?: CapacityReservationTarget; +} + +export namespace LaunchTemplateCapacityReservationSpecificationRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: LaunchTemplateCapacityReservationSpecificationRequest): any => ({ + ...obj, + }); +} + +/** + *The CPU options for the instance. Both the core count and threads per core + * must be specified in the request.
+ */ +export interface LaunchTemplateCpuOptionsRequest { + /** + *The number of CPU cores for the instance.
+ */ + CoreCount?: number; + + /** + *The number of threads per CPU core. To disable multithreading + * for the instance, specify a value of 1. Otherwise, specify the default value of 2.
+ */ + ThreadsPerCore?: number; +} + +export namespace LaunchTemplateCpuOptionsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: LaunchTemplateCpuOptionsRequest): any => ({ + ...obj, + }); +} + +/** + *The credit option for CPU usage of a T2, T3, or T3a instance.
+ */ +export interface CreditSpecificationRequest { + /** + *The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are
+ * standard and unlimited.
A specification for an Elastic Graphics accelerator.
+ */ +export interface ElasticGpuSpecification { + /** + *The type of Elastic Graphics accelerator. For more information about the values to specify for
+ * Type, see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows
+ * Instances.
@@ -9203,240 +9553,3 @@ export namespace DeleteFleetSuccessItem { ...obj, }); } - -export enum DeleteFleetErrorCode { - FLEET_ID_DOES_NOT_EXIST = "fleetIdDoesNotExist", - FLEET_ID_MALFORMED = "fleetIdMalformed", - FLEET_NOT_IN_DELETABLE_STATE = "fleetNotInDeletableState", - UNEXPECTED_ERROR = "unexpectedError", -} - -/** - *
Describes an EC2 Fleet error.
- */ -export interface DeleteFleetError { - /** - *The error code.
- */ - Code?: DeleteFleetErrorCode | string; - - /** - *The description for the error code.
- */ - Message?: string; -} - -export namespace DeleteFleetError { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DeleteFleetError): any => ({ - ...obj, - }); -} - -/** - *Describes an EC2 Fleet that was not successfully deleted.
- */ -export interface DeleteFleetErrorItem { - /** - *The error.
- */ - Error?: DeleteFleetError; - - /** - *The ID of the EC2 Fleet.
- */ - FleetId?: string; -} - -export namespace DeleteFleetErrorItem { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DeleteFleetErrorItem): any => ({ - ...obj, - }); -} - -export interface DeleteFleetsResult { - /** - *Information about the EC2 Fleets that are successfully deleted.
- */ - SuccessfulFleetDeletions?: DeleteFleetSuccessItem[]; - - /** - *Information about the EC2 Fleets that are not successfully deleted.
- */ - UnsuccessfulFleetDeletions?: DeleteFleetErrorItem[]; -} - -export namespace DeleteFleetsResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DeleteFleetsResult): any => ({ - ...obj, - }); -} - -export interface DeleteFlowLogsRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more flow log IDs.
- *Constraint: Maximum of 1000 flow log IDs.
- */ - FlowLogIds: string[] | undefined; -} - -export namespace DeleteFlowLogsRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DeleteFlowLogsRequest): any => ({ - ...obj, - }); -} - -export interface DeleteFlowLogsResult { - /** - *Information about the flow logs that could not be deleted successfully.
- */ - Unsuccessful?: UnsuccessfulItem[]; -} - -export namespace DeleteFlowLogsResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DeleteFlowLogsResult): any => ({ - ...obj, - }); -} - -export interface DeleteFpgaImageRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the AFI.
- */ - FpgaImageId: string | undefined; -} - -export namespace DeleteFpgaImageRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DeleteFpgaImageRequest): any => ({ - ...obj, - }); -} - -export interface DeleteFpgaImageResult { - /** - *Is true if the request succeeds, and an error otherwise.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the internet gateway.
- */ - InternetGatewayId: string | undefined; -} - -export namespace DeleteInternetGatewayRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DeleteInternetGatewayRequest): any => ({ - ...obj, - }); -} - -export interface DeleteKeyPairRequest { - /** - *The name of the key pair.
- */ - KeyName?: string; - - /** - *The ID of the key pair.
- */ - KeyPairId?: string; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The ID of the launch template. You must specify either the launch template ID or - * launch template name in the request.
- */ - LaunchTemplateId?: string; - - /** - *The name of the launch template. You must specify either the launch template ID or - * launch template name in the request.
- */ - LaunchTemplateName?: string; -} - -export namespace DeleteLaunchTemplateRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DeleteLaunchTemplateRequest): any => ({ - ...obj, - }); -} diff --git a/clients/client-ec2/models/models_2.ts b/clients/client-ec2/models/models_2.ts index dea79a7ad441d..3f884d188fd76 100644 --- a/clients/client-ec2/models/models_2.ts +++ b/clients/client-ec2/models/models_2.ts @@ -15,7 +15,6 @@ import { BundleTask, ByoipCidr, CapacityReservation, - CapacityReservationPreference, CarrierGateway, ClientVpnAuthenticationType, ClientVpnAuthorizationRuleStatus, @@ -36,12 +35,12 @@ import { FleetReplacementStrategy, FleetType, HostRecovery, - IamInstanceProfile, IamInstanceProfileAssociation, + InstanceEventWindow, + InstanceEventWindowState, InstanceLifecycle, LaunchTemplateAndOverridesResponse, LogDestinationType, - Placement, PlatformValues, SpotAllocationStrategy, SpotInstanceInterruptionBehavior, @@ -54,15 +53,15 @@ import { _InstanceType, } from "./models_0"; import { + CapacityReservationPreference, CapacityReservationTargetResponse, + DeleteFleetSuccessItem, FleetStateCode, GroupIdentifier, - InstanceIpv6Address, LaunchTemplate, LocalGatewayRoute, LocalGatewayRouteTableVpcAssociation, ManagedPrefixList, - NetworkInterfaceStatus, TransitGateway, TransitGatewayConnect, TransitGatewayConnectPeer, @@ -72,6 +71,312 @@ import { TransitGatewayRouteTable, } from "./models_1"; +export enum DeleteFleetErrorCode { + FLEET_ID_DOES_NOT_EXIST = "fleetIdDoesNotExist", + FLEET_ID_MALFORMED = "fleetIdMalformed", + FLEET_NOT_IN_DELETABLE_STATE = "fleetNotInDeletableState", + UNEXPECTED_ERROR = "unexpectedError", +} + +/** + *Describes an EC2 Fleet error.
+ */ +export interface DeleteFleetError { + /** + *The error code.
+ */ + Code?: DeleteFleetErrorCode | string; + + /** + *The description for the error code.
+ */ + Message?: string; +} + +export namespace DeleteFleetError { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteFleetError): any => ({ + ...obj, + }); +} + +/** + *Describes an EC2 Fleet that was not successfully deleted.
+ */ +export interface DeleteFleetErrorItem { + /** + *The error.
+ */ + Error?: DeleteFleetError; + + /** + *The ID of the EC2 Fleet.
+ */ + FleetId?: string; +} + +export namespace DeleteFleetErrorItem { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteFleetErrorItem): any => ({ + ...obj, + }); +} + +export interface DeleteFleetsResult { + /** + *Information about the EC2 Fleets that are successfully deleted.
+ */ + SuccessfulFleetDeletions?: DeleteFleetSuccessItem[]; + + /** + *Information about the EC2 Fleets that are not successfully deleted.
+ */ + UnsuccessfulFleetDeletions?: DeleteFleetErrorItem[]; +} + +export namespace DeleteFleetsResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteFleetsResult): any => ({ + ...obj, + }); +} + +export interface DeleteFlowLogsRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more flow log IDs.
+ *Constraint: Maximum of 1000 flow log IDs.
+ */ + FlowLogIds: string[] | undefined; +} + +export namespace DeleteFlowLogsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteFlowLogsRequest): any => ({ + ...obj, + }); +} + +export interface DeleteFlowLogsResult { + /** + *Information about the flow logs that could not be deleted successfully.
+ */ + Unsuccessful?: UnsuccessfulItem[]; +} + +export namespace DeleteFlowLogsResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteFlowLogsResult): any => ({ + ...obj, + }); +} + +export interface DeleteFpgaImageRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the AFI.
+ */ + FpgaImageId: string | undefined; +} + +export namespace DeleteFpgaImageRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteFpgaImageRequest): any => ({ + ...obj, + }); +} + +export interface DeleteFpgaImageResult { + /** + *Is true if the request succeeds, and an error otherwise.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Specify true to force delete the event window. Use the force delete parameter
+ * if the event window is currently associated with targets.
The ID of the event window.
+ */ + InstanceEventWindowId: string | undefined; +} + +export namespace DeleteInstanceEventWindowRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteInstanceEventWindowRequest): any => ({ + ...obj, + }); +} + +/** + *The state of the event window.
+ */ +export interface InstanceEventWindowStateChange { + /** + *The ID of the event window.
+ */ + InstanceEventWindowId?: string; + + /** + *The current state of the event window.
+ */ + State?: InstanceEventWindowState | string; +} + +export namespace InstanceEventWindowStateChange { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InstanceEventWindowStateChange): any => ({ + ...obj, + }); +} + +export interface DeleteInstanceEventWindowResult { + /** + *The state of the event window.
+ */ + InstanceEventWindowState?: InstanceEventWindowStateChange; +} + +export namespace DeleteInstanceEventWindowResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteInstanceEventWindowResult): any => ({ + ...obj, + }); +} + +export interface DeleteInternetGatewayRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the internet gateway.
+ */ + InternetGatewayId: string | undefined; +} + +export namespace DeleteInternetGatewayRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteInternetGatewayRequest): any => ({ + ...obj, + }); +} + +export interface DeleteKeyPairRequest { + /** + *The name of the key pair.
+ */ + KeyName?: string; + + /** + *The ID of the key pair.
+ */ + KeyPairId?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The ID of the launch template. You must specify either the launch template ID or + * launch template name in the request.
+ */ + LaunchTemplateId?: string; + + /** + *The name of the launch template. You must specify either the launch template ID or + * launch template name in the request.
+ */ + LaunchTemplateName?: string; +} + +export namespace DeleteLaunchTemplateRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteLaunchTemplateRequest): any => ({ + ...obj, + }); +} + export interface DeleteLaunchTemplateResult { /** *Information about the launch template.
@@ -932,7 +1237,7 @@ export interface DeleteTagsRequest { * key regardless of its value. If you specify a tag key with an empty string as the tag * value, we delete the tag only if its value is an empty string. *If you omit this parameter, we delete all user-defined tags for the specified
- * resources. We do not delete AWS-generated tags (tags that have the aws:
+ * resources. We do not delete Amazon Web Services-generated tags (tags that have the aws:
* prefix).
The filters.
- *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The IDs of the event windows.
+ */ + InstanceEventWindowIds?: string[]; + + /** + *One or more filters.
+ *
- * affinity - The affinity setting for an instance running on a
- * Dedicated Host (default | host).
+ * dedicated-host-id - The event windows associated with the specified
+ * Dedicated Host ID.
+ * event-window-name - The event windows associated with the specified
+ * names.
+ * instance-id - The event windows associated with the specified instance
+ * ID.
+ * instance-tag - The event windows associated with the specified tag and
+ * value.
+ * instance-tag-key - The event windows associated with the specified tag
+ * key, regardless of the value.
+ * instance-tag-value - The event windows associated with the specified tag
+ * value, regardless of the key.
+ * tag:Owner and the value CMX, specify tag:Owner
+ * for the filter name and CMX for the filter value.
+ * tag-key - The key of a tag assigned to the event window. Use this filter
+ * to find all event windows that have a tag with a specific key, regardless of the tag
+ * value.
+ * tag-value - The value of a tag assigned to the event window. Use this
+ * filter to find all event windows that have a tag with a specific value, regardless of
+ * the tag key.
The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another call with the returned NextToken value. This value can
+ * be between 20 and 500. You cannot specify this parameter and the event window IDs parameter
+ * in the same call.
The token to request the next page of results.
+ */ + NextToken?: string; +} + +export namespace DescribeInstanceEventWindowsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeInstanceEventWindowsRequest): any => ({ + ...obj, + }); +} + +export interface DescribeInstanceEventWindowsResult { + /** + *Information about the event windows.
+ */ + InstanceEventWindows?: InstanceEventWindow[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
+ *
+ * affinity - The affinity setting for an instance running on a
+ * Dedicated Host (default | host).
@@ -9644,887 +10066,3 @@ export enum HttpTokensState { optional = "optional", required = "required", } - -export type InstanceMetadataOptionsState = "applied" | "pending"; - -/** - *
The metadata options for the instance.
- */ -export interface InstanceMetadataOptionsResponse { - /** - *The state of the metadata option changes.
- *
- * pending - The metadata options are being updated and the instance is not
- * ready to process metadata traffic with the new selection.
- * applied - The metadata options have been successfully applied on the
- * instance.
The state of token usage for your instance metadata requests. If the parameter is not
- * specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata
- * with or without a signed token header on your request. If you retrieve the IAM role
- * credentials without a token, the version 1.0 role credentials are returned. If you
- * retrieve the IAM role credentials using a valid signed token, the version 2.0 role
- * credentials are returned.
If the state is required, you must send a signed token header with any
- * instance metadata retrieval requests. In this state, retrieving the IAM role credential
- * always returns the version 2.0 credentials; the version 1.0 credentials are not
- * available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the - * number, the further instance metadata requests can travel.
- *Default: 1
- *Possible values: Integers from 1 to 64
- */ - HttpPutResponseHopLimit?: number; - - /** - *This parameter enables or disables the HTTP metadata endpoint on your instances. If
- * the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your
- * instance metadata.
Describes the monitoring of an instance.
- */ -export interface Monitoring { - /** - *Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is - * enabled.
- */ - State?: MonitoringState | string; -} - -export namespace Monitoring { - /** - * @internal - */ - export const filterSensitiveLog = (obj: Monitoring): any => ({ - ...obj, - }); -} - -/** - *Describes association information for an Elastic IP address (IPv4).
- */ -export interface InstanceNetworkInterfaceAssociation { - /** - *The carrier IP address associated with the network interface.
- */ - CarrierIp?: string; - - /** - *The ID of the owner of the Elastic IP address.
- */ - IpOwnerId?: string; - - /** - *The public DNS name.
- */ - PublicDnsName?: string; - - /** - *The public IP address or Elastic IP address bound to the network interface.
- */ - PublicIp?: string; -} - -export namespace InstanceNetworkInterfaceAssociation { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InstanceNetworkInterfaceAssociation): any => ({ - ...obj, - }); -} - -/** - *Describes a network interface attachment.
- */ -export interface InstanceNetworkInterfaceAttachment { - /** - *The time stamp when the attachment initiated.
- */ - AttachTime?: Date; - - /** - *The ID of the network interface attachment.
- */ - AttachmentId?: string; - - /** - *Indicates whether the network interface is deleted when the instance is terminated.
- */ - DeleteOnTermination?: boolean; - - /** - *The index of the device on the instance for the network interface attachment.
- */ - DeviceIndex?: number; - - /** - *The attachment state.
- */ - Status?: AttachmentStatus | string; - - /** - *The index of the network card.
- */ - NetworkCardIndex?: number; -} - -export namespace InstanceNetworkInterfaceAttachment { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InstanceNetworkInterfaceAttachment): any => ({ - ...obj, - }); -} - -/** - *Describes a private IPv4 address.
- */ -export interface InstancePrivateIpAddress { - /** - *The association information for an Elastic IP address for the network interface.
- */ - Association?: InstanceNetworkInterfaceAssociation; - - /** - *Indicates whether this IPv4 address is the primary private IP address of the network interface.
- */ - Primary?: boolean; - - /** - *The private IPv4 DNS name.
- */ - PrivateDnsName?: string; - - /** - *The private IPv4 address of the network interface.
- */ - PrivateIpAddress?: string; -} - -export namespace InstancePrivateIpAddress { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InstancePrivateIpAddress): any => ({ - ...obj, - }); -} - -/** - *Describes a network interface.
- */ -export interface InstanceNetworkInterface { - /** - *The association information for an Elastic IPv4 associated with the network - * interface.
- */ - Association?: InstanceNetworkInterfaceAssociation; - - /** - *The network interface attachment.
- */ - Attachment?: InstanceNetworkInterfaceAttachment; - - /** - *The description.
- */ - Description?: string; - - /** - *One or more security groups.
- */ - Groups?: GroupIdentifier[]; - - /** - *One or more IPv6 addresses associated with the network interface.
- */ - Ipv6Addresses?: InstanceIpv6Address[]; - - /** - *The MAC address.
- */ - MacAddress?: string; - - /** - *The ID of the network interface.
- */ - NetworkInterfaceId?: string; - - /** - *The ID of the account that created the network interface.
- */ - OwnerId?: string; - - /** - *The private DNS name.
- */ - PrivateDnsName?: string; - - /** - *The IPv4 address of the network interface within the subnet.
- */ - PrivateIpAddress?: string; - - /** - *One or more private IPv4 addresses associated with the network interface.
- */ - PrivateIpAddresses?: InstancePrivateIpAddress[]; - - /** - *Indicates whether source/destination checking is enabled.
- */ - SourceDestCheck?: boolean; - - /** - *The status of the network interface.
- */ - Status?: NetworkInterfaceStatus | string; - - /** - *The ID of the subnet.
- */ - SubnetId?: string; - - /** - *The ID of the VPC.
- */ - VpcId?: string; - - /** - *Describes the type of network interface.
- *Valid values: interface | efa | trunk
- *
Describes the current state of an instance.
- */ -export interface InstanceState { - /** - *The state of the instance as a 16-bit unsigned integer.
- *The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values - * between 256 and 65,535. These numerical values are used for internal purposes and should - * be ignored.
- *The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values - * between 0 and 255.
- *The valid values for instance-state-code will all be in the range of the low byte and - * they are:
- *
- * 0 : pending
- *
- * 16 : running
- *
- * 32 : shutting-down
- *
- * 48 : terminated
- *
- * 64 : stopping
- *
- * 80 : stopped
- *
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in - * decimal.
- */ - Code?: number; - - /** - *The current state of the instance.
- */ - Name?: InstanceStateName | string; -} - -export namespace InstanceState { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InstanceState): any => ({ - ...obj, - }); -} - -/** - *Describes an instance.
- */ -export interface Instance { - /** - *The AMI launch index, which can be used to find this instance in the launch - * group.
- */ - AmiLaunchIndex?: number; - - /** - *The ID of the AMI used to launch the instance.
- */ - ImageId?: string; - - /** - *The ID of the instance.
- */ - InstanceId?: string; - - /** - *The instance type.
- */ - InstanceType?: _InstanceType | string; - - /** - *The kernel associated with this instance, if applicable.
- */ - KernelId?: string; - - /** - *The name of the key pair, if this instance was launched with an associated key - * pair.
- */ - KeyName?: string; - - /** - *The time the instance was launched.
- */ - LaunchTime?: Date; - - /** - *The monitoring for the instance.
- */ - Monitoring?: Monitoring; - - /** - *The location where the instance launched, if applicable.
- */ - Placement?: Placement; - - /** - *The value is Windows for Windows instances; otherwise blank.
(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname
- * can only be used inside the Amazon EC2 network. This name is not available until the
- * instance enters the running state.
[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS - * hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not - * using the Amazon-provided DNS server in your VPC, your custom domain name servers must - * resolve the hostname as appropriate.
- */ - PrivateDnsName?: string; - - /** - *The private IPv4 address assigned to the instance.
- */ - PrivateIpAddress?: string; - - /** - *The product codes attached to this instance, if applicable.
- */ - ProductCodes?: ProductCode[]; - - /** - *(IPv4 only) The public DNS name assigned to the instance. This name is not available
- * until the instance enters the running state. For EC2-VPC, this name is only
- * available if you've enabled DNS hostnames for your VPC.
The public IPv4 address, or the Carrier IP address assigned to the instance, if - * applicable.
- *A Carrier IP address only applies to an instance launched in a subnet associated with - * a Wavelength Zone.
- */ - PublicIpAddress?: string; - - /** - *The RAM disk associated with this instance, if applicable.
- */ - RamdiskId?: string; - - /** - *The current state of the instance.
- */ - State?: InstanceState; - - /** - *The reason for the most recent state transition. This might be an empty string.
- */ - StateTransitionReason?: string; - - /** - *[EC2-VPC] The ID of the subnet in which the instance is running.
- */ - SubnetId?: string; - - /** - *[EC2-VPC] The ID of the VPC in which the instance is running.
- */ - VpcId?: string; - - /** - *The architecture of the image.
- */ - Architecture?: ArchitectureValues | string; - - /** - *Any block device mapping entries for the instance.
- */ - BlockDeviceMappings?: InstanceBlockDeviceMapping[]; - - /** - *The idempotency token you provided when you launched the instance, if - * applicable.
- */ - ClientToken?: string; - - /** - *Indicates whether the instance is optimized for Amazon EBS I/O. This optimization - * provides dedicated throughput to Amazon EBS and an optimized configuration stack to - * provide optimal I/O performance. This optimization isn't available with all instance - * types. Additional usage charges apply when using an EBS Optimized instance.
- */ - EbsOptimized?: boolean; - - /** - *Specifies whether enhanced networking with ENA is enabled.
- */ - EnaSupport?: boolean; - - /** - *The hypervisor type of the instance. The value xen is used for both Xen and
- * Nitro hypervisors.
The IAM instance profile associated with the instance, if applicable.
- */ - IamInstanceProfile?: IamInstanceProfile; - - /** - *Indicates whether this is a Spot Instance or a Scheduled Instance.
- */ - InstanceLifecycle?: InstanceLifecycleType | string; - - /** - *The Elastic GPU associated with the instance.
- */ - ElasticGpuAssociations?: ElasticGpuAssociation[]; - - /** - *The elastic inference accelerator associated with the instance.
- */ - ElasticInferenceAcceleratorAssociations?: ElasticInferenceAcceleratorAssociation[]; - - /** - *[EC2-VPC] The network interfaces for the instance.
- */ - NetworkInterfaces?: InstanceNetworkInterface[]; - - /** - *The Amazon Resource Name (ARN) of the Outpost.
- */ - OutpostArn?: string; - - /** - *The device name of the root device volume (for example,
- * /dev/sda1).
The root device type used by the AMI. The AMI can use an EBS volume or an instance - * store volume.
- */ - RootDeviceType?: DeviceType | string; - - /** - *The security groups for the instance.
- */ - SecurityGroups?: GroupIdentifier[]; - - /** - *Indicates whether source/destination checking is enabled.
- */ - SourceDestCheck?: boolean; - - /** - *If the request is a Spot Instance request, the ID of the request.
- */ - SpotInstanceRequestId?: string; - - /** - *Specifies whether enhanced networking with the Intel 82599 Virtual Function interface - * is enabled.
- */ - SriovNetSupport?: string; - - /** - *The reason for the most recent state transition.
- */ - StateReason?: StateReason; - - /** - *Any tags assigned to the instance.
- */ - Tags?: Tag[]; - - /** - *The virtualization type of the instance.
- */ - VirtualizationType?: VirtualizationType | string; - - /** - *The CPU options for the instance.
- */ - CpuOptions?: CpuOptions; - - /** - *The ID of the Capacity Reservation.
- */ - CapacityReservationId?: string; - - /** - *Information about the Capacity Reservation targeting option.
- */ - CapacityReservationSpecification?: CapacityReservationSpecificationResponse; - - /** - *Indicates whether the instance is enabled for hibernation.
- */ - HibernationOptions?: HibernationOptions; - - /** - *The license configurations.
- */ - Licenses?: LicenseConfiguration[]; - - /** - *The metadata options for the instance.
- */ - MetadataOptions?: InstanceMetadataOptionsResponse; - - /** - *Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
- */ - EnclaveOptions?: EnclaveOptions; - - /** - *The boot mode of the instance. For more information, see Boot modes in the - * Amazon EC2 User Guide.
- */ - BootMode?: BootModeValues | string; -} - -export namespace Instance { - /** - * @internal - */ - export const filterSensitiveLog = (obj: Instance): any => ({ - ...obj, - }); -} - -/** - *Describes a launch request for one or more instances, and includes - * owner, requester, and security group information that applies to all - * instances in the launch request.
- */ -export interface Reservation { - /** - *[EC2-Classic only] The security groups.
- */ - Groups?: GroupIdentifier[]; - - /** - *The instances.
- */ - Instances?: Instance[]; - - /** - *The ID of the account that owns the reservation.
- */ - OwnerId?: string; - - /** - *The ID of the requester that launched the instances on your behalf (for example, - * Management Console or Auto Scaling).
- */ - RequesterId?: string; - - /** - *The ID of the reservation.
- */ - ReservationId?: string; -} - -export namespace Reservation { - /** - * @internal - */ - export const filterSensitiveLog = (obj: Reservation): any => ({ - ...obj, - }); -} - -export interface DescribeInstancesResult { - /** - *Information about the reservations.
- */ - Reservations?: Reservation[]; - - /** - *The token to use to retrieve the next page of results. This value is null
- * when there are no more results to return.
The filters.
- *
- * availability-zone - The Availability Zone of the instance.
- * event.code - The code for the scheduled event
- * (instance-reboot | system-reboot |
- * system-maintenance | instance-retirement |
- * instance-stop).
- * event.description - A description of the event.
- * event.instance-event-id - The ID of the event whose date and time
- * you are modifying.
- * event.not-after - The latest end time for the scheduled event
- * (for example, 2014-09-15T17:15:20.000Z).
- * event.not-before - The earliest start time for the scheduled
- * event (for example, 2014-09-15T17:15:20.000Z).
- * event.not-before-deadline - The deadline for starting the event
- * (for example, 2014-09-15T17:15:20.000Z).
- * instance-state-code - The code for the instance state, as a
- * 16-bit unsigned integer. The high byte is used for internal purposes and should
- * be ignored. The low byte is set based on the state represented. The valid values
- * are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64
- * (stopping), and 80 (stopped).
- * instance-state-name - The state of the instance
- * (pending | running | shutting-down |
- * terminated | stopping |
- * stopped).
- * instance-status.reachability - Filters on instance status where
- * the name is reachability (passed | failed
- * | initializing | insufficient-data).
- * instance-status.status - The status of the instance
- * (ok | impaired | initializing |
- * insufficient-data | not-applicable).
- * system-status.reachability - Filters on system status where the
- * name is reachability (passed | failed |
- * initializing | insufficient-data).
- * system-status.status - The system status of the instance
- * (ok | impaired | initializing |
- * insufficient-data | not-applicable).
The instance IDs.
- *Default: Describes all your instances.
- *Constraints: Maximum 100 explicitly specified instance IDs.
- */ - InstanceIds?: string[]; - - /** - *The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another call with the returned NextToken value. This value
- * can be between 5 and 1000. You cannot specify this parameter and the instance IDs
- * parameter in the same call.
The token to retrieve the next page of results.
- */ - NextToken?: string; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
When true, includes the health status for all instances. When
- * false, includes the health status for running instances only.
Default: false
- *
Describes a scheduled event for an instance.
- */ -export interface InstanceStatusEvent { - /** - *The ID of the event.
- */ - InstanceEventId?: string; - - /** - *The event code.
- */ - Code?: EventCode | string; - - /** - *A description of the event.
- *After a scheduled event is completed, it can still be described for up to a week. If - * the event has been completed, this description starts with the following text: - * [Completed].
- */ - Description?: string; - - /** - *The latest scheduled end time for the event.
- */ - NotAfter?: Date; - - /** - *The earliest scheduled start time for the event.
- */ - NotBefore?: Date; - - /** - *The deadline for starting the event.
- */ - NotBeforeDeadline?: Date; -} - -export namespace InstanceStatusEvent { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InstanceStatusEvent): any => ({ - ...obj, - }); -} diff --git a/clients/client-ec2/models/models_3.ts b/clients/client-ec2/models/models_3.ts index ff1c8290ca9e0..7de9406b83966 100644 --- a/clients/client-ec2/models/models_3.ts +++ b/clients/client-ec2/models/models_3.ts @@ -2,17 +2,20 @@ import { ActiveInstance, ActivityStatus, AllocationStrategy, - AllowedPrincipal, AlternatePathHint, + AttachmentStatus, AttributeValue, BatchState, BlockDeviceMapping, CurrencyCodeValues, FleetLaunchTemplateSpecification, FleetType, + IamInstanceProfile, IamInstanceProfileSpecification, InternetGateway, IpPermission, + Placement, + PlatformValues, ReservedInstancesListing, ResourceType, SecurityGroupRule, @@ -28,14 +31,11 @@ import { TrunkInterfaceAssociation, UserIdGroupPair, VolumeType, - Vpc, - VpcPeeringConnection, _InstanceType, } from "./models_0"; import { ConnectionNotification, DnsEntry, - DnsNameState, GroupIdentifier, InstanceInterruptionBehavior, InstanceIpv6Address, @@ -49,13 +49,12 @@ import { NetworkInterface, NetworkInterfaceAttachment, NetworkInterfacePermission, + NetworkInterfaceStatus, PlacementGroup, PortRange, PrivateIpAddressSpecification, ReplaceRootVolumeTask, RouteTable, - ServiceConfiguration, - ServiceTypeDetail, Snapshot, SpotDatafeedSubscription, SpotInstanceStateFault, @@ -71,2508 +70,2263 @@ import { TransitGatewayRouteTable, Volume, VpcEndpoint, - VpnConnection, - VpnGateway, } from "./models_1"; import { + ArchitectureValues, AttributeBooleanValue, + BootModeValues, + CapacityReservationSpecificationResponse, + CpuOptions, + DeviceType, + ElasticGpuAssociation, + ElasticInferenceAcceleratorAssociation, + EnclaveOptions, EventInformation, Filter, + HibernationOptions, + HttpTokensState, + HypervisorType, IdFormat, - InstanceState, - InstanceStatusEvent, + InstanceBlockDeviceMapping, + InstanceLifecycleType, + InstanceMetadataEndpointState, + LicenseConfiguration, PermissionGroup, ProductCode, + StateReason, VirtualizationType, } from "./models_2"; -export type StatusName = "reachability"; - -export type StatusType = "failed" | "initializing" | "insufficient-data" | "passed"; +export type InstanceMetadataOptionsState = "applied" | "pending"; /** - *Describes the instance status.
+ *The metadata options for the instance.
*/ -export interface InstanceStatusDetails { +export interface InstanceMetadataOptionsResponse { /** - *The time when a status check failed. For an instance that was launched and impaired, - * this is the time when the instance was launched.
+ *The state of the metadata option changes.
+ *
+ * pending - The metadata options are being updated and the instance is not
+ * ready to process metadata traffic with the new selection.
+ * applied - The metadata options have been successfully applied on the
+ * instance.
The type of instance status.
+ *The state of token usage for your instance metadata requests. If the parameter is not
+ * specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata
+ * with or without a signed token header on your request. If you retrieve the IAM role
+ * credentials without a token, the version 1.0 role credentials are returned. If you
+ * retrieve the IAM role credentials using a valid signed token, the version 2.0 role
+ * credentials are returned.
If the state is required, you must send a signed token header with any
+ * instance metadata retrieval requests. In this state, retrieving the IAM role credential
+ * always returns the version 2.0 credentials; the version 1.0 credentials are not
+ * available.
The status.
+ *The desired HTTP PUT response hop limit for instance metadata requests. The larger the + * number, the further instance metadata requests can travel.
+ *Default: 1
+ *Possible values: Integers from 1 to 64
*/ - Status?: StatusType | string; + HttpPutResponseHopLimit?: number; + + /** + *This parameter enables or disables the HTTP metadata endpoint on your instances. If
+ * the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your
+ * instance metadata.
Describes the status of an instance.
+ *Describes the monitoring of an instance.
*/ -export interface InstanceStatusSummary { +export interface Monitoring { /** - *The system instance health or application instance health.
- */ - Details?: InstanceStatusDetails[]; - - /** - *The status.
+ *Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is + * enabled.
*/ - Status?: SummaryStatus | string; + State?: MonitoringState | string; } -export namespace InstanceStatusSummary { +export namespace Monitoring { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceStatusSummary): any => ({ + export const filterSensitiveLog = (obj: Monitoring): any => ({ ...obj, }); } /** - *Describes the status of an instance.
+ *Describes association information for an Elastic IP address (IPv4).
*/ -export interface InstanceStatus { +export interface InstanceNetworkInterfaceAssociation { /** - *The Availability Zone of the instance.
+ *The carrier IP address associated with the network interface.
*/ - AvailabilityZone?: string; + CarrierIp?: string; /** - *The Amazon Resource Name (ARN) of the Outpost.
+ *The ID of the owner of the Elastic IP address.
*/ - OutpostArn?: string; + IpOwnerId?: string; /** - *Any scheduled events associated with the instance.
+ *The public DNS name.
*/ - Events?: InstanceStatusEvent[]; + PublicDnsName?: string; /** - *The ID of the instance.
+ *The public IP address or Elastic IP address bound to the network interface.
*/ - InstanceId?: string; + PublicIp?: string; +} +export namespace InstanceNetworkInterfaceAssociation { /** - *The intended state of the instance. DescribeInstanceStatus requires
- * that an instance be in the running state.
Describes a network interface attachment.
+ */ +export interface InstanceNetworkInterfaceAttachment { /** - *Reports impaired functionality that stems from issues internal to the instance, such - * as impaired reachability.
+ *The time stamp when the attachment initiated.
*/ - InstanceStatus?: InstanceStatusSummary; + AttachTime?: Date; /** - *Reports impaired functionality that stems from issues related to the systems that - * support an instance, such as hardware failures and network connectivity problems.
+ *The ID of the network interface attachment.
*/ - SystemStatus?: InstanceStatusSummary; + AttachmentId?: string; + + /** + *Indicates whether the network interface is deleted when the instance is terminated.
+ */ + DeleteOnTermination?: boolean; + + /** + *The index of the device on the instance for the network interface attachment.
+ */ + DeviceIndex?: number; + + /** + *The attachment state.
+ */ + Status?: AttachmentStatus | string; + + /** + *The index of the network card.
+ */ + NetworkCardIndex?: number; } -export namespace InstanceStatus { +export namespace InstanceNetworkInterfaceAttachment { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceStatus): any => ({ + export const filterSensitiveLog = (obj: InstanceNetworkInterfaceAttachment): any => ({ ...obj, }); } -export interface DescribeInstanceStatusResult { +/** + *Describes a private IPv4 address.
+ */ +export interface InstancePrivateIpAddress { /** - *Information about the status of the instances.
+ *The association information for an Elastic IP address for the network interface.
*/ - InstanceStatuses?: InstanceStatus[]; + Association?: InstanceNetworkInterfaceAssociation; /** - *The token to use to retrieve the next page of results. This value is null
- * when there are no more results to return.
Indicates whether this IPv4 address is the primary private IP address of the network interface.
*/ - NextToken?: string; + Primary?: boolean; + + /** + *The private IPv4 DNS name.
+ */ + PrivateDnsName?: string; + + /** + *The private IPv4 address of the network interface.
+ */ + PrivateIpAddress?: string; } -export namespace DescribeInstanceStatusResult { +export namespace InstancePrivateIpAddress { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeInstanceStatusResult): any => ({ + export const filterSensitiveLog = (obj: InstancePrivateIpAddress): any => ({ ...obj, }); } -export type LocationType = "availability-zone" | "availability-zone-id" | "region"; +/** + *Describes a network interface.
+ */ +export interface InstanceNetworkInterface { + /** + *The association information for an Elastic IPv4 associated with the network + * interface.
+ */ + Association?: InstanceNetworkInterfaceAssociation; -export interface DescribeInstanceTypeOfferingsRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is
- * DryRunOperation. Otherwise, it is UnauthorizedOperation.
The network interface attachment.
*/ - DryRun?: boolean; + Attachment?: InstanceNetworkInterfaceAttachment; /** - *The location type.
+ *The description.
*/ - LocationType?: LocationType | string; + Description?: string; /** - *One or more filters. Filter names and values are case-sensitive.
- *
- * location - This depends on the location type. For example, if the location type is
- * region (default), the location is the Region code (for example, us-east-2.)
- * instance-type - The instance type. For example,
- * c5.2xlarge.
One or more security groups.
*/ - Filters?: Filter[]; + Groups?: GroupIdentifier[]; /** - *The maximum number of results to return for the request in a single page. The remaining results - * can be seen by sending another request with the next token value.
+ *One or more IPv6 addresses associated with the network interface.
*/ - MaxResults?: number; + Ipv6Addresses?: InstanceIpv6Address[]; /** - *The token to retrieve the next page of results.
+ *The MAC address.
*/ - NextToken?: string; -} + MacAddress?: string; -export namespace DescribeInstanceTypeOfferingsRequest { /** - * @internal + *The ID of the network interface.
*/ - export const filterSensitiveLog = (obj: DescribeInstanceTypeOfferingsRequest): any => ({ - ...obj, - }); -} + NetworkInterfaceId?: string; -/** - *The instance types offered.
- */ -export interface InstanceTypeOffering { /** - *The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
+ *The ID of the account that created the network interface.
*/ - InstanceType?: _InstanceType | string; + OwnerId?: string; /** - *The location type.
+ *The private DNS name.
*/ - LocationType?: LocationType | string; + PrivateDnsName?: string; /** - *The identifier for the location. This depends on the location type. For example, if the location type is
- * region, the location is the Region code (for example, us-east-2.)
The IPv4 address of the network interface within the subnet.
*/ - Location?: string; -} + PrivateIpAddress?: string; -export namespace InstanceTypeOffering { /** - * @internal + *One or more private IPv4 addresses associated with the network interface.
*/ - export const filterSensitiveLog = (obj: InstanceTypeOffering): any => ({ - ...obj, - }); -} + PrivateIpAddresses?: InstancePrivateIpAddress[]; -export interface DescribeInstanceTypeOfferingsResult { /** - *The instance types offered.
+ *Indicates whether source/destination checking is enabled.
*/ - InstanceTypeOfferings?: InstanceTypeOffering[]; + SourceDestCheck?: boolean; /** - *The token to use to retrieve the next page of results. This value is null when there
- * are no more results to return.
The status of the network interface.
*/ - NextToken?: string; -} + Status?: NetworkInterfaceStatus | string; -export namespace DescribeInstanceTypeOfferingsResult { /** - * @internal + *The ID of the subnet.
*/ - export const filterSensitiveLog = (obj: DescribeInstanceTypeOfferingsResult): any => ({ - ...obj, - }); -} + SubnetId?: string; -export interface DescribeInstanceTypesRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is
- * DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the VPC.
*/ - DryRun?: boolean; + VpcId?: string; /** - *The instance types. For more information, see Instance types in the Amazon EC2 User Guide.
+ *Describes the type of network interface.
+ *Valid values: interface | efa | trunk
+ *
One or more filters. Filter names and values are case-sensitive.
- *
- * auto-recovery-supported - Indicates whether auto recovery is supported
- * (true | false).
- * bare-metal - Indicates whether it is a bare metal instance type
- * (true | false).
- * burstable-performance-supported - Indicates whether it is a burstable
- * performance instance type (true | false).
- * current-generation - Indicates whether this instance type is the latest
- * generation instance type of an instance family (true | false).
Describes the current state of an instance.
+ */ +export interface InstanceState { + /** + *The state of the instance as a 16-bit unsigned integer.
+ *The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values + * between 256 and 65,535. These numerical values are used for internal purposes and should + * be ignored.
+ *The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values + * between 0 and 255.
+ *The valid values for instance-state-code will all be in the range of the low byte and + * they are:
+ *
- * ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline
- * bandwidth performance for an EBS-optimized instance type, in Mbps.
+ * 0 : pending
+ *
- * ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage
- * operations per second for an EBS-optimized instance type.
+ * 16 : running
+ *
- * ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline
- * throughput performance for an EBS-optimized instance type, in MB/s.
+ * 32 : shutting-down
+ *
- * ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth
- * performance for an EBS-optimized instance type, in Mbps.
+ * 48 : terminated
+ *
- * ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage
- * operations per second for an EBS-optimized instance type.
+ * 64 : stopping
+ *
- * ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum
- * throughput performance for an EBS-optimized instance type, in MB/s.
- * ebs-info.ebs-optimized-support - Indicates whether the instance type is
- * EBS-optimized (supported | unsupported |
- * default).
- * ebs-info.encryption-support - Indicates whether EBS encryption is supported
- * (supported | unsupported).
- * ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe)
- * is supported for EBS volumes (required | supported |
- * unsupported).
- * free-tier-eligible - Indicates whether the instance type is eligible to use
- * in the free tier (true | false).
- * hibernation-supported - Indicates whether On-Demand hibernation is supported
- * (true | false).
- * hypervisor - The hypervisor (nitro | xen).
- * instance-storage-info.disk.count - The number of local disks.
- * instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in
- * GB.
- * instance-storage-info.disk.type - The storage technology for the local
- * instance storage disks (hdd | ssd).
- * instance-storage-info.nvme-support - Indicates whether non-volatile memory
- * express (NVMe) is supported for instance store (required | supported)
- * | unsupported).
- * instance-storage-info.total-size-in-gb - The total amount of storage available from all local
- * instance storage, in GB.
- * instance-storage-supported - Indicates whether the instance type has local
- * instance storage (true | false).
- * instance-type - The instance type (for example c5.2xlarge or
- * c5*).
- * memory-info.size-in-mib - The memory size.
- * network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic
- * Fabric Adapters (EFAs) per instance.
- * network-info.efa-supported - Indicates whether the instance type supports
- * Elastic Fabric Adapter (EFA) (true | false).
- * network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is
- * supported or required (required | supported |
- * unsupported).
- * network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per
- * network interface.
- * network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per
- * network interface.
- * network-info.ipv6-supported - Indicates whether the instance type supports
- * IPv6 (true | false).
- * network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
- * network-info.network-performance - The network performance (for example, "25
- * Gigabit").
- * processor-info.supported-architecture - The CPU architecture
- * (arm64 | i386 | x86_64).
- * processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
- * supported-boot-mode - The boot mode (legacy-bios |
- * uefi).
- * supported-root-device-type - The root device type (ebs |
- * instance-store).
- * supported-usage-class - The usage class (on-demand |
- * spot).
- * supported-virtualization-type - The virtualization type (hvm |
- * paravirtual).
- * vcpu-info.default-cores - The default number of cores for the instance type.
- * vcpu-info.default-threads-per-core - The default number of threads per core for the instance
- * type.
- * vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
- * vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
- * vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type.
- * For example, "1" or "1,2".
+ * 80 : stopped
+ *
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in + * decimal.
*/ - Filters?: Filter[]; - - /** - *The maximum number of results to return for the request in a single page. The remaining results - * can be seen by sending another request with the next token value.
- */ - MaxResults?: number; + Code?: number; /** - *The token to retrieve the next page of results.
+ *The current state of the instance.
*/ - NextToken?: string; + Name?: InstanceStateName | string; } -export namespace DescribeInstanceTypesRequest { +export namespace InstanceState { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeInstanceTypesRequest): any => ({ + export const filterSensitiveLog = (obj: InstanceState): any => ({ ...obj, }); } /** - *Describes the optimized EBS performance for supported instance types.
+ *Describes an instance.
*/ -export interface EbsOptimizedInfo { +export interface Instance { /** - *The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
+ *The AMI launch index, which can be used to find this instance in the launch + * group.
*/ - BaselineBandwidthInMbps?: number; + AmiLaunchIndex?: number; /** - *The baseline throughput performance for an EBS-optimized instance type, in MB/s.
+ *The ID of the AMI used to launch the instance.
*/ - BaselineThroughputInMBps?: number; + ImageId?: string; /** - *The baseline input/output storage operations per seconds for an EBS-optimized instance type.
+ *The ID of the instance.
*/ - BaselineIops?: number; + InstanceId?: string; /** - *The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
+ *The instance type.
*/ - MaximumBandwidthInMbps?: number; + InstanceType?: _InstanceType | string; /** - *The maximum throughput performance for an EBS-optimized instance type, in MB/s.
+ *The kernel associated with this instance, if applicable.
*/ - MaximumThroughputInMBps?: number; + KernelId?: string; /** - *The maximum input/output storage operations per second for an EBS-optimized instance type.
+ *The name of the key pair, if this instance was launched with an associated key + * pair.
*/ - MaximumIops?: number; -} + KeyName?: string; -export namespace EbsOptimizedInfo { /** - * @internal + *The time the instance was launched.
*/ - export const filterSensitiveLog = (obj: EbsOptimizedInfo): any => ({ - ...obj, - }); -} - -export type EbsOptimizedSupport = "default" | "supported" | "unsupported"; - -export type EbsEncryptionSupport = "supported" | "unsupported"; + LaunchTime?: Date; -export enum EbsNvmeSupport { - REQUIRED = "required", - SUPPORTED = "supported", - UNSUPPORTED = "unsupported", -} + /** + *The monitoring for the instance.
+ */ + Monitoring?: Monitoring; -/** - *Describes the Amazon EBS features supported by the instance type.
- */ -export interface EbsInfo { /** - *Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized - * instances in Amazon EC2 User Guide.
+ *The location where the instance launched, if applicable.
*/ - EbsOptimizedSupport?: EbsOptimizedSupport | string; + Placement?: Placement; /** - *Indicates whether Amazon EBS encryption is supported.
+ *The value is Windows for Windows instances; otherwise blank.
Describes the optimized EBS performance for the instance type.
+ *(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname
+ * can only be used inside the Amazon EC2 network. This name is not available until the
+ * instance enters the running state.
[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS + * hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not + * using the Amazon-provided DNS server in your VPC, your custom domain name servers must + * resolve the hostname as appropriate.
*/ - EbsOptimizedInfo?: EbsOptimizedInfo; + PrivateDnsName?: string; /** - *Indicates whether non-volatile memory express (NVMe) is supported.
+ *The private IPv4 address assigned to the instance.
*/ - NvmeSupport?: EbsNvmeSupport | string; -} + PrivateIpAddress?: string; -export namespace EbsInfo { /** - * @internal + *The product codes attached to this instance, if applicable.
*/ - export const filterSensitiveLog = (obj: EbsInfo): any => ({ - ...obj, - }); -} + ProductCodes?: ProductCode[]; -/** - *Describes the memory for the FPGA accelerator for the instance type.
- */ -export interface FpgaDeviceMemoryInfo { /** - *The size of the memory available to the FPGA accelerator, in MiB.
+ *(IPv4 only) The public DNS name assigned to the instance. This name is not available
+ * until the instance enters the running state. For EC2-VPC, this name is only
+ * available if you've enabled DNS hostnames for your VPC.
The public IPv4 address, or the Carrier IP address assigned to the instance, if + * applicable.
+ *A Carrier IP address only applies to an instance launched in a subnet associated with + * a Wavelength Zone.
*/ - export const filterSensitiveLog = (obj: FpgaDeviceMemoryInfo): any => ({ - ...obj, - }); -} + PublicIpAddress?: string; -/** - *Describes the FPGA accelerator for the instance type.
- */ -export interface FpgaDeviceInfo { /** - *The name of the FPGA accelerator.
+ *The RAM disk associated with this instance, if applicable.
*/ - Name?: string; + RamdiskId?: string; /** - *The manufacturer of the FPGA accelerator.
+ *The current state of the instance.
*/ - Manufacturer?: string; + State?: InstanceState; /** - *The count of FPGA accelerators for the instance type.
+ *The reason for the most recent state transition. This might be an empty string.
*/ - Count?: number; + StateTransitionReason?: string; /** - *Describes the memory for the FPGA accelerator for the instance type.
+ *[EC2-VPC] The ID of the subnet in which the instance is running.
*/ - MemoryInfo?: FpgaDeviceMemoryInfo; -} + SubnetId?: string; -export namespace FpgaDeviceInfo { /** - * @internal + *[EC2-VPC] The ID of the VPC in which the instance is running.
*/ - export const filterSensitiveLog = (obj: FpgaDeviceInfo): any => ({ - ...obj, - }); -} + VpcId?: string; -/** - *Describes the FPGAs for the instance type.
- */ -export interface FpgaInfo { /** - *Describes the FPGAs for the instance type.
+ *The architecture of the image.
*/ - Fpgas?: FpgaDeviceInfo[]; + Architecture?: ArchitectureValues | string; /** - *The total memory of all FPGA accelerators for the instance type.
+ *Any block device mapping entries for the instance.
*/ - TotalFpgaMemoryInMiB?: number; -} + BlockDeviceMappings?: InstanceBlockDeviceMapping[]; -export namespace FpgaInfo { /** - * @internal + *The idempotency token you provided when you launched the instance, if + * applicable.
*/ - export const filterSensitiveLog = (obj: FpgaInfo): any => ({ - ...obj, - }); -} + ClientToken?: string; -/** - *Describes the memory available to the GPU accelerator.
- */ -export interface GpuDeviceMemoryInfo { /** - *The size of the memory available to the GPU accelerator, in MiB.
+ *Indicates whether the instance is optimized for Amazon EBS I/O. This optimization + * provides dedicated throughput to Amazon EBS and an optimized configuration stack to + * provide optimal I/O performance. This optimization isn't available with all instance + * types. Additional usage charges apply when using an EBS Optimized instance.
*/ - SizeInMiB?: number; -} + EbsOptimized?: boolean; -export namespace GpuDeviceMemoryInfo { /** - * @internal + *Specifies whether enhanced networking with ENA is enabled.
*/ - export const filterSensitiveLog = (obj: GpuDeviceMemoryInfo): any => ({ - ...obj, - }); -} + EnaSupport?: boolean; -/** - *Describes the GPU accelerators for the instance type.
- */ -export interface GpuDeviceInfo { /** - *The name of the GPU accelerator.
+ *The hypervisor type of the instance. The value xen is used for both Xen and
+ * Nitro hypervisors.
The manufacturer of the GPU accelerator.
+ *The IAM instance profile associated with the instance, if applicable.
*/ - Manufacturer?: string; + IamInstanceProfile?: IamInstanceProfile; /** - *The number of GPUs for the instance type.
+ *Indicates whether this is a Spot Instance or a Scheduled Instance.
*/ - Count?: number; + InstanceLifecycle?: InstanceLifecycleType | string; /** - *Describes the memory available to the GPU accelerator.
+ *The Elastic GPU associated with the instance.
*/ - MemoryInfo?: GpuDeviceMemoryInfo; -} + ElasticGpuAssociations?: ElasticGpuAssociation[]; -export namespace GpuDeviceInfo { /** - * @internal + *The elastic inference accelerator associated with the instance.
*/ - export const filterSensitiveLog = (obj: GpuDeviceInfo): any => ({ - ...obj, - }); -} + ElasticInferenceAcceleratorAssociations?: ElasticInferenceAcceleratorAssociation[]; -/** - *Describes the GPU accelerators for the instance type.
- */ -export interface GpuInfo { /** - *Describes the GPU accelerators for the instance type.
+ *[EC2-VPC] The network interfaces for the instance.
*/ - Gpus?: GpuDeviceInfo[]; + NetworkInterfaces?: InstanceNetworkInterface[]; /** - *The total size of the memory for the GPU accelerators for the instance type, in MiB.
+ *The Amazon Resource Name (ARN) of the Outpost.
*/ - TotalGpuMemoryInMiB?: number; -} + OutpostArn?: string; -export namespace GpuInfo { /** - * @internal + *The device name of the root device volume (for example,
+ * /dev/sda1).
Describes the Inference accelerators for the instance type.
- */ -export interface InferenceDeviceInfo { /** - *The number of Inference accelerators for the instance type.
+ *The root device type used by the AMI. The AMI can use an EBS volume or an instance + * store volume.
*/ - Count?: number; + RootDeviceType?: DeviceType | string; /** - *The name of the Inference accelerator.
+ *The security groups for the instance.
*/ - Name?: string; + SecurityGroups?: GroupIdentifier[]; /** - *The manufacturer of the Inference accelerator.
+ *Indicates whether source/destination checking is enabled.
*/ - Manufacturer?: string; -} + SourceDestCheck?: boolean; -export namespace InferenceDeviceInfo { /** - * @internal + *If the request is a Spot Instance request, the ID of the request.
*/ - export const filterSensitiveLog = (obj: InferenceDeviceInfo): any => ({ - ...obj, - }); -} + SpotInstanceRequestId?: string; -/** - *Describes the Inference accelerators for the instance type.
- */ -export interface InferenceAcceleratorInfo { /** - *Describes the Inference accelerators for the instance type.
+ *Specifies whether enhanced networking with the Intel 82599 Virtual Function interface + * is enabled.
*/ - Accelerators?: InferenceDeviceInfo[]; -} + SriovNetSupport?: string; -export namespace InferenceAcceleratorInfo { /** - * @internal + *The reason for the most recent state transition.
*/ - export const filterSensitiveLog = (obj: InferenceAcceleratorInfo): any => ({ - ...obj, - }); -} - -export type DiskType = "hdd" | "ssd"; + StateReason?: StateReason; -/** - *Describes the disk.
- */ -export interface DiskInfo { /** - *The size of the disk in GB.
+ *Any tags assigned to the instance.
*/ - SizeInGB?: number; + Tags?: Tag[]; /** - *The number of disks with this configuration.
+ *The virtualization type of the instance.
*/ - Count?: number; + VirtualizationType?: VirtualizationType | string; /** - *The type of disk.
+ *The CPU options for the instance.
*/ - Type?: DiskType | string; -} + CpuOptions?: CpuOptions; -export namespace DiskInfo { /** - * @internal + *The ID of the Capacity Reservation.
*/ - export const filterSensitiveLog = (obj: DiskInfo): any => ({ - ...obj, - }); -} + CapacityReservationId?: string; -export enum EphemeralNvmeSupport { - REQUIRED = "required", - SUPPORTED = "supported", - UNSUPPORTED = "unsupported", -} + /** + *Information about the Capacity Reservation targeting option.
+ */ + CapacityReservationSpecification?: CapacityReservationSpecificationResponse; -/** - *Describes the disks that are available for the instance type.
- */ -export interface InstanceStorageInfo { /** - *The total size of the disks, in GB.
+ *Indicates whether the instance is enabled for hibernation.
*/ - TotalSizeInGB?: number; + HibernationOptions?: HibernationOptions; /** - *Describes the disks that are available for the instance type.
+ *The license configurations.
*/ - Disks?: DiskInfo[]; + Licenses?: LicenseConfiguration[]; /** - *Indicates whether non-volatile memory express (NVMe) is supported for instance store.
+ *The metadata options for the instance.
*/ - NvmeSupport?: EphemeralNvmeSupport | string; -} + MetadataOptions?: InstanceMetadataOptionsResponse; -export namespace InstanceStorageInfo { /** - * @internal + *Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
*/ - export const filterSensitiveLog = (obj: InstanceStorageInfo): any => ({ - ...obj, - }); -} + EnclaveOptions?: EnclaveOptions; -/** - *Describes the memory for the instance type.
- */ -export interface MemoryInfo { /** - *The size of the memory, in MiB.
+ *The boot mode of the instance. For more information, see Boot modes in the + * Amazon EC2 User Guide.
*/ - SizeInMiB?: number; + BootMode?: BootModeValues | string; } -export namespace MemoryInfo { +export namespace Instance { /** * @internal */ - export const filterSensitiveLog = (obj: MemoryInfo): any => ({ + export const filterSensitiveLog = (obj: Instance): any => ({ ...obj, }); } /** - *Describes the Elastic Fabric Adapters for the instance type.
+ *Describes a launch request for one or more instances, and includes + * owner, requester, and security group information that applies to all + * instances in the launch request.
*/ -export interface EfaInfo { +export interface Reservation { /** - *The maximum number of Elastic Fabric Adapters for the instance type.
+ *[EC2-Classic only] The security groups.
*/ - MaximumEfaInterfaces?: number; -} + Groups?: GroupIdentifier[]; -export namespace EfaInfo { /** - * @internal + *The instances.
*/ - export const filterSensitiveLog = (obj: EfaInfo): any => ({ - ...obj, - }); -} - -export type EnaSupport = "required" | "supported" | "unsupported"; + Instances?: Instance[]; -/** - *Describes the network card support of the instance type.
- */ -export interface NetworkCardInfo { /** - *The index of the network card.
+ *The ID of the account that owns the reservation.
*/ - NetworkCardIndex?: number; + OwnerId?: string; /** - *The network performance of the network card.
+ *The ID of the requester that launched the instances on your behalf (for example, + * Management Console or Auto Scaling).
*/ - NetworkPerformance?: string; + RequesterId?: string; /** - *The maximum number of network interfaces for the network card.
+ *The ID of the reservation.
*/ - MaximumNetworkInterfaces?: number; + ReservationId?: string; } -export namespace NetworkCardInfo { +export namespace Reservation { /** * @internal */ - export const filterSensitiveLog = (obj: NetworkCardInfo): any => ({ + export const filterSensitiveLog = (obj: Reservation): any => ({ ...obj, }); } -/** - *Describes the networking features of the instance type.
- */ -export interface NetworkInfo { - /** - *The network performance.
- */ - NetworkPerformance?: string; - - /** - *The maximum number of network interfaces for the instance type.
- */ - MaximumNetworkInterfaces?: number; - - /** - *The maximum number of physical network cards that can be allocated to the instance.
- */ - MaximumNetworkCards?: number; - - /** - *The index of the default network card, starting at 0.
- */ - DefaultNetworkCardIndex?: number; - - /** - *Describes the network cards for the instance type.
- */ - NetworkCards?: NetworkCardInfo[]; - - /** - *The maximum number of IPv4 addresses per network interface.
- */ - Ipv4AddressesPerInterface?: number; - - /** - *The maximum number of IPv6 addresses per network interface.
- */ - Ipv6AddressesPerInterface?: number; - - /** - *Indicates whether IPv6 is supported.
- */ - Ipv6Supported?: boolean; - - /** - *Indicates whether Elastic Network Adapter (ENA) is supported.
- */ - EnaSupport?: EnaSupport | string; - +export interface DescribeInstancesResult { /** - *Indicates whether Elastic Fabric Adapter (EFA) is supported.
+ *Information about the reservations.
*/ - EfaSupported?: boolean; + Reservations?: Reservation[]; /** - *Describes the Elastic Fabric Adapters for the instance type.
+ *The token to use to retrieve the next page of results. This value is null
+ * when there are no more results to return.
Describes the placement group support of the instance type.
- */ -export interface PlacementGroupInfo { +export interface DescribeInstanceStatusRequest { /** - *The supported placement group types.
+ *The filters.
+ *
+ * availability-zone - The Availability Zone of the instance.
+ * event.code - The code for the scheduled event
+ * (instance-reboot | system-reboot |
+ * system-maintenance | instance-retirement |
+ * instance-stop).
+ * event.description - A description of the event.
+ * event.instance-event-id - The ID of the event whose date and time
+ * you are modifying.
+ * event.not-after - The latest end time for the scheduled event
+ * (for example, 2014-09-15T17:15:20.000Z).
+ * event.not-before - The earliest start time for the scheduled
+ * event (for example, 2014-09-15T17:15:20.000Z).
+ * event.not-before-deadline - The deadline for starting the event
+ * (for example, 2014-09-15T17:15:20.000Z).
+ * instance-state-code - The code for the instance state, as a
+ * 16-bit unsigned integer. The high byte is used for internal purposes and should
+ * be ignored. The low byte is set based on the state represented. The valid values
+ * are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64
+ * (stopping), and 80 (stopped).
+ * instance-state-name - The state of the instance
+ * (pending | running | shutting-down |
+ * terminated | stopping |
+ * stopped).
+ * instance-status.reachability - Filters on instance status where
+ * the name is reachability (passed | failed
+ * | initializing | insufficient-data).
+ * instance-status.status - The status of the instance
+ * (ok | impaired | initializing |
+ * insufficient-data | not-applicable).
+ * system-status.reachability - Filters on system status where the
+ * name is reachability (passed | failed |
+ * initializing | insufficient-data).
+ * system-status.status - The system status of the instance
+ * (ok | impaired | initializing |
+ * insufficient-data | not-applicable).
The instance IDs.
+ *Default: Describes all your instances.
+ *Constraints: Maximum 100 explicitly specified instance IDs.
*/ - export const filterSensitiveLog = (obj: PlacementGroupInfo): any => ({ - ...obj, - }); -} + InstanceIds?: string[]; -export type ArchitectureType = "arm64" | "i386" | "x86_64"; + /** + *The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another call with the returned NextToken value. This value
+ * can be between 5 and 1000. You cannot specify this parameter and the instance IDs
+ * parameter in the same call.
Describes the processor used by the instance type.
- */ -export interface ProcessorInfo { /** - *The architectures supported by the instance type.
+ *The token to retrieve the next page of results.
*/ - SupportedArchitectures?: (ArchitectureType | string)[]; + NextToken?: string; /** - *The speed of the processor, in GHz.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
When true, includes the health status for all instances. When
+ * false, includes the health status for running instances only.
Default: false
+ *
Describes the vCPU configurations for the instance type.
+ *Describes a scheduled event for an instance.
*/ -export interface VCpuInfo { +export interface InstanceStatusEvent { /** - *The default number of vCPUs for the instance type.
+ *The ID of the event.
*/ - DefaultVCpus?: number; + InstanceEventId?: string; /** - *The default number of cores for the instance type.
+ *The event code.
*/ - DefaultCores?: number; + Code?: EventCode | string; /** - *The default number of threads per core for the instance type.
+ *A description of the event.
+ *After a scheduled event is completed, it can still be described for up to a week. If + * the event has been completed, this description starts with the following text: + * [Completed].
*/ - DefaultThreadsPerCore?: number; + Description?: string; /** - *The valid number of cores that can be configured for the instance type.
+ *The latest scheduled end time for the event.
*/ - ValidCores?: number[]; + NotAfter?: Date; /** - *The valid number of threads per core that can be configured for the instance type.
+ *The earliest scheduled start time for the event.
*/ - ValidThreadsPerCore?: number[]; + NotBefore?: Date; + + /** + *The deadline for starting the event.
+ */ + NotBeforeDeadline?: Date; } -export namespace VCpuInfo { +export namespace InstanceStatusEvent { /** * @internal */ - export const filterSensitiveLog = (obj: VCpuInfo): any => ({ + export const filterSensitiveLog = (obj: InstanceStatusEvent): any => ({ ...obj, }); } +export type StatusName = "reachability"; + +export type StatusType = "failed" | "initializing" | "insufficient-data" | "passed"; + /** - *Describes the instance type.
+ *Describes the instance status.
*/ -export interface InstanceTypeInfo { +export interface InstanceStatusDetails { /** - *The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
+ *The time when a status check failed. For an instance that was launched and impaired, + * this is the time when the instance was launched.
*/ - InstanceType?: _InstanceType | string; + ImpairedSince?: Date; /** - *Indicates whether the instance type is current generation.
+ *The type of instance status.
*/ - CurrentGeneration?: boolean; + Name?: StatusName | string; /** - *Indicates whether the instance type is eligible for the free tier.
+ *The status.
*/ - FreeTierEligible?: boolean; + Status?: StatusType | string; +} +export namespace InstanceStatusDetails { /** - *Indicates whether the instance type is offered for spot or On-Demand.
+ * @internal */ - SupportedUsageClasses?: (UsageClassType | string)[]; + export const filterSensitiveLog = (obj: InstanceStatusDetails): any => ({ + ...obj, + }); +} +export type SummaryStatus = "impaired" | "initializing" | "insufficient-data" | "not-applicable" | "ok"; + +/** + *Describes the status of an instance.
+ */ +export interface InstanceStatusSummary { /** - *The supported root device types.
+ *The system instance health or application instance health.
*/ - SupportedRootDeviceTypes?: (RootDeviceType | string)[]; + Details?: InstanceStatusDetails[]; /** - *The supported virtualization types.
+ *The status.
*/ - SupportedVirtualizationTypes?: (VirtualizationType | string)[]; + Status?: SummaryStatus | string; +} +export namespace InstanceStatusSummary { /** - *Indicates whether the instance is a bare metal instance type.
+ * @internal */ - BareMetal?: boolean; + export const filterSensitiveLog = (obj: InstanceStatusSummary): any => ({ + ...obj, + }); +} +/** + *Describes the status of an instance.
+ */ +export interface InstanceStatus { /** - *The hypervisor for the instance type.
+ *The Availability Zone of the instance.
*/ - Hypervisor?: InstanceTypeHypervisor | string; + AvailabilityZone?: string; /** - *Describes the processor.
+ *The Amazon Resource Name (ARN) of the Outpost.
*/ - ProcessorInfo?: ProcessorInfo; + OutpostArn?: string; /** - *Describes the vCPU configurations for the instance type.
+ *Any scheduled events associated with the instance.
*/ - VCpuInfo?: VCpuInfo; + Events?: InstanceStatusEvent[]; /** - *Describes the memory for the instance type.
+ *The ID of the instance.
*/ - MemoryInfo?: MemoryInfo; + InstanceId?: string; /** - *Indicates whether instance storage is supported.
+ *The intended state of the instance. DescribeInstanceStatus requires
+ * that an instance be in the running state.
Describes the instance storage for the instance type.
+ *Reports impaired functionality that stems from issues internal to the instance, such + * as impaired reachability.
*/ - InstanceStorageInfo?: InstanceStorageInfo; + InstanceStatus?: InstanceStatusSummary; /** - *Describes the Amazon EBS settings for the instance type.
+ *Reports impaired functionality that stems from issues related to the systems that + * support an instance, such as hardware failures and network connectivity problems.
*/ - EbsInfo?: EbsInfo; + SystemStatus?: InstanceStatusSummary; +} +export namespace InstanceStatus { /** - *Describes the network settings for the instance type.
+ * @internal */ - NetworkInfo?: NetworkInfo; + export const filterSensitiveLog = (obj: InstanceStatus): any => ({ + ...obj, + }); +} +export interface DescribeInstanceStatusResult { /** - *Describes the GPU accelerator settings for the instance type.
+ *Information about the status of the instances.
*/ - GpuInfo?: GpuInfo; + InstanceStatuses?: InstanceStatus[]; /** - *Describes the FPGA accelerator settings for the instance type.
+ *The token to use to retrieve the next page of results. This value is null
+ * when there are no more results to return.
Describes the placement group settings for the instance type.
+ * @internal */ - PlacementGroupInfo?: PlacementGroupInfo; + export const filterSensitiveLog = (obj: DescribeInstanceStatusResult): any => ({ + ...obj, + }); +} + +export type LocationType = "availability-zone" | "availability-zone-id" | "region"; +export interface DescribeInstanceTypeOfferingsRequest { /** - *Describes the Inference accelerator settings for the instance type.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is
+ * DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether On-Demand hibernation is supported.
+ *The location type.
*/ - HibernationSupported?: boolean; + LocationType?: LocationType | string; /** - *Indicates whether the instance type is a burstable performance instance type.
+ *One or more filters. Filter names and values are case-sensitive.
+ *
+ * location - This depends on the location type. For example, if the location type is
+ * region (default), the location is the Region code (for example, us-east-2.)
+ * instance-type - The instance type. For example,
+ * c5.2xlarge.
Indicates whether Dedicated Hosts are supported on the instance type.
+ *The maximum number of results to return for the request in a single page. The remaining results + * can be seen by sending another request with the next token value.
*/ - DedicatedHostsSupported?: boolean; + MaxResults?: number; /** - *Indicates whether auto recovery is supported.
- */ - AutoRecoverySupported?: boolean; - - /** - *The supported boot modes. For more information, see Boot modes in the - * Amazon EC2 User Guide.
- */ - SupportedBootModes?: (BootModeType | string)[]; -} - -export namespace InstanceTypeInfo { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InstanceTypeInfo): any => ({ - ...obj, - }); -} - -export interface DescribeInstanceTypesResult { - /** - *The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
- */ - InstanceTypes?: InstanceTypeInfo[]; - - /** - *The token to use to retrieve the next page of results. This value is null when there
- * are no more results to return.
The token to retrieve the next page of results.
*/ NextToken?: string; } -export namespace DescribeInstanceTypesResult { +export namespace DescribeInstanceTypeOfferingsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeInstanceTypesResult): any => ({ + export const filterSensitiveLog = (obj: DescribeInstanceTypeOfferingsRequest): any => ({ ...obj, }); } -export interface DescribeInternetGatewaysRequest { - /** - *One or more filters.
- *
- * attachment.state - The current state of the attachment between the gateway
- * and the VPC (available). Present only if a VPC is attached.
- * attachment.vpc-id - The ID of an attached VPC.
- * internet-gateway-id - The ID of the Internet gateway.
- * owner-id - The ID of the AWS account that owns the internet gateway.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The instance types offered.
+ */ +export interface InstanceTypeOffering { /** - *One or more internet gateway IDs.
- *Default: Describes all your internet gateways.
+ *The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
*/ - InternetGatewayIds?: string[]; + InstanceType?: _InstanceType | string; /** - *The token for the next page of results.
+ *The location type.
*/ - NextToken?: string; + LocationType?: LocationType | string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The identifier for the location. This depends on the location type. For example, if the location type is
+ * region, the location is the Region code (for example, us-east-2.)
Information about one or more internet gateways.
+ *The instance types offered.
*/ - InternetGateways?: InternetGateway[]; + InstanceTypeOfferings?: InstanceTypeOffering[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to use to retrieve the next page of results. This value is null when there
+ * are no more results to return.
The IDs of the IPv6 address pools.
- */ - PoolIds?: string[]; - - /** - *The token for the next page of results.
- */ - NextToken?: string; - - /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
/**
- * One or more filters.
- *
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Describes a CIDR block for an address pool.
- */ -export interface PoolCidrBlock { - /** - *The CIDR block.
- */ - Cidr?: string; -} - -export namespace PoolCidrBlock { - /** - * @internal - */ - export const filterSensitiveLog = (obj: PoolCidrBlock): any => ({ - ...obj, - }); -} - -/** - *Describes an IPv6 address pool.
- */ -export interface Ipv6Pool { - /** - *The ID of the address pool.
- */ - PoolId?: string; - - /** - *The description for the address pool.
- */ - Description?: string; - - /** - *The CIDR blocks for the address pool.
- */ - PoolCidrBlocks?: PoolCidrBlock[]; - - /** - *Any tags for the address pool.
- */ - Tags?: Tag[]; -} - -export namespace Ipv6Pool { - /** - * @internal - */ - export const filterSensitiveLog = (obj: Ipv6Pool): any => ({ - ...obj, - }); -} - -export interface DescribeIpv6PoolsResult { - /** - *Information about the IPv6 address pools.
- */ - Ipv6Pools?: Ipv6Pool[]; - - /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The instance types. For more information, see Instance types in the Amazon EC2 User Guide.
*/ - export const filterSensitiveLog = (obj: DescribeIpv6PoolsResult): any => ({ - ...obj, - }); -} + InstanceTypes?: (_InstanceType | string)[]; -export interface DescribeKeyPairsRequest { /** - *The filters.
+ *One or more filters. Filter names and values are case-sensitive.
*
- * key-pair-id - The ID of the key pair.
+ * auto-recovery-supported - Indicates whether auto recovery is supported
+ * (true | false).
- * fingerprint - The fingerprint of the key pair.
bare-metal - Indicates whether it is a bare metal instance type
+ * (true | false).
*
- * key-name - The name of the key pair.
burstable-performance-supported - Indicates whether it is a burstable
+ * performance instance type (true | false).
*
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * current-generation - Indicates whether this instance type is the latest
+ * generation instance type of an instance family (true | false).
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline
+ * bandwidth performance for an EBS-optimized instance type, in Mbps.
+ * ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage
+ * operations per second for an EBS-optimized instance type.
+ * ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline
+ * throughput performance for an EBS-optimized instance type, in MB/s.
+ * ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth
+ * performance for an EBS-optimized instance type, in Mbps.
+ * ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage
+ * operations per second for an EBS-optimized instance type.
+ * ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum
+ * throughput performance for an EBS-optimized instance type, in MB/s.
+ * ebs-info.ebs-optimized-support - Indicates whether the instance type is
+ * EBS-optimized (supported | unsupported |
+ * default).
+ * ebs-info.encryption-support - Indicates whether EBS encryption is supported
+ * (supported | unsupported).
+ * ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe)
+ * is supported for EBS volumes (required | supported |
+ * unsupported).
+ * free-tier-eligible - Indicates whether the instance type is eligible to use
+ * in the free tier (true | false).
+ * hibernation-supported - Indicates whether On-Demand hibernation is supported
+ * (true | false).
+ * hypervisor - The hypervisor (nitro | xen).
+ * instance-storage-info.disk.count - The number of local disks.
+ * instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in
+ * GB.
+ * instance-storage-info.disk.type - The storage technology for the local
+ * instance storage disks (hdd | ssd).
+ * instance-storage-info.nvme-support - Indicates whether non-volatile memory
+ * express (NVMe) is supported for instance store (required | supported)
+ * | unsupported).
+ * instance-storage-info.total-size-in-gb - The total amount of storage available from all local
+ * instance storage, in GB.
+ * instance-storage-supported - Indicates whether the instance type has local
+ * instance storage (true | false).
+ * instance-type - The instance type (for example c5.2xlarge or
+ * c5*).
+ * memory-info.size-in-mib - The memory size.
+ * network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic
+ * Fabric Adapters (EFAs) per instance.
+ * network-info.efa-supported - Indicates whether the instance type supports
+ * Elastic Fabric Adapter (EFA) (true | false).
+ * network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is
+ * supported or required (required | supported |
+ * unsupported).
+ * network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per
+ * network interface.
+ * network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per
+ * network interface.
+ * network-info.ipv6-supported - Indicates whether the instance type supports
+ * IPv6 (true | false).
+ * network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
+ * network-info.network-performance - The network performance (for example, "25
+ * Gigabit").
+ * processor-info.supported-architecture - The CPU architecture
+ * (arm64 | i386 | x86_64).
+ * processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
+ * supported-boot-mode - The boot mode (legacy-bios |
+ * uefi).
+ * supported-root-device-type - The root device type (ebs |
+ * instance-store).
+ * supported-usage-class - The usage class (on-demand |
+ * spot).
+ * supported-virtualization-type - The virtualization type (hvm |
+ * paravirtual).
+ * vcpu-info.default-cores - The default number of cores for the instance type.
+ * vcpu-info.default-threads-per-core - The default number of threads per core for the instance
+ * type.
+ * vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
+ * vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
+ * vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type.
+ * For example, "1" or "1,2".
The key pair names.
- *Default: Describes all of your key pairs.
- */ - KeyNames?: string[]; - - /** - *The IDs of the key pairs.
+ *The maximum number of results to return for the request in a single page. The remaining results + * can be seen by sending another request with the next token value.
*/ - KeyPairIds?: string[]; + MaxResults?: number; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The token to retrieve the next page of results.
*/ - DryRun?: boolean; + NextToken?: string; } -export namespace DescribeKeyPairsRequest { +export namespace DescribeInstanceTypesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeKeyPairsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeInstanceTypesRequest): any => ({ ...obj, }); } /** - *Describes a key pair.
+ *Describes the optimized EBS performance for supported instance types.
*/ -export interface KeyPairInfo { +export interface EbsOptimizedInfo { /** - *The ID of the key pair.
+ *The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
*/ - KeyPairId?: string; + BaselineBandwidthInMbps?: number; /** - *If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. - * If you used ImportKeyPair to provide Amazon Web Services the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.
+ *The baseline throughput performance for an EBS-optimized instance type, in MB/s.
*/ - KeyFingerprint?: string; + BaselineThroughputInMBps?: number; /** - *The name of the key pair.
+ *The baseline input/output storage operations per seconds for an EBS-optimized instance type.
*/ - KeyName?: string; + BaselineIops?: number; /** - *Any tags applied to the key pair.
+ *The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
*/ - Tags?: Tag[]; -} + MaximumBandwidthInMbps?: number; -export namespace KeyPairInfo { /** - * @internal + *The maximum throughput performance for an EBS-optimized instance type, in MB/s.
*/ - export const filterSensitiveLog = (obj: KeyPairInfo): any => ({ - ...obj, - }); -} + MaximumThroughputInMBps?: number; -export interface DescribeKeyPairsResult { /** - *Information about the key pairs.
+ *The maximum input/output storage operations per second for an EBS-optimized instance type.
*/ - KeyPairs?: KeyPairInfo[]; + MaximumIops?: number; } -export namespace DescribeKeyPairsResult { +export namespace EbsOptimizedInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeKeyPairsResult): any => ({ + export const filterSensitiveLog = (obj: EbsOptimizedInfo): any => ({ ...obj, }); } -export interface DescribeLaunchTemplatesRequest { - /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
Describes the Amazon EBS features supported by the instance type.
+ */ +export interface EbsInfo { + /** + *Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized + * instances in Amazon EC2 User Guide.
*/ - DryRun?: boolean; + EbsOptimizedSupport?: EbsOptimizedSupport | string; /** - *One or more launch template IDs.
+ *Indicates whether Amazon EBS encryption is supported.
*/ - LaunchTemplateIds?: string[]; + EncryptionSupport?: EbsEncryptionSupport | string; /** - *One or more launch template names.
+ *Describes the optimized EBS performance for the instance type.
*/ - LaunchTemplateNames?: string[]; + EbsOptimizedInfo?: EbsOptimizedInfo; /** - *One or more filters.
- *
- * create-time - The time the launch template was created.
- * launch-template-name - The name of the launch template.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Indicates whether non-volatile memory express (NVMe) is supported.
*/ - Filters?: Filter[]; + NvmeSupport?: EbsNvmeSupport | string; +} +export namespace EbsInfo { /** - *The token to request the next page of results.
+ * @internal */ - NextToken?: string; + export const filterSensitiveLog = (obj: EbsInfo): any => ({ + ...obj, + }); +} +/** + *Describes the memory for the FPGA accelerator for the instance type.
+ */ +export interface FpgaDeviceMemoryInfo { /** - *The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another call with the returned NextToken value. This value
- * can be between 1 and 200.
The size of the memory available to the FPGA accelerator, in MiB.
*/ - MaxResults?: number; + SizeInMiB?: number; } -export namespace DescribeLaunchTemplatesRequest { +export namespace FpgaDeviceMemoryInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLaunchTemplatesRequest): any => ({ + export const filterSensitiveLog = (obj: FpgaDeviceMemoryInfo): any => ({ ...obj, }); } -export interface DescribeLaunchTemplatesResult { +/** + *Describes the FPGA accelerator for the instance type.
+ */ +export interface FpgaDeviceInfo { /** - *Information about the launch templates.
+ *The name of the FPGA accelerator.
*/ - LaunchTemplates?: LaunchTemplate[]; + Name?: string; /** - *The token to use to retrieve the next page of results. This value is
- * null when there are no more results to return.
The manufacturer of the FPGA accelerator.
*/ - NextToken?: string; + Manufacturer?: string; + + /** + *The count of FPGA accelerators for the instance type.
+ */ + Count?: number; + + /** + *Describes the memory for the FPGA accelerator for the instance type.
+ */ + MemoryInfo?: FpgaDeviceMemoryInfo; } -export namespace DescribeLaunchTemplatesResult { +export namespace FpgaDeviceInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLaunchTemplatesResult): any => ({ + export const filterSensitiveLog = (obj: FpgaDeviceInfo): any => ({ ...obj, }); } -export interface DescribeLaunchTemplateVersionsRequest { +/** + *Describes the FPGAs for the instance type.
+ */ +export interface FpgaInfo { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
Describes the FPGAs for the instance type.
*/ - DryRun?: boolean; + Fpgas?: FpgaDeviceInfo[]; /** - *The ID of the launch template. To describe one or more versions of a specified launch - * template, you must specify either the launch template ID or the launch template name in - * the request. To describe all the latest or default launch template versions in your - * account, you must omit this parameter.
+ *The total memory of all FPGA accelerators for the instance type.
*/ - LaunchTemplateId?: string; + TotalFpgaMemoryInMiB?: number; +} +export namespace FpgaInfo { /** - *The name of the launch template. To describe one or more versions of a specified - * launch template, you must specify either the launch template ID or the launch template - * name in the request. To describe all the latest or default launch template versions in - * your account, you must omit this parameter.
+ * @internal */ - LaunchTemplateName?: string; + export const filterSensitiveLog = (obj: FpgaInfo): any => ({ + ...obj, + }); +} +/** + *Describes the memory available to the GPU accelerator.
+ */ +export interface GpuDeviceMemoryInfo { /** - *One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.
- *To describe one or more versions of a specified launch template, valid values are $Latest, $Default, and numbers.
To describe all launch templates in your account that are defined as the latest
- * version, the valid value is $Latest. To describe all launch templates in
- * your account that are defined as the default version, the valid value is
- * $Default. You can specify $Latest and
- * $Default in the same call. You cannot specify numbers.
The size of the memory available to the GPU accelerator, in MiB.
*/ - Versions?: string[]; + SizeInMiB?: number; +} +export namespace GpuDeviceMemoryInfo { /** - *The version number after which to describe launch template versions.
+ * @internal */ - MinVersion?: string; + export const filterSensitiveLog = (obj: GpuDeviceMemoryInfo): any => ({ + ...obj, + }); +} +/** + *Describes the GPU accelerators for the instance type.
+ */ +export interface GpuDeviceInfo { /** - *The version number up to which to describe launch template versions.
+ *The name of the GPU accelerator.
*/ - MaxVersion?: string; + Name?: string; /** - *The token to request the next page of results.
+ *The manufacturer of the GPU accelerator.
*/ - NextToken?: string; + Manufacturer?: string; /** - *The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another call with the returned NextToken value. This value
- * can be between 1 and 200.
The number of GPUs for the instance type.
*/ - MaxResults?: number; + Count?: number; /** - *One or more filters.
- *
- * create-time - The time the launch template version was created.
- * ebs-optimized - A boolean that indicates whether the instance
- * is optimized for Amazon EBS I/O.
- * iam-instance-profile - The ARN of the IAM instance
- * profile.
- * image-id - The ID of the AMI.
- * instance-type - The instance type.
- * is-default-version - A boolean that indicates whether the
- * launch template version is the default version.
- * kernel-id - The kernel ID.
- * ram-disk-id - The RAM disk ID.
Describes the memory available to the GPU accelerator.
*/ - Filters?: Filter[]; + MemoryInfo?: GpuDeviceMemoryInfo; } -export namespace DescribeLaunchTemplateVersionsRequest { +export namespace GpuDeviceInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLaunchTemplateVersionsRequest): any => ({ + export const filterSensitiveLog = (obj: GpuDeviceInfo): any => ({ ...obj, }); } -export interface DescribeLaunchTemplateVersionsResult { +/** + *Describes the GPU accelerators for the instance type.
+ */ +export interface GpuInfo { /** - *Information about the launch template versions.
+ *Describes the GPU accelerators for the instance type.
*/ - LaunchTemplateVersions?: LaunchTemplateVersion[]; + Gpus?: GpuDeviceInfo[]; /** - *The token to use to retrieve the next page of results. This value is
- * null when there are no more results to return.
The total size of the memory for the GPU accelerators for the instance type, in MiB.
*/ - NextToken?: string; + TotalGpuMemoryInMiB?: number; } -export namespace DescribeLaunchTemplateVersionsResult { +export namespace GpuInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLaunchTemplateVersionsResult): any => ({ + export const filterSensitiveLog = (obj: GpuInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewayRouteTablesRequest { +export enum InstanceTypeHypervisor { + NITRO = "nitro", + XEN = "xen", +} + +/** + *Describes the Inference accelerators for the instance type.
+ */ +export interface InferenceDeviceInfo { /** - *The IDs of the local gateway route tables.
+ *The number of Inference accelerators for the instance type.
*/ - LocalGatewayRouteTableIds?: string[]; + Count?: number; /** - *One or more filters.
- *
- * local-gateway-id - The ID of a local gateway.
- * local-gateway-route-table-id - The ID of a local gateway route table.
- * outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
- * state - The state of the local gateway route table.
The name of the Inference accelerator.
*/ - Filters?: Filter[]; + Name?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The manufacturer of the Inference accelerator.
*/ - MaxResults?: number; + Manufacturer?: string; +} +export namespace InferenceDeviceInfo { /** - *The token for the next page of results.
+ * @internal */ - NextToken?: string; + export const filterSensitiveLog = (obj: InferenceDeviceInfo): any => ({ + ...obj, + }); +} +/** + *Describes the Inference accelerators for the instance type.
+ */ +export interface InferenceAcceleratorInfo { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes the Inference accelerators for the instance type.
*/ - DryRun?: boolean; + Accelerators?: InferenceDeviceInfo[]; } -export namespace DescribeLocalGatewayRouteTablesRequest { +export namespace InferenceAcceleratorInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTablesRequest): any => ({ + export const filterSensitiveLog = (obj: InferenceAcceleratorInfo): any => ({ ...obj, }); } +export type DiskType = "hdd" | "ssd"; + /** - *Describes a local gateway route table.
+ *Describes the disk.
*/ -export interface LocalGatewayRouteTable { +export interface DiskInfo { /** - *The ID of the local gateway route table.
+ *The size of the disk in GB.
*/ - LocalGatewayRouteTableId?: string; + SizeInGB?: number; /** - *The Amazon Resource Name (ARN) of the local gateway route table.
+ *The number of disks with this configuration.
*/ - LocalGatewayRouteTableArn?: string; + Count?: number; /** - *The ID of the local gateway.
+ *The type of disk.
*/ - LocalGatewayId?: string; + Type?: DiskType | string; +} +export namespace DiskInfo { /** - *The Amazon Resource Name (ARN) of the Outpost.
+ * @internal */ - OutpostArn?: string; + export const filterSensitiveLog = (obj: DiskInfo): any => ({ + ...obj, + }); +} + +export enum EphemeralNvmeSupport { + REQUIRED = "required", + SUPPORTED = "supported", + UNSUPPORTED = "unsupported", +} +/** + *Describes the disks that are available for the instance type.
+ */ +export interface InstanceStorageInfo { /** - *The AWS account ID that owns the local gateway route table.
+ *The total size of the disks, in GB.
*/ - OwnerId?: string; + TotalSizeInGB?: number; /** - *The state of the local gateway route table.
+ *Describes the disks that are available for the instance type.
*/ - State?: string; + Disks?: DiskInfo[]; /** - *The tags assigned to the local gateway route table.
+ *Indicates whether non-volatile memory express (NVMe) is supported for instance store.
*/ - Tags?: Tag[]; + NvmeSupport?: EphemeralNvmeSupport | string; } -export namespace LocalGatewayRouteTable { +export namespace InstanceStorageInfo { /** * @internal */ - export const filterSensitiveLog = (obj: LocalGatewayRouteTable): any => ({ + export const filterSensitiveLog = (obj: InstanceStorageInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewayRouteTablesResult { - /** - *Information about the local gateway route tables.
- */ - LocalGatewayRouteTables?: LocalGatewayRouteTable[]; - +/** + *Describes the memory for the instance type.
+ */ +export interface MemoryInfo { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The size of the memory, in MiB.
*/ - NextToken?: string; + SizeInMiB?: number; } -export namespace DescribeLocalGatewayRouteTablesResult { +export namespace MemoryInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTablesResult): any => ({ + export const filterSensitiveLog = (obj: MemoryInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest { +/** + *Describes the Elastic Fabric Adapters for the instance type.
+ */ +export interface EfaInfo { /** - *The IDs of the associations.
+ *The maximum number of Elastic Fabric Adapters for the instance type.
*/ - LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds?: string[]; + MaximumEfaInterfaces?: number; +} +export namespace EfaInfo { /** - *One or more filters.
- *
- * local-gateway-id - The ID of a local gateway.
- * local-gateway-route-table-id - The ID of the local gateway route table.
- * local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
- * local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
- * state - The state of the association.
Describes the network card support of the instance type.
+ */ +export interface NetworkCardInfo { /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The index of the network card.
*/ - MaxResults?: number; + NetworkCardIndex?: number; /** - *The token for the next page of results.
+ *The network performance of the network card.
*/ - NextToken?: string; + NetworkPerformance?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of network interfaces for the network card.
*/ - DryRun?: boolean; + MaximumNetworkInterfaces?: number; } -export namespace DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest { +export namespace NetworkCardInfo { /** * @internal */ - export const filterSensitiveLog = ( - obj: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest - ): any => ({ + export const filterSensitiveLog = (obj: NetworkCardInfo): any => ({ ...obj, }); } /** - *Describes an association between a local gateway route table and a virtual interface group.
+ *Describes the networking features of the instance type.
*/ -export interface LocalGatewayRouteTableVirtualInterfaceGroupAssociation { +export interface NetworkInfo { /** - *The ID of the association.
+ *The network performance.
*/ - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId?: string; + NetworkPerformance?: string; /** - *The ID of the virtual interface group.
+ *The maximum number of network interfaces for the instance type.
*/ - LocalGatewayVirtualInterfaceGroupId?: string; + MaximumNetworkInterfaces?: number; /** - *The ID of the local gateway.
+ *The maximum number of physical network cards that can be allocated to the instance.
*/ - LocalGatewayId?: string; + MaximumNetworkCards?: number; /** - *The ID of the local gateway route table.
+ *The index of the default network card, starting at 0.
*/ - LocalGatewayRouteTableId?: string; + DefaultNetworkCardIndex?: number; /** - *The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
+ *Describes the network cards for the instance type.
*/ - LocalGatewayRouteTableArn?: string; + NetworkCards?: NetworkCardInfo[]; /** - *The AWS account ID that owns the local gateway virtual interface group association.
+ *The maximum number of IPv4 addresses per network interface.
*/ - OwnerId?: string; + Ipv4AddressesPerInterface?: number; /** - *The state of the association.
+ *The maximum number of IPv6 addresses per network interface.
*/ - State?: string; + Ipv6AddressesPerInterface?: number; /** - *The tags assigned to the association.
+ *Indicates whether IPv6 is supported.
*/ - Tags?: Tag[]; -} + Ipv6Supported?: boolean; -export namespace LocalGatewayRouteTableVirtualInterfaceGroupAssociation { /** - * @internal + *Indicates whether Elastic Network Adapter (ENA) is supported.
*/ - export const filterSensitiveLog = (obj: LocalGatewayRouteTableVirtualInterfaceGroupAssociation): any => ({ - ...obj, - }); -} + EnaSupport?: EnaSupport | string; -export interface DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult { /** - *Information about the associations.
+ *Indicates whether Elastic Fabric Adapter (EFA) is supported.
*/ - LocalGatewayRouteTableVirtualInterfaceGroupAssociations?: LocalGatewayRouteTableVirtualInterfaceGroupAssociation[]; + EfaSupported?: boolean; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the Elastic Fabric Adapters for the instance type.
*/ - NextToken?: string; + EfaInfo?: EfaInfo; } -export namespace DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult { +export namespace NetworkInfo { /** * @internal */ - export const filterSensitiveLog = ( - obj: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult - ): any => ({ + export const filterSensitiveLog = (obj: NetworkInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewayRouteTableVpcAssociationsRequest { - /** - *The IDs of the associations.
- */ - LocalGatewayRouteTableVpcAssociationIds?: string[]; +export type PlacementGroupStrategy = "cluster" | "partition" | "spread"; +/** + *Describes the placement group support of the instance type.
+ */ +export interface PlacementGroupInfo { /** - *One or more filters.
- *
- * local-gateway-id - The ID of a local gateway.
- * local-gateway-route-table-id - The ID of the local gateway route table.
- * local-gateway-route-table-vpc-association-id - The ID of the association.
- * state - The state of the association.
- * vpc-id - The ID of the VPC.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
- */ - NextToken?: string; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The supported placement group types.
*/ - DryRun?: boolean; + SupportedStrategies?: (PlacementGroupStrategy | string)[]; } -export namespace DescribeLocalGatewayRouteTableVpcAssociationsRequest { +export namespace PlacementGroupInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTableVpcAssociationsRequest): any => ({ + export const filterSensitiveLog = (obj: PlacementGroupInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewayRouteTableVpcAssociationsResult { +export type ArchitectureType = "arm64" | "i386" | "x86_64"; + +/** + *Describes the processor used by the instance type.
+ */ +export interface ProcessorInfo { /** - *Information about the associations.
+ *The architectures supported by the instance type.
*/ - LocalGatewayRouteTableVpcAssociations?: LocalGatewayRouteTableVpcAssociation[]; + SupportedArchitectures?: (ArchitectureType | string)[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The speed of the processor, in GHz.
*/ - NextToken?: string; + SustainedClockSpeedInGhz?: number; } -export namespace DescribeLocalGatewayRouteTableVpcAssociationsResult { +export namespace ProcessorInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTableVpcAssociationsResult): any => ({ + export const filterSensitiveLog = (obj: ProcessorInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewaysRequest { +export type BootModeType = "legacy-bios" | "uefi"; + +export type RootDeviceType = "ebs" | "instance-store"; + +export type UsageClassType = "on-demand" | "spot"; + +/** + *Describes the vCPU configurations for the instance type.
+ */ +export interface VCpuInfo { /** - *One or more filters.
- *
- * local-gateway-id - The ID of a local gateway.
- * local-gateway-route-table-id - The ID of the local gateway route table.
- * local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
- * local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
- * outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
- * state - The state of the association.
The default number of vCPUs for the instance type.
*/ - LocalGatewayIds?: string[]; + DefaultVCpus?: number; /** - *One or more filters.
+ *The default number of cores for the instance type.
*/ - Filters?: Filter[]; + DefaultCores?: number; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The default number of threads per core for the instance type.
*/ - MaxResults?: number; + DefaultThreadsPerCore?: number; /** - *The token for the next page of results.
+ *The valid number of cores that can be configured for the instance type.
*/ - NextToken?: string; + ValidCores?: number[]; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The valid number of threads per core that can be configured for the instance type.
*/ - DryRun?: boolean; + ValidThreadsPerCore?: number[]; } -export namespace DescribeLocalGatewaysRequest { +export namespace VCpuInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLocalGatewaysRequest): any => ({ + export const filterSensitiveLog = (obj: VCpuInfo): any => ({ ...obj, }); } /** - *Describes a local gateway.
+ *Describes the instance type.
*/ -export interface LocalGateway { +export interface InstanceTypeInfo { /** - *The ID of the local gateway.
+ *The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
*/ - LocalGatewayId?: string; + InstanceType?: _InstanceType | string; /** - *The Amazon Resource Name (ARN) of the Outpost.
+ *Indicates whether the instance type is current generation.
*/ - OutpostArn?: string; + CurrentGeneration?: boolean; /** - *The AWS account ID that owns the local gateway.
+ *Indicates whether the instance type is eligible for the free tier.
*/ - OwnerId?: string; + FreeTierEligible?: boolean; /** - *The state of the local gateway.
+ *Indicates whether the instance type is offered for spot or On-Demand.
*/ - State?: string; + SupportedUsageClasses?: (UsageClassType | string)[]; /** - *The tags assigned to the local gateway.
+ *The supported root device types.
*/ - Tags?: Tag[]; -} + SupportedRootDeviceTypes?: (RootDeviceType | string)[]; -export namespace LocalGateway { /** - * @internal + *The supported virtualization types.
*/ - export const filterSensitiveLog = (obj: LocalGateway): any => ({ - ...obj, - }); -} + SupportedVirtualizationTypes?: (VirtualizationType | string)[]; -export interface DescribeLocalGatewaysResult { /** - *Information about the local gateways.
+ *Indicates whether the instance is a bare metal instance type.
*/ - LocalGateways?: LocalGateway[]; + BareMetal?: boolean; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The hypervisor for the instance type.
*/ - NextToken?: string; -} + Hypervisor?: InstanceTypeHypervisor | string; -export namespace DescribeLocalGatewaysResult { /** - * @internal + *Describes the processor.
*/ - export const filterSensitiveLog = (obj: DescribeLocalGatewaysResult): any => ({ - ...obj, - }); -} + ProcessorInfo?: ProcessorInfo; -export interface DescribeLocalGatewayVirtualInterfaceGroupsRequest { /** - *The IDs of the virtual interface groups.
+ *Describes the vCPU configurations for the instance type.
*/ - LocalGatewayVirtualInterfaceGroupIds?: string[]; + VCpuInfo?: VCpuInfo; /** - *One or more filters.
- *
- * local-gateway-id - The ID of a local gateway.
- * local-gateway-virtual-interface-id - The ID of the virtual interface.
- * local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
Describes the memory for the instance type.
*/ - Filters?: Filter[]; + MemoryInfo?: MemoryInfo; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Indicates whether instance storage is supported.
*/ - MaxResults?: number; + InstanceStorageSupported?: boolean; /** - *The token for the next page of results.
+ *Describes the instance storage for the instance type.
*/ - NextToken?: string; + InstanceStorageInfo?: InstanceStorageInfo; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes the Amazon EBS settings for the instance type.
*/ - DryRun?: boolean; -} + EbsInfo?: EbsInfo; -export namespace DescribeLocalGatewayVirtualInterfaceGroupsRequest { /** - * @internal + *Describes the network settings for the instance type.
*/ - export const filterSensitiveLog = (obj: DescribeLocalGatewayVirtualInterfaceGroupsRequest): any => ({ - ...obj, - }); -} + NetworkInfo?: NetworkInfo; -/** - *Describes a local gateway virtual interface group.
- */ -export interface LocalGatewayVirtualInterfaceGroup { /** - *The ID of the virtual interface group.
+ *Describes the GPU accelerator settings for the instance type.
*/ - LocalGatewayVirtualInterfaceGroupId?: string; + GpuInfo?: GpuInfo; /** - *The IDs of the virtual interfaces.
+ *Describes the FPGA accelerator settings for the instance type.
*/ - LocalGatewayVirtualInterfaceIds?: string[]; + FpgaInfo?: FpgaInfo; /** - *The ID of the local gateway.
+ *Describes the placement group settings for the instance type.
*/ - LocalGatewayId?: string; + PlacementGroupInfo?: PlacementGroupInfo; /** - *The AWS account ID that owns the local gateway virtual interface group.
+ *Describes the Inference accelerator settings for the instance type.
*/ - OwnerId?: string; + InferenceAcceleratorInfo?: InferenceAcceleratorInfo; /** - *The tags assigned to the virtual interface group.
+ *Indicates whether On-Demand hibernation is supported.
*/ - Tags?: Tag[]; -} + HibernationSupported?: boolean; -export namespace LocalGatewayVirtualInterfaceGroup { /** - * @internal + *Indicates whether the instance type is a burstable performance instance type.
*/ - export const filterSensitiveLog = (obj: LocalGatewayVirtualInterfaceGroup): any => ({ - ...obj, - }); -} + BurstablePerformanceSupported?: boolean; -export interface DescribeLocalGatewayVirtualInterfaceGroupsResult { /** - *The virtual interface groups.
+ *Indicates whether Dedicated Hosts are supported on the instance type.
*/ - LocalGatewayVirtualInterfaceGroups?: LocalGatewayVirtualInterfaceGroup[]; + DedicatedHostsSupported?: boolean; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Indicates whether auto recovery is supported.
*/ - NextToken?: string; + AutoRecoverySupported?: boolean; + + /** + *The supported boot modes. For more information, see Boot modes in the + * Amazon EC2 User Guide.
+ */ + SupportedBootModes?: (BootModeType | string)[]; } -export namespace DescribeLocalGatewayVirtualInterfaceGroupsResult { +export namespace InstanceTypeInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLocalGatewayVirtualInterfaceGroupsResult): any => ({ + export const filterSensitiveLog = (obj: InstanceTypeInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewayVirtualInterfacesRequest { - /** - *The IDs of the virtual interfaces.
- */ - LocalGatewayVirtualInterfaceIds?: string[]; - - /** - *One or more filters.
- */ - Filters?: Filter[]; - +export interface DescribeInstanceTypesResult { /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
*/ - MaxResults?: number; + InstanceTypes?: InstanceTypeInfo[]; /** - *The token for the next page of results.
+ *The token to use to retrieve the next page of results. This value is null when there
+ * are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes a local gateway virtual interface.
- */ -export interface LocalGatewayVirtualInterface { - /** - *The ID of the virtual interface.
- */ - LocalGatewayVirtualInterfaceId?: string; - +export interface DescribeInternetGatewaysRequest { /** - *The ID of the local gateway.
+ *One or more filters.
+ *
+ * attachment.state - The current state of the attachment between the gateway
+ * and the VPC (available). Present only if a VPC is attached.
+ * attachment.vpc-id - The ID of an attached VPC.
+ * internet-gateway-id - The ID of the Internet gateway.
+ * owner-id - The ID of the AWS account that owns the internet gateway.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The ID of the VLAN.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The local address.
+ *One or more internet gateway IDs.
+ *Default: Describes all your internet gateways.
*/ - LocalAddress?: string; + InternetGatewayIds?: string[]; /** - *The peer address.
+ *The token for the next page of results.
*/ - PeerAddress?: string; + NextToken?: string; /** - *The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The peer BGP ASN.
+ * @internal */ - PeerBgpAsn?: number; + export const filterSensitiveLog = (obj: DescribeInternetGatewaysRequest): any => ({ + ...obj, + }); +} +export interface DescribeInternetGatewaysResult { /** - *The AWS account ID that owns the local gateway virtual interface.
+ *Information about one or more internet gateways.
*/ - OwnerId?: string; + InternetGateways?: InternetGateway[]; /** - *The tags assigned to the virtual interface.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the virtual interfaces.
+ *The IDs of the IPv6 address pools.
*/ - LocalGatewayVirtualInterfaces?: LocalGatewayVirtualInterface[]; + PoolIds?: string[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token for the next page of results.
*/ NextToken?: string; -} -export namespace DescribeLocalGatewayVirtualInterfacesResult { /** - * @internal + *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -2584,148 +2338,86 @@ export interface DescribeManagedPrefixListsRequest {
*
One or more filters.
*
- * owner-id - The ID of the prefix list owner.
- * prefix-list-id - The ID of the prefix list.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * prefix-list-name - The name of the prefix list.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
- */ - NextToken?: string; - - /** - *One or more prefix list IDs.
- */ - PrefixListIds?: string[]; } -export namespace DescribeManagedPrefixListsRequest { +export namespace DescribeIpv6PoolsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeManagedPrefixListsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeIpv6PoolsRequest): any => ({ ...obj, }); } -export interface DescribeManagedPrefixListsResult { - /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes a CIDR block for an address pool.
+ */ +export interface PoolCidrBlock { /** - *Information about the prefix lists.
+ *The CIDR block.
*/ - PrefixLists?: ManagedPrefixList[]; + Cidr?: string; } -export namespace DescribeManagedPrefixListsResult { +export namespace PoolCidrBlock { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeManagedPrefixListsResult): any => ({ + export const filterSensitiveLog = (obj: PoolCidrBlock): any => ({ ...obj, }); } -export interface DescribeMovingAddressesRequest { - /** - *One or more filters.
- *
- * moving-status - The status of the Elastic IP address
- * (MovingToVpc | RestoringToClassic).
Describes an IPv6 address pool.
+ */ +export interface Ipv6Pool { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the address pool.
*/ - DryRun?: boolean; + PoolId?: string; /** - *The maximum number of results to return for the request in a single page. The remaining
- * results of the initial request can be seen by sending another request with the returned
- * NextToken value. This value can be between 5 and 1000; if
- * MaxResults is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
+ *The description for the address pool.
*/ - MaxResults?: number; + Description?: string; /** - *The token for the next page of results.
+ *The CIDR blocks for the address pool.
*/ - NextToken?: string; + PoolCidrBlocks?: PoolCidrBlock[]; /** - *One or more Elastic IP addresses.
+ *Any tags for the address pool.
*/ - PublicIps?: string[]; + Tags?: Tag[]; } -export namespace DescribeMovingAddressesRequest { +export namespace Ipv6Pool { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeMovingAddressesRequest): any => ({ + export const filterSensitiveLog = (obj: Ipv6Pool): any => ({ ...obj, }); } -export type MoveStatus = "movingToVpc" | "restoringToClassic"; - -/** - *Describes the status of a moving Elastic IP address.
- */ -export interface MovingAddressStatus { - /** - *The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.
- */ - MoveStatus?: MoveStatus | string; - - /** - *The Elastic IP address.
- */ - PublicIp?: string; -} - -export namespace MovingAddressStatus { - /** - * @internal - */ - export const filterSensitiveLog = (obj: MovingAddressStatus): any => ({ - ...obj, - }); -} - -export interface DescribeMovingAddressesResult { +export interface DescribeIpv6PoolsResult { /** - *The status for each Elastic IP address.
+ *Information about the IPv6 address pools.
*/ - MovingAddressStatuses?: MovingAddressStatus[]; + Ipv6Pools?: Ipv6Pool[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more filters.
+ *The filters.
*
- * nat-gateway-id - The ID of the NAT gateway.
+ * key-pair-id - The ID of the key pair.
- * state - The state of the NAT gateway (pending |
- * failed | available | deleting | deleted).
fingerprint - The fingerprint of the key pair.
*
- * subnet-id - The ID of the subnet in which the NAT gateway resides.
key-name - The name of the key pair.
*
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ *
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * vpc-id - The ID of the VPC in which the NAT gateway resides.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
One or more NAT gateway IDs.
- */ - NatGatewayIds?: string[]; - - /** - *The token for the next page of results.
- */ - NextToken?: string; -} + Filters?: Filter[]; -export namespace DescribeNatGatewaysRequest { /** - * @internal + *The key pair names.
+ *Default: Describes all of your key pairs.
*/ - export const filterSensitiveLog = (obj: DescribeNatGatewaysRequest): any => ({ - ...obj, - }); -} + KeyNames?: string[]; -export interface DescribeNatGatewaysResult { /** - *Information about the NAT gateways.
+ *The IDs of the key pairs.
*/ - NatGateways?: NatGateway[]; + KeyPairIds?: string[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters.
- *
- * association.association-id - The ID of an association ID for the ACL.
- * association.network-acl-id - The ID of the network ACL involved in the association.
- * association.subnet-id - The ID of the subnet involved in the association.
- * default - Indicates whether the ACL is the default network ACL for the VPC.
- * entry.cidr - The IPv4 CIDR range specified in the entry.
- * entry.icmp.code - The ICMP code specified in the entry, if any.
- * entry.icmp.type - The ICMP type specified in the entry, if any.
- * entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
- * entry.port-range.from - The start of the port range specified in the entry.
- * entry.port-range.to - The end of the port range specified in the entry.
- * entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
- * entry.rule-action - Allows or denies the matching traffic (allow | deny).
- * entry.rule-number - The number of an entry (in other words, rule) in
- * the set of ACL entries.
- * network-acl-id - The ID of the network ACL.
- * owner-id - The ID of the AWS account that owns the network ACL.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * vpc-id - The ID of the VPC for the network ACL.
Describes a key pair.
+ */ +export interface KeyPairInfo { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the key pair.
*/ - DryRun?: boolean; + KeyPairId?: string; /** - *One or more network ACL IDs.
- *Default: Describes all your network ACLs.
+ *If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. + * If you used ImportKeyPair to provide Amazon Web Services the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.
*/ - NetworkAclIds?: string[]; + KeyFingerprint?: string; /** - *The token for the next page of results.
+ *The name of the key pair.
*/ - NextToken?: string; + KeyName?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Any tags applied to the key pair.
*/ - MaxResults?: number; + Tags?: Tag[]; } -export namespace DescribeNetworkAclsRequest { +export namespace KeyPairInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeNetworkAclsRequest): any => ({ + export const filterSensitiveLog = (obj: KeyPairInfo): any => ({ ...obj, }); } -export interface DescribeNetworkAclsResult { - /** - *Information about one or more network ACLs.
- */ - NetworkAcls?: NetworkAcl[]; - +export interface DescribeKeyPairsResult { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the key pairs.
*/ - NextToken?: string; + KeyPairs?: KeyPairInfo[]; } -export namespace DescribeNetworkAclsResult { +export namespace DescribeKeyPairsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeNetworkAclsResult): any => ({ + export const filterSensitiveLog = (obj: DescribeKeyPairsResult): any => ({ ...obj, }); } -export interface DescribeNetworkInsightsAnalysesRequest { +export interface DescribeLaunchTemplatesRequest { /** - *The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The ID of the path. You must specify either a path ID or analysis IDs.
+ *One or more launch template IDs.
*/ - NetworkInsightsPathId?: string; + LaunchTemplateIds?: string[]; /** - *The time when the network insights analyses started.
+ *One or more launch template names.
*/ - AnalysisStartTime?: Date; + LaunchTemplateNames?: string[]; /** - *The time when the network insights analyses ended.
- */ - AnalysisEndTime?: Date; - - /** - *The filters. The following are possible values:
- *One or more filters.
+ *PathFound - A Boolean value that indicates whether a feasible path is found.
+ *
+ * create-time - The time the launch template was created.
Status - The status of the analysis (running | succeeded | failed).
+ *
+ * launch-template-name - The name of the launch template.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The token to request the next page of results.
*/ - DryRun?: boolean; + NextToken?: string; /** - *The token for the next page of results.
+ *The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another call with the returned NextToken value. This value
+ * can be between 1 and 200.
Describes a path component.
- */ -export interface AnalysisComponent { +export interface DescribeLaunchTemplatesResult { /** - *The ID of the component.
+ *Information about the launch templates.
*/ - Id?: string; + LaunchTemplates?: LaunchTemplate[]; /** - *The Amazon Resource Name (ARN) of the component.
+ *The token to use to retrieve the next page of results. This value is
+ * null when there are no more results to return.
Describes a network access control (ACL) rule.
- */ -export interface AnalysisAclRule { +export interface DescribeLaunchTemplateVersionsRequest { /** - *The IPv4 address range, in CIDR notation.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Indicates whether the rule is an outbound rule.
+ *The ID of the launch template. To describe one or more versions of a specified launch + * template, you must specify either the launch template ID or the launch template name in + * the request. To describe all the latest or default launch template versions in your + * account, you must omit this parameter.
*/ - Egress?: boolean; + LaunchTemplateId?: string; /** - *The range of ports.
+ *The name of the launch template. To describe one or more versions of a specified + * launch template, you must specify either the launch template ID or the launch template + * name in the request. To describe all the latest or default launch template versions in + * your account, you must omit this parameter.
*/ - PortRange?: PortRange; + LaunchTemplateName?: string; /** - *The protocol.
+ *One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.
+ *To describe one or more versions of a specified launch template, valid values are $Latest, $Default, and numbers.
To describe all launch templates in your account that are defined as the latest
+ * version, the valid value is $Latest. To describe all launch templates in
+ * your account that are defined as the default version, the valid value is
+ * $Default. You can specify $Latest and
+ * $Default in the same call. You cannot specify numbers.
Indicates whether to allow or deny traffic that matches the rule.
+ *The version number after which to describe launch template versions.
*/ - RuleAction?: string; + MinVersion?: string; /** - *The rule number.
+ *The version number up to which to describe launch template versions.
*/ - RuleNumber?: number; + MaxVersion?: string; + + /** + *The token to request the next page of results.
+ */ + NextToken?: string; + + /** + *The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another call with the returned NextToken value. This value
+ * can be between 1 and 200.
One or more filters.
+ *
+ * create-time - The time the launch template version was created.
+ * ebs-optimized - A boolean that indicates whether the instance
+ * is optimized for Amazon EBS I/O.
+ * iam-instance-profile - The ARN of the IAM instance
+ * profile.
+ * image-id - The ID of the AMI.
+ * instance-type - The instance type.
+ * is-default-version - A boolean that indicates whether the
+ * launch template version is the default version.
+ * kernel-id - The kernel ID.
+ * ram-disk-id - The RAM disk ID.
Describes a load balancer listener.
- */ -export interface AnalysisLoadBalancerListener { +export interface DescribeLaunchTemplateVersionsResult { /** - *The port on which the load balancer is listening.
+ *Information about the launch template versions.
*/ - LoadBalancerPort?: number; + LaunchTemplateVersions?: LaunchTemplateVersion[]; /** - *[Classic Load Balancers] The back-end port for the listener.
+ *The token to use to retrieve the next page of results. This value is
+ * null when there are no more results to return.
Describes a load balancer target.
- */ -export interface AnalysisLoadBalancerTarget { +export interface DescribeLocalGatewayRouteTablesRequest { /** - *The IP address.
+ *The IDs of the local gateway route tables.
*/ - Address?: string; + LocalGatewayRouteTableIds?: string[]; /** - *The Availability Zone.
+ *One or more filters.
+ *
+ * local-gateway-id - The ID of a local gateway.
+ * local-gateway-route-table-id - The ID of a local gateway route table.
+ * outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
+ * state - The state of the local gateway route table.
Information about the instance.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The port on which the target is listening.
+ *The token for the next page of results.
*/ - Port?: number; + NextToken?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a route table route.
+ *Describes a local gateway route table.
*/ -export interface AnalysisRouteTableRoute { +export interface LocalGatewayRouteTable { /** - *The destination IPv4 address, in CIDR notation.
+ *The ID of the local gateway route table.
*/ - DestinationCidr?: string; + LocalGatewayRouteTableId?: string; /** - *The prefix of the AWS service.
+ *The Amazon Resource Name (ARN) of the local gateway route table.
*/ - DestinationPrefixListId?: string; + LocalGatewayRouteTableArn?: string; /** - *The ID of an egress-only internet gateway.
+ *The ID of the local gateway.
*/ - EgressOnlyInternetGatewayId?: string; + LocalGatewayId?: string; /** - *The ID of the gateway, such as an internet gateway or virtual private gateway.
+ *The Amazon Resource Name (ARN) of the Outpost.
*/ - GatewayId?: string; + OutpostArn?: string; /** - *The ID of the instance, such as a NAT instance.
+ *The AWS account ID that owns the local gateway route table.
*/ - InstanceId?: string; + OwnerId?: string; /** - *The ID of a NAT gateway.
+ *The state of the local gateway route table.
*/ - NatGatewayId?: string; + State?: string; /** - *The ID of a network interface.
+ *The tags assigned to the local gateway route table.
*/ - NetworkInterfaceId?: string; + Tags?: Tag[]; +} +export namespace LocalGatewayRouteTable { /** - *Describes how the route was created. The following are possible values:
- *
- * CreateRouteTable - The route was automatically created when the route table was created.
- * CreateRoute - The route was manually added to the route table.
- * EnableVgwRoutePropagation - The route was propagated by route propagation.
The ID of a transit gateway.
+ *Information about the local gateway route tables.
*/ - TransitGatewayId?: string; + LocalGatewayRouteTables?: LocalGatewayRouteTable[]; /** - *The ID of a VPC peering connection.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes a security group rule.
- */ -export interface AnalysisSecurityGroupRule { +export interface DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest { /** - *The IPv4 address range, in CIDR notation.
+ *The IDs of the associations.
*/ - Cidr?: string; + LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds?: string[]; /** - *The direction. The following are possible values:
+ *One or more filters.
*egress
+ *
+ * local-gateway-id - The ID of a local gateway.
ingress
+ *
+ * local-gateway-route-table-id - The ID of the local gateway route table.
+ * local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
+ * local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
+ * state - The state of the association.
The security group ID.
- */ - SecurityGroupId?: string; + Filters?: Filter[]; /** - *The port range.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The prefix list ID.
+ *The token for the next page of results.
*/ - PrefixListId?: string; + NextToken?: string; /** - *The protocol name.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes.
+ *Describes an association between a local gateway route table and a virtual interface group.
*/ -export interface Explanation { - /** - *The network ACL.
- */ - Acl?: AnalysisComponent; - +export interface LocalGatewayRouteTableVirtualInterfaceGroupAssociation { /** - *The network ACL rule.
+ *The ID of the association.
*/ - AclRule?: AnalysisAclRule; + LocalGatewayRouteTableVirtualInterfaceGroupAssociationId?: string; /** - *The IPv4 address, in CIDR notation.
+ *The ID of the virtual interface group.
*/ - Address?: string; + LocalGatewayVirtualInterfaceGroupId?: string; /** - *The IPv4 addresses, in CIDR notation.
+ *The ID of the local gateway.
*/ - Addresses?: string[]; + LocalGatewayId?: string; /** - *The resource to which the component is attached.
+ *The ID of the local gateway route table.
*/ - AttachedTo?: AnalysisComponent; + LocalGatewayRouteTableId?: string; /** - *The Availability Zones.
+ *The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
*/ - AvailabilityZones?: string[]; + LocalGatewayRouteTableArn?: string; /** - *The CIDR ranges.
+ *The AWS account ID that owns the local gateway virtual interface group association.
*/ - Cidrs?: string[]; + OwnerId?: string; /** - *The component.
+ *The state of the association.
*/ - Component?: AnalysisComponent; + State?: string; /** - *The customer gateway.
+ *The tags assigned to the association.
*/ - CustomerGateway?: AnalysisComponent; + Tags?: Tag[]; +} +export namespace LocalGatewayRouteTableVirtualInterfaceGroupAssociation { /** - *The destination.
+ * @internal */ - Destination?: AnalysisComponent; + export const filterSensitiveLog = (obj: LocalGatewayRouteTableVirtualInterfaceGroupAssociation): any => ({ + ...obj, + }); +} +export interface DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult { /** - *The destination VPC.
+ *Information about the associations.
*/ - DestinationVpc?: AnalysisComponent; + LocalGatewayRouteTableVirtualInterfaceGroupAssociations?: LocalGatewayRouteTableVirtualInterfaceGroupAssociation[]; /** - *The direction. The following are possible values:
- *egress
- *ingress
- *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The explanation code.
+ * @internal */ - ExplanationCode?: string; + export const filterSensitiveLog = ( + obj: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult + ): any => ({ + ...obj, + }); +} +export interface DescribeLocalGatewayRouteTableVpcAssociationsRequest { /** - *The route table.
+ *The IDs of the associations.
*/ - IngressRouteTable?: AnalysisComponent; + LocalGatewayRouteTableVpcAssociationIds?: string[]; /** - *The internet gateway.
+ *One or more filters.
+ *
+ * local-gateway-id - The ID of a local gateway.
+ * local-gateway-route-table-id - The ID of the local gateway route table.
+ * local-gateway-route-table-vpc-association-id - The ID of the association.
+ * state - The state of the association.
+ * vpc-id - The ID of the VPC.
The Amazon Resource Name (ARN) of the load balancer.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The listener for a Classic Load Balancer.
+ *The token for the next page of results.
*/ - ClassicLoadBalancerListener?: AnalysisLoadBalancerListener; + NextToken?: string; /** - *The listener port of the load balancer.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The target.
+ * @internal */ - LoadBalancerTarget?: AnalysisLoadBalancerTarget; + export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTableVpcAssociationsRequest): any => ({ + ...obj, + }); +} +export interface DescribeLocalGatewayRouteTableVpcAssociationsResult { /** - *The target group.
+ *Information about the associations.
*/ - LoadBalancerTargetGroup?: AnalysisComponent; + LocalGatewayRouteTableVpcAssociations?: LocalGatewayRouteTableVpcAssociation[]; /** - *The target groups.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The target port.
+ * @internal */ - LoadBalancerTargetPort?: number; + export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTableVpcAssociationsResult): any => ({ + ...obj, + }); +} +export interface DescribeLocalGatewaysRequest { /** - *The load balancer listener.
- */ - ElasticLoadBalancerListener?: AnalysisComponent; - - /** - *The missing component.
- */ - MissingComponent?: string; - - /** - *The NAT gateway.
- */ - NatGateway?: AnalysisComponent; - - /** - *The network interface.
+ *One or more filters.
+ *
+ * local-gateway-id - The ID of a local gateway.
+ * local-gateway-route-table-id - The ID of the local gateway route table.
+ * local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
+ * local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
+ * outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
+ * state - The state of the association.
The packet field.
+ *One or more filters.
*/ - PacketField?: string; + Filters?: Filter[]; /** - *The VPC peering connection.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The port.
+ *The token for the next page of results.
*/ - Port?: number; + NextToken?: string; /** - *The port ranges.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The prefix list.
+ * @internal */ - PrefixList?: AnalysisComponent; + export const filterSensitiveLog = (obj: DescribeLocalGatewaysRequest): any => ({ + ...obj, + }); +} +/** + *Describes a local gateway.
+ */ +export interface LocalGateway { /** - *The protocols.
+ *The ID of the local gateway.
*/ - Protocols?: string[]; + LocalGatewayId?: string; /** - *The route table route.
+ *The Amazon Resource Name (ARN) of the Outpost.
*/ - RouteTableRoute?: AnalysisRouteTableRoute; + OutpostArn?: string; /** - *The route table.
+ *The AWS account ID that owns the local gateway.
*/ - RouteTable?: AnalysisComponent; + OwnerId?: string; /** - *The security group.
+ *The state of the local gateway.
*/ - SecurityGroup?: AnalysisComponent; + State?: string; /** - *The security group rule.
+ *The tags assigned to the local gateway.
*/ - SecurityGroupRule?: AnalysisSecurityGroupRule; + Tags?: Tag[]; +} +export namespace LocalGateway { /** - *The security groups.
+ * @internal */ - SecurityGroups?: AnalysisComponent[]; + export const filterSensitiveLog = (obj: LocalGateway): any => ({ + ...obj, + }); +} +export interface DescribeLocalGatewaysResult { /** - *The source VPC.
+ *Information about the local gateways.
*/ - SourceVpc?: AnalysisComponent; + LocalGateways?: LocalGateway[]; /** - *The state.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The subnet.
+ * @internal */ - Subnet?: AnalysisComponent; + export const filterSensitiveLog = (obj: DescribeLocalGatewaysResult): any => ({ + ...obj, + }); +} +export interface DescribeLocalGatewayVirtualInterfaceGroupsRequest { /** - *The route table for the subnet.
+ *The IDs of the virtual interface groups.
*/ - SubnetRouteTable?: AnalysisComponent; + LocalGatewayVirtualInterfaceGroupIds?: string[]; /** - *The component VPC.
+ *One or more filters.
+ *
+ * local-gateway-id - The ID of a local gateway.
+ * local-gateway-virtual-interface-id - The ID of the virtual interface.
+ * local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
The VPC endpoint.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The VPN connection.
+ *The token for the next page of results.
*/ - VpnConnection?: AnalysisComponent; + NextToken?: string; /** - *The VPN gateway.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a header. Reflects any changes made by a component as traffic passes through. - * The fields of an inbound header are null except for the first component of a path.
+ *Describes a local gateway virtual interface group.
*/ -export interface AnalysisPacketHeader { +export interface LocalGatewayVirtualInterfaceGroup { /** - *The destination addresses.
+ *The ID of the virtual interface group.
*/ - DestinationAddresses?: string[]; + LocalGatewayVirtualInterfaceGroupId?: string; /** - *The destination port ranges.
+ *The IDs of the virtual interfaces.
*/ - DestinationPortRanges?: PortRange[]; + LocalGatewayVirtualInterfaceIds?: string[]; /** - *The protocol.
+ *The ID of the local gateway.
*/ - Protocol?: string; + LocalGatewayId?: string; /** - *The source addresses.
+ *The AWS account ID that owns the local gateway virtual interface group.
*/ - SourceAddresses?: string[]; + OwnerId?: string; /** - *The source port ranges.
+ *The tags assigned to the virtual interface group.
*/ - SourcePortRanges?: PortRange[]; + Tags?: Tag[]; } -export namespace AnalysisPacketHeader { +export namespace LocalGatewayVirtualInterfaceGroup { /** * @internal */ - export const filterSensitiveLog = (obj: AnalysisPacketHeader): any => ({ + export const filterSensitiveLog = (obj: LocalGatewayVirtualInterfaceGroup): any => ({ ...obj, }); } -/** - *Describes a path component.
- */ -export interface PathComponent { +export interface DescribeLocalGatewayVirtualInterfaceGroupsResult { /** - *The sequence number.
+ *The virtual interface groups.
*/ - SequenceNumber?: number; + LocalGatewayVirtualInterfaceGroups?: LocalGatewayVirtualInterfaceGroup[]; /** - *The network ACL rule.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The component.
+ * @internal */ - Component?: AnalysisComponent; + export const filterSensitiveLog = (obj: DescribeLocalGatewayVirtualInterfaceGroupsResult): any => ({ + ...obj, + }); +} +export interface DescribeLocalGatewayVirtualInterfacesRequest { /** - *The destination VPC.
+ *The IDs of the virtual interfaces.
*/ - DestinationVpc?: AnalysisComponent; + LocalGatewayVirtualInterfaceIds?: string[]; /** - *The outbound header.
+ *One or more filters.
*/ - OutboundHeader?: AnalysisPacketHeader; + Filters?: Filter[]; /** - *The inbound header.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The route table route.
+ *The token for the next page of results.
*/ - RouteTableRoute?: AnalysisRouteTableRoute; + NextToken?: string; /** - *The security group rule.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The source VPC.
+ * @internal */ - SourceVpc?: AnalysisComponent; + export const filterSensitiveLog = (obj: DescribeLocalGatewayVirtualInterfacesRequest): any => ({ + ...obj, + }); +} +/** + *Describes a local gateway virtual interface.
+ */ +export interface LocalGatewayVirtualInterface { /** - *The subnet.
+ *The ID of the virtual interface.
*/ - Subnet?: AnalysisComponent; - - /** - *The component VPC.
- */ - Vpc?: AnalysisComponent; -} - -export namespace PathComponent { - /** - * @internal - */ - export const filterSensitiveLog = (obj: PathComponent): any => ({ - ...obj, - }); -} - -export type AnalysisStatus = "failed" | "running" | "succeeded"; - -/** - *Describes a network insights analysis.
- */ -export interface NetworkInsightsAnalysis { - /** - *The ID of the network insights analysis.
- */ - NetworkInsightsAnalysisId?: string; - - /** - *The Amazon Resource Name (ARN) of the network insights analysis.
- */ - NetworkInsightsAnalysisArn?: string; - - /** - *The ID of the path.
- */ - NetworkInsightsPathId?: string; - - /** - *The Amazon Resource Names (ARN) of the AWS resources that the path must traverse.
- */ - FilterInArns?: string[]; - - /** - *The time the analysis started.
- */ - StartDate?: Date; + LocalGatewayVirtualInterfaceId?: string; /** - *The status of the network insights analysis.
+ *The ID of the local gateway.
*/ - Status?: AnalysisStatus | string; + LocalGatewayId?: string; /** - *The status message, if the status is failed.
The ID of the VLAN.
*/ - StatusMessage?: string; + Vlan?: number; /** - *Indicates whether the destination is reachable from the source.
+ *The local address.
*/ - NetworkPathFound?: boolean; + LocalAddress?: string; /** - *The components in the path from source to destination.
+ *The peer address.
*/ - ForwardPathComponents?: PathComponent[]; + PeerAddress?: string; /** - *The components in the path from destination to source.
+ *The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
*/ - ReturnPathComponents?: PathComponent[]; + LocalBgpAsn?: number; /** - *The explanations. For more information, see Reachability Analyzer explanation codes.
+ *The peer BGP ASN.
*/ - Explanations?: Explanation[]; + PeerBgpAsn?: number; /** - *Potential intermediate components.
+ *The AWS account ID that owns the local gateway virtual interface.
*/ - AlternatePathHints?: AlternatePathHint[]; + OwnerId?: string; /** - *The tags.
+ *The tags assigned to the virtual interface.
*/ Tags?: Tag[]; } -export namespace NetworkInsightsAnalysis { +export namespace LocalGatewayVirtualInterface { /** * @internal */ - export const filterSensitiveLog = (obj: NetworkInsightsAnalysis): any => ({ + export const filterSensitiveLog = (obj: LocalGatewayVirtualInterface): any => ({ ...obj, }); } -export interface DescribeNetworkInsightsAnalysesResult { +export interface DescribeLocalGatewayVirtualInterfacesResult { /** - *Information about the network insights analyses.
+ *Information about the virtual interfaces.
*/ - NetworkInsightsAnalyses?: NetworkInsightsAnalysis[]; + LocalGatewayVirtualInterfaces?: LocalGatewayVirtualInterface[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the paths.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The filters. The following are possible values:
- *Destination - The ID of the resource.
- *DestinationPort - The destination port.
- *One or more filters.
+ *Name - The path name.
+ *
+ * owner-id - The ID of the prefix list owner.
Protocol - The protocol.
+ *
+ * prefix-list-id - The ID of the prefix list.
Source - The ID of the resource.
+ *
+ * prefix-list-name - The name of the prefix list.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
nextToken value.
*/
MaxResults?: number;
/**
- * Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
*/ - DryRun?: boolean; + NextToken?: string; /** - *The token for the next page of results.
+ *One or more prefix list IDs.
*/ - NextToken?: string; + PrefixListIds?: string[]; } -export namespace DescribeNetworkInsightsPathsRequest { +export namespace DescribeManagedPrefixListsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeNetworkInsightsPathsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeManagedPrefixListsRequest): any => ({ ...obj, }); } -export interface DescribeNetworkInsightsPathsResult { +export interface DescribeManagedPrefixListsResult { /** - *Information about the paths.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the prefix lists.
*/ - NextToken?: string; + PrefixLists?: ManagedPrefixList[]; } -export namespace DescribeNetworkInsightsPathsResult { +export namespace DescribeManagedPrefixListsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeNetworkInsightsPathsResult): any => ({ + export const filterSensitiveLog = (obj: DescribeManagedPrefixListsResult): any => ({ ...obj, }); } -export type NetworkInterfaceAttribute = "attachment" | "description" | "groupSet" | "sourceDestCheck"; - -/** - *Contains the parameters for DescribeNetworkInterfaceAttribute.
- */ -export interface DescribeNetworkInterfaceAttributeRequest { +export interface DescribeMovingAddressesRequest { /** - *The attribute of the network interface. This parameter is required.
+ *One or more filters.
+ *
+ * moving-status - The status of the Elastic IP address
+ * (MovingToVpc | RestoringToClassic).
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
/**
- * The ID of the network interface.
+ *The maximum number of results to return for the request in a single page. The remaining
+ * results of the initial request can be seen by sending another request with the returned
+ * NextToken value. This value can be between 5 and 1000; if
+ * MaxResults is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
*/ - NetworkInterfaceId: string | undefined; + MaxResults?: number; + + /** + *The token for the next page of results.
+ */ + NextToken?: string; + + /** + *One or more Elastic IP addresses.
+ */ + PublicIps?: string[]; } -export namespace DescribeNetworkInterfaceAttributeRequest { +export namespace DescribeMovingAddressesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeNetworkInterfaceAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeMovingAddressesRequest): any => ({ ...obj, }); } +export type MoveStatus = "movingToVpc" | "restoringToClassic"; + /** - *Contains the output of DescribeNetworkInterfaceAttribute.
+ *Describes the status of a moving Elastic IP address.
*/ -export interface DescribeNetworkInterfaceAttributeResult { +export interface MovingAddressStatus { /** - *The attachment (if any) of the network interface.
+ *The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.
*/ - Attachment?: NetworkInterfaceAttachment; + MoveStatus?: MoveStatus | string; /** - *The description of the network interface.
+ *The Elastic IP address.
*/ - Description?: AttributeValue; + PublicIp?: string; +} +export namespace MovingAddressStatus { /** - *The security groups associated with the network interface.
+ * @internal */ - Groups?: GroupIdentifier[]; + export const filterSensitiveLog = (obj: MovingAddressStatus): any => ({ + ...obj, + }); +} +export interface DescribeMovingAddressesResult { /** - *The ID of the network interface.
+ *The status for each Elastic IP address.
*/ - NetworkInterfaceId?: string; + MovingAddressStatuses?: MovingAddressStatus[]; /** - *Indicates whether source/destination checking is enabled.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for DescribeNetworkInterfacePermissions.
- */ -export interface DescribeNetworkInterfacePermissionsRequest { +export interface DescribeNatGatewaysRequest { /** - *One or more network interface permission IDs.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters.
- *
- * network-interface-permission.network-interface-permission-id - The ID of the
- * permission.
nat-gateway-id - The ID of the NAT gateway.
*
- * network-interface-permission.network-interface-id - The ID of
- * the network interface.
+ * state - The state of the NAT gateway (pending |
+ * failed | available | deleting | deleted).
- * network-interface-permission.aws-account-id - The account ID.
+ * subnet-id - The ID of the subnet in which the NAT gateway resides.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * network-interface-permission.aws-service - The Amazon Web Service.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ *
*
- * network-interface-permission.permission - The type of
- * permission (INSTANCE-ATTACH |
- * EIP-ASSOCIATE).
+ * vpc-id - The ID of the VPC in which the NAT gateway resides.
The token to request the next page of results.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of results to return in a single call. To retrieve the remaining results,
- * make another call with the returned NextToken value. If this parameter is not specified, up to 50 results are returned by default.
One or more NAT gateway IDs.
*/ - MaxResults?: number; + NatGatewayIds?: string[]; + + /** + *The token for the next page of results.
+ */ + NextToken?: string; } -export namespace DescribeNetworkInterfacePermissionsRequest { +export namespace DescribeNatGatewaysRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeNetworkInterfacePermissionsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeNatGatewaysRequest): any => ({ ...obj, }); } -/** - *Contains the output for DescribeNetworkInterfacePermissions.
- */ -export interface DescribeNetworkInterfacePermissionsResult { +export interface DescribeNatGatewaysResult { /** - *The network interface permissions.
+ *Information about the NAT gateways.
*/ - NetworkInterfacePermissions?: NetworkInterfacePermission[]; + NatGateways?: NatGateway[]; /** - *The token to use to retrieve the next page of results.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for DescribeNetworkInterfaces.
- */ -export interface DescribeNetworkInterfacesRequest { +export interface DescribeNetworkAclsRequest { /** *One or more filters.
*
- * addresses.private-ip-address - The private IPv4 addresses
- * associated with the network interface.
- * addresses.primary - Whether the private IPv4 address is the primary
- * IP address associated with the network interface.
- * addresses.association.public-ip - The association ID returned when
- * the network interface was associated with the Elastic IP address
- * (IPv4).
- * addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
- * association.association-id - The association ID returned when the
- * network interface was associated with an IPv4 address.
- * association.allocation-id - The allocation ID returned when you
- * allocated the Elastic IP address (IPv4) for your network interface.
- * association.ip-owner-id - The owner of the Elastic IP address
- * (IPv4) associated with the network interface.
- * association.public-ip - The address of the Elastic IP address
- * (IPv4) bound to the network interface.
- * association.public-dns-name - The public DNS name for the network
- * interface (IPv4).
- * attachment.attachment-id - The ID of the interface attachment.
- * attachment.attach-time - The time that the network interface was attached to an instance.
- * attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
- * attachment.device-index - The device index to which the network interface is attached.
- * attachment.instance-id - The ID of the instance to which the network interface is attached.
association.association-id - The ID of an association ID for the ACL.
*
- * attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
association.network-acl-id - The ID of the network ACL involved in the association.
*
- * attachment.status - The status of the attachment (attaching | attached | detaching | detached).
association.subnet-id - The ID of the subnet involved in the association.
*
- * availability-zone - The Availability Zone of the network interface.
default - Indicates whether the ACL is the default network ACL for the VPC.
*
- * description - The description of the network interface.
entry.cidr - The IPv4 CIDR range specified in the entry.
*
- * group-id - The ID of a security group associated with the network interface.
entry.icmp.code - The ICMP code specified in the entry, if any.
*
- * group-name - The name of a security group associated with the network interface.
entry.icmp.type - The ICMP type specified in the entry, if any.
*
- * ipv6-addresses.ipv6-address - An IPv6 address associated with
- * the network interface.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
*
- * mac-address - The MAC address of the network interface.
- * network-interface-id - The ID of the network interface.
- * owner-id - The account ID of the network interface owner.
- * private-ip-address - The private IPv4 address or addresses of the
- * network interface.
entry.port-range.from - The start of the port range specified in the entry.
*
- * private-dns-name - The private DNS name of the network interface (IPv4).
entry.port-range.to - The end of the port range specified in the entry.
*
- * requester-id - The alias or account ID of the principal or service that created the network interface.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
*
- * requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service
- * (for example, Management Console, Auto Scaling, and so on).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
*
- * source-dest-check - Indicates whether the network interface performs source/destination checking.
- * A value of true means checking is enabled, and false means checking is disabled.
- * The value must be false for the network interface to perform network address translation (NAT) in your VPC.
entry.rule-number - The number of an entry (in other words, rule) in
+ * the set of ACL entries.
*
- * status - The status of the network interface. If the network interface is not attached to an instance, the status is available;
- * if a network interface is attached to an instance the status is in-use.
network-acl-id - The ID of the network ACL.
*
- * subnet-id - The ID of the subnet for the network interface.
owner-id - The ID of the AWS account that owns the network ACL.
* @@ -4134,7 +3801,7 @@ export interface DescribeNetworkInterfacesRequest { *
- * vpc-id - The ID of the VPC for the network interface.
vpc-id - The ID of the VPC for the network ACL.
* Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
/**
- * One or more network interface IDs.
- *Default: Describes all your network interfaces.
+ *One or more network ACL IDs.
+ *Default: Describes all your network ACLs.
*/ - NetworkInterfaceIds?: string[]; + NetworkAclIds?: string[]; /** - *The token to retrieve the next page of results.
+ *The token for the next page of results.
*/ NextToken?: string; /** - *The maximum number of items to return for this request. The request returns a token that you - * can specify in a subsequent call to get the next set of results. You cannot specify this - * parameter and the network interface IDs parameter in the same request.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Contains the output of DescribeNetworkInterfaces.
- */ -export interface DescribeNetworkInterfacesResult { +export interface DescribeNetworkAclsResult { /** - *Information about one or more network interfaces.
+ *Information about one or more network ACLs.
*/ - NetworkInterfaces?: NetworkInterface[]; + NetworkAcls?: NetworkAcl[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
- *
- * group-name - The name of the placement group.
- * state - The state of the placement group (pending |
- * available | deleting |
- * deleted).
- * strategy - The strategy of the placement group
- * (cluster | spread |
- * partition).
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
*/ - Filters?: Filter[]; + NetworkInsightsAnalysisIds?: string[]; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the path. You must specify either a path ID or analysis IDs.
*/ - DryRun?: boolean; + NetworkInsightsPathId?: string; /** - *The names of the placement groups.
- *Default: Describes all your placement groups, or only those otherwise - * specified.
+ *The time when the network insights analyses started.
*/ - GroupNames?: string[]; + AnalysisStartTime?: Date; /** - *The IDs of the placement groups.
+ *The time when the network insights analyses ended.
*/ - GroupIds?: string[]; -} - -export namespace DescribePlacementGroupsRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribePlacementGroupsRequest): any => ({ - ...obj, - }); -} - -export interface DescribePlacementGroupsResult { - /** - *Information about the placement groups.
- */ - PlacementGroups?: PlacementGroup[]; -} - -export namespace DescribePlacementGroupsResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribePlacementGroupsResult): any => ({ - ...obj, - }); -} - -export interface DescribePrefixListsRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more filters.
- *The filters. The following are possible values:
+ *
- * prefix-list-id: The ID of a prefix list.
PathFound - A Boolean value that indicates whether a feasible path is found.
*
- * prefix-list-name: The name of a prefix list.
Status - The status of the analysis (running | succeeded | failed).
*The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
nextToken value.
*/
MaxResults?: number;
/**
- * The token for the next page of results.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more prefix list IDs.
+ *The token for the next page of results.
*/ - PrefixListIds?: string[]; + NextToken?: string; } -export namespace DescribePrefixListsRequest { +export namespace DescribeNetworkInsightsAnalysesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribePrefixListsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeNetworkInsightsAnalysesRequest): any => ({ ...obj, }); } /** - *Describes prefixes for Amazon Web Services services.
+ *Describes a path component.
*/ -export interface PrefixList { - /** - *The IP address range of the Amazon Web Service.
- */ - Cidrs?: string[]; - +export interface AnalysisComponent { /** - *The ID of the prefix.
+ *The ID of the component.
*/ - PrefixListId?: string; + Id?: string; /** - *The name of the prefix.
+ *The Amazon Resource Name (ARN) of the component.
*/ - PrefixListName?: string; + Arn?: string; } -export namespace PrefixList { +export namespace AnalysisComponent { /** * @internal */ - export const filterSensitiveLog = (obj: PrefixList): any => ({ + export const filterSensitiveLog = (obj: AnalysisComponent): any => ({ ...obj, }); } -export interface DescribePrefixListsResult { - /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes a network access control (ACL) rule.
+ */ +export interface AnalysisAclRule { /** - *All available prefix lists.
+ *The IPv4 address range, in CIDR notation.
*/ - PrefixLists?: PrefixList[]; -} + Cidr?: string; -export namespace DescribePrefixListsResult { /** - * @internal + *Indicates whether the rule is an outbound rule.
*/ - export const filterSensitiveLog = (obj: DescribePrefixListsResult): any => ({ - ...obj, - }); -} + Egress?: boolean; -export interface DescribePrincipalIdFormatRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The range of ports.
*/ - DryRun?: boolean; + PortRange?: PortRange; /** - *The type of resource: bundle |
- * conversion-task | customer-gateway | dhcp-options |
- * elastic-ip-allocation | elastic-ip-association |
- * export-task | flow-log | image |
- * import-task | instance | internet-gateway |
- * network-acl | network-acl-association |
- * network-interface | network-interface-attachment |
- * prefix-list | reservation | route-table |
- * route-table-association | security-group |
- * snapshot | subnet |
- * subnet-cidr-block-association | volume | vpc
- * | vpc-cidr-block-association | vpc-endpoint |
- * vpc-peering-connection | vpn-connection | vpn-gateway
- *
The protocol.
*/ - Resources?: string[]; + Protocol?: string; /** - *The maximum number of results to return in a single call. To retrieve the remaining - * results, make another call with the returned NextToken value.
+ *Indicates whether to allow or deny traffic that matches the rule.
*/ - MaxResults?: number; + RuleAction?: string; /** - *The token to request the next page of results.
+ *The rule number.
*/ - NextToken?: string; + RuleNumber?: number; } -export namespace DescribePrincipalIdFormatRequest { +export namespace AnalysisAclRule { /** * @internal */ - export const filterSensitiveLog = (obj: DescribePrincipalIdFormatRequest): any => ({ + export const filterSensitiveLog = (obj: AnalysisAclRule): any => ({ ...obj, }); } /** - *PrincipalIdFormat description
+ *Describes a load balancer listener.
*/ -export interface PrincipalIdFormat { - /** - *PrincipalIdFormatARN description
- */ - Arn?: string; - - /** - *PrincipalIdFormatStatuses description
- */ - Statuses?: IdFormat[]; -} - -export namespace PrincipalIdFormat { - /** - * @internal - */ - export const filterSensitiveLog = (obj: PrincipalIdFormat): any => ({ - ...obj, - }); -} - -export interface DescribePrincipalIdFormatResult { +export interface AnalysisLoadBalancerListener { /** - *Information about the ID format settings for the ARN.
+ *The port on which the load balancer is listening.
*/ - Principals?: PrincipalIdFormat[]; + LoadBalancerPort?: number; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ *[Classic Load Balancers] The back-end port for the listener.
*/ - NextToken?: string; + InstancePort?: number; } -export namespace DescribePrincipalIdFormatResult { +export namespace AnalysisLoadBalancerListener { /** * @internal */ - export const filterSensitiveLog = (obj: DescribePrincipalIdFormatResult): any => ({ + export const filterSensitiveLog = (obj: AnalysisLoadBalancerListener): any => ({ ...obj, }); } -export interface DescribePublicIpv4PoolsRequest { +/** + *Describes a load balancer target.
+ */ +export interface AnalysisLoadBalancerTarget { /** - *The IDs of the address pools.
+ *The IP address.
*/ - PoolIds?: string[]; + Address?: string; /** - *The token for the next page of results.
+ *The Availability Zone.
*/ - NextToken?: string; + AvailabilityZone?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Information about the instance.
*/ - MaxResults?: number; + Instance?: AnalysisComponent; /** - *One or more filters.
- *
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The port on which the target is listening.
*/ - Filters?: Filter[]; + Port?: number; } -export namespace DescribePublicIpv4PoolsRequest { +export namespace AnalysisLoadBalancerTarget { /** * @internal */ - export const filterSensitiveLog = (obj: DescribePublicIpv4PoolsRequest): any => ({ + export const filterSensitiveLog = (obj: AnalysisLoadBalancerTarget): any => ({ ...obj, }); } /** - *Describes an address range of an IPv4 address pool.
+ *Describes a route table route.
*/ -export interface PublicIpv4PoolRange { +export interface AnalysisRouteTableRoute { /** - *The first IP address in the range.
+ *The destination IPv4 address, in CIDR notation.
*/ - FirstAddress?: string; + DestinationCidr?: string; /** - *The last IP address in the range.
+ *The prefix of the AWS service.
*/ - LastAddress?: string; + DestinationPrefixListId?: string; /** - *The number of addresses in the range.
+ *The ID of an egress-only internet gateway.
*/ - AddressCount?: number; + EgressOnlyInternetGatewayId?: string; /** - *The number of available addresses in the range.
+ *The ID of the gateway, such as an internet gateway or virtual private gateway.
*/ - AvailableAddressCount?: number; -} + GatewayId?: string; -export namespace PublicIpv4PoolRange { /** - * @internal + *The ID of the instance, such as a NAT instance.
*/ - export const filterSensitiveLog = (obj: PublicIpv4PoolRange): any => ({ - ...obj, - }); -} + InstanceId?: string; -/** - *Describes an IPv4 address pool.
- */ -export interface PublicIpv4Pool { /** - *The ID of the address pool.
+ *The ID of a NAT gateway.
*/ - PoolId?: string; + NatGatewayId?: string; /** - *A description of the address pool.
+ *The ID of a network interface.
*/ - Description?: string; + NetworkInterfaceId?: string; /** - *The address ranges.
- */ - PoolAddressRanges?: PublicIpv4PoolRange[]; - - /** - *The total number of addresses.
- */ - TotalAddressCount?: number; - - /** - *The total number of available addresses.
+ *Describes how the route was created. The following are possible values:
+ *
+ * CreateRouteTable - The route was automatically created when the route table was created.
+ * CreateRoute - The route was manually added to the route table.
+ * EnableVgwRoutePropagation - The route was propagated by route propagation.
The name of the location from which the address pool is advertised. - * A network border group is a unique set of Availability Zones or Local Zones - * from where Amazon Web Services advertises public IP addresses.
+ *The ID of a transit gateway.
*/ - NetworkBorderGroup?: string; + TransitGatewayId?: string; /** - *Any tags for the address pool.
+ *The ID of a VPC peering connection.
*/ - Tags?: Tag[]; + VpcPeeringConnectionId?: string; } -export namespace PublicIpv4Pool { +export namespace AnalysisRouteTableRoute { /** * @internal */ - export const filterSensitiveLog = (obj: PublicIpv4Pool): any => ({ + export const filterSensitiveLog = (obj: AnalysisRouteTableRoute): any => ({ ...obj, }); } -export interface DescribePublicIpv4PoolsResult { - /** - *Information about the address pools.
- */ - PublicIpv4Pools?: PublicIpv4Pool[]; - - /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes a security group rule.
+ */ +export interface AnalysisSecurityGroupRule { /** - * @internal + *The IPv4 address range, in CIDR notation.
*/ - export const filterSensitiveLog = (obj: DescribePublicIpv4PoolsResult): any => ({ - ...obj, - }); -} + Cidr?: string; -export interface DescribeRegionsRequest { /** - *The filters.
+ *The direction. The following are possible values:
*
- * endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
- * opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in |
- * not-opted-in).
egress
*
- * region-name - The name of the Region (for example, us-east-1).
ingress
*The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.
+ *The security group ID.
*/ - RegionNames?: string[]; + SecurityGroupId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The port range.
*/ - DryRun?: boolean; + PortRange?: PortRange; /** - *Indicates whether to display all Regions, including Regions that are disabled for your account.
+ *The prefix list ID.
*/ - AllRegions?: boolean; + PrefixListId?: string; + + /** + *The protocol name.
+ */ + Protocol?: string; } -export namespace DescribeRegionsRequest { +export namespace AnalysisSecurityGroupRule { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeRegionsRequest): any => ({ + export const filterSensitiveLog = (obj: AnalysisSecurityGroupRule): any => ({ ...obj, }); } /** - *Describes a Region.
+ *Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes.
*/ -export interface Region { +export interface Explanation { /** - *The Region service endpoint.
+ *The network ACL.
*/ - Endpoint?: string; + Acl?: AnalysisComponent; /** - *The name of the Region.
+ *The network ACL rule.
*/ - RegionName?: string; + AclRule?: AnalysisAclRule; /** - *The Region opt-in status. The possible values are opt-in-not-required, opted-in, and
- * not-opted-in.
The IPv4 address, in CIDR notation.
*/ - OptInStatus?: string; -} + Address?: string; -export namespace Region { /** - * @internal + *The IPv4 addresses, in CIDR notation.
*/ - export const filterSensitiveLog = (obj: Region): any => ({ - ...obj, - }); -} + Addresses?: string[]; -export interface DescribeRegionsResult { /** - *Information about the Regions.
+ *The resource to which the component is attached.
*/ - Regions?: Region[]; -} + AttachedTo?: AnalysisComponent; -export namespace DescribeRegionsResult { /** - * @internal + *The Availability Zones.
*/ - export const filterSensitiveLog = (obj: DescribeRegionsResult): any => ({ - ...obj, - }); -} + AvailabilityZones?: string[]; -export interface DescribeReplaceRootVolumeTasksRequest { /** - *The ID of the root volume replacement task to view.
+ *The CIDR ranges.
*/ - ReplaceRootVolumeTaskIds?: string[]; + Cidrs?: string[]; /** - *Filter to use:
+ *The component.
+ */ + Component?: AnalysisComponent; + + /** + *The customer gateway.
+ */ + CustomerGateway?: AnalysisComponent; + + /** + *The destination.
+ */ + Destination?: AnalysisComponent; + + /** + *The destination VPC.
+ */ + DestinationVpc?: AnalysisComponent; + + /** + *The direction. The following are possible values:
*
- * instance-id - The ID of the instance for which the root volume replacement task was created.
egress
+ *ingress
*The maximum number of results to return with a single call. To retrieve the remaining results,
- * make another call with the returned nextToken value.
The explanation code.
*/ - MaxResults?: number; + ExplanationCode?: string; /** - *The token for the next page of results.
+ *The route table.
*/ - NextToken?: string; + IngressRouteTable?: AnalysisComponent; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The internet gateway.
*/ - DryRun?: boolean; -} + InternetGateway?: AnalysisComponent; -export namespace DescribeReplaceRootVolumeTasksRequest { /** - * @internal + *The Amazon Resource Name (ARN) of the load balancer.
*/ - export const filterSensitiveLog = (obj: DescribeReplaceRootVolumeTasksRequest): any => ({ - ...obj, - }); -} + LoadBalancerArn?: string; -export interface DescribeReplaceRootVolumeTasksResult { /** - *Information about the root volume replacement task.
+ *The listener for a Classic Load Balancer.
*/ - ReplaceRootVolumeTasks?: ReplaceRootVolumeTask[]; + ClassicLoadBalancerListener?: AnalysisLoadBalancerListener; /** - *The token to use to retrieve the next page of results. This value is null when there are no
- * more results to return.
The listener port of the load balancer.
*/ - NextToken?: string; -} + LoadBalancerListenerPort?: number; -export namespace DescribeReplaceRootVolumeTasksResult { /** - * @internal + *The target.
*/ - export const filterSensitiveLog = (obj: DescribeReplaceRootVolumeTasksResult): any => ({ - ...obj, - }); -} + LoadBalancerTarget?: AnalysisLoadBalancerTarget; -export enum OfferingClassType { - CONVERTIBLE = "convertible", - STANDARD = "standard", -} + /** + *The target group.
+ */ + LoadBalancerTargetGroup?: AnalysisComponent; -export type OfferingTypeValues = - | "All Upfront" - | "Heavy Utilization" - | "Light Utilization" - | "Medium Utilization" - | "No Upfront" - | "Partial Upfront"; + /** + *The target groups.
+ */ + LoadBalancerTargetGroups?: AnalysisComponent[]; -/** - *Contains the parameters for DescribeReservedInstances.
- */ -export interface DescribeReservedInstancesRequest { /** - *One or more filters.
- *
- * availability-zone - The Availability Zone where the Reserved Instance can be used.
- * duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
- * end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
- * fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
- * instance-type - The instance type that is covered by the reservation.
- * scope - The scope of the Reserved Instance (Region or Availability Zone).
- * product-description - The Reserved Instance product platform
- * description. Instances that include (Amazon VPC) in the product platform
- * description will only be displayed to EC2-Classic account holders and are for use with
- * Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE
- * Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise
- * Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat
- * Enterprise Linux with HA (Amazon VPC) | Windows | Windows
- * (Amazon VPC) | Windows with SQL Server Standard | Windows with
- * SQL Server Standard (Amazon VPC) | Windows with SQL Server Web |
- * Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server
- * Enterprise | Windows with SQL Server Enterprise (Amazon
- * VPC)).
- * reserved-instances-id - The ID of the Reserved Instance.
- * start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
- * state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
The target port.
*/ - Filters?: Filter[]; + LoadBalancerTargetPort?: number; /** - *Describes whether the Reserved Instance is Standard or Convertible.
+ *The load balancer listener.
*/ - OfferingClass?: OfferingClassType | string; + ElasticLoadBalancerListener?: AnalysisComponent; /** - *One or more Reserved Instance IDs.
- *Default: Describes all your Reserved Instances, or only those otherwise specified.
+ *The missing component.
*/ - ReservedInstancesIds?: string[]; + MissingComponent?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The NAT gateway.
*/ - DryRun?: boolean; + NatGateway?: AnalysisComponent; /** - *The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API
- * version, you only have access to the Medium Utilization Reserved Instance
- * offering type.
The network interface.
*/ - OfferingType?: OfferingTypeValues | string; -} + NetworkInterface?: AnalysisComponent; -export namespace DescribeReservedInstancesRequest { /** - * @internal + *The packet field.
*/ - export const filterSensitiveLog = (obj: DescribeReservedInstancesRequest): any => ({ - ...obj, - }); -} - -export type RIProductDescription = "Linux/UNIX" | "Linux/UNIX (Amazon VPC)" | "Windows" | "Windows (Amazon VPC)"; + PacketField?: string; -export type RecurringChargeFrequency = "Hourly"; + /** + *The VPC peering connection.
+ */ + VpcPeeringConnection?: AnalysisComponent; -/** - *Describes a recurring charge.
- */ -export interface RecurringCharge { /** - *The amount of the recurring charge.
+ *The port.
*/ - Amount?: number; + Port?: number; /** - *The frequency of the recurring charge.
+ *The port ranges.
*/ - Frequency?: RecurringChargeFrequency | string; -} + PortRanges?: PortRange[]; -export namespace RecurringCharge { /** - * @internal + *The prefix list.
*/ - export const filterSensitiveLog = (obj: RecurringCharge): any => ({ - ...obj, - }); -} + PrefixList?: AnalysisComponent; -export enum Scope { - AVAILABILITY_ZONE = "Availability Zone", - REGIONAL = "Region", -} + /** + *The protocols.
+ */ + Protocols?: string[]; -export type ReservedInstanceState = - | "active" - | "payment-failed" - | "payment-pending" - | "queued" - | "queued-deleted" - | "retired"; + /** + *The route table route.
+ */ + RouteTableRoute?: AnalysisRouteTableRoute; -/** - *Describes a Reserved Instance.
- */ -export interface ReservedInstances { /** - *The Availability Zone in which the Reserved Instance can be used.
+ *The route table.
*/ - AvailabilityZone?: string; + RouteTable?: AnalysisComponent; /** - *The duration of the Reserved Instance, in seconds.
+ *The security group.
*/ - Duration?: number; + SecurityGroup?: AnalysisComponent; /** - *The time when the Reserved Instance expires.
+ *The security group rule.
*/ - End?: Date; + SecurityGroupRule?: AnalysisSecurityGroupRule; /** - *The purchase price of the Reserved Instance.
+ *The security groups.
*/ - FixedPrice?: number; + SecurityGroups?: AnalysisComponent[]; /** - *The number of reservations purchased.
+ *The source VPC.
*/ - InstanceCount?: number; + SourceVpc?: AnalysisComponent; /** - *The instance type on which the Reserved Instance can be used.
+ *The state.
*/ - InstanceType?: _InstanceType | string; + State?: string; /** - *The Reserved Instance product platform description.
+ *The subnet.
*/ - ProductDescription?: RIProductDescription | string; + Subnet?: AnalysisComponent; /** - *The ID of the Reserved Instance.
+ *The route table for the subnet.
*/ - ReservedInstancesId?: string; + SubnetRouteTable?: AnalysisComponent; /** - *The date and time the Reserved Instance started.
+ *The component VPC.
*/ - Start?: Date; + Vpc?: AnalysisComponent; /** - *The state of the Reserved Instance purchase.
+ *The VPC endpoint.
*/ - State?: ReservedInstanceState | string; + VpcEndpoint?: AnalysisComponent; /** - *The usage price of the Reserved Instance, per hour.
+ *The VPN connection.
*/ - UsagePrice?: number; + VpnConnection?: AnalysisComponent; /** - *The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.
- * At this time, the only supported currency is USD.
The VPN gateway.
*/ - CurrencyCode?: CurrencyCodeValues | string; + VpnGateway?: AnalysisComponent; +} +export namespace Explanation { /** - *The tenancy of the instance.
+ * @internal */ - InstanceTenancy?: Tenancy | string; + export const filterSensitiveLog = (obj: Explanation): any => ({ + ...obj, + }); +} +/** + *Describes a header. Reflects any changes made by a component as traffic passes through. + * The fields of an inbound header are null except for the first component of a path.
+ */ +export interface AnalysisPacketHeader { /** - *The offering class of the Reserved Instance.
+ *The destination addresses.
*/ - OfferingClass?: OfferingClassType | string; + DestinationAddresses?: string[]; /** - *The Reserved Instance offering type.
+ *The destination port ranges.
*/ - OfferingType?: OfferingTypeValues | string; + DestinationPortRanges?: PortRange[]; /** - *The recurring charge tag assigned to the resource.
+ *The protocol.
*/ - RecurringCharges?: RecurringCharge[]; + Protocol?: string; /** - *The scope of the Reserved Instance.
+ *The source addresses.
*/ - Scope?: Scope | string; + SourceAddresses?: string[]; /** - *Any tags assigned to the resource.
+ *The source port ranges.
*/ - Tags?: Tag[]; + SourcePortRanges?: PortRange[]; } -export namespace ReservedInstances { +export namespace AnalysisPacketHeader { /** * @internal */ - export const filterSensitiveLog = (obj: ReservedInstances): any => ({ + export const filterSensitiveLog = (obj: AnalysisPacketHeader): any => ({ ...obj, }); } /** - *Contains the output for DescribeReservedInstances.
+ *Describes a path component.
*/ -export interface DescribeReservedInstancesResult { +export interface PathComponent { /** - *A list of Reserved Instances.
+ *The sequence number.
*/ - ReservedInstances?: ReservedInstances[]; -} + SequenceNumber?: number; -export namespace DescribeReservedInstancesResult { /** - * @internal + *The network ACL rule.
*/ - export const filterSensitiveLog = (obj: DescribeReservedInstancesResult): any => ({ - ...obj, - }); -} + AclRule?: AnalysisAclRule; -/** - *Contains the parameters for DescribeReservedInstancesListings.
- */ -export interface DescribeReservedInstancesListingsRequest { /** - *One or more filters.
- *
- * reserved-instances-id - The ID of the Reserved Instances.
- * reserved-instances-listing-id - The ID of the Reserved Instances listing.
- * status - The status of the Reserved Instance listing (pending | active |
- * cancelled | closed).
- * status-message - The reason for the status.
The component.
*/ - Filters?: Filter[]; + Component?: AnalysisComponent; /** - *One or more Reserved Instance IDs.
+ *The destination VPC.
*/ - ReservedInstancesId?: string; + DestinationVpc?: AnalysisComponent; /** - *One or more Reserved Instance listing IDs.
+ *The outbound header.
*/ - ReservedInstancesListingId?: string; -} + OutboundHeader?: AnalysisPacketHeader; -export namespace DescribeReservedInstancesListingsRequest { /** - * @internal + *The inbound header.
*/ - export const filterSensitiveLog = (obj: DescribeReservedInstancesListingsRequest): any => ({ - ...obj, - }); -} + InboundHeader?: AnalysisPacketHeader; -/** - *Contains the output of DescribeReservedInstancesListings.
- */ -export interface DescribeReservedInstancesListingsResult { /** - *Information about the Reserved Instance listing.
+ *The route table route.
*/ - ReservedInstancesListings?: ReservedInstancesListing[]; -} + RouteTableRoute?: AnalysisRouteTableRoute; -export namespace DescribeReservedInstancesListingsResult { /** - * @internal + *The security group rule.
*/ - export const filterSensitiveLog = (obj: DescribeReservedInstancesListingsResult): any => ({ - ...obj, - }); -} + SecurityGroupRule?: AnalysisSecurityGroupRule; -/** - *Contains the parameters for DescribeReservedInstancesModifications.
- */ -export interface DescribeReservedInstancesModificationsRequest { /** - *One or more filters.
- *
- * client-token - The idempotency token for the modification request.
- * create-date - The time when the modification request was created.
- * effective-date - The time when the modification becomes effective.
- * modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
- * modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
- * modification-result.target-configuration.instance-count - The number of new Reserved Instances.
- * modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
- * modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
- * reserved-instances-id - The ID of the Reserved Instances modified.
- * reserved-instances-modification-id - The ID of the modification request.
- * status - The status of the Reserved Instances modification request
- * (processing | fulfilled | failed).
- * status-message - The reason for the status.
- * update-date - The time when the modification request was last updated.
The source VPC.
*/ - Filters?: Filter[]; + SourceVpc?: AnalysisComponent; /** - *IDs for the submitted modification request.
+ *The subnet.
*/ - ReservedInstancesModificationIds?: string[]; + Subnet?: AnalysisComponent; /** - *The token to retrieve the next page of results.
+ *The component VPC.
*/ - NextToken?: string; + Vpc?: AnalysisComponent; } -export namespace DescribeReservedInstancesModificationsRequest { +export namespace PathComponent { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeReservedInstancesModificationsRequest): any => ({ + export const filterSensitiveLog = (obj: PathComponent): any => ({ ...obj, }); } +export type AnalysisStatus = "failed" | "running" | "succeeded"; + /** - *Describes the configuration settings for the modified Reserved Instances.
+ *Describes a network insights analysis.
*/ -export interface ReservedInstancesConfiguration { - /** - *The Availability Zone for the modified Reserved Instances.
- */ - AvailabilityZone?: string; - +export interface NetworkInsightsAnalysis { /** - *The number of modified Reserved Instances.
- *This is a required field for a request.
- *The ID of the network insights analysis.
*/ - InstanceCount?: number; + NetworkInsightsAnalysisId?: string; /** - *The instance type for the modified Reserved Instances.
+ *The Amazon Resource Name (ARN) of the network insights analysis.
*/ - InstanceType?: _InstanceType | string; + NetworkInsightsAnalysisArn?: string; /** - *The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
+ *The ID of the path.
*/ - Platform?: string; + NetworkInsightsPathId?: string; /** - *Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.
+ *The Amazon Resource Names (ARN) of the AWS resources that the path must traverse.
*/ - Scope?: Scope | string; -} + FilterInArns?: string[]; -export namespace ReservedInstancesConfiguration { /** - * @internal + *The time the analysis started.
*/ - export const filterSensitiveLog = (obj: ReservedInstancesConfiguration): any => ({ - ...obj, - }); -} + StartDate?: Date; -/** - *Describes the modification request/s.
- */ -export interface ReservedInstancesModificationResult { /** - *The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
+ *The status of the network insights analysis.
*/ - ReservedInstancesId?: string; + Status?: AnalysisStatus | string; /** - *The target Reserved Instances configurations supplied as part of the modification request.
+ *The status message, if the status is failed.
Indicates whether the destination is reachable from the source.
*/ - export const filterSensitiveLog = (obj: ReservedInstancesModificationResult): any => ({ - ...obj, - }); -} + NetworkPathFound?: boolean; -/** - *Describes the ID of a Reserved Instance.
- */ -export interface ReservedInstancesId { /** - *The ID of the Reserved Instance.
+ *The components in the path from source to destination.
*/ - ReservedInstancesId?: string; -} + ForwardPathComponents?: PathComponent[]; -export namespace ReservedInstancesId { /** - * @internal + *The components in the path from destination to source.
*/ - export const filterSensitiveLog = (obj: ReservedInstancesId): any => ({ - ...obj, - }); -} + ReturnPathComponents?: PathComponent[]; -/** - *Describes a Reserved Instance modification.
- */ -export interface ReservedInstancesModification { /** - *A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. - * For more information, see Ensuring - * Idempotency.
+ *The explanations. For more information, see Reachability Analyzer explanation codes.
*/ - ClientToken?: string; + Explanations?: Explanation[]; /** - *The time when the modification request was created.
+ *Potential intermediate components.
*/ - CreateDate?: Date; + AlternatePathHints?: AlternatePathHint[]; /** - *The time for the modification to become effective.
+ *The tags.
*/ - EffectiveDate?: Date; + Tags?: Tag[]; +} +export namespace NetworkInsightsAnalysis { /** - *Contains target configurations along with their corresponding new Reserved Instance IDs.
+ * @internal */ - ModificationResults?: ReservedInstancesModificationResult[]; + export const filterSensitiveLog = (obj: NetworkInsightsAnalysis): any => ({ + ...obj, + }); +} +export interface DescribeNetworkInsightsAnalysesResult { /** - *The IDs of one or more Reserved Instances.
+ *Information about the network insights analyses.
*/ - ReservedInstancesIds?: ReservedInstancesId[]; + NetworkInsightsAnalyses?: NetworkInsightsAnalysis[]; /** - *A unique ID for the Reserved Instance modification.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The status of the Reserved Instances modification request.
+ * @internal */ - Status?: string; + export const filterSensitiveLog = (obj: DescribeNetworkInsightsAnalysesResult): any => ({ + ...obj, + }); +} +export interface DescribeNetworkInsightsPathsRequest { /** - *The reason for the status.
+ *The IDs of the paths.
*/ - StatusMessage?: string; + NetworkInsightsPathIds?: string[]; /** - *The time when the modification request was last updated.
- */ - UpdateDate?: Date; -} - -export namespace ReservedInstancesModification { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ReservedInstancesModification): any => ({ - ...obj, - }); -} - -/** - *Contains the output of DescribeReservedInstancesModifications.
- */ -export interface DescribeReservedInstancesModificationsResult { - /** - *The token to use to retrieve the next page of results. This value is null when
- * there are no more results to return.
The Reserved Instance modification information.
- */ - ReservedInstancesModifications?: ReservedInstancesModification[]; -} - -export namespace DescribeReservedInstancesModificationsResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribeReservedInstancesModificationsResult): any => ({ - ...obj, - }); -} - -/** - *Contains the parameters for DescribeReservedInstancesOfferings.
- */ -export interface DescribeReservedInstancesOfferingsRequest { - /** - *The Availability Zone in which the Reserved Instance can be used.
- */ - AvailabilityZone?: string; - - /** - *One or more filters.
+ *The filters. The following are possible values:
*
- * availability-zone - The Availability Zone where the Reserved Instance can be
- * used.
- * duration - The duration of the Reserved Instance (for example, one year or
- * three years), in seconds (31536000 | 94608000).
- * fixed-price - The purchase price of the Reserved Instance (for example,
- * 9800.0).
- * instance-type - The instance type that is covered by the
- * reservation.
- * marketplace - Set to true to show only Reserved Instance
- * Marketplace offerings. When this filter is not used, which is the default behavior, all
- * offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
Destination - The ID of the resource.
*
- * product-description - The Reserved Instance product platform description.
- * Instances that include (Amazon VPC) in the product platform description will
- * only be displayed to EC2-Classic account holders and are for use with Amazon VPC.
- * (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE
- * Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise
- * Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat
- * Enterprise Linux with HA (Amazon VPC) | Windows | Windows
- * (Amazon VPC) | Windows with SQL Server Standard | Windows with
- * SQL Server Standard (Amazon VPC) | Windows with SQL Server Web |
- * Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server
- * Enterprise | Windows with SQL Server Enterprise (Amazon VPC))
DestinationPort - The destination port.
*
- * reserved-instances-offering-id - The Reserved Instances offering
- * ID.
Name - The path name.
*
- * scope - The scope of the Reserved Instance (Availability Zone or
- * Region).
Protocol - The protocol.
*
- * usage-price - The usage price of the Reserved Instance, per hour (for
- * example, 0.84).
Source - The ID of the resource.
*Include Reserved Instance Marketplace offerings in the response.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The instance type that the reservation will cover (for example, m1.small). For more information, see
- * Instance types in the
- * Amazon EC2 User Guide.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The maximum duration (in seconds) to filter when searching for offerings.
- *Default: 94608000 (3 years)
+ *The token for the next page of results.
*/ - MaxDuration?: number; + NextToken?: string; +} +export namespace DescribeNetworkInsightsPathsRequest { /** - *The maximum number of instances to filter when searching for offerings.
- *Default: 20
+ * @internal */ - MaxInstanceCount?: number; + export const filterSensitiveLog = (obj: DescribeNetworkInsightsPathsRequest): any => ({ + ...obj, + }); +} +export interface DescribeNetworkInsightsPathsResult { /** - *The minimum duration (in seconds) to filter when searching for offerings.
- *Default: 2592000 (1 month)
+ *Information about the paths.
*/ - MinDuration?: number; + NetworkInsightsPaths?: NetworkInsightsPath[]; /** - *The offering class of the Reserved Instance. Can be standard or convertible.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The Reserved Instance product platform description. Instances that include (Amazon
- * VPC) in the description are for use with Amazon VPC.
Contains the parameters for DescribeNetworkInterfaceAttribute.
+ */ +export interface DescribeNetworkInterfaceAttributeRequest { /** - *One or more Reserved Instances offering IDs.
+ *The attribute of the network interface. This parameter is required.
*/ - ReservedInstancesOfferingIds?: string[]; + Attribute?: NetworkInterfaceAttribute | string; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -5513,292 +4734,302 @@ export interface DescribeReservedInstancesOfferingsRequest { DryRun?: boolean; /** - *
The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy
- * of dedicated is applied to instances that run in a VPC on single-tenant hardware
- * (i.e., Dedicated Instances).
- * Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
- *
The ID of the network interface.
*/ - InstanceTenancy?: Tenancy | string; + NetworkInterfaceId: string | undefined; +} +export namespace DescribeNetworkInterfaceAttributeRequest { /** - *The maximum number of results to return for the request in a single page. The remaining
- * results of the initial request can be seen by sending another request with the returned
- * NextToken value. The maximum is 100.
Default: 100
+ * @internal */ - MaxResults?: number; + export const filterSensitiveLog = (obj: DescribeNetworkInterfaceAttributeRequest): any => ({ + ...obj, + }); +} +/** + *Contains the output of DescribeNetworkInterfaceAttribute.
+ */ +export interface DescribeNetworkInterfaceAttributeResult { /** - *The token to retrieve the next page of results.
+ *The attachment (if any) of the network interface.
*/ - NextToken?: string; + Attachment?: NetworkInterfaceAttachment; /** - *The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API
- * version, you only have access to the Medium Utilization Reserved Instance
- * offering type.
The description of the network interface.
*/ - OfferingType?: OfferingTypeValues | string; -} + Description?: AttributeValue; -export namespace DescribeReservedInstancesOfferingsRequest { /** - * @internal + *The security groups associated with the network interface.
*/ - export const filterSensitiveLog = (obj: DescribeReservedInstancesOfferingsRequest): any => ({ - ...obj, - }); -} + Groups?: GroupIdentifier[]; -/** - *Describes a Reserved Instance offering.
- */ -export interface PricingDetail { /** - *The number of reservations available for the price.
+ *The ID of the network interface.
*/ - Count?: number; + NetworkInterfaceId?: string; /** - *The price per instance.
+ *Indicates whether source/destination checking is enabled.
*/ - Price?: number; + SourceDestCheck?: AttributeBooleanValue; } -export namespace PricingDetail { +export namespace DescribeNetworkInterfaceAttributeResult { /** * @internal */ - export const filterSensitiveLog = (obj: PricingDetail): any => ({ + export const filterSensitiveLog = (obj: DescribeNetworkInterfaceAttributeResult): any => ({ ...obj, }); } /** - *Describes a Reserved Instance offering.
+ *Contains the parameters for DescribeNetworkInterfacePermissions.
*/ -export interface ReservedInstancesOffering { +export interface DescribeNetworkInterfacePermissionsRequest { /** - *The Availability Zone in which the Reserved Instance can be used.
+ *One or more network interface permission IDs.
*/ - AvailabilityZone?: string; + NetworkInterfacePermissionIds?: string[]; /** - *The duration of the Reserved Instance, in seconds.
+ *One or more filters.
+ *
+ * network-interface-permission.network-interface-permission-id - The ID of the
+ * permission.
+ * network-interface-permission.network-interface-id - The ID of
+ * the network interface.
+ * network-interface-permission.aws-account-id - The account ID.
+ * network-interface-permission.aws-service - The Amazon Web Service.
+ * network-interface-permission.permission - The type of
+ * permission (INSTANCE-ATTACH |
+ * EIP-ASSOCIATE).
The purchase price of the Reserved Instance.
+ *The token to request the next page of results.
*/ - FixedPrice?: number; - - /** - *The instance type on which the Reserved Instance can be used.
- */ - InstanceType?: _InstanceType | string; - - /** - *The Reserved Instance product platform description.
- */ - ProductDescription?: RIProductDescription | string; - - /** - *The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote - * to confirm that an exchange can be made.
- */ - ReservedInstancesOfferingId?: string; - - /** - *The usage price of the Reserved Instance, per hour.
- */ - UsagePrice?: number; - - /** - *The currency of the Reserved Instance offering you are purchasing. It's
- * specified using ISO 4217 standard currency codes. At this time,
- * the only supported currency is USD.
The tenancy of the instance.
- */ - InstanceTenancy?: Tenancy | string; - - /** - *Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services.
- * If it's a Reserved Instance Marketplace offering, this is true.
If convertible it can be exchanged for Reserved Instances of
- * the same or higher monetary value, with different configurations. If standard, it is not
- * possible to perform an exchange.
The Reserved Instance offering type.
- */ - OfferingType?: OfferingTypeValues | string; - - /** - *The pricing details of the Reserved Instance offering.
- */ - PricingDetails?: PricingDetail[]; - - /** - *The recurring charge tag assigned to the resource.
- */ - RecurringCharges?: RecurringCharge[]; + NextToken?: string; /** - *Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
+ *The maximum number of results to return in a single call. To retrieve the remaining results,
+ * make another call with the returned NextToken value. If this parameter is not specified, up to 50 results are returned by default.
Contains the output of DescribeReservedInstancesOfferings.
+ *Contains the output for DescribeNetworkInterfacePermissions.
*/ -export interface DescribeReservedInstancesOfferingsResult { +export interface DescribeNetworkInterfacePermissionsResult { /** - *A list of Reserved Instances offerings.
+ *The network interface permissions.
*/ - ReservedInstancesOfferings?: ReservedInstancesOffering[]; + NetworkInterfacePermissions?: NetworkInterfacePermission[]; /** - *The token to use to retrieve the next page of results. This value is null when
- * there are no more results to return.
The token to use to retrieve the next page of results.
*/ NextToken?: string; } -export namespace DescribeReservedInstancesOfferingsResult { +export namespace DescribeNetworkInterfacePermissionsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeReservedInstancesOfferingsResult): any => ({ + export const filterSensitiveLog = (obj: DescribeNetworkInterfacePermissionsResult): any => ({ ...obj, }); } -export interface DescribeRouteTablesRequest { +/** + *Contains the parameters for DescribeNetworkInterfaces.
+ */ +export interface DescribeNetworkInterfacesRequest { /** *One or more filters.
*
- * association.route-table-association-id - The ID of an association
- * ID for the route table.
addresses.private-ip-address - The private IPv4 addresses
+ * associated with the network interface.
*
- * association.route-table-id - The ID of the route table involved in
- * the association.
addresses.primary - Whether the private IPv4 address is the primary
+ * IP address associated with the network interface.
*
- * association.subnet-id - The ID of the subnet involved in the
- * association.
addresses.association.public-ip - The association ID returned when
+ * the network interface was associated with the Elastic IP address
+ * (IPv4).
*
- * association.main - Indicates whether the route table is the main
- * route table for the VPC (true | false). Route tables
- * that do not have an association ID are not returned in the response.
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
*
- * owner-id - The ID of the AWS account that owns the route table.
association.association-id - The association ID returned when the
+ * network interface was associated with an IPv4 address.
*
- * route-table-id - The ID of the route table.
association.allocation-id - The allocation ID returned when you
+ * allocated the Elastic IP address (IPv4) for your network interface.
*
- * route.destination-cidr-block - The IPv4 CIDR range specified in a
- * route in the table.
+ * association.ip-owner-id - The owner of the Elastic IP address
+ * (IPv4) associated with the network interface.
- * route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
+ * association.public-ip - The address of the Elastic IP address
+ * (IPv4) bound to the network interface.
- * route.destination-prefix-list-id - The ID (prefix) of the AWS
- * service specified in a route in the table.
+ * association.public-dns-name - The public DNS name for the network
+ * interface (IPv4).
- * route.egress-only-internet-gateway-id - The ID of an
- * egress-only Internet gateway specified in a route in the route table.
+ * attachment.attachment-id - The ID of the interface attachment.
- * route.gateway-id - The ID of a gateway specified in a route in the table.
attachment.attach-time - The time that the network interface was attached to an instance.
*
- * route.instance-id - The ID of an instance specified in a route in the table.
+ * attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
- * route.nat-gateway-id - The ID of a NAT gateway.
+ * attachment.device-index - The device index to which the network interface is attached.
- * route.transit-gateway-id - The ID of a transit gateway.
attachment.instance-id - The ID of the instance to which the network interface is attached.
*
- * route.origin - Describes how the route was created.
- * CreateRouteTable indicates that the route was automatically
- * created when the route table was created; CreateRoute indicates
- * that the route was manually added to the route table;
- * EnableVgwRoutePropagation indicates that the route was
- * propagated by route propagation.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
+ *
+ * attachment.status - The status of the attachment (attaching | attached | detaching | detached).
+ * availability-zone - The Availability Zone of the network interface.
+ * description - The description of the network interface.
+ * group-id - The ID of a security group associated with the network interface.
+ * group-name - The name of a security group associated with the network interface.
- * route.state - The state of a route in the route table
- * (active | blackhole). The blackhole state
- * indicates that the route's target isn't available (for example, the specified
- * gateway isn't attached to the VPC, the specified NAT instance has been
- * terminated, and so on).
ipv6-addresses.ipv6-address - An IPv6 address associated with
+ * the network interface.
*
- * route.vpc-peering-connection-id - The ID of a VPC peering
- * connection specified in a route in the table.
+ * mac-address - The MAC address of the network interface.
+ *
+ * network-interface-id - The ID of the network interface.
+ * owner-id - The account ID of the network interface owner.
+ * private-ip-address - The private IPv4 address or addresses of the
+ * network interface.
+ * private-dns-name - The private DNS name of the network interface (IPv4).
+ * requester-id - The alias or account ID of the principal or service that created the network interface.
+ * requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service
+ * (for example, Management Console, Auto Scaling, and so on).
+ * source-dest-check - Indicates whether the network interface performs source/destination checking.
+ * A value of true means checking is enabled, and false means checking is disabled.
+ * The value must be false for the network interface to perform network address translation (NAT) in your VPC.
+ * status - The status of the network interface. If the network interface is not attached to an instance, the status is available;
+ * if a network interface is attached to an instance the status is in-use.
+ * subnet-id - The ID of the subnet for the network interface.
* tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ *
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * vpc-id - The ID of the VPC for the route table.
+ * vpc-id - The ID of the VPC for the network interface.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
/**
- * One or more route table IDs.
- *Default: Describes all your route tables.
- */ - RouteTableIds?: string[]; + *One or more network interface IDs.
+ *Default: Describes all your network interfaces.
+ */ + NetworkInterfaceIds?: string[]; /** - *The token for the next page of results.
+ *The token to retrieve the next page of results.
*/ NextToken?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of items to return for this request. The request returns a token that you + * can specify in a subsequent call to get the next set of results. You cannot specify this + * parameter and the network interface IDs parameter in the same request.
*/ MaxResults?: number; } -export namespace DescribeRouteTablesRequest { +export namespace DescribeNetworkInterfacesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeRouteTablesRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeNetworkInterfacesRequest): any => ({ ...obj, }); } /** - *Contains the output of DescribeRouteTables.
+ *Contains the output of DescribeNetworkInterfaces.
*/ -export interface DescribeRouteTablesResult { +export interface DescribeNetworkInterfacesResult { /** - *Information about one or more route tables.
+ *Information about one or more network interfaces.
*/ - RouteTables?: RouteTable[]; + NetworkInterfaces?: NetworkInterface[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.
- */ -export interface SlotDateTimeRangeRequest { - /** - *The earliest date and time, in UTC, for the Scheduled Instance to start.
- */ - EarliestTime: Date | undefined; - - /** - *The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.
- */ - LatestTime: Date | undefined; -} - -export namespace SlotDateTimeRangeRequest { +export interface DescribePlacementGroupsRequest { /** - * @internal + *The filters.
+ *
+ * group-name - The name of the placement group.
+ * state - The state of the placement group (pending |
+ * available | deleting |
+ * deleted).
+ * strategy - The strategy of the placement group
+ * (cluster | spread |
+ * partition).
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
Describes the recurring schedule for a Scheduled Instance.
- */ -export interface ScheduledInstanceRecurrenceRequest { /** - *The frequency (Daily, Weekly, or Monthly).
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The interval quantity. The interval unit depends on the value of Frequency. For example, every 2
- * weeks or every 2 months.
The names of the placement groups.
+ *Default: Describes all your placement groups, or only those otherwise + * specified.
*/ - Interval?: number; + GroupNames?: string[]; /** - *The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
+ *The IDs of the placement groups.
*/ - OccurrenceDays?: number[]; + GroupIds?: string[]; +} +export namespace DescribePlacementGroupsRequest { /** - *Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
+ * @internal */ - OccurrenceRelativeToEnd?: boolean; + export const filterSensitiveLog = (obj: DescribePlacementGroupsRequest): any => ({ + ...obj, + }); +} +export interface DescribePlacementGroupsResult { /** - *The unit for OccurrenceDays (DayOfWeek or DayOfMonth).
- * This value is required for a monthly schedule.
- * You can't specify DayOfWeek with a weekly schedule.
- * You can't specify this value with a daily schedule.
Information about the placement groups.
*/ - OccurrenceUnit?: string; + PlacementGroups?: PlacementGroup[]; } -export namespace ScheduledInstanceRecurrenceRequest { +export namespace DescribePlacementGroupsResult { /** * @internal */ - export const filterSensitiveLog = (obj: ScheduledInstanceRecurrenceRequest): any => ({ + export const filterSensitiveLog = (obj: DescribePlacementGroupsResult): any => ({ ...obj, }); } -/** - *Contains the parameters for DescribeScheduledInstanceAvailability.
- */ -export interface DescribeScheduledInstanceAvailabilityRequest { +export interface DescribePrefixListsRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -5941,2423 +5181,2958 @@ export interface DescribeScheduledInstanceAvailabilityRequest {
DryRun?: boolean;
/**
- *
The filters.
- *
- * availability-zone - The Availability Zone (for example, us-west-2a).
- * instance-type - The instance type (for example, c4.large).
One or more filters.
+ *
- * network-platform - The network platform (EC2-Classic or EC2-VPC).
+ * prefix-list-id: The ID of a prefix list.
- * platform - The platform (Linux/UNIX or Windows).
+ * prefix-list-name: The name of a prefix list.
The time period for the first schedule to start.
- */ - FirstSlotStartTimeRange: SlotDateTimeRangeRequest | undefined; - - /** - *The maximum number of results to return in a single call.
- * This value can be between 5 and 300. The default value is 300.
- * To retrieve the remaining results, make another call with the returned
- * NextToken value.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours
- * and less than 1,720.
The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
- */ - MinSlotDurationInHours?: number; - - /** - *The token for the next set of results.
+ *The token for the next page of results.
*/ NextToken?: string; /** - *The schedule recurrence.
+ *One or more prefix list IDs.
*/ - Recurrence: ScheduledInstanceRecurrenceRequest | undefined; + PrefixListIds?: string[]; } -export namespace DescribeScheduledInstanceAvailabilityRequest { +export namespace DescribePrefixListsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeScheduledInstanceAvailabilityRequest): any => ({ + export const filterSensitiveLog = (obj: DescribePrefixListsRequest): any => ({ ...obj, }); } /** - *Describes the recurring schedule for a Scheduled Instance.
+ *Describes prefixes for Amazon Web Services services.
*/ -export interface ScheduledInstanceRecurrence { +export interface PrefixList { /** - *The frequency (Daily, Weekly, or Monthly).
The IP address range of the Amazon Web Service.
*/ - Frequency?: string; + Cidrs?: string[]; /** - *The interval quantity. The interval unit depends on the value of frequency. For example, every 2
- * weeks or every 2 months.
The ID of the prefix.
*/ - Interval?: number; + PrefixListId?: string; /** - *The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
+ *The name of the prefix.
*/ - OccurrenceDaySet?: number[]; + PrefixListName?: string; +} +export namespace PrefixList { /** - *Indicates whether the occurrence is relative to the end of the specified week or month.
+ * @internal */ - OccurrenceRelativeToEnd?: boolean; + export const filterSensitiveLog = (obj: PrefixList): any => ({ + ...obj, + }); +} +export interface DescribePrefixListsResult { /** - *The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
All available prefix lists.
+ */ + PrefixLists?: PrefixList[]; } -export namespace ScheduledInstanceRecurrence { +export namespace DescribePrefixListsResult { /** * @internal */ - export const filterSensitiveLog = (obj: ScheduledInstanceRecurrence): any => ({ + export const filterSensitiveLog = (obj: DescribePrefixListsResult): any => ({ ...obj, }); } -/** - *Describes a schedule that is available for your Scheduled Instances.
- */ -export interface ScheduledInstanceAvailability { +export interface DescribePrincipalIdFormatRequest { /** - *The Availability Zone.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The number of available instances.
+ *The type of resource: bundle |
+ * conversion-task | customer-gateway | dhcp-options |
+ * elastic-ip-allocation | elastic-ip-association |
+ * export-task | flow-log | image |
+ * import-task | instance | internet-gateway |
+ * network-acl | network-acl-association |
+ * network-interface | network-interface-attachment |
+ * prefix-list | reservation | route-table |
+ * route-table-association | security-group |
+ * snapshot | subnet |
+ * subnet-cidr-block-association | volume | vpc
+ * | vpc-cidr-block-association | vpc-endpoint |
+ * vpc-peering-connection | vpn-connection | vpn-gateway
+ *
The time period for the first schedule to start.
+ *The maximum number of results to return in a single call. To retrieve the remaining + * results, make another call with the returned NextToken value.
*/ - FirstSlotStartTime?: Date; + MaxResults?: number; /** - *The hourly price for a single instance.
+ *The token to request the next page of results.
*/ - HourlyPrice?: string; + NextToken?: string; +} +export namespace DescribePrincipalIdFormatRequest { /** - *The instance type. You can specify one of the C3, C4, M4, or R3 instance types.
+ * @internal */ - InstanceType?: string; + export const filterSensitiveLog = (obj: DescribePrincipalIdFormatRequest): any => ({ + ...obj, + }); +} +/** + *PrincipalIdFormat description
+ */ +export interface PrincipalIdFormat { /** - *The maximum term. The only possible value is 365 days.
+ *PrincipalIdFormatARN description
*/ - MaxTermDurationInDays?: number; + Arn?: string; /** - *The minimum term. The only possible value is 365 days.
+ *PrincipalIdFormatStatuses description
*/ - MinTermDurationInDays?: number; + Statuses?: IdFormat[]; +} +export namespace PrincipalIdFormat { /** - *The network platform (EC2-Classic or EC2-VPC).
The platform (Linux/UNIX or Windows).
Information about the ID format settings for the ARN.
*/ - Platform?: string; + Principals?: PrincipalIdFormat[]; /** - *The purchase token. This token expires in two hours.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
*/ - PurchaseToken?: string; + NextToken?: string; +} +export namespace DescribePrincipalIdFormatResult { /** - *The schedule recurrence.
+ * @internal */ - Recurrence?: ScheduledInstanceRecurrence; + export const filterSensitiveLog = (obj: DescribePrincipalIdFormatResult): any => ({ + ...obj, + }); +} + +export interface DescribePublicIpv4PoolsRequest { + /** + *The IDs of the address pools.
+ */ + PoolIds?: string[]; /** - *The number of hours in the schedule.
+ *The token for the next page of results.
*/ - SlotDurationInHours?: number; + NextToken?: string; /** - *The total number of hours for a single instance for the entire term.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
One or more filters.
+ *
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Contains the output of DescribeScheduledInstanceAvailability.
+ *Describes an address range of an IPv4 address pool.
*/ -export interface DescribeScheduledInstanceAvailabilityResult { +export interface PublicIpv4PoolRange { /** - *The token required to retrieve the next set of results. This value is null when there are no more results to return.
The first IP address in the range.
*/ - NextToken?: string; + FirstAddress?: string; /** - *Information about the available Scheduled Instances.
+ *The last IP address in the range.
*/ - ScheduledInstanceAvailabilitySet?: ScheduledInstanceAvailability[]; + LastAddress?: string; + + /** + *The number of addresses in the range.
+ */ + AddressCount?: number; + + /** + *The number of available addresses in the range.
+ */ + AvailableAddressCount?: number; } -export namespace DescribeScheduledInstanceAvailabilityResult { +export namespace PublicIpv4PoolRange { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeScheduledInstanceAvailabilityResult): any => ({ + export const filterSensitiveLog = (obj: PublicIpv4PoolRange): any => ({ ...obj, }); } /** - *Describes the time period for a Scheduled Instance to start its first schedule.
+ *Describes an IPv4 address pool.
*/ -export interface SlotStartTimeRangeRequest { +export interface PublicIpv4Pool { /** - *The earliest date and time, in UTC, for the Scheduled Instance to start.
+ *The ID of the address pool.
*/ - EarliestTime?: Date; + PoolId?: string; /** - *The latest date and time, in UTC, for the Scheduled Instance to start.
+ *A description of the address pool.
*/ - LatestTime?: Date; + Description?: string; + + /** + *The address ranges.
+ */ + PoolAddressRanges?: PublicIpv4PoolRange[]; + + /** + *The total number of addresses.
+ */ + TotalAddressCount?: number; + + /** + *The total number of available addresses.
+ */ + TotalAvailableAddressCount?: number; + + /** + *The name of the location from which the address pool is advertised. + * A network border group is a unique set of Availability Zones or Local Zones + * from where Amazon Web Services advertises public IP addresses.
+ */ + NetworkBorderGroup?: string; + + /** + *Any tags for the address pool.
+ */ + Tags?: Tag[]; } -export namespace SlotStartTimeRangeRequest { +export namespace PublicIpv4Pool { /** * @internal */ - export const filterSensitiveLog = (obj: SlotStartTimeRangeRequest): any => ({ + export const filterSensitiveLog = (obj: PublicIpv4Pool): any => ({ ...obj, }); } -/** - *Contains the parameters for DescribeScheduledInstances.
- */ -export interface DescribeScheduledInstancesRequest { +export interface DescribePublicIpv4PoolsResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the address pools.
*/ - DryRun?: boolean; + PublicIpv4Pools?: PublicIpv4Pool[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
*
- * availability-zone - The Availability Zone (for example, us-west-2a).
- * instance-type - The instance type (for example, c4.large).
endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
*
- * network-platform - The network platform (EC2-Classic or EC2-VPC).
opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in |
+ * not-opted-in).
*
- * platform - The platform (Linux/UNIX or Windows).
region-name - The name of the Region (for example, us-east-1).
* The maximum number of results to return in a single call.
- * This value can be between 5 and 300. The default value is 100.
- * To retrieve the remaining results, make another call with the returned
- * NextToken value.
The token for the next set of results.
+ *The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.
*/ - NextToken?: string; + RegionNames?: string[]; /** - *The Scheduled Instance IDs.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The time period for the first schedule to start.
+ *Indicates whether to display all Regions, including Regions that are disabled for your account.
*/ - SlotStartTimeRange?: SlotStartTimeRangeRequest; + AllRegions?: boolean; } -export namespace DescribeScheduledInstancesRequest { +export namespace DescribeRegionsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeScheduledInstancesRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeRegionsRequest): any => ({ ...obj, }); } /** - *Describes a Scheduled Instance.
+ *Describes a Region.
*/ -export interface ScheduledInstance { +export interface Region { /** - *The Availability Zone.
+ *The Region service endpoint.
*/ - AvailabilityZone?: string; + Endpoint?: string; /** - *The date when the Scheduled Instance was purchased.
+ *The name of the Region.
*/ - CreateDate?: Date; + RegionName?: string; /** - *The hourly price for a single instance.
+ *The Region opt-in status. The possible values are opt-in-not-required, opted-in, and
+ * not-opted-in.
The number of instances.
+ * @internal */ - InstanceCount?: number; + export const filterSensitiveLog = (obj: Region): any => ({ + ...obj, + }); +} +export interface DescribeRegionsResult { /** - *The instance type.
+ *Information about the Regions.
*/ - InstanceType?: string; + Regions?: Region[]; +} +export namespace DescribeRegionsResult { /** - *The network platform (EC2-Classic or EC2-VPC).
The time for the next schedule to start.
- */ - NextSlotStartTime?: Date; - - /** - *The platform (Linux/UNIX or Windows).
The time that the previous schedule ended or will end.
- */ - PreviousSlotEndTime?: Date; - - /** - *The schedule recurrence.
- */ - Recurrence?: ScheduledInstanceRecurrence; - - /** - *The Scheduled Instance ID.
- */ - ScheduledInstanceId?: string; - - /** - *The number of hours in the schedule.
- */ - SlotDurationInHours?: number; - - /** - *The end date for the Scheduled Instance.
- */ - TermEndDate?: Date; - - /** - *The start date for the Scheduled Instance.
+ *The ID of the root volume replacement task to view.
*/ - TermStartDate?: Date; + ReplaceRootVolumeTaskIds?: string[]; /** - *The total number of hours for a single instance for the entire term.
+ *Filter to use:
+ *
+ * instance-id - The ID of the instance for which the root volume replacement task was created.
The maximum number of results to return with a single call. To retrieve the remaining results,
+ * make another call with the returned nextToken value.
Contains the output of DescribeScheduledInstances.
- */ -export interface DescribeScheduledInstancesResult { /** - *The token required to retrieve the next set of results. This value is null when there are no more results to return.
The token for the next page of results.
*/ NextToken?: string; - /** - *Information about the Scheduled Instances.
- */ - ScheduledInstanceSet?: ScheduledInstance[]; -} - -export namespace DescribeScheduledInstancesResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribeScheduledInstancesResult): any => ({ - ...obj, - }); -} - -export interface DescribeSecurityGroupReferencesRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The IDs of the security groups in your account.
- */ - GroupId: string[] | undefined; } -export namespace DescribeSecurityGroupReferencesRequest { +export namespace DescribeReplaceRootVolumeTasksRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSecurityGroupReferencesRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeReplaceRootVolumeTasksRequest): any => ({ ...obj, }); } -/** - *Describes a VPC with a security group that references your security group.
- */ -export interface SecurityGroupReference { - /** - *The ID of your security group.
- */ - GroupId?: string; - +export interface DescribeReplaceRootVolumeTasksResult { /** - *The ID of the VPC with the referencing security group.
+ *Information about the root volume replacement task.
*/ - ReferencingVpcId?: string; + ReplaceRootVolumeTasks?: ReplaceRootVolumeTask[]; /** - *The ID of the VPC peering connection.
+ *The token to use to retrieve the next page of results. This value is null when there are no
+ * more results to return.
Information about the VPCs with the referencing security groups.
- */ - SecurityGroupReferenceSet?: SecurityGroupReference[]; +export enum OfferingClassType { + CONVERTIBLE = "convertible", + STANDARD = "standard", } -export namespace DescribeSecurityGroupReferencesResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribeSecurityGroupReferencesResult): any => ({ - ...obj, - }); -} +export type OfferingTypeValues = + | "All Upfront" + | "Heavy Utilization" + | "Light Utilization" + | "Medium Utilization" + | "No Upfront" + | "Partial Upfront"; -export interface DescribeSecurityGroupRulesRequest { +/** + *Contains the parameters for DescribeReservedInstances.
+ */ +export interface DescribeReservedInstancesRequest { /** *One or more filters.
- *
- * group-id - The ID of the security group.
+ * availability-zone - The Availability Zone where the Reserved Instance can be used.
- * security-group-rule-id - The ID of the security group rule.
+ * duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
+ * end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
+ * fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
+ * instance-type - The instance type that is covered by the reservation.
+ * scope - The scope of the Reserved Instance (Region or Availability Zone).
+ * product-description - The Reserved Instance product platform
+ * description. Instances that include (Amazon VPC) in the product platform
+ * description will only be displayed to EC2-Classic account holders and are for use with
+ * Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE
+ * Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise
+ * Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat
+ * Enterprise Linux with HA (Amazon VPC) | Windows | Windows
+ * (Amazon VPC) | Windows with SQL Server Standard | Windows with
+ * SQL Server Standard (Amazon VPC) | Windows with SQL Server Web |
+ * Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server
+ * Enterprise | Windows with SQL Server Enterprise (Amazon
+ * VPC)).
+ * reserved-instances-id - The ID of the Reserved Instance.
+ * start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
+ * state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
* tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
The IDs of the security group rules.
+ *Describes whether the Reserved Instance is Standard or Convertible.
*/ - SecurityGroupRuleIds?: string[]; + OfferingClass?: OfferingClassType | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more Reserved Instance IDs.
+ *Default: Describes all your Reserved Instances, or only those otherwise specified.
*/ - DryRun?: boolean; + ReservedInstancesIds?: string[]; /** - *The token for the next page of results.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another request with the returned NextToken value. This value
- * can be between 5 and 1000. If this parameter is not specified, then all results are
- * returned.
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API
+ * version, you only have access to the Medium Utilization Reserved Instance
+ * offering type.
Describes a recurring charge.
+ */ +export interface RecurringCharge { /** - *Information about security group rules.
+ *The amount of the recurring charge.
*/ - SecurityGroupRules?: SecurityGroupRule[]; + Amount?: number; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The frequency of the recurring charge.
*/ - NextToken?: string; + Frequency?: RecurringChargeFrequency | string; } -export namespace DescribeSecurityGroupRulesResult { +export namespace RecurringCharge { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSecurityGroupRulesResult): any => ({ + export const filterSensitiveLog = (obj: RecurringCharge): any => ({ ...obj, }); } -export interface DescribeSecurityGroupsRequest { - /** - *The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
- *
- * description - The description of the security group.
- * egress.ip-permission.cidr - An IPv4 CIDR block for an outbound
- * security group rule.
- * egress.ip-permission.from-port - For an outbound rule, the
- * start of port range for the TCP and UDP protocols, or an ICMP type
- * number.
- * egress.ip-permission.group-id - The ID of a security group
- * that has been referenced in an outbound security group rule.
- * egress.ip-permission.group-name - The name of a security group
- * that is referenced in an outbound security group rule.
- * egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an
- * outbound security group rule.
- * egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
- * egress.ip-permission.protocol - The IP protocol for an
- * outbound security group rule (tcp | udp |
- * icmp, a protocol number, or -1 for all protocols).
- * egress.ip-permission.to-port - For an outbound rule, the end
- * of port range for the TCP and UDP protocols, or an ICMP code.
- * egress.ip-permission.user-id - The ID of an Amazon Web Services account that
- * has been referenced in an outbound security group rule.
- * group-id - The ID of the security group.
- * group-name - The name of the security group.
- * ip-permission.cidr - An IPv4 CIDR block for an inbound security
- * group rule.
- * ip-permission.from-port - For an inbound rule, the start of port
- * range for the TCP and UDP protocols, or an ICMP type number.
- * ip-permission.group-id - The ID of a security group that has been
- * referenced in an inbound security group rule.
- * ip-permission.group-name - The name of a security group that is
- * referenced in an inbound security group rule.
- * ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security
- * group rule.
- * ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
- * ip-permission.protocol - The IP protocol for an inbound security
- * group rule (tcp | udp | icmp, a
- * protocol number, or -1 for all protocols).
- * ip-permission.to-port - For an inbound rule, the end of port range
- * for the TCP and UDP protocols, or an ICMP code.
- * ip-permission.user-id - The ID of an Amazon Web Services account that has been
- * referenced in an inbound security group rule.
- * owner-id - The Amazon Web Services account ID of the owner of the security group.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * vpc-id - The ID of the VPC specified when the security group was created.
Describes a Reserved Instance.
+ */ +export interface ReservedInstances { + /** + *The Availability Zone in which the Reserved Instance can be used.
*/ - Filters?: Filter[]; + AvailabilityZone?: string; /** - *The IDs of the security groups. Required for security groups in a nondefault VPC.
- *Default: Describes all of your security groups.
+ *The duration of the Reserved Instance, in seconds.
*/ - GroupIds?: string[]; + Duration?: number; /** - *[EC2-Classic and default VPC only] The names of the security groups. You can specify either
- * the security group name or the security group ID. For security groups in a nondefault VPC, use
- * the group-name filter to describe security groups by name.
Default: Describes all of your security groups.
+ *The time when the Reserved Instance expires.
*/ - GroupNames?: string[]; + End?: Date; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The purchase price of the Reserved Instance.
*/ - DryRun?: boolean; + FixedPrice?: number; /** - *The token to request the next page of results.
+ *The number of reservations purchased.
*/ - NextToken?: string; + InstanceCount?: number; /** - *The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another request with the returned NextToken value. This value
- * can be between 5 and 1000. If this parameter is not specified, then all results are
- * returned.
The instance type on which the Reserved Instance can be used.
*/ - MaxResults?: number; -} + InstanceType?: _InstanceType | string; -export namespace DescribeSecurityGroupsRequest { /** - * @internal + *The Reserved Instance product platform description.
*/ - export const filterSensitiveLog = (obj: DescribeSecurityGroupsRequest): any => ({ - ...obj, - }); -} + ProductDescription?: RIProductDescription | string; -/** - *Describes a security group.
- */ -export interface SecurityGroup { /** - *A description of the security group.
+ *The ID of the Reserved Instance.
*/ - Description?: string; + ReservedInstancesId?: string; /** - *The name of the security group.
+ *The date and time the Reserved Instance started.
*/ - GroupName?: string; + Start?: Date; /** - *The inbound rules associated with the security group.
+ *The state of the Reserved Instance purchase.
*/ - IpPermissions?: IpPermission[]; + State?: ReservedInstanceState | string; /** - *The Amazon Web Services account ID of the owner of the security group.
+ *The usage price of the Reserved Instance, per hour.
*/ - OwnerId?: string; + UsagePrice?: number; /** - *The ID of the security group.
+ *The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.
+ * At this time, the only supported currency is USD.
[VPC only] The outbound rules associated with the security group.
+ *The tenancy of the instance.
*/ - IpPermissionsEgress?: IpPermission[]; + InstanceTenancy?: Tenancy | string; /** - *Any tags assigned to the security group.
+ *The offering class of the Reserved Instance.
*/ - Tags?: Tag[]; + OfferingClass?: OfferingClassType | string; /** - *[VPC only] The ID of the VPC for the security group.
+ *The Reserved Instance offering type.
*/ - VpcId?: string; -} + OfferingType?: OfferingTypeValues | string; -export namespace SecurityGroup { /** - * @internal + *The recurring charge tag assigned to the resource.
*/ - export const filterSensitiveLog = (obj: SecurityGroup): any => ({ - ...obj, - }); -} + RecurringCharges?: RecurringCharge[]; -export interface DescribeSecurityGroupsResult { /** - *Information about the security groups.
+ *The scope of the Reserved Instance.
*/ - SecurityGroups?: SecurityGroup[]; + Scope?: Scope | string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Any tags assigned to the resource.
*/ - NextToken?: string; + Tags?: Tag[]; } -export namespace DescribeSecurityGroupsResult { +export namespace ReservedInstances { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSecurityGroupsResult): any => ({ + export const filterSensitiveLog = (obj: ReservedInstances): any => ({ ...obj, }); } -export type SnapshotAttributeName = "createVolumePermission" | "productCodes"; - -export interface DescribeSnapshotAttributeRequest { +/** + *Contains the output for DescribeReservedInstances.
+ */ +export interface DescribeReservedInstancesResult { /** - *The snapshot attribute you would like to view.
+ *A list of Reserved Instances.
*/ - Attribute: SnapshotAttributeName | string | undefined; + ReservedInstances?: ReservedInstances[]; +} +export namespace DescribeReservedInstancesResult { /** - *The ID of the EBS snapshot.
+ * @internal */ - SnapshotId: string | undefined; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes the user or group to be added or removed from the list of create volume - * permissions for a volume.
+ *Contains the parameters for DescribeReservedInstancesListings.
*/ -export interface CreateVolumePermission { +export interface DescribeReservedInstancesListingsRequest { /** - *The group to be added or removed. The possible value is all.
One or more filters.
+ *
+ * reserved-instances-id - The ID of the Reserved Instances.
+ * reserved-instances-listing-id - The ID of the Reserved Instances listing.
+ * status - The status of the Reserved Instance listing (pending | active |
+ * cancelled | closed).
+ * status-message - The reason for the status.
The AWS account ID to be added or removed.
+ *One or more Reserved Instance IDs.
*/ - UserId?: string; + ReservedInstancesId?: string; + + /** + *One or more Reserved Instance listing IDs.
+ */ + ReservedInstancesListingId?: string; } -export namespace CreateVolumePermission { +export namespace DescribeReservedInstancesListingsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateVolumePermission): any => ({ + export const filterSensitiveLog = (obj: DescribeReservedInstancesListingsRequest): any => ({ ...obj, }); } -export interface DescribeSnapshotAttributeResult { - /** - *The users and groups that have the permissions for creating volumes from the - * snapshot.
- */ - CreateVolumePermissions?: CreateVolumePermission[]; - - /** - *The product codes.
- */ - ProductCodes?: ProductCode[]; - +/** + *Contains the output of DescribeReservedInstancesListings.
+ */ +export interface DescribeReservedInstancesListingsResult { /** - *The ID of the EBS snapshot.
+ *Information about the Reserved Instance listing.
*/ - SnapshotId?: string; + ReservedInstancesListings?: ReservedInstancesListing[]; } -export namespace DescribeSnapshotAttributeResult { +export namespace DescribeReservedInstancesListingsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSnapshotAttributeResult): any => ({ + export const filterSensitiveLog = (obj: DescribeReservedInstancesListingsResult): any => ({ ...obj, }); } -export interface DescribeSnapshotsRequest { +/** + *Contains the parameters for DescribeReservedInstancesModifications.
+ */ +export interface DescribeReservedInstancesModificationsRequest { /** - *The filters.
+ *One or more filters.
*
- * description - A description of the snapshot.
client-token - The idempotency token for the modification request.
*
- * encrypted - Indicates whether the snapshot is encrypted
- * (true | false)
create-date - The time when the modification request was created.
*
- * owner-alias - The owner alias, from an Amazon-maintained list
- * (amazon).
- * This is not the user-configured AWS account alias set using the IAM console.
- * We recommend that you use the related parameter instead of this filter.
effective-date - The time when the modification becomes effective.
*
- * owner-id - The AWS account ID of the owner. We recommend that
- * you use the related parameter instead of this filter.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
*
- * progress - The progress of the snapshot, as a percentage (for example,
- * 80%).
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
*
- * snapshot-id - The snapshot ID.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
*
- * start-time - The time stamp when the snapshot was initiated.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
*
- * status - The status of the snapshot (pending |
- * completed | error).
modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
*
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
reserved-instances-id - The ID of the Reserved Instances modified.
*
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
reserved-instances-modification-id - The ID of the modification request.
*
- * volume-id - The ID of the volume the snapshot is for.
status - The status of the Reserved Instances modification request
+ * (processing | fulfilled | failed).
*
- * volume-size - The size of the volume, in GiB.
status-message - The reason for the status.
+ *
+ * update-date - The time when the modification request was last updated.
The maximum number of snapshot results returned by DescribeSnapshots in
- * paginated output. When this parameter is used, DescribeSnapshots only returns
- * MaxResults results in a single page along with a NextToken
- * response element. The remaining results of the initial request can be seen by sending another
- * DescribeSnapshots request with the returned NextToken value. This
- * value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000,
- * only 1,000 results are returned. If this parameter is not used, then
- * DescribeSnapshots returns all results. You cannot specify this parameter and
- * the snapshot IDs parameter in the same request.
IDs for the submitted modification request.
*/ - MaxResults?: number; + ReservedInstancesModificationIds?: string[]; /** - *The NextToken value returned from a previous paginated
- * DescribeSnapshots request where MaxResults was used and the
- * results exceeded the value of that parameter. Pagination continues from the end of the
- * previous results that returned the NextToken value. This value is
- * null when there are no more results to return.
The token to retrieve the next page of results.
*/ NextToken?: string; +} +export namespace DescribeReservedInstancesModificationsRequest { /** - *Scopes the results to snapshots with the specified owners. You can specify a combination of
- * AWS account IDs, self, and amazon.
The IDs of the AWS accounts that can create volumes from the snapshot.
+ * @internal */ - RestorableByUserIds?: string[]; + export const filterSensitiveLog = (obj: DescribeReservedInstancesModificationsRequest): any => ({ + ...obj, + }); +} +/** + *Describes the configuration settings for the modified Reserved Instances.
+ */ +export interface ReservedInstancesConfiguration { /** - *The snapshot IDs.
- *Default: Describes the snapshots for which you have create volume permissions.
+ *The Availability Zone for the modified Reserved Instances.
*/ - SnapshotIds?: string[]; + AvailabilityZone?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The number of modified Reserved Instances.
+ *This is a required field for a request.
+ *The instance type for the modified Reserved Instances.
*/ - export const filterSensitiveLog = (obj: DescribeSnapshotsRequest): any => ({ - ...obj, - }); -} + InstanceType?: _InstanceType | string; -export interface DescribeSnapshotsResult { /** - *Information about the snapshots.
+ *The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
*/ - Snapshots?: Snapshot[]; + Platform?: string; /** - *The NextToken value to include in a future DescribeSnapshots
- * request. When the results of a DescribeSnapshots request exceed
- * MaxResults, this value can be used to retrieve the next page of results. This
- * value is null when there are no more results to return.
Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.
*/ - NextToken?: string; + Scope?: Scope | string; } -export namespace DescribeSnapshotsResult { +export namespace ReservedInstancesConfiguration { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSnapshotsResult): any => ({ + export const filterSensitiveLog = (obj: ReservedInstancesConfiguration): any => ({ ...obj, }); } /** - *Contains the parameters for DescribeSpotDatafeedSubscription.
+ *Describes the modification request/s.
*/ -export interface DescribeSpotDatafeedSubscriptionRequest { +export interface ReservedInstancesModificationResult { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
*/ - DryRun?: boolean; + ReservedInstancesId?: string; + + /** + *The target Reserved Instances configurations supplied as part of the modification request.
+ */ + TargetConfiguration?: ReservedInstancesConfiguration; } -export namespace DescribeSpotDatafeedSubscriptionRequest { +export namespace ReservedInstancesModificationResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSpotDatafeedSubscriptionRequest): any => ({ + export const filterSensitiveLog = (obj: ReservedInstancesModificationResult): any => ({ ...obj, }); } /** - *Contains the output of DescribeSpotDatafeedSubscription.
+ *Describes the ID of a Reserved Instance.
*/ -export interface DescribeSpotDatafeedSubscriptionResult { +export interface ReservedInstancesId { /** - *The Spot Instance data feed subscription.
+ *The ID of the Reserved Instance.
*/ - SpotDatafeedSubscription?: SpotDatafeedSubscription; + ReservedInstancesId?: string; } -export namespace DescribeSpotDatafeedSubscriptionResult { +export namespace ReservedInstancesId { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSpotDatafeedSubscriptionResult): any => ({ + export const filterSensitiveLog = (obj: ReservedInstancesId): any => ({ ...obj, }); } /** - *Contains the parameters for DescribeSpotFleetInstances.
+ *Describes a Reserved Instance modification.
*/ -export interface DescribeSpotFleetInstancesRequest { +export interface ReservedInstancesModification { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. + * For more information, see Ensuring + * Idempotency.
*/ - DryRun?: boolean; + ClientToken?: string; /** - *The maximum number of results to return in a single call. Specify a value between 1
- * and 1000. The default value is 1000. To retrieve the remaining results, make another
- * call with the returned NextToken value.
The time when the modification request was created.
*/ - MaxResults?: number; + CreateDate?: Date; /** - *The token for the next set of results.
+ *The time for the modification to become effective.
*/ - NextToken?: string; + EffectiveDate?: Date; /** - *The ID of the Spot Fleet request.
+ *Contains target configurations along with their corresponding new Reserved Instance IDs.
*/ - SpotFleetRequestId: string | undefined; -} + ModificationResults?: ReservedInstancesModificationResult[]; -export namespace DescribeSpotFleetInstancesRequest { /** - * @internal + *The IDs of one or more Reserved Instances.
*/ - export const filterSensitiveLog = (obj: DescribeSpotFleetInstancesRequest): any => ({ - ...obj, - }); -} + ReservedInstancesIds?: ReservedInstancesId[]; -/** - *Contains the output of DescribeSpotFleetInstances.
- */ -export interface DescribeSpotFleetInstancesResponse { /** - *The running instances. This list is refreshed periodically and might be out of - * date.
+ *A unique ID for the Reserved Instance modification.
*/ - ActiveInstances?: ActiveInstance[]; + ReservedInstancesModificationId?: string; /** - *The token required to retrieve the next set of results. This value is
- * null when there are no more results to return.
The status of the Reserved Instances modification request.
*/ - NextToken?: string; + Status?: string; /** - *The ID of the Spot Fleet request.
+ *The reason for the status.
*/ - SpotFleetRequestId?: string; + StatusMessage?: string; + + /** + *The time when the modification request was last updated.
+ */ + UpdateDate?: Date; } -export namespace DescribeSpotFleetInstancesResponse { +export namespace ReservedInstancesModification { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSpotFleetInstancesResponse): any => ({ + export const filterSensitiveLog = (obj: ReservedInstancesModification): any => ({ ...obj, }); } -export enum EventType { - BATCH_CHANGE = "fleetRequestChange", - ERROR = "error", - INFORMATION = "information", - INSTANCE_CHANGE = "instanceChange", -} - /** - *Contains the parameters for DescribeSpotFleetRequestHistory.
+ *Contains the output of DescribeReservedInstancesModifications.
*/ -export interface DescribeSpotFleetRequestHistoryRequest { - /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The type of events to describe. By default, all events are described.
- */ - EventType?: EventType | string; - - /** - *The maximum number of results to return in a single call. Specify a value between 1
- * and 1000. The default value is 1000. To retrieve the remaining results, make another
- * call with the returned NextToken value.
The token for the next set of results.
+ *The token to use to retrieve the next page of results. This value is null when
+ * there are no more results to return.
The ID of the Spot Fleet request.
- */ - SpotFleetRequestId: string | undefined; - - /** - *The starting date and time for the events, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *The Reserved Instance modification information.
*/ - StartTime: Date | undefined; + ReservedInstancesModifications?: ReservedInstancesModification[]; } -export namespace DescribeSpotFleetRequestHistoryRequest { +export namespace DescribeReservedInstancesModificationsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSpotFleetRequestHistoryRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeReservedInstancesModificationsResult): any => ({ ...obj, }); } /** - *Describes an event in the history of the Spot Fleet request.
+ *Contains the parameters for DescribeReservedInstancesOfferings.
*/ -export interface HistoryRecord { +export interface DescribeReservedInstancesOfferingsRequest { /** - *Information about the event.
+ *The Availability Zone in which the Reserved Instance can be used.
*/ - EventInformation?: EventInformation; + AvailabilityZone?: string; /** - *The event type.
- *One or more filters.
+ *
- * error - An error with the Spot Fleet request.
+ * availability-zone - The Availability Zone where the Reserved Instance can be
+ * used.
- * fleetRequestChange - A change in the status or configuration of
- * the Spot Fleet request.
+ * duration - The duration of the Reserved Instance (for example, one year or
+ * three years), in seconds (31536000 | 94608000).
- * instanceChange - An instance was launched or terminated.
+ * fixed-price - The purchase price of the Reserved Instance (for example,
+ * 9800.0).
- * Information - An informational event.
+ * instance-type - The instance type that is covered by the
+ * reservation.
+ * marketplace - Set to true to show only Reserved Instance
+ * Marketplace offerings. When this filter is not used, which is the default behavior, all
+ * offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
+ * product-description - The Reserved Instance product platform description.
+ * Instances that include (Amazon VPC) in the product platform description will
+ * only be displayed to EC2-Classic account holders and are for use with Amazon VPC.
+ * (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE
+ * Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise
+ * Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat
+ * Enterprise Linux with HA (Amazon VPC) | Windows | Windows
+ * (Amazon VPC) | Windows with SQL Server Standard | Windows with
+ * SQL Server Standard (Amazon VPC) | Windows with SQL Server Web |
+ * Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server
+ * Enterprise | Windows with SQL Server Enterprise (Amazon VPC))
+ * reserved-instances-offering-id - The Reserved Instances offering
+ * ID.
+ * scope - The scope of the Reserved Instance (Availability Zone or
+ * Region).
+ * usage-price - The usage price of the Reserved Instance, per hour (for
+ * example, 0.84).
The date and time of the event, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *Include Reserved Instance Marketplace offerings in the response.
*/ - Timestamp?: Date; -} + IncludeMarketplace?: boolean; -export namespace HistoryRecord { /** - * @internal + *The instance type that the reservation will cover (for example, m1.small). For more information, see
+ * Instance types in the
+ * Amazon EC2 User Guide.
Contains the output of DescribeSpotFleetRequestHistory.
- */ -export interface DescribeSpotFleetRequestHistoryResponse { /** - *Information about the events in the history of the Spot Fleet request.
+ *The maximum duration (in seconds) to filter when searching for offerings.
+ *Default: 94608000 (3 years)
*/ - HistoryRecords?: HistoryRecord[]; + MaxDuration?: number; /** - *The last date and time for the events, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ). - * All records up to this time were retrieved.
- *If nextToken indicates that there are more results, this value is not
- * present.
The maximum number of instances to filter when searching for offerings.
+ *Default: 20
*/ - LastEvaluatedTime?: Date; + MaxInstanceCount?: number; /** - *The token required to retrieve the next set of results. This value is
- * null when there are no more results to return.
The minimum duration (in seconds) to filter when searching for offerings.
+ *Default: 2592000 (1 month)
*/ - NextToken?: string; + MinDuration?: number; /** - *The ID of the Spot Fleet request.
+ *The offering class of the Reserved Instance. Can be standard or convertible.
The starting date and time for the events, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *The Reserved Instance product platform description. Instances that include (Amazon
+ * VPC) in the description are for use with Amazon VPC.
One or more Reserved Instances offering IDs.
*/ - export const filterSensitiveLog = (obj: DescribeSpotFleetRequestHistoryResponse): any => ({ - ...obj, - }); -} + ReservedInstancesOfferingIds?: string[]; -/** - *Contains the parameters for DescribeSpotFleetRequests.
- */ -export interface DescribeSpotFleetRequestsRequest { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return in a single call. Specify a value between 1
- * and 1000. The default value is 1000. To retrieve the remaining results, make another
- * call with the returned NextToken value.
The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy
+ * of dedicated is applied to instances that run in a VPC on single-tenant hardware
+ * (i.e., Dedicated Instances).
+ * Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
+ *
The maximum number of results to return for the request in a single page. The remaining
+ * results of the initial request can be seen by sending another request with the returned
+ * NextToken value. The maximum is 100.
Default: 100
*/ MaxResults?: number; /** - *The token for the next set of results.
+ *The token to retrieve the next page of results.
*/ NextToken?: string; /** - *The IDs of the Spot Fleet requests.
+ *The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API
+ * version, you only have access to the Medium Utilization Reserved Instance
+ * offering type.
Describes whether monitoring is enabled.
+ *Describes a Reserved Instance offering.
*/ -export interface SpotFleetMonitoring { +export interface PricingDetail { /** - *Enables monitoring for the instance.
- *Default: false
- *
The number of reservations available for the price.
*/ - Enabled?: boolean; + Count?: number; + + /** + *The price per instance.
+ */ + Price?: number; } -export namespace SpotFleetMonitoring { +export namespace PricingDetail { /** * @internal */ - export const filterSensitiveLog = (obj: SpotFleetMonitoring): any => ({ + export const filterSensitiveLog = (obj: PricingDetail): any => ({ ...obj, }); } /** - *Describes a network interface.
+ *Describes a Reserved Instance offering.
*/ -export interface InstanceNetworkInterfaceSpecification { - /** - *Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The
- * public IP address can only be assigned to a network interface for eth0, and can only be
- * assigned to a new network interface, not an existing one. You cannot specify more than one
- * network interface in the request. If launching into a default subnet, the default value is
- * true.
If set to true, the interface is deleted when the instance is terminated. You can
- * specify true only if creating a new network interface when launching an
- * instance.
The description of the network interface. Applies only if creating a network interface when launching an instance.
- */ - Description?: string; - - /** - *The position of the network interface in the attachment order. - * A primary network interface has a device index of 0.
- *If you specify a network interface when launching an instance, - * you must specify the device index.
- */ - DeviceIndex?: number; - +export interface ReservedInstancesOffering { /** - *The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
+ *The Availability Zone in which the Reserved Instance can be used.
*/ - Groups?: string[]; + AvailabilityZone?: string; /** - *A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses - * the IPv6 addresses from the range of the subnet. You cannot specify this option and the - * option to assign specific IPv6 addresses in the same request. You can specify this - * option if you've specified a minimum number of instances to launch.
+ *The duration of the Reserved Instance, in seconds.
*/ - Ipv6AddressCount?: number; + Duration?: number; /** - *One or more IPv6 addresses to assign to the network interface. You cannot specify - * this option and the option to assign a number of IPv6 addresses in the same request. You - * cannot specify this option if you've specified a minimum number of instances to - * launch.
+ *The purchase price of the Reserved Instance.
*/ - Ipv6Addresses?: InstanceIpv6Address[]; + FixedPrice?: number; /** - *The ID of the network interface.
- *If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
+ *The instance type on which the Reserved Instance can be used.
*/ - NetworkInterfaceId?: string; + InstanceType?: _InstanceType | string; /** - *The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching - * more than one instance in a RunInstances request.
+ *The Reserved Instance product platform description.
*/ - PrivateIpAddress?: string; + ProductDescription?: RIProductDescription | string; /** - *One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're - * launching more than one instance in a RunInstances request.
+ *The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote + * to confirm that an exchange can be made.
*/ - PrivateIpAddresses?: PrivateIpAddressSpecification[]; + ReservedInstancesOfferingId?: string; /** - *The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're - * launching more than one instance in a RunInstances request.
+ *The usage price of the Reserved Instance, per hour.
*/ - SecondaryPrivateIpAddressCount?: number; + UsagePrice?: number; /** - *The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
+ *The currency of the Reserved Instance offering you are purchasing. It's
+ * specified using ISO 4217 standard currency codes. At this time,
+ * the only supported currency is USD.
Indicates whether to assign a carrier IP address to the network interface.
- *You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. - * For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.
+ *The tenancy of the instance.
*/ - AssociateCarrierIpAddress?: boolean; + InstanceTenancy?: Tenancy | string; /** - *The type of network interface.
- *To create an Elastic Fabric Adapter (EFA), specify
- * efa. For more information, see Elastic Fabric Adapter in the
- * Amazon Elastic Compute Cloud User Guide.
Valid values: interface | efa
- *
Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services.
+ * If it's a Reserved Instance Marketplace offering, this is true.
The index of the network card. Some instance types support multiple network cards. - * The primary network interface must be assigned to network card index 0. - * The default is network card index 0.
+ *If convertible it can be exchanged for Reserved Instances of
+ * the same or higher monetary value, with different configurations. If standard, it is not
+ * possible to perform an exchange.
The Reserved Instance offering type.
*/ - export const filterSensitiveLog = (obj: InstanceNetworkInterfaceSpecification): any => ({ - ...obj, - }); -} + OfferingType?: OfferingTypeValues | string; -/** - *Describes Spot Instance placement.
- */ -export interface SpotPlacement { /** - *The Availability Zone.
- *[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; - * for example, "us-west-2a, us-west-2b".
+ *The pricing details of the Reserved Instance offering.
*/ - AvailabilityZone?: string; + PricingDetails?: PricingDetail[]; /** - *The name of the placement group.
+ *The recurring charge tag assigned to the resource.
*/ - GroupName?: string; + RecurringCharges?: RecurringCharge[]; /** - *The tenancy of the instance (if the instance is running in a VPC). An instance with a
- * tenancy of dedicated runs on single-tenant hardware. The host
- * tenancy is not supported for Spot Instances.
Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
*/ - Tenancy?: Tenancy | string; + Scope?: Scope | string; } -export namespace SpotPlacement { +export namespace ReservedInstancesOffering { /** * @internal */ - export const filterSensitiveLog = (obj: SpotPlacement): any => ({ + export const filterSensitiveLog = (obj: ReservedInstancesOffering): any => ({ ...obj, }); } /** - *The tags for a Spot Fleet resource.
+ *Contains the output of DescribeReservedInstancesOfferings.
*/ -export interface SpotFleetTagSpecification { +export interface DescribeReservedInstancesOfferingsResult { /** - *The type of resource. Currently, the only resource type that is supported is
- * instance. To tag the Spot Fleet request on creation, use the
- * TagSpecifications parameter in
- * SpotFleetRequestConfigData
- * .
A list of Reserved Instances offerings.
*/ - ResourceType?: ResourceType | string; + ReservedInstancesOfferings?: ReservedInstancesOffering[]; /** - *The tags.
+ *The token to use to retrieve the next page of results. This value is null when
+ * there are no more results to return.
Describes the launch specification for one or more Spot Instances. If you include
- * On-Demand capacity in your fleet request or want to specify an EFA network device, you
- * can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
- */ - SecurityGroups?: GroupIdentifier[]; - - /** - *Deprecated.
- */ - AddressingType?: string; - - /** - *One or more block devices that are mapped to the Spot Instances. You can't specify both - * a snapshot ID and an encryption value. This is because only blank volumes can be - * encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its - * encryption status is used for the volume encryption status.
- */ - BlockDeviceMappings?: BlockDeviceMapping[]; - - /** - *Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
- *Default: false
- *
The IAM instance profile.
- */ - IamInstanceProfile?: IamInstanceProfileSpecification; - - /** - *The ID of the AMI.
- */ - ImageId?: string; - - /** - *The instance type.
- */ - InstanceType?: _InstanceType | string; - - /** - *The ID of the kernel.
- */ - KernelId?: string; - - /** - *The name of the key pair.
- */ - KeyName?: string; - - /** - *Enable or disable monitoring for the instances.
- */ - Monitoring?: SpotFleetMonitoring; - - /** - *One or more network interfaces. If you specify a network interface, you must specify - * subnet IDs and security group IDs using the network interface.
- *
- * SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.
The placement information.
- */ - Placement?: SpotPlacement; - - /** - *The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel - * requirements for information about whether you need to specify a RAM disk. To find kernel - * requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.
- */ - RamdiskId?: string; - - /** - *The maximum price per unit hour that you are willing to pay for a Spot Instance.
- * If this value is not specified, the default is the Spot price specified for the fleet.
- * To determine the Spot price per unit hour, divide the Spot price by the
- * value of WeightedCapacity.
One or more filters.
+ *
+ * association.route-table-association-id - The ID of an association
+ * ID for the route table.
+ * association.route-table-id - The ID of the route table involved in
+ * the association.
+ * association.subnet-id - The ID of the subnet involved in the
+ * association.
+ * association.main - Indicates whether the route table is the main
+ * route table for the VPC (true | false). Route tables
+ * that do not have an association ID are not returned in the response.
+ * owner-id - The ID of the AWS account that owns the route table.
+ * route-table-id - The ID of the route table.
+ * route.destination-cidr-block - The IPv4 CIDR range specified in a
+ * route in the table.
+ * route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
+ * route.destination-prefix-list-id - The ID (prefix) of the AWS
+ * service specified in a route in the table.
+ * route.egress-only-internet-gateway-id - The ID of an
+ * egress-only Internet gateway specified in a route in the route table.
+ * route.gateway-id - The ID of a gateway specified in a route in the table.
+ * route.instance-id - The ID of an instance specified in a route in the table.
+ * route.nat-gateway-id - The ID of a NAT gateway.
+ * route.transit-gateway-id - The ID of a transit gateway.
+ * route.origin - Describes how the route was created.
+ * CreateRouteTable indicates that the route was automatically
+ * created when the route table was created; CreateRoute indicates
+ * that the route was manually added to the route table;
+ * EnableVgwRoutePropagation indicates that the route was
+ * propagated by route propagation.
+ * route.state - The state of a route in the route table
+ * (active | blackhole). The blackhole state
+ * indicates that the route's target isn't available (for example, the specified
+ * gateway isn't attached to the VPC, the specified NAT instance has been
+ * terminated, and so on).
+ * route.vpc-peering-connection-id - The ID of a VPC peering
+ * connection specified in a route in the table.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * vpc-id - The ID of the VPC for the route table.
The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate - * them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The Base64-encoded user data that instances use when starting up.
+ *One or more route table IDs.
+ *Default: Describes all your route tables.
*/ - UserData?: string; + RouteTableIds?: string[]; /** - *The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
- *If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
+ *The token for the next page of results.
*/ - WeightedCapacity?: number; + NextToken?: string; /** - *The tags to apply during creation.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Describes overrides for a launch template.
+ *Contains the output of DescribeRouteTables.
*/ -export interface LaunchTemplateOverrides { - /** - *The instance type.
- */ - InstanceType?: _InstanceType | string; - - /** - *The maximum price per unit hour that you are willing to pay for a Spot - * Instance.
- */ - SpotPrice?: string; - - /** - *The ID of the subnet in which to launch the instances.
- */ - SubnetId?: string; - - /** - *The Availability Zone in which to launch the instances.
- */ - AvailabilityZone?: string; - +export interface DescribeRouteTablesResult { /** - *The number of units provided by the specified instance type.
+ *Information about one or more route tables.
*/ - WeightedCapacity?: number; + RouteTables?: RouteTable[]; /** - *The priority for the launch template override. The highest priority is launched - * first.
- *If OnDemandAllocationStrategy is set to prioritized, Spot Fleet
- * uses priority to determine which launch template override to use first in fulfilling
- * On-Demand capacity.
If the Spot AllocationStrategy is set to
- * capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis
- * to determine which launch template override to use in fulfilling Spot capacity, but
- * optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the
- * higher the priority. If no number is set, the launch template override has the lowest
- * priority. You can set the same priority for different launch template overrides.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes a launch template and overrides.
+ *Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.
*/ -export interface LaunchTemplateConfig { +export interface SlotDateTimeRangeRequest { /** - *The launch template.
+ *The earliest date and time, in UTC, for the Scheduled Instance to start.
*/ - LaunchTemplateSpecification?: FleetLaunchTemplateSpecification; + EarliestTime: Date | undefined; /** - *Any parameters that you specify override the same parameters in the launch - * template.
+ *The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.
*/ - Overrides?: LaunchTemplateOverrides[]; + LatestTime: Date | undefined; } -export namespace LaunchTemplateConfig { +export namespace SlotDateTimeRangeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateConfig): any => ({ + export const filterSensitiveLog = (obj: SlotDateTimeRangeRequest): any => ({ ...obj, }); } /** - *Describes a Classic Load Balancer.
+ *Describes the recurring schedule for a Scheduled Instance.
*/ -export interface ClassicLoadBalancer { +export interface ScheduledInstanceRecurrenceRequest { /** - *The name of the load balancer.
+ *The frequency (Daily, Weekly, or Monthly).
The interval quantity. The interval unit depends on the value of Frequency. For example, every 2
+ * weeks or every 2 months.
Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers - * the running Spot Instances with these Classic Load Balancers.
- */ -export interface ClassicLoadBalancersConfig { /** - *One or more Classic Load Balancers.
+ *The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
*/ - ClassicLoadBalancers?: ClassicLoadBalancer[]; + OccurrenceDays?: number[]; + + /** + *Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
+ */ + OccurrenceRelativeToEnd?: boolean; + + /** + *The unit for OccurrenceDays (DayOfWeek or DayOfMonth).
+ * This value is required for a monthly schedule.
+ * You can't specify DayOfWeek with a weekly schedule.
+ * You can't specify this value with a daily schedule.
Describes a load balancer target group.
+ *Contains the parameters for DescribeScheduledInstanceAvailability.
*/ -export interface TargetGroup { +export interface DescribeScheduledInstanceAvailabilityRequest { /** - *The Amazon Resource Name (ARN) of the target group.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The filters.
+ *
+ * availability-zone - The Availability Zone (for example, us-west-2a).
+ * instance-type - The instance type (for example, c4.large).
+ * network-platform - The network platform (EC2-Classic or EC2-VPC).
+ * platform - The platform (Linux/UNIX or Windows).
Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the - * running Spot Instances with these target groups.
- */ -export interface TargetGroupsConfig { /** - *One or more target groups.
+ *The time period for the first schedule to start.
*/ - TargetGroups?: TargetGroup[]; -} + FirstSlotStartTimeRange: SlotDateTimeRangeRequest | undefined; -export namespace TargetGroupsConfig { /** - * @internal + *The maximum number of results to return in a single call.
+ * This value can be between 5 and 300. The default value is 300.
+ * To retrieve the remaining results, make another call with the returned
+ * NextToken value.
Describes the Classic Load Balancers and target groups to attach to a Spot Fleet - * request.
- */ -export interface LoadBalancersConfig { /** - *The Classic Load Balancers.
+ *The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours
+ * and less than 1,720.
The target groups.
+ *The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
*/ - TargetGroupsConfig?: TargetGroupsConfig; -} + MinSlotDurationInHours?: number; -export namespace LoadBalancersConfig { /** - * @internal + *The token for the next set of results.
*/ - export const filterSensitiveLog = (obj: LoadBalancersConfig): any => ({ - ...obj, - }); -} - -export enum OnDemandAllocationStrategy { - LOWEST_PRICE = "lowestPrice", - PRIORITIZED = "prioritized", -} - -export enum ReplacementStrategy { - LAUNCH = "launch", -} + NextToken?: string; -/** - *The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your - * Spot Instance is at an elevated risk of being interrupted. For more information, see - * Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.
- */ -export interface SpotCapacityRebalance { /** - *The replacement strategy to use. Only available for fleets of type
- * maintain. You must specify a value, otherwise you get an error.
To allow Spot Fleet to launch a replacement Spot Instance when an instance rebalance
- * notification is emitted for a Spot Instance in the fleet, specify
- * launch.
When a replacement instance is launched, the instance marked for rebalance is not - * automatically terminated. You can terminate it, or you can leave it running. You are - * charged for all instances while they are running.
- *The schedule recurrence.
*/ - ReplacementStrategy?: ReplacementStrategy | string; + Recurrence: ScheduledInstanceRecurrenceRequest | undefined; } -export namespace SpotCapacityRebalance { +export namespace DescribeScheduledInstanceAvailabilityRequest { /** * @internal */ - export const filterSensitiveLog = (obj: SpotCapacityRebalance): any => ({ + export const filterSensitiveLog = (obj: DescribeScheduledInstanceAvailabilityRequest): any => ({ ...obj, }); } /** - *The strategies for managing your Spot Instances that are at an elevated risk of being - * interrupted.
+ *Describes the recurring schedule for a Scheduled Instance.
*/ -export interface SpotMaintenanceStrategies { +export interface ScheduledInstanceRecurrence { /** - *The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an - * elevated risk of being interrupted.
+ *The frequency (Daily, Weekly, or Monthly).
The interval quantity. The interval unit depends on the value of frequency. For example, every 2
+ * weeks or every 2 months.
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
+ */ + OccurrenceDaySet?: number[]; + + /** + *Indicates whether the occurrence is relative to the end of the specified week or month.
+ */ + OccurrenceRelativeToEnd?: boolean; + + /** + *The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).
Describes the configuration of a Spot Fleet request.
+ *Describes a schedule that is available for your Scheduled Instances.
*/ -export interface SpotFleetRequestConfigData { +export interface ScheduledInstanceAvailability { /** - *Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by - * the Spot Fleet request.
- *If the allocation strategy is lowestPrice, Spot Fleet launches instances from
- * the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified, Spot Fleet launches instances from
- * all the Spot Instance pools that you specify.
If the allocation strategy is capacityOptimized (recommended), Spot Fleet
- * launches instances from Spot Instance pools with optimal capacity for the number of instances
- * that are launching. To give certain instance types a higher chance of launching first,
- * use capacityOptimizedPrioritized. Set a priority for each instance type by
- * using the Priority parameter for LaunchTemplateOverrides. You
- * can assign the same priority to different LaunchTemplateOverrides. EC2
- * implements the priorities on a best-effort basis, but optimizes for capacity first.
- * capacityOptimizedPrioritized is supported only if your Spot Fleet uses a
- * launch template. Note that if the OnDemandAllocationStrategy is set to
- * prioritized, the same priority is applied when fulfilling On-Demand
- * capacity.
The Availability Zone.
*/ - AllocationStrategy?: AllocationStrategy | string; + AvailabilityZone?: string; /** - *The order of the launch template overrides to use in fulfilling On-Demand capacity. If
- * you specify lowestPrice, Spot Fleet uses price to determine the order, launching
- * the lowest price first. If you specify prioritized, Spot Fleet uses the priority
- * that you assign to each Spot Fleet launch template override, launching the highest priority
- * first. If you do not specify a value, Spot Fleet defaults to lowestPrice.
The number of available instances.
*/ - OnDemandAllocationStrategy?: OnDemandAllocationStrategy | string; + AvailableInstanceCount?: number; /** - *The strategies for managing your Spot Instances that are at an elevated risk of being - * interrupted.
+ *The time period for the first schedule to start.
*/ - SpotMaintenanceStrategies?: SpotMaintenanceStrategies; + FirstSlotStartTime?: Date; /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of your - * listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.
+ *The hourly price for a single instance.
*/ - ClientToken?: string; + HourlyPrice?: string; /** - *Indicates whether running Spot Instances should be terminated if you decrease the - * target capacity of the Spot Fleet request below the current size of the Spot - * Fleet.
+ *The instance type. You can specify one of the C3, C4, M4, or R3 instance types.
*/ - ExcessCapacityTerminationPolicy?: ExcessCapacityTerminationPolicy | string; + InstanceType?: string; /** - *The number of units fulfilled by this request compared to the set target capacity. You - * cannot set this value.
+ *The maximum term. The only possible value is 365 days.
*/ - FulfilledCapacity?: number; + MaxTermDurationInDays?: number; /** - *The number of On-Demand units fulfilled by this request compared to the set target - * On-Demand capacity.
+ *The minimum term. The only possible value is 365 days.
*/ - OnDemandFulfilledCapacity?: number; + MinTermDurationInDays?: number; /** - *The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that
- * grants the Spot Fleet the permission to request, launch, terminate, and tag instances on
- * your behalf. For more information, see Spot
- * Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet
- * can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using
- * CancelSpotFleetRequests or when the Spot Fleet request expires, if you set
- * TerminateInstancesWithExpiration.
The network platform (EC2-Classic or EC2-VPC).
The launch specifications for the Spot Fleet request. If you specify
- * LaunchSpecifications, you can't specify
- * LaunchTemplateConfigs. If you include On-Demand capacity in your
- * request, you must use LaunchTemplateConfigs.
The platform (Linux/UNIX or Windows).
The launch template and overrides. If you specify LaunchTemplateConfigs,
- * you can't specify LaunchSpecifications. If you include On-Demand capacity
- * in your request, you must use LaunchTemplateConfigs.
The purchase token. This token expires in two hours.
*/ - LaunchTemplateConfigs?: LaunchTemplateConfig[]; + PurchaseToken?: string; /** - *The maximum price per unit hour that you are willing to pay for a Spot Instance. The - * default is the On-Demand price.
+ *The schedule recurrence.
*/ - SpotPrice?: string; + Recurrence?: ScheduledInstanceRecurrence; /** - *The number of units to request for the Spot Fleet. You can choose to set the target
- * capacity in terms of instances or a performance characteristic that is important to your
- * application workload, such as vCPUs, memory, or I/O. If the request type is
- * maintain, you can specify a target capacity of 0 and add capacity
- * later.
The number of hours in the schedule.
*/ - TargetCapacity: number | undefined; + SlotDurationInHours?: number; /** - *The number of On-Demand units to request. You can choose to set the target capacity in
- * terms of instances or a performance characteristic that is important to your application
- * workload, such as vCPUs, memory, or I/O. If the request type is maintain,
- * you can specify a target capacity of 0 and add capacity later.
The total number of hours for a single instance for the entire term.
*/ - OnDemandTargetCapacity?: number; + TotalScheduledInstanceHours?: number; +} +export namespace ScheduledInstanceAvailability { /** - *The maximum amount per hour for On-Demand Instances that you're willing to pay. You
- * can use the onDemandMaxTotalPrice parameter, the
- * spotMaxTotalPrice parameter, or both parameters to ensure that your
- * fleet cost does not exceed your budget. If you set a maximum price per hour for the
- * On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the
- * maximum amount you're willing to pay. When the maximum amount you're willing to pay is
- * reached, the fleet stops launching instances even if it hasn’t met the target
- * capacity.
Contains the output of DescribeScheduledInstanceAvailability.
+ */ +export interface DescribeScheduledInstanceAvailabilityResult { /** - *The maximum amount per hour for Spot Instances that you're willing to pay. You can use
- * the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice
- * parameter, or both parameters to ensure that your fleet cost does not exceed your
- * budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request,
- * Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay.
- * When the maximum amount you're willing to pay is reached, the fleet stops launching
- * instances even if it hasn’t met the target capacity.
The token required to retrieve the next set of results. This value is null when there are no more results to return.
Indicates whether running Spot Instances are terminated when the Spot Fleet request - * expires.
+ *Information about the available Scheduled Instances.
*/ - TerminateInstancesWithExpiration?: boolean; + ScheduledInstanceAvailabilitySet?: ScheduledInstanceAvailability[]; +} +export namespace DescribeScheduledInstanceAvailabilityResult { /** - *The type of request. Indicates whether the Spot Fleet only requests the target
- * capacity or also attempts to maintain it. When this value is request, the
- * Spot Fleet only places the required requests. It does not attempt to replenish Spot
- * Instances if capacity is diminished, nor does it submit requests in alternative Spot
- * pools if capacity is not available. When this value is maintain, the Spot
- * Fleet maintains the target capacity. The Spot Fleet places the required requests to meet
- * capacity and automatically replenishes any interrupted instances. Default:
- * maintain. instant is listed but is not used by Spot
- * Fleet.
Describes the time period for a Scheduled Instance to start its first schedule.
+ */ +export interface SlotStartTimeRangeRequest { /** - *The start date and time of the request, in UTC format - * (YYYY-MM-DDTHH:MM:SSZ). - * By default, Amazon EC2 starts fulfilling the request immediately.
+ *The earliest date and time, in UTC, for the Scheduled Instance to start.
*/ - ValidFrom?: Date; + EarliestTime?: Date; /** - *The end date and time of the request, in UTC format - * (YYYY-MM-DDTHH:MM:SSZ). - * After the end date and time, no new Spot Instance requests are placed or able to fulfill - * the request. If no value is specified, the Spot Fleet request remains until you cancel - * it.
+ *The latest date and time, in UTC, for the Scheduled Instance to start.
*/ - ValidUntil?: Date; + LatestTime?: Date; +} +export namespace SlotStartTimeRangeRequest { /** - *Indicates whether Spot Fleet should replace unhealthy instances.
+ * @internal */ - ReplaceUnhealthyInstances?: boolean; + export const filterSensitiveLog = (obj: SlotStartTimeRangeRequest): any => ({ + ...obj, + }); +} +/** + *Contains the parameters for DescribeScheduledInstances.
+ */ +export interface DescribeScheduledInstancesRequest { /** - *The behavior when a Spot Instance is interrupted. The default is
- * terminate.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more Classic Load Balancers and target groups to attach to the Spot Fleet - * request. Spot Fleet registers the running Spot Instances with the specified Classic Load - * Balancers and target groups.
- *With Network Load Balancers, Spot Fleet cannot register instances that have the - * following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, - * M3, and T1.
+ *The filters.
+ *
+ * availability-zone - The Availability Zone (for example, us-west-2a).
+ * instance-type - The instance type (for example, c4.large).
+ * network-platform - The network platform (EC2-Classic or EC2-VPC).
+ * platform - The platform (Linux/UNIX or Windows).
The number of Spot pools across which to allocate your target Spot capacity. Valid
- * only when Spot AllocationStrategy is set to
- * lowest-price. Spot Fleet selects the cheapest Spot pools and evenly
- * allocates your target Spot capacity across the number of Spot pools that you
- * specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a - * best effort basis. If a pool runs out of Spot capacity before fulfilling your target - * capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest - * pool. To ensure that your target capacity is met, you might receive Spot Instances from more than - * the number of pools that you specified. Similarly, if most of the pools have no Spot - * capacity, you might receive your full target capacity from fewer than the number of - * pools that you specified.
+ *The maximum number of results to return in a single call.
+ * This value can be between 5 and 300. The default value is 100.
+ * To retrieve the remaining results, make another call with the returned
+ * NextToken value.
Reserved.
+ *The token for the next set of results.
*/ - Context?: string; + NextToken?: string; /** - *The key-value pair for tagging the Spot Fleet request on creation. The value for
- * ResourceType must be spot-fleet-request, otherwise the
- * Spot Fleet request fails. To tag instances at launch, specify the tags in the launch
- * template (valid only if you use LaunchTemplateConfigs) or in
- * the
- * SpotFleetTagSpecification
- * (valid only if you use
- * LaunchSpecifications). For information about tagging after launch, see
- * Tagging Your Resources.
The Scheduled Instance IDs.
*/ - TagSpecifications?: TagSpecification[]; + ScheduledInstanceIds?: string[]; + + /** + *The time period for the first schedule to start.
+ */ + SlotStartTimeRange?: SlotStartTimeRangeRequest; } -export namespace SpotFleetRequestConfigData { +export namespace DescribeScheduledInstancesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: SpotFleetRequestConfigData): any => ({ + export const filterSensitiveLog = (obj: DescribeScheduledInstancesRequest): any => ({ ...obj, }); } /** - *Describes a Spot Fleet request.
+ *Describes a Scheduled Instance.
*/ -export interface SpotFleetRequestConfig { +export interface ScheduledInstance { /** - *The progress of the Spot Fleet request.
- * If there is an error, the status is error.
- * After all requests are placed, the status is pending_fulfillment.
- * If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled.
- * If the size of the fleet is decreased, the status is pending_termination
- * while Spot Instances are terminating.
The Availability Zone.
*/ - ActivityStatus?: ActivityStatus | string; + AvailabilityZone?: string; /** - *The creation date and time of the request.
+ *The date when the Scheduled Instance was purchased.
*/ - CreateTime?: Date; + CreateDate?: Date; /** - *The configuration of the Spot Fleet request.
+ *The hourly price for a single instance.
*/ - SpotFleetRequestConfig?: SpotFleetRequestConfigData; + HourlyPrice?: string; /** - *The ID of the Spot Fleet request.
+ *The number of instances.
*/ - SpotFleetRequestId?: string; + InstanceCount?: number; /** - *The state of the Spot Fleet request.
+ *The instance type.
*/ - SpotFleetRequestState?: BatchState | string; + InstanceType?: string; /** - *The tags for a Spot Fleet resource.
+ *The network platform (EC2-Classic or EC2-VPC).
The time for the next schedule to start.
+ */ + NextSlotStartTime?: Date; + + /** + *The platform (Linux/UNIX or Windows).
The time that the previous schedule ended or will end.
+ */ + PreviousSlotEndTime?: Date; + + /** + *The schedule recurrence.
+ */ + Recurrence?: ScheduledInstanceRecurrence; + + /** + *The Scheduled Instance ID.
+ */ + ScheduledInstanceId?: string; + + /** + *The number of hours in the schedule.
+ */ + SlotDurationInHours?: number; + + /** + *The end date for the Scheduled Instance.
+ */ + TermEndDate?: Date; + + /** + *The start date for the Scheduled Instance.
+ */ + TermStartDate?: Date; + + /** + *The total number of hours for a single instance for the entire term.
+ */ + TotalScheduledInstanceHours?: number; } -export namespace SpotFleetRequestConfig { +export namespace ScheduledInstance { /** * @internal */ - export const filterSensitiveLog = (obj: SpotFleetRequestConfig): any => ({ + export const filterSensitiveLog = (obj: ScheduledInstance): any => ({ ...obj, }); } /** - *Contains the output of DescribeSpotFleetRequests.
+ *Contains the output of DescribeScheduledInstances.
*/ -export interface DescribeSpotFleetRequestsResponse { +export interface DescribeScheduledInstancesResult { /** - *The token required to retrieve the next set of results. This value is
- * null when there are no more results to return.
The token required to retrieve the next set of results. This value is null when there are no more results to return.
Information about the configuration of your Spot Fleet.
+ *Information about the Scheduled Instances.
*/ - SpotFleetRequestConfigs?: SpotFleetRequestConfig[]; + ScheduledInstanceSet?: ScheduledInstance[]; } -export namespace DescribeSpotFleetRequestsResponse { +export namespace DescribeScheduledInstancesResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSpotFleetRequestsResponse): any => ({ + export const filterSensitiveLog = (obj: DescribeScheduledInstancesResult): any => ({ ...obj, }); } -/** - *Contains the parameters for DescribeSpotInstanceRequests.
- */ -export interface DescribeSpotInstanceRequestsRequest { +export interface DescribeSecurityGroupReferencesRequest { /** - *One or more filters.
- *
- * availability-zone-group - The Availability Zone group.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The IDs of the security groups in your account.
+ */ + GroupId: string[] | undefined; +} + +export namespace DescribeSecurityGroupReferencesRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeSecurityGroupReferencesRequest): any => ({ + ...obj, + }); +} + +/** + *Describes a VPC with a security group that references your security group.
+ */ +export interface SecurityGroupReference { + /** + *The ID of your security group.
+ */ + GroupId?: string; + + /** + *The ID of the VPC with the referencing security group.
+ */ + ReferencingVpcId?: string; + + /** + *The ID of the VPC peering connection.
+ */ + VpcPeeringConnectionId?: string; +} + +export namespace SecurityGroupReference { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SecurityGroupReference): any => ({ + ...obj, + }); +} + +export interface DescribeSecurityGroupReferencesResult { + /** + *Information about the VPCs with the referencing security groups.
+ */ + SecurityGroupReferenceSet?: SecurityGroupReference[]; +} + +export namespace DescribeSecurityGroupReferencesResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeSecurityGroupReferencesResult): any => ({ + ...obj, + }); +} + +export interface DescribeSecurityGroupRulesRequest { + /** + *One or more filters.
+ *
- * create-time - The time stamp when the Spot Instance request was
- * created.
group-id - The ID of the security group.
*
- * fault-code - The fault code related to the request.
security-group-rule-id - The ID of the security group rule.
*
- * fault-message - The fault message related to the request.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The IDs of the security group rules.
+ */ + SecurityGroupRuleIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
+ */ + NextToken?: string; + + /** + *The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another request with the returned NextToken value. This value
+ * can be between 5 and 1000. If this parameter is not specified, then all results are
+ * returned.
Information about security group rules.
+ */ + SecurityGroupRules?: SecurityGroupRule[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
+ *
- * instance-id - The ID of the instance that fulfilled the
- * request.
+ * description - The description of the security group.
- * launch-group - The Spot Instance launch group.
egress.ip-permission.cidr - An IPv4 CIDR block for an outbound
+ * security group rule.
*
- * launch.block-device-mapping.delete-on-termination - Indicates
- * whether the EBS volume is deleted on instance termination.
egress.ip-permission.from-port - For an outbound rule, the
+ * start of port range for the TCP and UDP protocols, or an ICMP type
+ * number.
*
- * launch.block-device-mapping.device-name - The device name for the
- * volume in the block device mapping (for example, /dev/sdh or
- * xvdh).
egress.ip-permission.group-id - The ID of a security group
+ * that has been referenced in an outbound security group rule.
*
- * launch.block-device-mapping.snapshot-id - The ID of the snapshot
- * for the EBS volume.
egress.ip-permission.group-name - The name of a security group
+ * that is referenced in an outbound security group rule.
*
- * launch.block-device-mapping.volume-size - The size of the EBS
- * volume, in GiB.
egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an
+ * outbound security group rule.
*
- * launch.block-device-mapping.volume-type - The type of EBS volume:
- * gp2 for General Purpose SSD, io1 or
- * io2 for Provisioned IOPS SSD, st1 for Throughput
- * Optimized HDD, sc1for Cold HDD, or standard for
- * Magnetic.
+ * egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
- * launch.group-id - The ID of the security group for the
- * instance.
egress.ip-permission.protocol - The IP protocol for an
+ * outbound security group rule (tcp | udp |
+ * icmp, a protocol number, or -1 for all protocols).
*
- * launch.group-name - The name of the security group for the
- * instance.
egress.ip-permission.to-port - For an outbound rule, the end
+ * of port range for the TCP and UDP protocols, or an ICMP code.
*
- * launch.image-id - The ID of the AMI.
egress.ip-permission.user-id - The ID of an Amazon Web Services account that
+ * has been referenced in an outbound security group rule.
*
- * launch.instance-type - The type of instance (for example,
- * m3.medium).
+ * group-id - The ID of the security group.
- * launch.kernel-id - The kernel ID.
+ * group-name - The name of the security group.
- * launch.key-name - The name of the key pair the instance launched
- * with.
+ * ip-permission.cidr - An IPv4 CIDR block for an inbound security
+ * group rule.
- * launch.monitoring-enabled - Whether detailed monitoring is
- * enabled for the Spot Instance.
+ * ip-permission.from-port - For an inbound rule, the start of port
+ * range for the TCP and UDP protocols, or an ICMP type number.
- * launch.ramdisk-id - The RAM disk ID.
+ * ip-permission.group-id - The ID of a security group that has been
+ * referenced in an inbound security group rule.
- * launched-availability-zone - The Availability Zone in which the
- * request is launched.
+ * ip-permission.group-name - The name of a security group that is
+ * referenced in an inbound security group rule.
- * network-interface.addresses.primary - Indicates whether the IP
- * address is the primary private IP address.
+ * ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security
+ * group rule.
- * network-interface.delete-on-termination - Indicates whether the
- * network interface is deleted when the instance is terminated.
ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
*
- * network-interface.description - A description of the network
- * interface.
+ * ip-permission.protocol - The IP protocol for an inbound security
+ * group rule (tcp | udp | icmp, a
+ * protocol number, or -1 for all protocols).
- * network-interface.device-index - The index of the device for the
- * network interface attachment on the instance.
+ * ip-permission.to-port - For an inbound rule, the end of port range
+ * for the TCP and UDP protocols, or an ICMP code.
- * network-interface.group-id - The ID of the security group
- * associated with the network interface.
+ * ip-permission.user-id - The ID of an Amazon Web Services account that has been
+ * referenced in an inbound security group rule.
- * network-interface.network-interface-id - The ID of the network
- * interface.
+ * owner-id - The Amazon Web Services account ID of the owner of the security group.
- * network-interface.private-ip-address - The primary private IP
- * address of the network interface.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * network-interface.subnet-id - The ID of the subnet for the
- * instance.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * product-description - The product description associated with the
- * instance (Linux/UNIX | Windows).
+ * vpc-id - The ID of the VPC specified when the security group was created.
The IDs of the security groups. Required for security groups in a nondefault VPC.
+ *Default: Describes all of your security groups.
+ */ + GroupIds?: string[]; + + /** + *[EC2-Classic and default VPC only] The names of the security groups. You can specify either
+ * the security group name or the security group ID. For security groups in a nondefault VPC, use
+ * the group-name filter to describe security groups by name.
Default: Describes all of your security groups.
+ */ + GroupNames?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token to request the next page of results.
+ */ + NextToken?: string; + + /** + *The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another request with the returned NextToken value. This value
+ * can be between 5 and 1000. If this parameter is not specified, then all results are
+ * returned.
Describes a security group.
+ */ +export interface SecurityGroup { + /** + *A description of the security group.
+ */ + Description?: string; + + /** + *The name of the security group.
+ */ + GroupName?: string; + + /** + *The inbound rules associated with the security group.
+ */ + IpPermissions?: IpPermission[]; + + /** + *The Amazon Web Services account ID of the owner of the security group.
+ */ + OwnerId?: string; + + /** + *The ID of the security group.
+ */ + GroupId?: string; + + /** + *[VPC only] The outbound rules associated with the security group.
+ */ + IpPermissionsEgress?: IpPermission[]; + + /** + *Any tags assigned to the security group.
+ */ + Tags?: Tag[]; + + /** + *[VPC only] The ID of the VPC for the security group.
+ */ + VpcId?: string; +} + +export namespace SecurityGroup { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SecurityGroup): any => ({ + ...obj, + }); +} + +export interface DescribeSecurityGroupsResult { + /** + *Information about the security groups.
+ */ + SecurityGroups?: SecurityGroup[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The snapshot attribute you would like to view.
+ */ + Attribute: SnapshotAttributeName | string | undefined; + + /** + *The ID of the EBS snapshot.
+ */ + SnapshotId: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the user or group to be added or removed from the list of create volume + * permissions for a volume.
+ */ +export interface CreateVolumePermission { + /** + *The group to be added or removed. The possible value is all.
The AWS account ID to be added or removed.
+ */ + UserId?: string; +} + +export namespace CreateVolumePermission { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateVolumePermission): any => ({ + ...obj, + }); +} + +export interface DescribeSnapshotAttributeResult { + /** + *The users and groups that have the permissions for creating volumes from the + * snapshot.
+ */ + CreateVolumePermissions?: CreateVolumePermission[]; + + /** + *The product codes.
+ */ + ProductCodes?: ProductCode[]; + + /** + *The ID of the EBS snapshot.
+ */ + SnapshotId?: string; +} + +export namespace DescribeSnapshotAttributeResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeSnapshotAttributeResult): any => ({ + ...obj, + }); +} + +export interface DescribeSnapshotsRequest { + /** + *The filters.
+ *
- * spot-instance-request-id - The Spot Instance request ID.
+ * description - A description of the snapshot.
- * spot-price - The maximum hourly price for any Spot Instance
- * launched to fulfill the request.
+ * encrypted - Indicates whether the snapshot is encrypted
+ * (true | false)
- * state - The state of the Spot Instance request (open
- * | active | closed | cancelled |
- * failed). Spot request status information can help you track
- * your Amazon EC2 Spot Instance requests. For more information, see Spot
- * request status in the Amazon EC2 User Guide for Linux Instances.
+ * owner-alias - The owner alias, from an Amazon-maintained list
+ * (amazon).
+ * This is not the user-configured AWS account alias set using the IAM console.
+ * We recommend that you use the related parameter instead of this filter.
- * status-code - The short code describing the most recent
- * evaluation of your Spot Instance request.
+ * owner-id - The AWS account ID of the owner. We recommend that
+ * you use the related parameter instead of this filter.
+ * progress - The progress of the snapshot, as a percentage (for example,
+ * 80%).
+ * snapshot-id - The snapshot ID.
+ * start-time - The time stamp when the snapshot was initiated.
+ * status - The status of the snapshot (pending |
+ * completed | error).
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * volume-id - The ID of the volume the snapshot is for.
+ * volume-size - The size of the volume, in GiB.
The maximum number of snapshot results returned by DescribeSnapshots in
+ * paginated output. When this parameter is used, DescribeSnapshots only returns
+ * MaxResults results in a single page along with a NextToken
+ * response element. The remaining results of the initial request can be seen by sending another
+ * DescribeSnapshots request with the returned NextToken value. This
+ * value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000,
+ * only 1,000 results are returned. If this parameter is not used, then
+ * DescribeSnapshots returns all results. You cannot specify this parameter and
+ * the snapshot IDs parameter in the same request.
The NextToken value returned from a previous paginated
+ * DescribeSnapshots request where MaxResults was used and the
+ * results exceeded the value of that parameter. Pagination continues from the end of the
+ * previous results that returned the NextToken value. This value is
+ * null when there are no more results to return.
Scopes the results to snapshots with the specified owners. You can specify a combination of
+ * AWS account IDs, self, and amazon.
The IDs of the AWS accounts that can create volumes from the snapshot.
+ */ + RestorableByUserIds?: string[]; + + /** + *The snapshot IDs.
+ *Default: Describes the snapshots for which you have create volume permissions.
+ */ + SnapshotIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the snapshots.
+ */ + Snapshots?: Snapshot[]; + + /** + *The NextToken value to include in a future DescribeSnapshots
+ * request. When the results of a DescribeSnapshots request exceed
+ * MaxResults, this value can be used to retrieve the next page of results. This
+ * value is null when there are no more results to return.
Contains the parameters for DescribeSpotDatafeedSubscription.
+ */ +export interface DescribeSpotDatafeedSubscriptionRequest { + /** + *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Contains the output of DescribeSpotDatafeedSubscription.
+ */ +export interface DescribeSpotDatafeedSubscriptionResult { + /** + *The Spot Instance data feed subscription.
+ */ + SpotDatafeedSubscription?: SpotDatafeedSubscription; +} + +export namespace DescribeSpotDatafeedSubscriptionResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeSpotDatafeedSubscriptionResult): any => ({ + ...obj, + }); +} + +/** + *Contains the parameters for DescribeSpotFleetInstances.
+ */ +export interface DescribeSpotFleetInstancesRequest { + /** + *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The maximum number of results to return in a single call. Specify a value between 1
+ * and 1000. The default value is 1000. To retrieve the remaining results, make another
+ * call with the returned NextToken value.
The token for the next set of results.
+ */ + NextToken?: string; + + /** + *The ID of the Spot Fleet request.
+ */ + SpotFleetRequestId: string | undefined; +} + +export namespace DescribeSpotFleetInstancesRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeSpotFleetInstancesRequest): any => ({ + ...obj, + }); +} + +/** + *Contains the output of DescribeSpotFleetInstances.
+ */ +export interface DescribeSpotFleetInstancesResponse { + /** + *The running instances. This list is refreshed periodically and might be out of + * date.
+ */ + ActiveInstances?: ActiveInstance[]; + + /** + *The token required to retrieve the next set of results. This value is
+ * null when there are no more results to return.
The ID of the Spot Fleet request.
+ */ + SpotFleetRequestId?: string; +} + +export namespace DescribeSpotFleetInstancesResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeSpotFleetInstancesResponse): any => ({ + ...obj, + }); +} + +export enum EventType { + BATCH_CHANGE = "fleetRequestChange", + ERROR = "error", + INFORMATION = "information", + INSTANCE_CHANGE = "instanceChange", +} + +/** + *Contains the parameters for DescribeSpotFleetRequestHistory.
+ */ +export interface DescribeSpotFleetRequestHistoryRequest { + /** + *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The type of events to describe. By default, all events are described.
+ */ + EventType?: EventType | string; + + /** + *The maximum number of results to return in a single call. Specify a value between 1
+ * and 1000. The default value is 1000. To retrieve the remaining results, make another
+ * call with the returned NextToken value.
The token for the next set of results.
+ */ + NextToken?: string; + + /** + *The ID of the Spot Fleet request.
+ */ + SpotFleetRequestId: string | undefined; + + /** + *The starting date and time for the events, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
+ */ + StartTime: Date | undefined; +} + +export namespace DescribeSpotFleetRequestHistoryRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeSpotFleetRequestHistoryRequest): any => ({ + ...obj, + }); +} + +/** + *Describes an event in the history of the Spot Fleet request.
+ */ +export interface HistoryRecord { + /** + *Information about the event.
+ */ + EventInformation?: EventInformation; + + /** + *The event type.
+ *
- * status-message - The message explaining the status of the Spot
- * Instance request.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
error - An error with the Spot Fleet request.
*
- * type - The type of Spot Instance request (one-time |
- * persistent).
fleetRequestChange - A change in the status or configuration of
+ * the Spot Fleet request.
*
- * valid-from - The start date of the request.
instanceChange - An instance was launched or terminated.
*
- * valid-until - The end date of the request.
Information - An informational event.
* The date and time of the event, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
+ */ + Timestamp?: Date; +} + +export namespace HistoryRecord { + /** + * @internal + */ + export const filterSensitiveLog = (obj: HistoryRecord): any => ({ + ...obj, + }); +} + +/** + *Contains the output of DescribeSpotFleetRequestHistory.
+ */ +export interface DescribeSpotFleetRequestHistoryResponse { + /** + *Information about the events in the history of the Spot Fleet request.
+ */ + HistoryRecords?: HistoryRecord[]; + + /** + *The last date and time for the events, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ). + * All records up to this time were retrieved.
+ *If nextToken indicates that there are more results, this value is not
+ * present.
The token required to retrieve the next set of results. This value is
+ * null when there are no more results to return.
The ID of the Spot Fleet request.
+ */ + SpotFleetRequestId?: string; + + /** + *The starting date and time for the events, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
+ */ + StartTime?: Date; +} + +export namespace DescribeSpotFleetRequestHistoryResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeSpotFleetRequestHistoryResponse): any => ({ + ...obj, + }); +} +/** + *Contains the parameters for DescribeSpotFleetRequests.
+ */ +export interface DescribeSpotFleetRequestsRequest { /** *Checks whether you have the required permissions for the action, without actually * making the request, and provides an error response. If you have the required @@ -8367,1743 +8142,1981 @@ export interface DescribeSpotInstanceRequestsRequest { DryRun?: boolean; /** - *
One or more Spot Instance request IDs.
+ *The maximum number of results to return in a single call. Specify a value between 1
+ * and 1000. The default value is 1000. To retrieve the remaining results, make another
+ * call with the returned NextToken value.
The token to request the next set of results. This value is null when
- * there are no more results to return.
The token for the next set of results.
*/ NextToken?: string; /** - *The maximum number of results to return in a single call. Specify a value between 5
- * and 1000. To retrieve the remaining results, make another call with the returned
- * NextToken value.
The IDs of the Spot Fleet requests.
*/ - MaxResults?: number; + SpotFleetRequestIds?: string[]; } -export namespace DescribeSpotInstanceRequestsRequest { +export namespace DescribeSpotFleetRequestsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSpotInstanceRequestsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeSpotFleetRequestsRequest): any => ({ ...obj, }); } +export enum ExcessCapacityTerminationPolicy { + DEFAULT = "default", + NO_TERMINATION = "noTermination", +} + /** - *Describes the monitoring of an instance.
+ *Describes whether monitoring is enabled.
*/ -export interface RunInstancesMonitoringEnabled { +export interface SpotFleetMonitoring { /** - *Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is - * enabled.
+ *Enables monitoring for the instance.
+ *Default: false
+ *
Describes the launch specification for an instance.
+ *Describes a network interface.
*/ -export interface LaunchSpecification { +export interface InstanceNetworkInterfaceSpecification { /** - *The Base64-encoded user data for the instance.
+ *Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The
+ * public IP address can only be assigned to a network interface for eth0, and can only be
+ * assigned to a new network interface, not an existing one. You cannot specify more than one
+ * network interface in the request. If launching into a default subnet, the default value is
+ * true.
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
+ *If set to true, the interface is deleted when the instance is terminated. You can
+ * specify true only if creating a new network interface when launching an
+ * instance.
Deprecated.
+ *The description of the network interface. Applies only if creating a network interface when launching an instance.
*/ - AddressingType?: string; + Description?: string; /** - *One or more block device mapping entries.
+ *The position of the network interface in the attachment order. + * A primary network interface has a device index of 0.
+ *If you specify a network interface when launching an instance, + * you must specify the device index.
*/ - BlockDeviceMappings?: BlockDeviceMapping[]; + DeviceIndex?: number; /** - *Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
- *Default: false
- *
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
*/ - EbsOptimized?: boolean; + Groups?: string[]; /** - *The IAM instance profile.
+ *A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses + * the IPv6 addresses from the range of the subnet. You cannot specify this option and the + * option to assign specific IPv6 addresses in the same request. You can specify this + * option if you've specified a minimum number of instances to launch.
*/ - IamInstanceProfile?: IamInstanceProfileSpecification; + Ipv6AddressCount?: number; /** - *The ID of the AMI.
+ *One or more IPv6 addresses to assign to the network interface. You cannot specify + * this option and the option to assign a number of IPv6 addresses in the same request. You + * cannot specify this option if you've specified a minimum number of instances to + * launch.
*/ - ImageId?: string; + Ipv6Addresses?: InstanceIpv6Address[]; /** - *The instance type.
+ *The ID of the network interface.
+ *If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
*/ - InstanceType?: _InstanceType | string; + NetworkInterfaceId?: string; /** - *The ID of the kernel.
+ *The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching + * more than one instance in a RunInstances request.
*/ - KernelId?: string; + PrivateIpAddress?: string; /** - *The name of the key pair.
+ *One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're + * launching more than one instance in a RunInstances request.
*/ - KeyName?: string; + PrivateIpAddresses?: PrivateIpAddressSpecification[]; /** - *One or more network interfaces. If you specify a network interface, you must specify - * subnet IDs and security group IDs using the network interface.
+ *The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're + * launching more than one instance in a RunInstances request.
*/ - NetworkInterfaces?: InstanceNetworkInterfaceSpecification[]; + SecondaryPrivateIpAddressCount?: number; /** - *The placement information for the instance.
+ *The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
*/ - Placement?: SpotPlacement; + SubnetId?: string; /** - *The ID of the RAM disk.
+ *Indicates whether to assign a carrier IP address to the network interface.
+ *You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. + * For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.
*/ - RamdiskId?: string; + AssociateCarrierIpAddress?: boolean; /** - *The ID of the subnet in which to launch the instance.
+ *The type of network interface.
+ *To create an Elastic Fabric Adapter (EFA), specify
+ * efa. For more information, see Elastic Fabric Adapter in the
+ * Amazon Elastic Compute Cloud User Guide.
Valid values: interface | efa
+ *
The index of the network card. Some instance types support multiple network cards. + * The primary network interface must be assigned to network card index 0. + * The default is network card index 0.
+ */ + NetworkCardIndex?: number; +} + +export namespace InstanceNetworkInterfaceSpecification { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InstanceNetworkInterfaceSpecification): any => ({ + ...obj, + }); +} + +/** + *Describes Spot Instance placement.
+ */ +export interface SpotPlacement { + /** + *The Availability Zone.
+ *[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; + * for example, "us-west-2a, us-west-2b".
+ */ + AvailabilityZone?: string; + + /** + *The name of the placement group.
*/ - SubnetId?: string; + GroupName?: string; /** - *Describes the monitoring of an instance.
+ *The tenancy of the instance (if the instance is running in a VPC). An instance with a
+ * tenancy of dedicated runs on single-tenant hardware. The host
+ * tenancy is not supported for Spot Instances.
Describes the status of a Spot Instance request.
+ *The tags for a Spot Fleet resource.
*/ -export interface SpotInstanceStatus { - /** - *The status code. For a list of status codes, see Spot status codes in the Amazon EC2 User Guide for Linux Instances.
- */ - Code?: string; - +export interface SpotFleetTagSpecification { /** - *The description for the status code.
+ *The type of resource. Currently, the only resource type that is supported is
+ * instance. To tag the Spot Fleet request on creation, use the
+ * TagSpecifications parameter in
+ * SpotFleetRequestConfigData
+ * .
The date and time of the most recent status update, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *The tags.
*/ - UpdateTime?: Date; + Tags?: Tag[]; } -export namespace SpotInstanceStatus { +export namespace SpotFleetTagSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: SpotInstanceStatus): any => ({ + export const filterSensitiveLog = (obj: SpotFleetTagSpecification): any => ({ ...obj, }); } /** - *Describes a Spot Instance request.
+ *Describes the launch specification for one or more Spot Instances. If you include
+ * On-Demand capacity in your fleet request or want to specify an EFA network device, you
+ * can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.
Deprecated.
- */ - ActualBlockHourlyPrice?: string; - +export interface SpotFleetLaunchSpecification { /** - *The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
+ *One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
*/ - AvailabilityZoneGroup?: string; + SecurityGroups?: GroupIdentifier[]; /** *Deprecated.
*/ - BlockDurationMinutes?: number; + AddressingType?: string; /** - *The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
+ *One or more block devices that are mapped to the Spot Instances. You can't specify both + * a snapshot ID and an encryption value. This is because only blank volumes can be + * encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its + * encryption status is used for the volume encryption status.
*/ - CreateTime?: Date; + BlockDeviceMappings?: BlockDeviceMapping[]; /** - *The fault codes for the Spot Instance request, if any.
+ *Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
+ *Default: false
+ *
The instance ID, if an instance has been launched to fulfill the Spot Instance request.
+ *The IAM instance profile.
*/ - InstanceId?: string; + IamInstanceProfile?: IamInstanceProfileSpecification; /** - *The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
+ *The ID of the AMI.
*/ - LaunchGroup?: string; + ImageId?: string; /** - *Additional information for launching instances.
+ *The instance type.
*/ - LaunchSpecification?: LaunchSpecification; + InstanceType?: _InstanceType | string; /** - *The Availability Zone in which the request is launched.
+ *The ID of the kernel.
*/ - LaunchedAvailabilityZone?: string; + KernelId?: string; /** - *The product description associated with the Spot Instance.
+ *The name of the key pair.
*/ - ProductDescription?: RIProductDescription | string; + KeyName?: string; /** - *The ID of the Spot Instance request.
+ *Enable or disable monitoring for the instances.
*/ - SpotInstanceRequestId?: string; + Monitoring?: SpotFleetMonitoring; /** - *The maximum price per hour that you are willing to pay for a Spot Instance.
+ *One or more network interfaces. If you specify a network interface, you must specify + * subnet IDs and security group IDs using the network interface.
+ *
+ * SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.
The state of the Spot Instance request. Spot status information helps track your Spot - * Instance requests. For more information, see Spot status in the - * Amazon EC2 User Guide for Linux Instances.
+ *The placement information.
*/ - State?: SpotInstanceState | string; + Placement?: SpotPlacement; /** - *The status code and status message describing the Spot Instance request.
+ *The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel + * requirements for information about whether you need to specify a RAM disk. To find kernel + * requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.
*/ - Status?: SpotInstanceStatus; + RamdiskId?: string; /** - *Any tags assigned to the resource.
+ *The maximum price per unit hour that you are willing to pay for a Spot Instance.
+ * If this value is not specified, the default is the Spot price specified for the fleet.
+ * To determine the Spot price per unit hour, divide the Spot price by the
+ * value of WeightedCapacity.
The Spot Instance request type.
+ *The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate + * them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".
*/ - Type?: SpotInstanceType | string; + SubnetId?: string; /** - *The start date of the request, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ). - * The request becomes active at this date and time.
+ *The Base64-encoded user data that instances use when starting up.
*/ - ValidFrom?: Date; + UserData?: string; /** - *The end date of the request, in UTC format - * (YYYY-MM-DDTHH:MM:SSZ).
- *For a persistent request, the request remains active until the validUntil date
- * and time is reached. Otherwise, the request remains active until you cancel it.
- *
For a one-time request, the request remains active until all instances launch,
- * the request is canceled, or the validUntil date and time is reached. By default, the
- * request is valid for 7 days from the date the request was created.
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
+ *If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
*/ - ValidUntil?: Date; + WeightedCapacity?: number; /** - *The behavior when a Spot Instance is interrupted.
+ *The tags to apply during creation.
*/ - InstanceInterruptionBehavior?: InstanceInterruptionBehavior | string; + TagSpecifications?: SpotFleetTagSpecification[]; } -export namespace SpotInstanceRequest { +export namespace SpotFleetLaunchSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: SpotInstanceRequest): any => ({ + export const filterSensitiveLog = (obj: SpotFleetLaunchSpecification): any => ({ ...obj, }); } /** - *Contains the output of DescribeSpotInstanceRequests.
+ *Describes overrides for a launch template.
*/ -export interface DescribeSpotInstanceRequestsResult { - /** - *One or more Spot Instance requests.
- */ - SpotInstanceRequests?: SpotInstanceRequest[]; - +export interface LaunchTemplateOverrides { /** - *The token to use to retrieve the next set of results. This value is null
- * when there are no more results to return.
The instance type.
*/ - NextToken?: string; -} + InstanceType?: _InstanceType | string; -export namespace DescribeSpotInstanceRequestsResult { /** - * @internal + *The maximum price per unit hour that you are willing to pay for a Spot + * Instance.
*/ - export const filterSensitiveLog = (obj: DescribeSpotInstanceRequestsResult): any => ({ - ...obj, - }); -} + SpotPrice?: string; -/** - *Contains the parameters for DescribeSpotPriceHistory.
- */ -export interface DescribeSpotPriceHistoryRequest { /** - *One or more filters.
- *
- * availability-zone - The Availability Zone for which prices should
- * be returned.
- * instance-type - The type of instance (for example,
- * m3.medium).
- * product-description - The product description for the Spot price
- * (Linux/UNIX | Red Hat Enterprise Linux |
- * SUSE Linux | Windows | Linux/UNIX (Amazon
- * VPC) | Red Hat Enterprise Linux (Amazon VPC) |
- * SUSE Linux (Amazon VPC) | Windows (Amazon
- * VPC)).
- * spot-price - The Spot price. The value must match exactly (or use
- * wildcards; greater than or less than comparison is not supported).
- * timestamp - The time stamp of the Spot price history, in UTC format
- * (for example,
- * YYYY-MM-DDTHH:MM:SSZ).
- * You can use wildcards (* and ?). Greater than or less than comparison is not
- * supported.
The ID of the subnet in which to launch the instances.
*/ - Filters?: Filter[]; + SubnetId?: string; /** - *Filters the results by the specified Availability Zone.
+ *The Availability Zone in which to launch the instances.
*/ AvailabilityZone?: string; /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The number of units provided by the specified instance type.
*/ - DryRun?: boolean; + WeightedCapacity?: number; /** - *The date and time, up to the current date, from which to stop retrieving the price - * history data, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *The priority for the launch template override. The highest priority is launched + * first.
+ *If OnDemandAllocationStrategy is set to prioritized, Spot Fleet
+ * uses priority to determine which launch template override to use first in fulfilling
+ * On-Demand capacity.
If the Spot AllocationStrategy is set to
+ * capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis
+ * to determine which launch template override to use in fulfilling Spot capacity, but
+ * optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the
+ * higher the priority. If no number is set, the launch template override has the lowest
+ * priority. You can set the same priority for different launch template overrides.
Filters the results by the specified instance types.
+ * @internal */ - InstanceTypes?: (_InstanceType | string)[]; + export const filterSensitiveLog = (obj: LaunchTemplateOverrides): any => ({ + ...obj, + }); +} +/** + *Describes a launch template and overrides.
+ */ +export interface LaunchTemplateConfig { /** - *The maximum number of results to return in a single call. Specify a value between 1
- * and 1000. The default value is 1000. To retrieve the remaining results, make another
- * call with the returned NextToken value.
The launch template.
*/ - MaxResults?: number; + LaunchTemplateSpecification?: FleetLaunchTemplateSpecification; /** - *The token for the next set of results.
+ *Any parameters that you specify override the same parameters in the launch + * template.
*/ - NextToken?: string; + Overrides?: LaunchTemplateOverrides[]; +} +export namespace LaunchTemplateConfig { /** - *Filters the results by the specified basic product descriptions.
+ * @internal */ - ProductDescriptions?: string[]; + export const filterSensitiveLog = (obj: LaunchTemplateConfig): any => ({ + ...obj, + }); +} +/** + *Describes a Classic Load Balancer.
+ */ +export interface ClassicLoadBalancer { /** - *The date and time, up to the past 90 days, from which to start retrieving the price - * history data, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *The name of the load balancer.
*/ - StartTime?: Date; + Name?: string; } -export namespace DescribeSpotPriceHistoryRequest { +export namespace ClassicLoadBalancer { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSpotPriceHistoryRequest): any => ({ + export const filterSensitiveLog = (obj: ClassicLoadBalancer): any => ({ ...obj, }); } /** - *Describes the maximum price per hour that you are willing to pay for a Spot - * Instance.
+ *Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers + * the running Spot Instances with these Classic Load Balancers.
*/ -export interface SpotPrice { +export interface ClassicLoadBalancersConfig { /** - *The Availability Zone.
+ *One or more Classic Load Balancers.
*/ - AvailabilityZone?: string; + ClassicLoadBalancers?: ClassicLoadBalancer[]; +} +export namespace ClassicLoadBalancersConfig { /** - *The instance type.
+ * @internal */ - InstanceType?: _InstanceType | string; + export const filterSensitiveLog = (obj: ClassicLoadBalancersConfig): any => ({ + ...obj, + }); +} +/** + *Describes a load balancer target group.
+ */ +export interface TargetGroup { /** - *A general description of the AMI.
+ *The Amazon Resource Name (ARN) of the target group.
*/ - ProductDescription?: RIProductDescription | string; + Arn?: string; +} +export namespace TargetGroup { /** - *The maximum price per hour that you are willing to pay for a Spot Instance.
+ * @internal */ - SpotPrice?: string; + export const filterSensitiveLog = (obj: TargetGroup): any => ({ + ...obj, + }); +} +/** + *Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the + * running Spot Instances with these target groups.
+ */ +export interface TargetGroupsConfig { /** - *The date and time the request was created, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *One or more target groups.
*/ - Timestamp?: Date; + TargetGroups?: TargetGroup[]; } -export namespace SpotPrice { +export namespace TargetGroupsConfig { /** * @internal */ - export const filterSensitiveLog = (obj: SpotPrice): any => ({ + export const filterSensitiveLog = (obj: TargetGroupsConfig): any => ({ ...obj, }); } /** - *Contains the output of DescribeSpotPriceHistory.
+ *Describes the Classic Load Balancers and target groups to attach to a Spot Fleet + * request.
*/ -export interface DescribeSpotPriceHistoryResult { +export interface LoadBalancersConfig { /** - *The token required to retrieve the next set of results. This value is null or an empty - * string when there are no more results to return.
+ *The Classic Load Balancers.
*/ - NextToken?: string; + ClassicLoadBalancersConfig?: ClassicLoadBalancersConfig; /** - *The historical Spot prices.
+ *The target groups.
*/ - SpotPriceHistory?: SpotPrice[]; + TargetGroupsConfig?: TargetGroupsConfig; } -export namespace DescribeSpotPriceHistoryResult { +export namespace LoadBalancersConfig { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSpotPriceHistoryResult): any => ({ + export const filterSensitiveLog = (obj: LoadBalancersConfig): any => ({ ...obj, }); } -export interface DescribeStaleSecurityGroupsRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your + * Spot Instance is at an elevated risk of being interrupted. For more information, see + * Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.
+ */ +export interface SpotCapacityRebalance { /** - *The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
+ *The replacement strategy to use. Only available for fleets of type
+ * maintain. You must specify a value, otherwise you get an error.
To allow Spot Fleet to launch a replacement Spot Instance when an instance rebalance
+ * notification is emitted for a Spot Instance in the fleet, specify
+ * launch.
When a replacement instance is launched, the instance marked for rebalance is not + * automatically terminated. You can terminate it, or you can leave it running. You are + * charged for all instances while they are running.
+ *The token for the next set of items to return. (You received this token from a prior call.)
+ * @internal */ - NextToken?: string; + export const filterSensitiveLog = (obj: SpotCapacityRebalance): any => ({ + ...obj, + }); +} +/** + *The strategies for managing your Spot Instances that are at an elevated risk of being + * interrupted.
+ */ +export interface SpotMaintenanceStrategies { /** - *The ID of the VPC.
+ *The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an + * elevated risk of being interrupted.
*/ - VpcId: string | undefined; + CapacityRebalance?: SpotCapacityRebalance; } -export namespace DescribeStaleSecurityGroupsRequest { +export namespace SpotMaintenanceStrategies { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeStaleSecurityGroupsRequest): any => ({ + export const filterSensitiveLog = (obj: SpotMaintenanceStrategies): any => ({ ...obj, }); } /** - *Describes a stale rule in a security group.
+ *Describes the configuration of a Spot Fleet request.
*/ -export interface StaleIpPermission { +export interface SpotFleetRequestConfigData { /** - *The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of
- * -1 indicates all ICMP types.
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by + * the Spot Fleet request.
+ *If the allocation strategy is lowestPrice, Spot Fleet launches instances from
+ * the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified, Spot Fleet launches instances from
+ * all the Spot Instance pools that you specify.
If the allocation strategy is capacityOptimized (recommended), Spot Fleet
+ * launches instances from Spot Instance pools with optimal capacity for the number of instances
+ * that are launching. To give certain instance types a higher chance of launching first,
+ * use capacityOptimizedPrioritized. Set a priority for each instance type by
+ * using the Priority parameter for LaunchTemplateOverrides. You
+ * can assign the same priority to different LaunchTemplateOverrides. EC2
+ * implements the priorities on a best-effort basis, but optimizes for capacity first.
+ * capacityOptimizedPrioritized is supported only if your Spot Fleet uses a
+ * launch template. Note that if the OnDemandAllocationStrategy is set to
+ * prioritized, the same priority is applied when fulfilling On-Demand
+ * capacity.
The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).
The order of the launch template overrides to use in fulfilling On-Demand capacity. If
+ * you specify lowestPrice, Spot Fleet uses price to determine the order, launching
+ * the lowest price first. If you specify prioritized, Spot Fleet uses the priority
+ * that you assign to each Spot Fleet launch template override, launching the highest priority
+ * first. If you do not specify a value, Spot Fleet defaults to lowestPrice.
The IP ranges. Not applicable for stale security group rules.
+ *The strategies for managing your Spot Instances that are at an elevated risk of being + * interrupted.
*/ - IpRanges?: string[]; + SpotMaintenanceStrategies?: SpotMaintenanceStrategies; /** - *The prefix list IDs. Not applicable for stale security group rules.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of your + * listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.
*/ - PrefixListIds?: string[]; + ClientToken?: string; /** - *The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of
- * -1 indicates all ICMP types.
Indicates whether running Spot Instances should be terminated if you decrease the + * target capacity of the Spot Fleet request below the current size of the Spot + * Fleet.
*/ - ToPort?: number; + ExcessCapacityTerminationPolicy?: ExcessCapacityTerminationPolicy | string; /** - *The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.
+ *The number of units fulfilled by this request compared to the set target capacity. You + * cannot set this value.
*/ - UserIdGroupPairs?: UserIdGroupPair[]; -} + FulfilledCapacity?: number; -export namespace StaleIpPermission { /** - * @internal + *The number of On-Demand units fulfilled by this request compared to the set target + * On-Demand capacity.
*/ - export const filterSensitiveLog = (obj: StaleIpPermission): any => ({ - ...obj, - }); -} + OnDemandFulfilledCapacity?: number; + + /** + *The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that
+ * grants the Spot Fleet the permission to request, launch, terminate, and tag instances on
+ * your behalf. For more information, see Spot
+ * Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet
+ * can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using
+ * CancelSpotFleetRequests or when the Spot Fleet request expires, if you set
+ * TerminateInstancesWithExpiration.
The launch specifications for the Spot Fleet request. If you specify
+ * LaunchSpecifications, you can't specify
+ * LaunchTemplateConfigs. If you include On-Demand capacity in your
+ * request, you must use LaunchTemplateConfigs.
The launch template and overrides. If you specify LaunchTemplateConfigs,
+ * you can't specify LaunchSpecifications. If you include On-Demand capacity
+ * in your request, you must use LaunchTemplateConfigs.
Describes a stale security group (a security group that contains stale rules).
- */ -export interface StaleSecurityGroup { /** - *The description of the security group.
+ *The maximum price per unit hour that you are willing to pay for a Spot Instance. The + * default is the On-Demand price.
*/ - Description?: string; + SpotPrice?: string; /** - *The ID of the security group.
+ *The number of units to request for the Spot Fleet. You can choose to set the target
+ * capacity in terms of instances or a performance characteristic that is important to your
+ * application workload, such as vCPUs, memory, or I/O. If the request type is
+ * maintain, you can specify a target capacity of 0 and add capacity
+ * later.
The name of the security group.
+ *The number of On-Demand units to request. You can choose to set the target capacity in
+ * terms of instances or a performance characteristic that is important to your application
+ * workload, such as vCPUs, memory, or I/O. If the request type is maintain,
+ * you can specify a target capacity of 0 and add capacity later.
Information about the stale inbound rules in the security group.
+ *The maximum amount per hour for On-Demand Instances that you're willing to pay. You
+ * can use the onDemandMaxTotalPrice parameter, the
+ * spotMaxTotalPrice parameter, or both parameters to ensure that your
+ * fleet cost does not exceed your budget. If you set a maximum price per hour for the
+ * On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the
+ * maximum amount you're willing to pay. When the maximum amount you're willing to pay is
+ * reached, the fleet stops launching instances even if it hasn’t met the target
+ * capacity.
Information about the stale outbound rules in the security group.
+ *The maximum amount per hour for Spot Instances that you're willing to pay. You can use
+ * the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice
+ * parameter, or both parameters to ensure that your fleet cost does not exceed your
+ * budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request,
+ * Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay.
+ * When the maximum amount you're willing to pay is reached, the fleet stops launching
+ * instances even if it hasn’t met the target capacity.
The ID of the VPC for the security group.
+ *Indicates whether running Spot Instances are terminated when the Spot Fleet request + * expires.
*/ - VpcId?: string; -} + TerminateInstancesWithExpiration?: boolean; -export namespace StaleSecurityGroup { /** - * @internal + *The type of request. Indicates whether the Spot Fleet only requests the target
+ * capacity or also attempts to maintain it. When this value is request, the
+ * Spot Fleet only places the required requests. It does not attempt to replenish Spot
+ * Instances if capacity is diminished, nor does it submit requests in alternative Spot
+ * pools if capacity is not available. When this value is maintain, the Spot
+ * Fleet maintains the target capacity. The Spot Fleet places the required requests to meet
+ * capacity and automatically replenishes any interrupted instances. Default:
+ * maintain. instant is listed but is not used by Spot
+ * Fleet.
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
+ *The start date and time of the request, in UTC format + * (YYYY-MM-DDTHH:MM:SSZ). + * By default, Amazon EC2 starts fulfilling the request immediately.
*/ - NextToken?: string; + ValidFrom?: Date; /** - *Information about the stale security groups.
+ *The end date and time of the request, in UTC format + * (YYYY-MM-DDTHH:MM:SSZ). + * After the end date and time, no new Spot Instance requests are placed or able to fulfill + * the request. If no value is specified, the Spot Fleet request remains until you cancel + * it.
*/ - StaleSecurityGroupSet?: StaleSecurityGroup[]; -} + ValidUntil?: Date; -export namespace DescribeStaleSecurityGroupsResult { /** - * @internal + *Indicates whether Spot Fleet should replace unhealthy instances.
*/ - export const filterSensitiveLog = (obj: DescribeStaleSecurityGroupsResult): any => ({ - ...obj, - }); -} + ReplaceUnhealthyInstances?: boolean; -export interface DescribeStoreImageTasksRequest { /** - *The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.
+ *The behavior when a Spot Instance is interrupted. The default is
+ * terminate.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more Classic Load Balancers and target groups to attach to the Spot Fleet + * request. Spot Fleet registers the running Spot Instances with the specified Classic Load + * Balancers and target groups.
+ *With Network Load Balancers, Spot Fleet cannot register instances that have the + * following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, + * M3, and T1.
*/ - DryRun?: boolean; + LoadBalancersConfig?: LoadBalancersConfig; /** - *The filters.
- *
- * task-state - Returns tasks in a certain state (InProgress |
- * Completed | Failed)
- * bucket - Returns task information for tasks that targeted a specific
- * bucket. For the filter value, specify the bucket name.
The number of Spot pools across which to allocate your target Spot capacity. Valid
+ * only when Spot AllocationStrategy is set to
+ * lowest-price. Spot Fleet selects the cheapest Spot pools and evenly
+ * allocates your target Spot capacity across the number of Spot pools that you
+ * specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a + * best effort basis. If a pool runs out of Spot capacity before fulfilling your target + * capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest + * pool. To ensure that your target capacity is met, you might receive Spot Instances from more than + * the number of pools that you specified. Similarly, if most of the pools have no Spot + * capacity, you might receive your full target capacity from fewer than the number of + * pools that you specified.
*/ - Filters?: Filter[]; + InstancePoolsToUseCount?: number; /** - *The token for the next page of results.
+ *Reserved.
*/ - NextToken?: string; + Context?: string; /** - *The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another call with the returned NextToken value. This value can be
- * between 1 and 200. You cannot specify this parameter and the ImageIDs parameter
- * in the same call.
The key-value pair for tagging the Spot Fleet request on creation. The value for
+ * ResourceType must be spot-fleet-request, otherwise the
+ * Spot Fleet request fails. To tag instances at launch, specify the tags in the launch
+ * template (valid only if you use LaunchTemplateConfigs) or in
+ * the
+ * SpotFleetTagSpecification
+ * (valid only if you use
+ * LaunchSpecifications). For information about tagging after launch, see
+ * Tagging Your Resources.
The information about the AMI store task, including the progress of the task.
+ *Describes a Spot Fleet request.
*/ -export interface StoreImageTaskResult { - /** - *The ID of the AMI that is being stored.
- */ - AmiId?: string; - +export interface SpotFleetRequestConfig { /** - *The time the task started.
+ *The progress of the Spot Fleet request.
+ * If there is an error, the status is error.
+ * After all requests are placed, the status is pending_fulfillment.
+ * If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled.
+ * If the size of the fleet is decreased, the status is pending_termination
+ * while Spot Instances are terminating.
The name of the S3 bucket that contains the stored AMI object.
+ *The creation date and time of the request.
*/ - Bucket?: string; + CreateTime?: Date; /** - *The name of the stored AMI object in the bucket.
+ *The configuration of the Spot Fleet request.
*/ - S3objectKey?: string; + SpotFleetRequestConfig?: SpotFleetRequestConfigData; /** - *The progress of the task as a percentage.
+ *The ID of the Spot Fleet request.
*/ - ProgressPercentage?: number; + SpotFleetRequestId?: string; /** - *The state of the store task (InProgress, Completed, or
- * Failed).
The state of the Spot Fleet request.
*/ - StoreTaskState?: string; + SpotFleetRequestState?: BatchState | string; /** - *If the tasks fails, the reason for the failure is returned. If the task succeeds,
- * null is returned.
The tags for a Spot Fleet resource.
*/ - StoreTaskFailureReason?: string; + Tags?: Tag[]; } -export namespace StoreImageTaskResult { +export namespace SpotFleetRequestConfig { /** * @internal */ - export const filterSensitiveLog = (obj: StoreImageTaskResult): any => ({ + export const filterSensitiveLog = (obj: SpotFleetRequestConfig): any => ({ ...obj, }); } -export interface DescribeStoreImageTasksResult { +/** + *Contains the output of DescribeSpotFleetRequests.
+ */ +export interface DescribeSpotFleetRequestsResponse { /** - *The information about the AMI store tasks.
+ *The token required to retrieve the next set of results. This value is
+ * null when there are no more results to return.
The token to use to retrieve the next page of results. This value is null
- * when there are no more results to return.
Information about the configuration of your Spot Fleet.
*/ - NextToken?: string; + SpotFleetRequestConfigs?: SpotFleetRequestConfig[]; } -export namespace DescribeStoreImageTasksResult { +export namespace DescribeSpotFleetRequestsResponse { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeStoreImageTasksResult): any => ({ + export const filterSensitiveLog = (obj: DescribeSpotFleetRequestsResponse): any => ({ ...obj, }); } -export interface DescribeSubnetsRequest { +/** + *Contains the parameters for DescribeSpotInstanceRequests.
+ */ +export interface DescribeSpotInstanceRequestsRequest { /** *One or more filters.
*
- * availability-zone - The Availability Zone for the subnet. You can also use
- * availabilityZone as the filter name.
availability-zone-group - The Availability Zone group.
+ *
+ * create-time - The time stamp when the Spot Instance request was
+ * created.
+ * fault-code - The fault code related to the request.
+ * fault-message - The fault message related to the request.
+ * instance-id - The ID of the instance that fulfilled the
+ * request.
+ * launch-group - The Spot Instance launch group.
+ * launch.block-device-mapping.delete-on-termination - Indicates
+ * whether the EBS volume is deleted on instance termination.
+ * launch.block-device-mapping.device-name - The device name for the
+ * volume in the block device mapping (for example, /dev/sdh or
+ * xvdh).
- * availability-zone-id - The ID of the Availability Zone for the subnet.
- * You can also use availabilityZoneId as the filter name.
launch.block-device-mapping.snapshot-id - The ID of the snapshot
+ * for the EBS volume.
*
- * available-ip-address-count - The number of IPv4 addresses in the
- * subnet that are available.
launch.block-device-mapping.volume-size - The size of the EBS
+ * volume, in GiB.
*
- * cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you
- * specify must exactly match the subnet's CIDR block for information to be
- * returned for the subnet. You can also use cidr or
- * cidrBlock as the filter names.
launch.block-device-mapping.volume-type - The type of EBS volume:
+ * gp2 for General Purpose SSD, io1 or
+ * io2 for Provisioned IOPS SSD, st1 for Throughput
+ * Optimized HDD, sc1for Cold HDD, or standard for
+ * Magnetic.
*
- * default-for-az - Indicates whether this is the default subnet for the
- * Availability Zone. You can also use defaultForAz as the filter name.
launch.group-id - The ID of the security group for the
+ * instance.
*
- * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR
- * block associated with the subnet.
launch.group-name - The name of the security group for the
+ * instance.
*
- * ipv6-cidr-block-association.association-id - An association ID
- * for an IPv6 CIDR block associated with the subnet.
launch.image-id - The ID of the AMI.
*
- * ipv6-cidr-block-association.state - The state of an IPv6 CIDR
- * block associated with the subnet.
launch.instance-type - The type of instance (for example,
+ * m3.medium).
*
- * outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
launch.kernel-id - The kernel ID.
*
- * owner-id - The ID of the AWS account that owns the subnet.
launch.key-name - The name of the key pair the instance launched
+ * with.
*
- * state - The state of the subnet (pending | available).
launch.monitoring-enabled - Whether detailed monitoring is
+ * enabled for the Spot Instance.
*
- * subnet-arn - The Amazon Resource Name (ARN) of the subnet.
launch.ramdisk-id - The RAM disk ID.
*
- * subnet-id - The ID of the subnet.
launched-availability-zone - The Availability Zone in which the
+ * request is launched.
+ *
+ * network-interface.addresses.primary - Indicates whether the IP
+ * address is the primary private IP address.
+ * network-interface.delete-on-termination - Indicates whether the
+ * network interface is deleted when the instance is terminated.
+ * network-interface.description - A description of the network
+ * interface.
+ * network-interface.device-index - The index of the device for the
+ * network interface attachment on the instance.
+ * network-interface.group-id - The ID of the security group
+ * associated with the network interface.
+ * network-interface.network-interface-id - The ID of the network
+ * interface.
+ * network-interface.private-ip-address - The primary private IP
+ * address of the network interface.
+ * network-interface.subnet-id - The ID of the subnet for the
+ * instance.
+ * product-description - The product description associated with the
+ * instance (Linux/UNIX | Windows).
+ * spot-instance-request-id - The Spot Instance request ID.
+ * spot-price - The maximum hourly price for any Spot Instance
+ * launched to fulfill the request.
+ * state - The state of the Spot Instance request (open
+ * | active | closed | cancelled |
+ * failed). Spot request status information can help you track
+ * your Amazon EC2 Spot Instance requests. For more information, see Spot
+ * request status in the Amazon EC2 User Guide for Linux Instances.
+ * status-code - The short code describing the most recent
+ * evaluation of your Spot Instance request.
+ * status-message - The message explaining the status of the Spot
+ * Instance request.
* tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ *
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * vpc-id - The ID of the VPC for the subnet.
type - The type of Spot Instance request (one-time |
+ * persistent).
+ *
+ * valid-from - The start date of the request.
+ * valid-until - The end date of the request.
One or more subnet IDs.
- *Default: Describes all your subnets.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more Spot Instance request IDs.
*/ - DryRun?: boolean; + SpotInstanceRequestIds?: string[]; /** - *The token for the next page of results.
+ *The token to request the next set of results. This value is null when
+ * there are no more results to return.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of results to return in a single call. Specify a value between 5
+ * and 1000. To retrieve the remaining results, make another call with the returned
+ * NextToken value.
Information about one or more subnets.
- */ - Subnets?: Subnet[]; - +/** + *Describes the monitoring of an instance.
+ */ +export interface RunInstancesMonitoringEnabled { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is + * enabled.
*/ - NextToken?: string; + Enabled: boolean | undefined; } -export namespace DescribeSubnetsResult { +export namespace RunInstancesMonitoringEnabled { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSubnetsResult): any => ({ + export const filterSensitiveLog = (obj: RunInstancesMonitoringEnabled): any => ({ ...obj, }); } -export interface DescribeTagsRequest { +/** + *Describes the launch specification for an instance.
+ */ +export interface LaunchSpecification { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The Base64-encoded user data for the instance.
*/ - DryRun?: boolean; + UserData?: string; /** - *The filters.
- *
- * key - The tag key.
- * resource-id - The ID of the resource.
- * resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).
- * tag:
- * value - The tag value.
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
*/ - Filters?: Filter[]; + SecurityGroups?: GroupIdentifier[]; /** - *The maximum number of results to return in a single call.
- * This value can be between 5 and 1000.
- * To retrieve the remaining results, make another call with the returned NextToken value.
Deprecated.
*/ - MaxResults?: number; + AddressingType?: string; /** - *The token to retrieve the next page of results.
+ *One or more block device mapping entries.
*/ - NextToken?: string; -} + BlockDeviceMappings?: BlockDeviceMapping[]; -export namespace DescribeTagsRequest { /** - * @internal + *Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
+ *Default: false
+ *
The IAM instance profile.
+ */ + IamInstanceProfile?: IamInstanceProfileSpecification; + + /** + *The ID of the AMI.
+ */ + ImageId?: string; + + /** + *The instance type.
+ */ + InstanceType?: _InstanceType | string; -/** - *Describes a tag.
- */ -export interface TagDescription { /** - *The tag key.
+ *The ID of the kernel.
*/ - Key?: string; + KernelId?: string; /** - *The ID of the resource.
+ *The name of the key pair.
*/ - ResourceId?: string; + KeyName?: string; /** - *The resource type.
+ *One or more network interfaces. If you specify a network interface, you must specify + * subnet IDs and security group IDs using the network interface.
*/ - ResourceType?: ResourceType | string; + NetworkInterfaces?: InstanceNetworkInterfaceSpecification[]; /** - *The tag value.
+ *The placement information for the instance.
*/ - Value?: string; -} + Placement?: SpotPlacement; -export namespace TagDescription { /** - * @internal + *The ID of the RAM disk.
*/ - export const filterSensitiveLog = (obj: TagDescription): any => ({ - ...obj, - }); -} + RamdiskId?: string; -export interface DescribeTagsResult { /** - *The token to use to retrieve the next page of results. This value is
- * null when there are no more results to return.
The ID of the subnet in which to launch the instance.
*/ - NextToken?: string; + SubnetId?: string; /** - *The tags.
+ *Describes the monitoring of an instance.
*/ - Tags?: TagDescription[]; + Monitoring?: RunInstancesMonitoringEnabled; } -export namespace DescribeTagsResult { +export namespace LaunchSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTagsResult): any => ({ + export const filterSensitiveLog = (obj: LaunchSpecification): any => ({ ...obj, }); } -export interface DescribeTrafficMirrorFiltersRequest { - /** - *The ID of the Traffic Mirror filter.
- */ - TrafficMirrorFilterIds?: string[]; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes the status of a Spot Instance request.
+ */ +export interface SpotInstanceStatus { /** - *One or more filters. The possible values are:
- *
- * description: The Traffic Mirror filter description.
- * traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
The status code. For a list of status codes, see Spot status codes in the Amazon EC2 User Guide for Linux Instances.
*/ - Filters?: Filter[]; + Code?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The description for the status code.
*/ - MaxResults?: number; + Message?: string; /** - *The token for the next page of results.
+ *The date and time of the most recent status update, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
*/ - NextToken?: string; + UpdateTime?: Date; } -export namespace DescribeTrafficMirrorFiltersRequest { +export namespace SpotInstanceStatus { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTrafficMirrorFiltersRequest): any => ({ + export const filterSensitiveLog = (obj: SpotInstanceStatus): any => ({ ...obj, }); } -export interface DescribeTrafficMirrorFiltersResult { +/** + *Describes a Spot Instance request.
+ */ +export interface SpotInstanceRequest { /** - *Information about one or more Traffic Mirror filters.
+ *Deprecated.
*/ - TrafficMirrorFilters?: TrafficMirrorFilter[]; + ActualBlockHourlyPrice?: string; /** - *The token to use to retrieve the next page of results. The value is null when there are no more results to return.
The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
*/ - NextToken?: string; -} + AvailabilityZoneGroup?: string; -export namespace DescribeTrafficMirrorFiltersResult { /** - * @internal + *Deprecated.
*/ - export const filterSensitiveLog = (obj: DescribeTrafficMirrorFiltersResult): any => ({ - ...obj, - }); -} + BlockDurationMinutes?: number; -export interface DescribeTrafficMirrorSessionsRequest { /** - *The ID of the Traffic Mirror session.
+ *The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
*/ - TrafficMirrorSessionIds?: string[]; + CreateTime?: Date; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The fault codes for the Spot Instance request, if any.
*/ - DryRun?: boolean; + Fault?: SpotInstanceStateFault; /** - *One or more filters. The possible values are:
- *
- * description: The Traffic Mirror session description.
- * network-interface-id: The ID of the Traffic Mirror session network interface.
- * owner-id: The ID of the account that owns the Traffic Mirror session.
- * packet-length: The assigned number of packets to mirror.
- * session-number: The assigned session number.
- * traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
- * traffic-mirror-session-id: The ID of the Traffic Mirror session.
- * traffic-mirror-target-id: The ID of the Traffic Mirror target.
- * virtual-network-id: The virtual network ID of the Traffic Mirror session.
The instance ID, if an instance has been launched to fulfill the Spot Instance request.
*/ - Filters?: Filter[]; + InstanceId?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
*/ - MaxResults?: number; + LaunchGroup?: string; /** - *The token for the next page of results.
+ *Additional information for launching instances.
*/ - NextToken?: string; -} + LaunchSpecification?: LaunchSpecification; -export namespace DescribeTrafficMirrorSessionsRequest { /** - * @internal + *The Availability Zone in which the request is launched.
*/ - export const filterSensitiveLog = (obj: DescribeTrafficMirrorSessionsRequest): any => ({ - ...obj, - }); -} + LaunchedAvailabilityZone?: string; -export interface DescribeTrafficMirrorSessionsResult { /** - *Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
+ *The product description associated with the Spot Instance.
*/ - TrafficMirrorSessions?: TrafficMirrorSession[]; + ProductDescription?: RIProductDescription | string; /** - *The token to use to retrieve the next page of results. The value is null when there are no more results to return.
The ID of the Spot Instance request.
*/ - NextToken?: string; -} + SpotInstanceRequestId?: string; -export namespace DescribeTrafficMirrorSessionsResult { /** - * @internal + *The maximum price per hour that you are willing to pay for a Spot Instance.
*/ - export const filterSensitiveLog = (obj: DescribeTrafficMirrorSessionsResult): any => ({ - ...obj, - }); -} + SpotPrice?: string; -export interface DescribeTrafficMirrorTargetsRequest { /** - *The ID of the Traffic Mirror targets.
+ *The state of the Spot Instance request. Spot status information helps track your Spot + * Instance requests. For more information, see Spot status in the + * Amazon EC2 User Guide for Linux Instances.
*/ - TrafficMirrorTargetIds?: string[]; + State?: SpotInstanceState | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The status code and status message describing the Spot Instance request.
*/ - DryRun?: boolean; + Status?: SpotInstanceStatus; /** - *One or more filters. The possible values are:
+ *Any tags assigned to the resource.
+ */ + Tags?: Tag[]; + + /** + *The Spot Instance request type.
+ */ + Type?: SpotInstanceType | string; + + /** + *The start date of the request, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ). + * The request becomes active at this date and time.
+ */ + ValidFrom?: Date; + + /** + *The end date of the request, in UTC format + * (YYYY-MM-DDTHH:MM:SSZ).
*
- * description: The Traffic Mirror target description.
- * network-interface-id: The ID of the Traffic Mirror session network interface.
- * network-load-balancer-arn: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session.
- * owner-id: The ID of the account that owns the Traffic Mirror session.
- * traffic-mirror-target-id: The ID of the Traffic Mirror target.
For a persistent request, the request remains active until the validUntil date
+ * and time is reached. Otherwise, the request remains active until you cancel it.
+ *
For a one-time request, the request remains active until all instances launch,
+ * the request is canceled, or the validUntil date and time is reached. By default, the
+ * request is valid for 7 days from the date the request was created.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ *The behavior when a Spot Instance is interrupted.
*/ - NextToken?: string; + InstanceInterruptionBehavior?: InstanceInterruptionBehavior | string; } -export namespace DescribeTrafficMirrorTargetsRequest { +export namespace SpotInstanceRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTrafficMirrorTargetsRequest): any => ({ + export const filterSensitiveLog = (obj: SpotInstanceRequest): any => ({ ...obj, }); } -export interface DescribeTrafficMirrorTargetsResult { +/** + *Contains the output of DescribeSpotInstanceRequests.
+ */ +export interface DescribeSpotInstanceRequestsResult { /** - *Information about one or more Traffic Mirror targets.
+ *One or more Spot Instance requests.
*/ - TrafficMirrorTargets?: TrafficMirrorTarget[]; + SpotInstanceRequests?: SpotInstanceRequest[]; /** - *The token to use to retrieve the next page of results. The value is null when there are no more results to return.
The token to use to retrieve the next set of results. This value is null
+ * when there are no more results to return.
The IDs of the attachments.
- */ - TransitGatewayAttachmentIds?: string[]; - +/** + *Contains the parameters for DescribeSpotPriceHistory.
+ */ +export interface DescribeSpotPriceHistoryRequest { /** - *One or more filters. The possible values are:
- *
- * association.state - The state of the association (associating | associated |
- * disassociating).
- * association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
- * resource-id - The ID of the resource.
- * resource-owner-id - The ID of the AWS account that owns the resource.
One or more filters.
+ *
- * resource-type - The resource type. Valid values are vpc
- * | vpn | direct-connect-gateway | peering
- * | connect.
+ * availability-zone - The Availability Zone for which prices should
+ * be returned.
- * state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
+ * instance-type - The type of instance (for example,
+ * m3.medium).
- * transit-gateway-attachment-id - The ID of the attachment.
+ * product-description - The product description for the Spot price
+ * (Linux/UNIX | Red Hat Enterprise Linux |
+ * SUSE Linux | Windows | Linux/UNIX (Amazon
+ * VPC) | Red Hat Enterprise Linux (Amazon VPC) |
+ * SUSE Linux (Amazon VPC) | Windows (Amazon
+ * VPC)).
- * transit-gateway-id - The ID of the transit gateway.
+ * spot-price - The Spot price. The value must match exactly (or use
+ * wildcards; greater than or less than comparison is not supported).
- * transit-gateway-owner-id - The ID of the AWS account that owns the transit gateway.
+ * timestamp - The time stamp of the Spot price history, in UTC format
+ * (for example,
+ * YYYY-MM-DDTHH:MM:SSZ).
+ * You can use wildcards (* and ?). Greater than or less than comparison is not
+ * supported.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Filters the results by the specified Availability Zone.
+ */ + AvailabilityZone?: string; + + /** + *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The date and time, up to the current date, from which to stop retrieving the price + * history data, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
+ */ + EndTime?: Date; + + /** + *Filters the results by the specified instance types.
+ */ + InstanceTypes?: (_InstanceType | string)[]; + + /** + *The maximum number of results to return in a single call. Specify a value between 1
+ * and 1000. The default value is 1000. To retrieve the remaining results, make another
+ * call with the returned NextToken value.
The token for the next page of results.
+ *The token for the next set of results.
*/ NextToken?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Filters the results by the specified basic product descriptions.
*/ - DryRun?: boolean; + ProductDescriptions?: string[]; + + /** + *The date and time, up to the past 90 days, from which to start retrieving the price + * history data, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
+ */ + StartTime?: Date; } -export namespace DescribeTransitGatewayAttachmentsRequest { +export namespace DescribeSpotPriceHistoryRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewayAttachmentsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeSpotPriceHistoryRequest): any => ({ ...obj, }); } /** - *Describes an association.
+ *Describes the maximum price per hour that you are willing to pay for a Spot + * Instance.
*/ -export interface TransitGatewayAttachmentAssociation { +export interface SpotPrice { /** - *The ID of the route table for the transit gateway.
+ *The Availability Zone.
*/ - TransitGatewayRouteTableId?: string; + AvailabilityZone?: string; /** - *The state of the association.
+ *The instance type.
*/ - State?: TransitGatewayAssociationState | string; + InstanceType?: _InstanceType | string; + + /** + *A general description of the AMI.
+ */ + ProductDescription?: RIProductDescription | string; + + /** + *The maximum price per hour that you are willing to pay for a Spot Instance.
+ */ + SpotPrice?: string; + + /** + *The date and time the request was created, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
+ */ + Timestamp?: Date; } -export namespace TransitGatewayAttachmentAssociation { +export namespace SpotPrice { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayAttachmentAssociation): any => ({ + export const filterSensitiveLog = (obj: SpotPrice): any => ({ ...obj, }); } /** - *Describes an attachment between a resource and a transit gateway.
+ *Contains the output of DescribeSpotPriceHistory.
*/ -export interface TransitGatewayAttachment { +export interface DescribeSpotPriceHistoryResult { /** - *The ID of the attachment.
+ *The token required to retrieve the next set of results. This value is null or an empty + * string when there are no more results to return.
*/ - TransitGatewayAttachmentId?: string; + NextToken?: string; /** - *The ID of the transit gateway.
+ *The historical Spot prices.
*/ - TransitGatewayId?: string; + SpotPriceHistory?: SpotPrice[]; +} +export namespace DescribeSpotPriceHistoryResult { /** - *The ID of the AWS account that owns the transit gateway.
+ * @internal */ - TransitGatewayOwnerId?: string; + export const filterSensitiveLog = (obj: DescribeSpotPriceHistoryResult): any => ({ + ...obj, + }); +} +export interface DescribeStaleSecurityGroupsRequest { /** - *The ID of the AWS account that owns the resource.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The resource type. Note that the tgw-peering resource type has been deprecated.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
*/ - ResourceType?: TransitGatewayAttachmentResourceType | string; + MaxResults?: number; /** - *The ID of the resource.
+ *The token for the next set of items to return. (You received this token from a prior call.)
*/ - ResourceId?: string; + NextToken?: string; /** - *The attachment state. Note that the initiating state has been deprecated.
The ID of the VPC.
*/ - State?: TransitGatewayAttachmentState | string; + VpcId: string | undefined; +} +export namespace DescribeStaleSecurityGroupsRequest { /** - *The association.
+ * @internal */ - Association?: TransitGatewayAttachmentAssociation; + export const filterSensitiveLog = (obj: DescribeStaleSecurityGroupsRequest): any => ({ + ...obj, + }); +} +/** + *Describes a stale rule in a security group.
+ */ +export interface StaleIpPermission { /** - *The creation time.
+ *The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of
+ * -1 indicates all ICMP types.
The tags for the attachment.
+ *The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).
The IP ranges. Not applicable for stale security group rules.
+ */ + IpRanges?: string[]; + + /** + *The prefix list IDs. Not applicable for stale security group rules.
*/ - export const filterSensitiveLog = (obj: TransitGatewayAttachment): any => ({ - ...obj, - }); -} + PrefixListIds?: string[]; -export interface DescribeTransitGatewayAttachmentsResult { /** - *Information about the attachments.
+ *The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of
+ * -1 indicates all ICMP types.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.
*/ - NextToken?: string; + UserIdGroupPairs?: UserIdGroupPair[]; } -export namespace DescribeTransitGatewayAttachmentsResult { +export namespace StaleIpPermission { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewayAttachmentsResult): any => ({ + export const filterSensitiveLog = (obj: StaleIpPermission): any => ({ ...obj, }); } -export interface DescribeTransitGatewayConnectPeersRequest { +/** + *Describes a stale security group (a security group that contains stale rules).
+ */ +export interface StaleSecurityGroup { /** - *The IDs of the Connect peers.
+ *The description of the security group.
*/ - TransitGatewayConnectPeerIds?: string[]; + Description?: string; /** - *One or more filters. The possible values are:
- *
- * state - The state of the Connect peer (pending |
- * available | deleting |
- * deleted).
- * transit-gateway-attachment-id - The ID of the attachment.
- * transit-gateway-connect-peer-id - The ID of the Connect peer.
The ID of the security group.
*/ - Filters?: Filter[]; + GroupId?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The name of the security group.
*/ - MaxResults?: number; + GroupName?: string; /** - *The token for the next page of results.
+ *Information about the stale inbound rules in the security group.
*/ - NextToken?: string; + StaleIpPermissions?: StaleIpPermission[]; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the stale outbound rules in the security group.
*/ - DryRun?: boolean; + StaleIpPermissionsEgress?: StaleIpPermission[]; + + /** + *The ID of the VPC for the security group.
+ */ + VpcId?: string; } -export namespace DescribeTransitGatewayConnectPeersRequest { +export namespace StaleSecurityGroup { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewayConnectPeersRequest): any => ({ + export const filterSensitiveLog = (obj: StaleSecurityGroup): any => ({ ...obj, }); } -export interface DescribeTransitGatewayConnectPeersResult { +export interface DescribeStaleSecurityGroupsResult { /** - *Information about the Connect peers.
+ *The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/ - TransitGatewayConnectPeers?: TransitGatewayConnectPeer[]; + NextToken?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the stale security groups.
*/ - NextToken?: string; + StaleSecurityGroupSet?: StaleSecurityGroup[]; } -export namespace DescribeTransitGatewayConnectPeersResult { +export namespace DescribeStaleSecurityGroupsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewayConnectPeersResult): any => ({ + export const filterSensitiveLog = (obj: DescribeStaleSecurityGroupsResult): any => ({ ...obj, }); } -export interface DescribeTransitGatewayConnectsRequest { +export interface DescribeStoreImageTasksRequest { /** - *The IDs of the attachments.
+ *The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.
*/ - TransitGatewayAttachmentIds?: string[]; + ImageIds?: string[]; /** - *One or more filters. The possible values are:
- *
- * options.protocol - The tunnel protocol (gre).
- * state - The state of the attachment (initiating |
- * initiatingRequest | pendingAcceptance |
- * rollingBack | pending | available |
- * modifying | deleting | deleted |
- * failed | rejected | rejecting |
- * failing).
- * transit-gateway-attachment-id - The ID of the
- * Connect attachment.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The filters.
+ *
- * transit-gateway-id - The ID of the transit gateway.
task-state - Returns tasks in a certain state (InProgress |
+ * Completed | Failed)
*
- * transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.
bucket - Returns task information for tasks that targeted a specific
+ * bucket. For the filter value, specify the bucket name.
* The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
*/ NextToken?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another call with the returned NextToken value. This value can be
+ * between 1 and 200. You cannot specify this parameter and the ImageIDs parameter
+ * in the same call.
Information about the Connect attachments.
- */ - TransitGatewayConnects?: TransitGatewayConnect[]; - +/** + *The information about the AMI store task, including the progress of the task.
+ */ +export interface StoreImageTaskResult { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the AMI that is being stored.
*/ - NextToken?: string; -} + AmiId?: string; -export namespace DescribeTransitGatewayConnectsResult { /** - * @internal + *The time the task started.
*/ - export const filterSensitiveLog = (obj: DescribeTransitGatewayConnectsResult): any => ({ - ...obj, - }); -} + TaskStartTime?: Date; -export interface DescribeTransitGatewayMulticastDomainsRequest { /** - *The ID of the transit gateway multicast domain.
+ *The name of the S3 bucket that contains the stored AMI object.
*/ - TransitGatewayMulticastDomainIds?: string[]; + Bucket?: string; /** - *One or more filters. The possible values are:
- *
- * state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.
- * transit-gateway-id - The ID of the transit gateway.
- * transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.
The name of the stored AMI object in the bucket.
*/ - Filters?: Filter[]; + S3objectKey?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The progress of the task as a percentage.
*/ - MaxResults?: number; + ProgressPercentage?: number; /** - *The token for the next page of results.
+ *The state of the store task (InProgress, Completed, or
+ * Failed).
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
If the tasks fails, the reason for the failure is returned. If the task succeeds,
+ * null is returned.
Information about the transit gateway multicast domains.
+ *The information about the AMI store tasks.
*/ - TransitGatewayMulticastDomains?: TransitGatewayMulticastDomain[]; + StoreImageTaskResults?: StoreImageTaskResult[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to use to retrieve the next page of results. This value is null
+ * when there are no more results to return.
One or more IDs of the transit gateway peering attachments.
- */ - TransitGatewayAttachmentIds?: string[]; - +export interface DescribeSubnetsRequest { /** - *One or more filters. The possible values are:
+ *One or more filters.
*
- * transit-gateway-attachment-id - The ID of the transit gateway attachment.
availability-zone - The Availability Zone for the subnet. You can also use
+ * availabilityZone as the filter name.
+ *
+ * availability-zone-id - The ID of the Availability Zone for the subnet.
+ * You can also use availabilityZoneId as the filter name.
+ * available-ip-address-count - The number of IPv4 addresses in the
+ * subnet that are available.
+ * cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you
+ * specify must exactly match the subnet's CIDR block for information to be
+ * returned for the subnet. You can also use cidr or
+ * cidrBlock as the filter names.
+ * default-for-az - Indicates whether this is the default subnet for the
+ * Availability Zone. You can also use defaultForAz as the filter name.
- * local-owner-id - The ID of your AWS account.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR
+ * block associated with the subnet.
*
- * remote-owner-id - The ID of the AWS account in the remote Region that owns the transit gateway.
ipv6-cidr-block-association.association-id - An association ID
+ * for an IPv6 CIDR block associated with the subnet.
*
- * state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
ipv6-cidr-block-association.state - The state of an IPv6 CIDR
+ * block associated with the subnet.
* + *
+ * outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
+ * owner-id - The ID of the AWS account that owns the subnet.
+ * state - The state of the subnet (pending | available).
+ * subnet-arn - The Amazon Resource Name (ARN) of the subnet.
+ * subnet-id - The ID of the subnet.
* tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * transit-gateway-id - The ID of the transit gateway.
vpc-id - The ID of the VPC for the subnet.
* The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
One or more subnet IDs.
+ *Default: Describes all your subnets.
*/ - MaxResults?: number; + SubnetIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
@@ -10111,27 +10124,26 @@ export interface DescribeTransitGatewayPeeringAttachmentsRequest { NextToken?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The transit gateway peering attachments.
+ *Information about one or more subnets.
*/ - TransitGatewayPeeringAttachments?: TransitGatewayPeeringAttachment[]; + Subnets?: Subnet[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the transit gateway route tables.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters. The possible values are:
+ *The filters.
*
- * default-association-route-table - Indicates whether this is the default
- * association route table for the transit gateway (true | false).
key - The tag key.
*
- * default-propagation-route-table - Indicates whether this is the default
- * propagation route table for the transit gateway (true | false).
resource-id - The ID of the resource.
*
- * state - The state of the route table (available | deleting | deleted | pending).
resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).
*
- * transit-gateway-id - The ID of the transit gateway.
tag:
- * transit-gateway-route-table-id - The ID of the transit gateway route table.
value - The tag value.
* The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of results to return in a single call.
+ * This value can be between 5 and 1000.
+ * To retrieve the remaining results, make another call with the returned NextToken value.
The token for the next page of results.
- */ - NextToken?: string; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the transit gateway route tables.
- */ - TransitGatewayRouteTables?: TransitGatewayRouteTable[]; - - /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to retrieve the next page of results.
*/ NextToken?: string; } -export namespace DescribeTransitGatewayRouteTablesResult { +export namespace DescribeTagsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewayRouteTablesResult): any => ({ + export const filterSensitiveLog = (obj: DescribeTagsRequest): any => ({ ...obj, }); } -export interface DescribeTransitGatewaysRequest { - /** - *The IDs of the transit gateways.
- */ - TransitGatewayIds?: string[]; - +/** + *Describes a tag.
+ */ +export interface TagDescription { /** - *One or more filters. The possible values are:
- *
- * options.propagation-default-route-table-id - The ID of the default propagation route table.
- * options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
- * options.association-default-route-table-id - The ID of the default association route table.
- * options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
- * options.default-route-table-association - Indicates whether resource attachments are automatically
- * associated with the default association route table (enable | disable).
- * options.default-route-table-propagation - Indicates whether resource attachments automatically propagate
- * routes to the default propagation route table (enable | disable).
- * options.dns-support - Indicates whether DNS support is enabled (enable | disable).
- * options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
- * owner-id - The ID of the AWS account that owns the transit gateway.
- * state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
- * transit-gateway-id - The ID of the transit gateway.
The tag key.
*/ - Filters?: Filter[]; + Key?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The ID of the resource.
*/ - MaxResults?: number; + ResourceId?: string; /** - *The token for the next page of results.
+ *The resource type.
*/ - NextToken?: string; + ResourceType?: ResourceType | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The tag value.
*/ - DryRun?: boolean; + Value?: string; } -export namespace DescribeTransitGatewaysRequest { +export namespace TagDescription { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewaysRequest): any => ({ + export const filterSensitiveLog = (obj: TagDescription): any => ({ ...obj, }); } -export interface DescribeTransitGatewaysResult { +export interface DescribeTagsResult { /** - *Information about the transit gateways.
+ *The token to use to retrieve the next page of results. This value is
+ * null when there are no more results to return.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The tags.
*/ - NextToken?: string; + Tags?: TagDescription[]; } -export namespace DescribeTransitGatewaysResult { +export namespace DescribeTagsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewaysResult): any => ({ + export const filterSensitiveLog = (obj: DescribeTagsResult): any => ({ ...obj, }); } -export interface DescribeTransitGatewayVpcAttachmentsRequest { +export interface DescribeTrafficMirrorFiltersRequest { /** - *The IDs of the attachments.
+ *The ID of the Traffic Mirror filter.
*/ - TransitGatewayAttachmentIds?: string[]; + TrafficMirrorFilterIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters. The possible values are:
- *
- * state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
- * transit-gateway-attachment-id - The ID of the attachment.
- * transit-gateway-id - The ID of the transit gateway.
description: The Traffic Mirror filter description.
*
- * vpc-id - The ID of the VPC.
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
* The token for the next page of results.
*/ NextToken?: string; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the VPC attachments.
+ *Information about one or more Traffic Mirror filters.
*/ - TransitGatewayVpcAttachments?: TransitGatewayVpcAttachment[]; + TrafficMirrorFilters?: TrafficMirrorFilter[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to use to retrieve the next page of results. The value is null when there are no more results to return.
The IDs of the associations.
+ *The ID of the Traffic Mirror session.
*/ - AssociationIds?: string[]; + TrafficMirrorSessionIds?: string[]; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -10432,74 +10359,95 @@ export interface DescribeTrunkInterfaceAssociationsRequest { DryRun?: boolean; /** - *
One or more filters.
- *One or more filters. The possible values are:
+ *
- * gre-key - The ID of a trunk interface association.
+ * description: The Traffic Mirror session description.
- * interface-protocol - The interface protocol. Valid values are VLAN and GRE.
+ * network-interface-id: The ID of the Traffic Mirror session network interface.
+ * owner-id: The ID of the account that owns the Traffic Mirror session.
+ * packet-length: The assigned number of packets to mirror.
+ * session-number: The assigned session number.
+ * traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
+ * traffic-mirror-session-id: The ID of the Traffic Mirror session.
+ * traffic-mirror-target-id: The ID of the Traffic Mirror target.
+ * virtual-network-id: The virtual network ID of the Traffic Mirror session.
The token for the next page of results.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
*/ - MaxResults?: number; + NextToken?: string; } -export namespace DescribeTrunkInterfaceAssociationsRequest { +export namespace DescribeTrafficMirrorSessionsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTrunkInterfaceAssociationsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeTrafficMirrorSessionsRequest): any => ({ ...obj, }); } -export interface DescribeTrunkInterfaceAssociationsResult { +export interface DescribeTrafficMirrorSessionsResult { /** - *Information about the trunk associations.
+ *Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
*/ - InterfaceAssociations?: TrunkInterfaceAssociation[]; + TrafficMirrorSessions?: TrafficMirrorSession[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to use to retrieve the next page of results. The value is null when there are no more results to return.
The attribute of the volume. This parameter is required.
- */ - Attribute: VolumeAttributeName | string | undefined; - +export interface DescribeTrafficMirrorTargetsRequest { /** - *The ID of the volume.
+ *The ID of the Traffic Mirror targets.
*/ - VolumeId: string | undefined; + TrafficMirrorTargetIds?: string[]; /** *Checks whether you have the required permissions for the action, without actually making the request,
@@ -10507,137 +10455,138 @@ export interface DescribeVolumeAttributeRequest {
* Otherwise, it is UnauthorizedOperation.
One or more filters. The possible values are:
+ *
+ * description: The Traffic Mirror target description.
+ * network-interface-id: The ID of the Traffic Mirror session network interface.
+ * network-load-balancer-arn: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session.
+ * owner-id: The ID of the account that owns the Traffic Mirror session.
+ * traffic-mirror-target-id: The ID of the Traffic Mirror target.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ */ + NextToken?: string; } -export namespace DescribeVolumeAttributeRequest { +export namespace DescribeTrafficMirrorTargetsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVolumeAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeTrafficMirrorTargetsRequest): any => ({ ...obj, }); } -export interface DescribeVolumeAttributeResult { - /** - *The state of autoEnableIO attribute.
A list of product codes.
+ *Information about one or more Traffic Mirror targets.
*/ - ProductCodes?: ProductCode[]; + TrafficMirrorTargets?: TrafficMirrorTarget[]; /** - *The ID of the volume.
+ *The token to use to retrieve the next page of results. The value is null when there are no more results to return.
The filters.
+ *The IDs of the attachments.
+ */ + TransitGatewayAttachmentIds?: string[]; + + /** + *One or more filters. The possible values are:
*
- * attachment.attach-time - The time stamp when the attachment
- * initiated.
- * attachment.delete-on-termination - Whether the volume is deleted on
- * instance termination.
- * attachment.device - The device name specified in the block device mapping
- * (for example, /dev/sda1).
- * attachment.instance-id - The ID of the instance the volume is attached
- * to.
- * attachment.status - The attachment state (attaching |
- * attached | detaching).
- * availability-zone - The Availability Zone in which the volume was
- * created.
- * create-time - The time stamp when the volume was created.
- * encrypted - Indicates whether the volume is encrypted (true
- * | false)
association.state - The state of the association (associating | associated |
+ * disassociating).
*
- * multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true
- * | false)
- * fast-restored - Indicates whether the volume was created from a
- * snapshot that is enabled for fast snapshot restore (true |
- * false).
association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
*
- * size - The size of the volume, in GiB.
resource-id - The ID of the resource.
*
- * snapshot-id - The snapshot from which the volume was created.
resource-owner-id - The ID of the AWS account that owns the resource.
*
- * status - The state of the volume (creating |
- * available | in-use | deleting |
- * deleted | error).
resource-type - The resource type. Valid values are vpc
+ * | vpn | direct-connect-gateway | peering
+ * | connect.
*
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
*
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
transit-gateway-attachment-id - The ID of the attachment.
*
- * volume-id - The volume ID.
transit-gateway-id - The ID of the transit gateway.
*
- * volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 |
- * st1 | sc1| standard)
transit-gateway-owner-id - The ID of the AWS account that owns the transit gateway.
* The volume IDs.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
*/ - VolumeIds?: string[]; + NextToken?: string; /** *Checks whether you have the required permissions for the action, without actually making the request,
@@ -10645,363 +10594,417 @@ export interface DescribeVolumesRequest {
* Otherwise, it is UnauthorizedOperation.
The maximum number of volume results returned by DescribeVolumes in paginated
- * output. When this parameter is used, DescribeVolumes only returns
- * MaxResults results in a single page along with a NextToken
- * response element. The remaining results of the initial request can be seen by sending another
- * DescribeVolumes request with the returned NextToken value. This
- * value can be between 5 and 500; if MaxResults is given a value larger than 500,
- * only 500 results are returned. If this parameter is not used, then
- * DescribeVolumes returns all results. You cannot specify this parameter and the
- * volume IDs parameter in the same request.
Describes an association.
+ */ +export interface TransitGatewayAttachmentAssociation { /** - *The NextToken value returned from a previous paginated
- * DescribeVolumes request where MaxResults was used and the results
- * exceeded the value of that parameter. Pagination continues from the end of the previous
- * results that returned the NextToken value. This value is null when
- * there are no more results to return.
The ID of the route table for the transit gateway.
*/ - NextToken?: string; + TransitGatewayRouteTableId?: string; + + /** + *The state of the association.
+ */ + State?: TransitGatewayAssociationState | string; } -export namespace DescribeVolumesRequest { +export namespace TransitGatewayAttachmentAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVolumesRequest): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayAttachmentAssociation): any => ({ ...obj, }); } -export interface DescribeVolumesResult { +/** + *Describes an attachment between a resource and a transit gateway.
+ */ +export interface TransitGatewayAttachment { /** - *Information about the volumes.
+ *The ID of the attachment.
*/ - Volumes?: Volume[]; + TransitGatewayAttachmentId?: string; /** - *The NextToken value to include in a future DescribeVolumes
- * request. When the results of a DescribeVolumes request exceed
- * MaxResults, this value can be used to retrieve the next page of results. This
- * value is null when there are no more results to return.
The ID of the transit gateway.
*/ - NextToken?: string; + TransitGatewayId?: string; + + /** + *The ID of the AWS account that owns the transit gateway.
+ */ + TransitGatewayOwnerId?: string; + + /** + *The ID of the AWS account that owns the resource.
+ */ + ResourceOwnerId?: string; + + /** + *The resource type. Note that the tgw-peering resource type has been deprecated.
The ID of the resource.
+ */ + ResourceId?: string; + + /** + *The attachment state. Note that the initiating state has been deprecated.
The association.
+ */ + Association?: TransitGatewayAttachmentAssociation; + + /** + *The creation time.
+ */ + CreationTime?: Date; + + /** + *The tags for the attachment.
+ */ + Tags?: Tag[]; } -export namespace DescribeVolumesResult { +export namespace TransitGatewayAttachment { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVolumesResult): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayAttachment): any => ({ ...obj, }); } -export interface DescribeVolumesModificationsRequest { +export interface DescribeTransitGatewayAttachmentsResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the attachments.
*/ - DryRun?: boolean; + TransitGatewayAttachments?: TransitGatewayAttachment[]; /** - *The IDs of the volumes.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
- *
- * modification-state - The current modification state (modifying |
- * optimizing | completed | failed).
- * original-iops - The original IOPS rate of the volume.
- * original-size - The original size of the volume, in GiB.
- * original-volume-type - The original volume type of the volume (standard |
- * io1 | io2 | gp2 | sc1 | st1).
- * originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).
- * start-time - The modification start time.
- * target-iops - The target IOPS rate of the volume.
- * target-size - The target size of the volume, in GiB.
The IDs of the Connect peers.
+ */ + TransitGatewayConnectPeerIds?: string[]; + + /** + *One or more filters. The possible values are:
+ *
- * target-volume-type - The target volume type of the volume (standard |
- * io1 | io2 | gp2 | sc1 | st1).
state - The state of the Connect peer (pending |
+ * available | deleting |
+ * deleted).
*
- * targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).
transit-gateway-attachment-id - The ID of the attachment.
*
- * volume-id - The ID of the volume.
transit-gateway-connect-peer-id - The ID of the Connect peer.
* The nextToken value returned by a previous paginated request.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
*/ NextToken?: string; /** - *The maximum number of results (up to a limit of 500) to be returned in a paginated - * request.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the Connect peers.
+ */ + TransitGatewayConnectPeers?: TransitGatewayConnectPeer[]; -/** - *Describes the modification status of an EBS volume.
- *If the volume has never been modified, some element values will be null.
- */ -export interface VolumeModification { /** - *The ID of the volume.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The current modification state. The modification state is null for unmodified - * volumes.
+ * @internal */ - ModificationState?: VolumeModificationState | string; + export const filterSensitiveLog = (obj: DescribeTransitGatewayConnectPeersResult): any => ({ + ...obj, + }); +} +export interface DescribeTransitGatewayConnectsRequest { /** - *A status message about the modification progress or failure.
+ *The IDs of the attachments.
*/ - StatusMessage?: string; + TransitGatewayAttachmentIds?: string[]; /** - *The target size of the volume, in GiB.
+ *One or more filters. The possible values are:
+ *
+ * options.protocol - The tunnel protocol (gre).
+ * state - The state of the attachment (initiating |
+ * initiatingRequest | pendingAcceptance |
+ * rollingBack | pending | available |
+ * modifying | deleting | deleted |
+ * failed | rejected | rejecting |
+ * failing).
+ * transit-gateway-attachment-id - The ID of the
+ * Connect attachment.
+ * transit-gateway-id - The ID of the transit gateway.
+ * transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.
The target IOPS rate of the volume.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The target EBS volume type of the volume.
+ *The token for the next page of results.
*/ - TargetVolumeType?: VolumeType | string; + NextToken?: string; /** - *The target throughput of the volume, in MiB/s.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The target setting for Amazon EBS Multi-Attach.
+ * @internal */ - TargetMultiAttachEnabled?: boolean; + export const filterSensitiveLog = (obj: DescribeTransitGatewayConnectsRequest): any => ({ + ...obj, + }); +} +export interface DescribeTransitGatewayConnectsResult { /** - *The original size of the volume, in GiB.
+ *Information about the Connect attachments.
*/ - OriginalSize?: number; + TransitGatewayConnects?: TransitGatewayConnect[]; /** - *The original IOPS rate of the volume.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The original EBS volume type of the volume.
+ * @internal */ - OriginalVolumeType?: VolumeType | string; + export const filterSensitiveLog = (obj: DescribeTransitGatewayConnectsResult): any => ({ + ...obj, + }); +} +export interface DescribeTransitGatewayMulticastDomainsRequest { /** - *The original throughput of the volume, in MiB/s.
+ *The ID of the transit gateway multicast domain.
*/ - OriginalThroughput?: number; + TransitGatewayMulticastDomainIds?: string[]; /** - *The original setting for Amazon EBS Multi-Attach.
+ *One or more filters. The possible values are:
+ *
+ * state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.
+ * transit-gateway-id - The ID of the transit gateway.
+ * transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.
The modification progress, from 0 to 100 percent complete.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The modification start time.
+ *The token for the next page of results.
*/ - StartTime?: Date; + NextToken?: string; /** - *The modification completion or failure time.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the volume modifications.
+ *Information about the transit gateway multicast domains.
*/ - VolumesModifications?: VolumeModification[]; + TransitGatewayMulticastDomains?: TransitGatewayMulticastDomain[]; /** - *Token for pagination, null if there are no more results
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
- *
- * action.code - The action code for the event (for example,
- * enable-volume-io).
- * action.description - A description of the action.
- * action.event-id - The event ID associated with the action.
- * availability-zone - The Availability Zone of the instance.
- * event.description - A description of the event.
One or more IDs of the transit gateway peering attachments.
+ */ + TransitGatewayAttachmentIds?: string[]; + + /** + *One or more filters. The possible values are:
+ *
- * event.event-id - The event ID.
+ * transit-gateway-attachment-id - The ID of the transit gateway attachment.
- * event.event-type - The event type (for io-enabled:
- * passed | failed; for io-performance:
- * io-performance:degraded | io-performance:severely-degraded |
- * io-performance:stalled).
+ * local-owner-id - The ID of your AWS account.
- * event.not-after - The latest end time for the event.
+ * remote-owner-id - The ID of the AWS account in the remote Region that owns the transit gateway.
- * event.not-before - The earliest start time for the event.
+ * state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
- * volume-status.details-name - The cause for
- * volume-status.status (io-enabled |
- * io-performance).
tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
*
- * volume-status.details-status - The status of
- * volume-status.details-name (for io-enabled:
- * passed | failed; for io-performance:
- * normal | degraded | severely-degraded |
- * stalled).
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
*
- * volume-status.status - The status of the volume (ok |
- * impaired | warning | insufficient-data).
+ * transit-gateway-id - The ID of the transit gateway.
The maximum number of volume results returned by DescribeVolumeStatus in
- * paginated output. When this parameter is used, the request only returns
- * MaxResults results in a single page along with a NextToken
- * response element. The remaining results of the initial request can be seen by sending another
- * request with the returned NextToken value. This value can be between 5 and 1,000;
- * if MaxResults is given a value larger than 1,000, only 1,000 results are returned.
- * If this parameter is not used, then DescribeVolumeStatus returns all results. You
- * cannot specify this parameter and the volume IDs parameter in the same request.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The NextToken value to include in a future DescribeVolumeStatus
- * request. When the results of the request exceed MaxResults, this value can be
- * used to retrieve the next page of results. This value is null when there are no
- * more results to return.
The token for the next page of results.
*/ NextToken?: string; - /** - *The IDs of the volumes.
- *Default: Describes all your volumes.
- */ - VolumeIds?: string[]; - /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -11010,322 +11013,388 @@ export interface DescribeVolumeStatusRequest {
DryRun?: boolean;
}
-export namespace DescribeVolumeStatusRequest {
+export namespace DescribeTransitGatewayPeeringAttachmentsRequest {
/**
* @internal
*/
- export const filterSensitiveLog = (obj: DescribeVolumeStatusRequest): any => ({
+ export const filterSensitiveLog = (obj: DescribeTransitGatewayPeeringAttachmentsRequest): any => ({
...obj,
});
}
-/**
- *
Describes a volume status operation code.
- */ -export interface VolumeStatusAction { +export interface DescribeTransitGatewayPeeringAttachmentsResult { /** - *The code identifying the operation, for example, enable-volume-io.
The transit gateway peering attachments.
*/ - Code?: string; + TransitGatewayPeeringAttachments?: TransitGatewayPeeringAttachment[]; /** - *A description of the operation.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the event associated with this operation.
+ * @internal */ - EventId?: string; + export const filterSensitiveLog = (obj: DescribeTransitGatewayPeeringAttachmentsResult): any => ({ + ...obj, + }); +} +export interface DescribeTransitGatewayRouteTablesRequest { /** - *The event type associated with this operation.
+ *The IDs of the transit gateway route tables.
*/ - EventType?: string; -} + TransitGatewayRouteTableIds?: string[]; -export namespace VolumeStatusAction { /** - * @internal + *One or more filters. The possible values are:
+ *
+ * default-association-route-table - Indicates whether this is the default
+ * association route table for the transit gateway (true | false).
+ * default-propagation-route-table - Indicates whether this is the default
+ * propagation route table for the transit gateway (true | false).
+ * state - The state of the route table (available | deleting | deleted | pending).
+ * transit-gateway-id - The ID of the transit gateway.
+ * transit-gateway-route-table-id - The ID of the transit gateway route table.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Information about the instances to which the volume is attached.
- */ -export interface VolumeStatusAttachmentStatus { /** - *The maximum IOPS supported by the attached instance.
+ *The token for the next page of results.
*/ - IoPerformance?: string; + NextToken?: string; /** - *The ID of the attached instance.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a volume status event.
- */ -export interface VolumeStatusEvent { - /** - *A description of the event.
- */ - Description?: string; - +export interface DescribeTransitGatewayRouteTablesResult { /** - *The ID of this event.
+ *Information about the transit gateway route tables.
*/ - EventId?: string; + TransitGatewayRouteTables?: TransitGatewayRouteTable[]; /** - *The type of this event.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The latest end time of the event.
+ * @internal */ - NotAfter?: Date; + export const filterSensitiveLog = (obj: DescribeTransitGatewayRouteTablesResult): any => ({ + ...obj, + }); +} +export interface DescribeTransitGatewaysRequest { /** - *The earliest start time of the event.
+ *The IDs of the transit gateways.
*/ - NotBefore?: Date; + TransitGatewayIds?: string[]; /** - *The ID of the instance associated with the event.
+ *One or more filters. The possible values are:
+ *
+ * options.propagation-default-route-table-id - The ID of the default propagation route table.
+ * options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
+ * options.association-default-route-table-id - The ID of the default association route table.
+ * options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
+ * options.default-route-table-association - Indicates whether resource attachments are automatically
+ * associated with the default association route table (enable | disable).
+ * options.default-route-table-propagation - Indicates whether resource attachments automatically propagate
+ * routes to the default propagation route table (enable | disable).
+ * options.dns-support - Indicates whether DNS support is enabled (enable | disable).
+ * options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
+ * owner-id - The ID of the AWS account that owns the transit gateway.
+ * state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
+ * transit-gateway-id - The ID of the transit gateway.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Describes a volume status.
- */ -export interface VolumeStatusDetails { /** - *The name of the volume status.
+ *The token for the next page of results.
*/ - Name?: VolumeStatusName | string; + NextToken?: string; /** - *The intended status of the volume status.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the status of a volume.
- */ -export interface VolumeStatusInfo { +export interface DescribeTransitGatewaysResult { /** - *The details of the volume status.
+ *Information about the transit gateways.
*/ - Details?: VolumeStatusDetails[]; + TransitGateways?: TransitGateway[]; /** - *The status of the volume.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the volume status.
- */ -export interface VolumeStatusItem { - /** - *The details of the operation.
- */ - Actions?: VolumeStatusAction[]; - - /** - *The Availability Zone of the volume.
- */ - AvailabilityZone?: string; - +export interface DescribeTransitGatewayVpcAttachmentsRequest { /** - *The Amazon Resource Name (ARN) of the Outpost.
+ *The IDs of the attachments.
*/ - OutpostArn?: string; + TransitGatewayAttachmentIds?: string[]; /** - *A list of events associated with the volume.
+ *One or more filters. The possible values are:
+ *
+ * state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
+ * transit-gateway-attachment-id - The ID of the attachment.
+ * transit-gateway-id - The ID of the transit gateway.
+ * vpc-id - The ID of the VPC.
The volume ID.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The volume status.
+ *The token for the next page of results.
*/ - VolumeStatus?: VolumeStatusInfo; + NextToken?: string; /** - *Information about the instances to which the volume is attached.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token to use to retrieve the next page of results. This value is null
- * when there are no more results to return.
Information about the VPC attachments.
*/ - NextToken?: string; + TransitGatewayVpcAttachments?: TransitGatewayVpcAttachment[]; /** - *Information about the status of the volumes.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the associations.
+ */ + AssociationIds?: string[]; -export interface DescribeVpcAttributeRequest { /** - *The VPC attribute.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the VPC.
+ *One or more filters.
+ *
+ * gre-key - The ID of a trunk interface association.
+ * interface-protocol - The interface protocol. Valid values are VLAN and GRE.
The token for the next page of results.
*/ - VpcId: string | undefined; + NextToken?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The ID of the VPC.
- */ - VpcId?: string; - +export interface DescribeTrunkInterfaceAssociationsResult { /** - *Indicates whether the instances launched in the VPC get DNS hostnames.
- * If this attribute is true, instances in the VPC get DNS hostnames;
- * otherwise, they do not.
Information about the trunk associations.
*/ - EnableDnsHostnames?: AttributeBooleanValue; + InterfaceAssociations?: TrunkInterfaceAssociation[]; /** - *Indicates whether DNS resolution is enabled for
- * the VPC. If this attribute is true, the Amazon DNS server
- * resolves DNS hostnames for your instances to their corresponding
- * IP addresses; otherwise, it does not.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
One or more filters.
- *
- * is-classic-link-enabled - Whether the VPC is enabled for ClassicLink
- * (true | false).
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The attribute of the volume. This parameter is required.
*/ - Filters?: Filter[]; + Attribute: VolumeAttributeName | string | undefined; + + /** + *The ID of the volume.
+ */ + VolumeId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request,
@@ -11333,140 +11402,202 @@ export interface DescribeVpcClassicLinkRequest {
* Otherwise, it is UnauthorizedOperation.
One or more VPCs for which you want to describe the ClassicLink status.
- */ - VpcIds?: string[]; } -export namespace DescribeVpcClassicLinkRequest { +export namespace DescribeVolumeAttributeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcClassicLinkRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeVolumeAttributeRequest): any => ({ ...obj, }); } -/** - *Describes whether a VPC is enabled for ClassicLink.
- */ -export interface VpcClassicLink { +export interface DescribeVolumeAttributeResult { /** - *Indicates whether the VPC is enabled for ClassicLink.
+ *The state of autoEnableIO attribute.
Any tags assigned to the VPC.
+ *A list of product codes.
*/ - Tags?: Tag[]; + ProductCodes?: ProductCode[]; /** - *The ID of the VPC.
+ *The ID of the volume.
*/ - VpcId?: string; + VolumeId?: string; } -export namespace VpcClassicLink { +export namespace DescribeVolumeAttributeResult { /** * @internal */ - export const filterSensitiveLog = (obj: VpcClassicLink): any => ({ + export const filterSensitiveLog = (obj: DescribeVolumeAttributeResult): any => ({ ...obj, }); } -export interface DescribeVpcClassicLinkResult { +export interface DescribeVolumesRequest { /** - *The ClassicLink status of one or more VPCs.
+ *The filters.
+ *
+ * attachment.attach-time - The time stamp when the attachment
+ * initiated.
+ * attachment.delete-on-termination - Whether the volume is deleted on
+ * instance termination.
+ * attachment.device - The device name specified in the block device mapping
+ * (for example, /dev/sda1).
+ * attachment.instance-id - The ID of the instance the volume is attached
+ * to.
+ * attachment.status - The attachment state (attaching |
+ * attached | detaching).
+ * availability-zone - The Availability Zone in which the volume was
+ * created.
+ * create-time - The time stamp when the volume was created.
+ * encrypted - Indicates whether the volume is encrypted (true
+ * | false)
+ * multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true
+ * | false)
+ * fast-restored - Indicates whether the volume was created from a
+ * snapshot that is enabled for fast snapshot restore (true |
+ * false).
+ * size - The size of the volume, in GiB.
+ * snapshot-id - The snapshot from which the volume was created.
+ * status - The state of the volume (creating |
+ * available | in-use | deleting |
+ * deleted | error).
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * volume-id - The volume ID.
+ * volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 |
+ * st1 | sc1| standard)
The volume IDs.
*/ - export const filterSensitiveLog = (obj: DescribeVpcClassicLinkResult): any => ({ - ...obj, - }); -} + VolumeIds?: string[]; -export interface DescribeVpcClassicLinkDnsSupportRequest { /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
+ *The maximum number of volume results returned by DescribeVolumes in paginated
+ * output. When this parameter is used, DescribeVolumes only returns
+ * MaxResults results in a single page along with a NextToken
+ * response element. The remaining results of the initial request can be seen by sending another
+ * DescribeVolumes request with the returned NextToken value. This
+ * value can be between 5 and 500; if MaxResults is given a value larger than 500,
+ * only 500 results are returned. If this parameter is not used, then
+ * DescribeVolumes returns all results. You cannot specify this parameter and the
+ * volume IDs parameter in the same request.
One or more VPC IDs.
+ *The NextToken value returned from a previous paginated
+ * DescribeVolumes request where MaxResults was used and the results
+ * exceeded the value of that parameter. Pagination continues from the end of the previous
+ * results that returned the NextToken value. This value is null when
+ * there are no more results to return.
Describes the ClassicLink DNS support status of a VPC.
- */ -export interface ClassicLinkDnsSupport { - /** - *Indicates whether ClassicLink DNS support is enabled for the VPC.
- */ - ClassicLinkDnsSupported?: boolean; - - /** - *The ID of the VPC.
- */ - VpcId?: string; -} - -export namespace ClassicLinkDnsSupport { +export interface DescribeVolumesResult { /** - * @internal + *Information about the volumes.
*/ - export const filterSensitiveLog = (obj: ClassicLinkDnsSupport): any => ({ - ...obj, - }); -} + Volumes?: Volume[]; -export interface DescribeVpcClassicLinkDnsSupportResult { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The NextToken value to include in a future DescribeVolumes
+ * request. When the results of a DescribeVolumes request exceed
+ * MaxResults, this value can be used to retrieve the next page of results. This
+ * value is null when there are no more results to return.
Information about the ClassicLink DNS support status of the VPCs.
- */ - Vpcs?: ClassicLinkDnsSupport[]; } -export namespace DescribeVpcClassicLinkDnsSupportResult { +export namespace DescribeVolumesResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcClassicLinkDnsSupportResult): any => ({ + export const filterSensitiveLog = (obj: DescribeVolumesResult): any => ({ ...obj, }); } -export interface DescribeVpcEndpointConnectionNotificationsRequest { +export interface DescribeVolumesModificationsRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -11475,736 +11606,618 @@ export interface DescribeVpcEndpointConnectionNotificationsRequest {
DryRun?: boolean;
/**
- *
The ID of the notification.
+ *The IDs of the volumes.
*/ - ConnectionNotificationId?: string; + VolumeIds?: string[]; /** - *One or more filters.
- *The filters.
+ *
- * connection-notification-arn - The ARN of the SNS topic for the
- * notification.
+ * modification-state - The current modification state (modifying |
+ * optimizing | completed | failed).
- * connection-notification-id - The ID of the
- * notification.
+ * original-iops - The original IOPS rate of the volume.
- * connection-notification-state - The state of the notification
- * (Enabled | Disabled).
+ * original-size - The original size of the volume, in GiB.
- * connection-notification-type - The type of notification
- * (Topic).
+ * original-volume-type - The original volume type of the volume (standard |
+ * io1 | io2 | gp2 | sc1 | st1).
- * service-id - The ID of the endpoint service.
+ * originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).
- * vpc-endpoint-id - The ID of the VPC endpoint.
+ * start-time - The modification start time.
+ * target-iops - The target IOPS rate of the volume.
+ * target-size - The target size of the volume, in GiB.
+ * target-volume-type - The target volume type of the volume (standard |
+ * io1 | io2 | gp2 | sc1 | st1).
+ * targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).
+ * volume-id - The ID of the volume.
The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another request with the returned NextToken value.
The nextToken value returned by a previous paginated request.
The token to request the next page of results.
+ *The maximum number of results (up to a limit of 500) to be returned in a paginated + * request.
*/ - NextToken?: string; + MaxResults?: number; } -export namespace DescribeVpcEndpointConnectionNotificationsRequest { +export namespace DescribeVolumesModificationsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcEndpointConnectionNotificationsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeVolumesModificationsRequest): any => ({ ...obj, }); } -export interface DescribeVpcEndpointConnectionNotificationsResult { +export type VolumeModificationState = "completed" | "failed" | "modifying" | "optimizing"; + +/** + *Describes the modification status of an EBS volume.
+ *If the volume has never been modified, some element values will be null.
+ */ +export interface VolumeModification { /** - *One or more notifications.
+ *The ID of the volume.
*/ - ConnectionNotificationSet?: ConnectionNotification[]; + VolumeId?: string; /** - *The token to use to retrieve the next page of results. This value is
- * null when there are no more results to return.
The current modification state. The modification state is null for unmodified + * volumes.
*/ - NextToken?: string; -} + ModificationState?: VolumeModificationState | string; -export namespace DescribeVpcEndpointConnectionNotificationsResult { /** - * @internal + *A status message about the modification progress or failure.
*/ - export const filterSensitiveLog = (obj: DescribeVpcEndpointConnectionNotificationsResult): any => ({ - ...obj, - }); -} + StatusMessage?: string; -export interface DescribeVpcEndpointConnectionsRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The target size of the volume, in GiB.
*/ - DryRun?: boolean; + TargetSize?: number; /** - *One or more filters.
- *
- * service-id - The ID of the service.
- * vpc-endpoint-owner - The AWS account number of the owner of the
- * endpoint.
- * vpc-endpoint-state - The state of the endpoint
- * (pendingAcceptance | pending |
- * available | deleting | deleted |
- * rejected | failed).
- * vpc-endpoint-id - The ID of the endpoint.
The target IOPS rate of the volume.
*/ - Filters?: Filter[]; + TargetIops?: number; /** - *The maximum number of results to return for the request in a single page. The remaining
- * results of the initial request can be seen by sending another request with the returned
- * NextToken value. This value can be between 5 and 1,000; if
- * MaxResults is given a value larger than 1,000, only 1,000 results are
- * returned.
The target EBS volume type of the volume.
*/ - MaxResults?: number; + TargetVolumeType?: VolumeType | string; /** - *The token to retrieve the next page of results.
+ *The target throughput of the volume, in MiB/s.
*/ - NextToken?: string; -} + TargetThroughput?: number; -export namespace DescribeVpcEndpointConnectionsRequest { /** - * @internal + *The target setting for Amazon EBS Multi-Attach.
*/ - export const filterSensitiveLog = (obj: DescribeVpcEndpointConnectionsRequest): any => ({ - ...obj, - }); -} + TargetMultiAttachEnabled?: boolean; -/** - *Describes a VPC endpoint connection to a service.
- */ -export interface VpcEndpointConnection { /** - *The ID of the service to which the endpoint is connected.
+ *The original size of the volume, in GiB.
*/ - ServiceId?: string; + OriginalSize?: number; /** - *The ID of the VPC endpoint.
+ *The original IOPS rate of the volume.
*/ - VpcEndpointId?: string; + OriginalIops?: number; /** - *The AWS account ID of the owner of the VPC endpoint.
+ *The original EBS volume type of the volume.
*/ - VpcEndpointOwner?: string; + OriginalVolumeType?: VolumeType | string; /** - *The state of the VPC endpoint.
+ *The original throughput of the volume, in MiB/s.
*/ - VpcEndpointState?: State | string; + OriginalThroughput?: number; /** - *The date and time that the VPC endpoint was created.
+ *The original setting for Amazon EBS Multi-Attach.
*/ - CreationTimestamp?: Date; + OriginalMultiAttachEnabled?: boolean; /** - *The DNS entries for the VPC endpoint.
+ *The modification progress, from 0 to 100 percent complete.
*/ - DnsEntries?: DnsEntry[]; + Progress?: number; /** - *The Amazon Resource Names (ARNs) of the network load balancers for the service.
+ *The modification start time.
*/ - NetworkLoadBalancerArns?: string[]; + StartTime?: Date; /** - *The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
+ *The modification completion or failure time.
*/ - GatewayLoadBalancerArns?: string[]; + EndTime?: Date; } -export namespace VpcEndpointConnection { +export namespace VolumeModification { /** * @internal */ - export const filterSensitiveLog = (obj: VpcEndpointConnection): any => ({ + export const filterSensitiveLog = (obj: VolumeModification): any => ({ ...obj, }); } -export interface DescribeVpcEndpointConnectionsResult { +export interface DescribeVolumesModificationsResult { /** - *Information about one or more VPC endpoint connections.
+ *Information about the volume modifications.
*/ - VpcEndpointConnections?: VpcEndpointConnection[]; + VolumesModifications?: VolumeModification[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Token for pagination, null if there are no more results
*/ NextToken?: string; } -export namespace DescribeVpcEndpointConnectionsResult { +export namespace DescribeVolumesModificationsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcEndpointConnectionsResult): any => ({ + export const filterSensitiveLog = (obj: DescribeVolumesModificationsResult): any => ({ ...obj, }); } -/** - *Contains the parameters for DescribeVpcEndpoints.
- */ -export interface DescribeVpcEndpointsRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more endpoint IDs.
- */ - VpcEndpointIds?: string[]; - +export interface DescribeVolumeStatusRequest { /** - *One or more filters.
- *The filters.
+ *
+ * action.code - The action code for the event (for example,
+ * enable-volume-io).
+ * action.description - A description of the action.
+ * action.event-id - The event ID associated with the action.
+ * availability-zone - The Availability Zone of the instance.
- * service-name - The name of the service.
+ * event.description - A description of the event.
- * vpc-id - The ID of the VPC in which the endpoint resides.
+ * event.event-id - The event ID.
- * vpc-endpoint-id - The ID of the endpoint.
+ * event.event-type - The event type (for io-enabled:
+ * passed | failed; for io-performance:
+ * io-performance:degraded | io-performance:severely-degraded |
+ * io-performance:stalled).
- * vpc-endpoint-state - The state of the endpoint
- * (pendingAcceptance | pending |
- * available | deleting | deleted |
- * rejected | failed).
+ * event.not-after - The latest end time for the event.
- * vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
+ * event.not-before - The earliest start time for the event.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * volume-status.details-name - The cause for
+ * volume-status.status (io-enabled |
+ * io-performance).
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * volume-status.details-status - The status of
+ * volume-status.details-name (for io-enabled:
+ * passed | failed; for io-performance:
+ * normal | degraded | severely-degraded |
+ * stalled).
+ * volume-status.status - The status of the volume (ok |
+ * impaired | warning | insufficient-data).
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
- *Constraint: If the value is greater than 1,000, we return only 1,000 items.
+ *The maximum number of volume results returned by DescribeVolumeStatus in
+ * paginated output. When this parameter is used, the request only returns
+ * MaxResults results in a single page along with a NextToken
+ * response element. The remaining results of the initial request can be seen by sending another
+ * request with the returned NextToken value. This value can be between 5 and 1,000;
+ * if MaxResults is given a value larger than 1,000, only 1,000 results are returned.
+ * If this parameter is not used, then DescribeVolumeStatus returns all results. You
+ * cannot specify this parameter and the volume IDs parameter in the same request.
The token for the next set of items to return. (You received this token from a prior call.)
+ *The NextToken value to include in a future DescribeVolumeStatus
+ * request. When the results of the request exceed MaxResults, this value can be
+ * used to retrieve the next page of results. This value is null when there are no
+ * more results to return.
Contains the output of DescribeVpcEndpoints.
- */ -export interface DescribeVpcEndpointsResult { /** - *Information about the endpoints.
+ *The IDs of the volumes.
+ *Default: Describes all your volumes.
*/ - VpcEndpoints?: VpcEndpoint[]; + VolumeIds?: string[]; /** - *The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes a volume status operation code.
+ */ +export interface VolumeStatusAction { /** - *The IDs of one or more services.
+ *The code identifying the operation, for example, enable-volume-io.
One or more filters.
- *
- * service-name - The name of the service.
- * service-id - The ID of the service.
- * service-state - The state of the service (Pending |
- * Available | Deleting | Deleted |
- * Failed).
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
A description of the operation.
*/ - Filters?: Filter[]; + Description?: string; /** - *The maximum number of results to return for the request in a single page. The remaining
- * results of the initial request can be seen by sending another request with the returned
- * NextToken value. This value can be between 5 and 1,000; if
- * MaxResults is given a value larger than 1,000, only 1,000 results are
- * returned.
The ID of the event associated with this operation.
*/ - MaxResults?: number; + EventId?: string; /** - *The token to retrieve the next page of results.
+ *The event type associated with this operation.
*/ - NextToken?: string; + EventType?: string; } -export namespace DescribeVpcEndpointServiceConfigurationsRequest { +export namespace VolumeStatusAction { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcEndpointServiceConfigurationsRequest): any => ({ + export const filterSensitiveLog = (obj: VolumeStatusAction): any => ({ ...obj, }); } -export interface DescribeVpcEndpointServiceConfigurationsResult { +/** + *Information about the instances to which the volume is attached.
+ */ +export interface VolumeStatusAttachmentStatus { /** - *Information about one or more services.
+ *The maximum IOPS supported by the attached instance.
*/ - ServiceConfigurations?: ServiceConfiguration[]; + IoPerformance?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the attached instance.
*/ - NextToken?: string; + InstanceId?: string; } -export namespace DescribeVpcEndpointServiceConfigurationsResult { +export namespace VolumeStatusAttachmentStatus { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcEndpointServiceConfigurationsResult): any => ({ + export const filterSensitiveLog = (obj: VolumeStatusAttachmentStatus): any => ({ ...obj, }); } -export interface DescribeVpcEndpointServicePermissionsRequest { +/** + *Describes a volume status event.
+ */ +export interface VolumeStatusEvent { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
A description of the event.
*/ - DryRun?: boolean; + Description?: string; /** - *The ID of the service.
+ *The ID of this event.
*/ - ServiceId: string | undefined; + EventId?: string; /** - *One or more filters.
- *
- * principal - The ARN of the principal.
- * principal-type - The principal type (All |
- * Service | OrganizationUnit | Account
- * | User | Role).
The type of this event.
*/ - Filters?: Filter[]; + EventType?: string; /** - *The maximum number of results to return for the request in a single page. The remaining
- * results of the initial request can be seen by sending another request with the returned
- * NextToken value. This value can be between 5 and 1,000; if
- * MaxResults is given a value larger than 1,000, only 1,000 results are
- * returned.
The latest end time of the event.
*/ - MaxResults?: number; + NotAfter?: Date; /** - *The token to retrieve the next page of results.
+ *The earliest start time of the event.
*/ - NextToken?: string; + NotBefore?: Date; + + /** + *The ID of the instance associated with the event.
+ */ + InstanceId?: string; } -export namespace DescribeVpcEndpointServicePermissionsRequest { +export namespace VolumeStatusEvent { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcEndpointServicePermissionsRequest): any => ({ + export const filterSensitiveLog = (obj: VolumeStatusEvent): any => ({ ...obj, }); } -export interface DescribeVpcEndpointServicePermissionsResult { +export type VolumeStatusName = "io-enabled" | "io-performance"; + +/** + *Describes a volume status.
+ */ +export interface VolumeStatusDetails { /** - *Information about one or more allowed principals.
+ *The name of the volume status.
*/ - AllowedPrincipals?: AllowedPrincipal[]; + Name?: VolumeStatusName | string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The intended status of the volume status.
*/ - NextToken?: string; + Status?: string; } -export namespace DescribeVpcEndpointServicePermissionsResult { +export namespace VolumeStatusDetails { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcEndpointServicePermissionsResult): any => ({ + export const filterSensitiveLog = (obj: VolumeStatusDetails): any => ({ ...obj, }); } +export type VolumeStatusInfoStatus = "impaired" | "insufficient-data" | "ok"; + /** - *Contains the parameters for DescribeVpcEndpointServices.
+ *Describes the status of a volume.
*/ -export interface DescribeVpcEndpointServicesRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more service names.
- */ - ServiceNames?: string[]; - - /** - *One or more filters.
- *
- * service-name - The name of the service.
- * service-type - The type of service (Interface |
- * Gateway).
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
- *Constraint: If the value is greater than 1,000, we return only 1,000 items.
+ *The details of the volume status.
*/ - MaxResults?: number; + Details?: VolumeStatusDetails[]; /** - *The token for the next set of items to return. (You received this token from a prior call.)
+ *The status of the volume.
*/ - NextToken?: string; + Status?: VolumeStatusInfoStatus | string; } -export namespace DescribeVpcEndpointServicesRequest { +export namespace VolumeStatusInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcEndpointServicesRequest): any => ({ + export const filterSensitiveLog = (obj: VolumeStatusInfo): any => ({ ...obj, }); } /** - *Information about the Private DNS name for interface endpoints.
+ *Describes the volume status.
*/ -export interface PrivateDnsDetails { +export interface VolumeStatusItem { /** - *The private DNS name assigned to the VPC endpoint service.
+ *The details of the operation.
*/ - PrivateDnsName?: string; -} + Actions?: VolumeStatusAction[]; -export namespace PrivateDnsDetails { /** - * @internal + *The Availability Zone of the volume.
*/ - export const filterSensitiveLog = (obj: PrivateDnsDetails): any => ({ - ...obj, - }); -} + AvailabilityZone?: string; -/** - *Describes a VPC endpoint service.
- */ -export interface ServiceDetail { /** - *The Amazon Resource Name (ARN) of the service.
+ *The Amazon Resource Name (ARN) of the Outpost.
*/ - ServiceName?: string; + OutpostArn?: string; /** - *The ID of the endpoint service.
+ *A list of events associated with the volume.
*/ - ServiceId?: string; + Events?: VolumeStatusEvent[]; /** - *The type of service.
+ *The volume ID.
*/ - ServiceType?: ServiceTypeDetail[]; + VolumeId?: string; /** - *The Availability Zones in which the service is available.
+ *The volume status.
*/ - AvailabilityZones?: string[]; + VolumeStatus?: VolumeStatusInfo; /** - *The AWS account ID of the service owner.
+ *Information about the instances to which the volume is attached.
*/ - Owner?: string; + AttachmentStatuses?: VolumeStatusAttachmentStatus[]; +} +export namespace VolumeStatusItem { /** - *The DNS names for the service.
+ * @internal */ - BaseEndpointDnsNames?: string[]; + export const filterSensitiveLog = (obj: VolumeStatusItem): any => ({ + ...obj, + }); +} +export interface DescribeVolumeStatusResult { /** - *The private DNS name for the service.
+ *The token to use to retrieve the next page of results. This value is null
+ * when there are no more results to return.
The private DNS names assigned to the VPC endpoint service.
+ *Information about the status of the volumes.
*/ - PrivateDnsNames?: PrivateDnsDetails[]; + VolumeStatuses?: VolumeStatusItem[]; +} +export namespace DescribeVolumeStatusResult { /** - *Indicates whether the service supports endpoint policies.
+ * @internal */ - VpcEndpointPolicySupported?: boolean; + export const filterSensitiveLog = (obj: DescribeVolumeStatusResult): any => ({ + ...obj, + }); +} - /** - *Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.
- */ - AcceptanceRequired?: boolean; +export type VpcAttributeName = "enableDnsHostnames" | "enableDnsSupport"; +export interface DescribeVpcAttributeRequest { /** - *Indicates whether the service manages its VPC endpoints. Management of the service VPC - * endpoints using the VPC endpoint API is restricted.
+ *The VPC attribute.
*/ - ManagesVpcEndpoints?: boolean; + Attribute: VpcAttributeName | string | undefined; /** - *Any tags assigned to the service.
+ *The ID of the VPC.
*/ - Tags?: Tag[]; + VpcId: string | undefined; /** - *The verification state of the VPC endpoint service.
- *Consumers of the endpoint service cannot use the private name when the state is not verified.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Contains the output of DescribeVpcEndpointServices.
- */ -export interface DescribeVpcEndpointServicesResult { +export interface DescribeVpcAttributeResult { /** - *A list of supported services.
+ *The ID of the VPC.
*/ - ServiceNames?: string[]; + VpcId?: string; /** - *Information about the service.
+ *Indicates whether the instances launched in the VPC get DNS hostnames.
+ * If this attribute is true, instances in the VPC get DNS hostnames;
+ * otherwise, they do not.
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
+ *Indicates whether DNS resolution is enabled for
+ * the VPC. If this attribute is true, the Amazon DNS server
+ * resolves DNS hostnames for your instances to their corresponding
+ * IP addresses; otherwise, it does not.
One or more filters.
- *
- * accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter
- * VPC.
- * accepter-vpc-info.owner-id - The AWS account ID of the owner of the
- * accepter VPC.
- * accepter-vpc-info.vpc-id - The ID of the accepter VPC.
- * expiration-time - The expiration date and time for the VPC peering
- * connection.
- * requester-vpc-info.cidr-block - The IPv4 CIDR block of the
- * requester's VPC.
- * requester-vpc-info.owner-id - The AWS account ID of the owner of the
- * requester VPC.
- * requester-vpc-info.vpc-id - The ID of the requester VPC.
- * status-code - The status of the VPC peering connection
- * (pending-acceptance | failed |
- * expired | provisioning | active |
- * deleting | deleted |
- * rejected).
- * status-message - A message that provides more information about the status
- * of the VPC peering connection, if applicable.
+ * is-classic-link-enabled - Whether the VPC is enabled for ClassicLink
+ * (true | false).
+ *
* tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ *
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * vpc-peering-connection-id - The ID of the VPC peering connection.
One or more VPC peering connection IDs.
- *Default: Describes all your VPC peering connections.
+ *One or more VPCs for which you want to describe the ClassicLink status.
+ */ + VpcIds?: string[]; +} + +export namespace DescribeVpcClassicLinkRequest { + /** + * @internal */ - VpcPeeringConnectionIds?: string[]; + export const filterSensitiveLog = (obj: DescribeVpcClassicLinkRequest): any => ({ + ...obj, + }); +} +/** + *Describes whether a VPC is enabled for ClassicLink.
+ */ +export interface VpcClassicLink { /** - *The token for the next page of results.
+ *Indicates whether the VPC is enabled for ClassicLink.
*/ - NextToken?: string; + ClassicLinkEnabled?: boolean; + + /** + *Any tags assigned to the VPC.
+ */ + Tags?: Tag[]; + + /** + *The ID of the VPC.
+ */ + VpcId?: string; +} + +export namespace VpcClassicLink { + /** + * @internal + */ + export const filterSensitiveLog = (obj: VpcClassicLink): any => ({ + ...obj, + }); +} + +export interface DescribeVpcClassicLinkResult { + /** + *The ClassicLink status of one or more VPCs.
+ */ + Vpcs?: VpcClassicLink[]; +} + +export namespace DescribeVpcClassicLinkResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeVpcClassicLinkResult): any => ({ + ...obj, + }); +} +export interface DescribeVpcClassicLinkDnsSupportRequest { /** *The maximum number of results to return with a single call.
* To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ */ + NextToken?: string; + + /** + *One or more VPC IDs.
+ */ + VpcIds?: string[]; } -export namespace DescribeVpcPeeringConnectionsRequest { +export namespace DescribeVpcClassicLinkDnsSupportRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcPeeringConnectionsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeVpcClassicLinkDnsSupportRequest): any => ({ ...obj, }); } -export interface DescribeVpcPeeringConnectionsResult { +/** + *Describes the ClassicLink DNS support status of a VPC.
+ */ +export interface ClassicLinkDnsSupport { /** - *Information about the VPC peering connections.
+ *Indicates whether ClassicLink DNS support is enabled for the VPC.
*/ - VpcPeeringConnections?: VpcPeeringConnection[]; + ClassicLinkDnsSupported?: boolean; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the VPC.
*/ - NextToken?: string; + VpcId?: string; } -export namespace DescribeVpcPeeringConnectionsResult { +export namespace ClassicLinkDnsSupport { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcPeeringConnectionsResult): any => ({ + export const filterSensitiveLog = (obj: ClassicLinkDnsSupport): any => ({ ...obj, }); } -export interface DescribeVpcsRequest { +export interface DescribeVpcClassicLinkDnsSupportResult { /** - *One or more filters.
- *
- * cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you
- * specify must exactly match the VPC's CIDR block for information to be returned
- * for the VPC. Must contain the slash followed by one or two digits (for example,
- * /28).
- * cidr-block-association.cidr-block - An IPv4 CIDR block associated with the
- * VPC.
- * cidr-block-association.association-id - The association ID for
- * an IPv4 CIDR block associated with the VPC.
- * cidr-block-association.state - The state of an IPv4 CIDR block
- * associated with the VPC.
- * dhcp-options-id - The ID of a set of DHCP options.
- * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR
- * block associated with the VPC.
- * ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
- * ipv6-cidr-block-association.association-id - The association
- * ID for an IPv6 CIDR block associated with the VPC.
- * ipv6-cidr-block-association.state - The state of an IPv6 CIDR
- * block associated with the VPC.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the ClassicLink DNS support status of the VPCs.
+ */ + Vpcs?: ClassicLinkDnsSupport[]; +} + +export namespace DescribeVpcClassicLinkDnsSupportResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeVpcClassicLinkDnsSupportResult): any => ({ + ...obj, + }); +} + +export interface DescribeVpcEndpointConnectionNotificationsRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the notification.
+ */ + ConnectionNotificationId?: string; + + /** + *One or more filters.
+ *
- * isDefault - Indicates whether the VPC is the default VPC.
connection-notification-arn - The ARN of the SNS topic for the
+ * notification.
*
- * owner-id - The ID of the AWS account that owns the VPC.
connection-notification-id - The ID of the
+ * notification.
*
- * state - The state of the VPC (pending | available).
connection-notification-state - The state of the notification
+ * (Enabled | Disabled).
*
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
connection-notification-type - The type of notification
+ * (Topic).
*
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
service-id - The ID of the endpoint service.
*
- * vpc-id - The ID of the VPC.
vpc-endpoint-id - The ID of the VPC endpoint.
* One or more VPC IDs.
- *Default: Describes all your VPCs.
- */ - VpcIds?: string[]; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another request with the returned NextToken value.
The token for the next page of results.
+ *The token to request the next page of results.
*/ NextToken?: string; - - /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Information about one or more VPCs.
+ *One or more notifications.
*/ - Vpcs?: Vpc[]; + ConnectionNotificationSet?: ConnectionNotification[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to use to retrieve the next page of results. This value is
+ * null when there are no more results to return.
Contains the parameters for DescribeVpnConnections.
- */ -export interface DescribeVpnConnectionsRequest { +export interface DescribeVpcEndpointConnectionsRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters.
- *
- * customer-gateway-configuration - The configuration information for the customer gateway.
- * customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
- * state - The state of the VPN connection (pending | available | deleting | deleted).
- * option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
- * route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
- * bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * type - The type of VPN connection. Currently the only supported type is ipsec.1.
service-id - The ID of the service.
*
- * vpn-connection-id - The ID of the VPN connection.
+ * vpc-endpoint-owner - The AWS account number of the owner of the
+ * endpoint.
- * vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
+ * vpc-endpoint-state - The state of the endpoint
+ * (pendingAcceptance | pending |
+ * available | deleting | deleted |
+ * rejected | failed).
- * transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
+ * vpc-endpoint-id - The ID of the endpoint.
One or more VPN connection IDs.
- *Default: Describes your VPN connections.
+ *The maximum number of results to return for the request in a single page. The remaining
+ * results of the initial request can be seen by sending another request with the returned
+ * NextToken value. This value can be between 5 and 1,000; if
+ * MaxResults is given a value larger than 1,000, only 1,000 results are
+ * returned.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The token to retrieve the next page of results.
*/ - DryRun?: boolean; + NextToken?: string; } -export namespace DescribeVpnConnectionsRequest { +export namespace DescribeVpcEndpointConnectionsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpnConnectionsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeVpcEndpointConnectionsRequest): any => ({ ...obj, }); } /** - *Contains the output of DescribeVpnConnections.
+ *Describes a VPC endpoint connection to a service.
*/ -export interface DescribeVpnConnectionsResult { +export interface VpcEndpointConnection { + /** + *The ID of the service to which the endpoint is connected.
+ */ + ServiceId?: string; + + /** + *The ID of the VPC endpoint.
+ */ + VpcEndpointId?: string; + + /** + *The AWS account ID of the owner of the VPC endpoint.
+ */ + VpcEndpointOwner?: string; + + /** + *The state of the VPC endpoint.
+ */ + VpcEndpointState?: State | string; + + /** + *The date and time that the VPC endpoint was created.
+ */ + CreationTimestamp?: Date; + + /** + *The DNS entries for the VPC endpoint.
+ */ + DnsEntries?: DnsEntry[]; + + /** + *The Amazon Resource Names (ARNs) of the network load balancers for the service.
+ */ + NetworkLoadBalancerArns?: string[]; + + /** + *The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
+ */ + GatewayLoadBalancerArns?: string[]; +} + +export namespace VpcEndpointConnection { /** - *Information about one or more VPN connections.
+ * @internal + */ + export const filterSensitiveLog = (obj: VpcEndpointConnection): any => ({ + ...obj, + }); +} + +export interface DescribeVpcEndpointConnectionsResult { + /** + *Information about one or more VPC endpoint connections.
+ */ + VpcEndpointConnections?: VpcEndpointConnection[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for DescribeVpnGateways.
+ *Contains the parameters for DescribeVpcEndpoints.
*/ -export interface DescribeVpnGatewaysRequest { +export interface DescribeVpcEndpointsRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more endpoint IDs.
+ */ + VpcEndpointIds?: string[]; + /** *One or more filters.
*
- * amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
- * attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
- * attachment.vpc-id - The ID of an attached VPC.
service-name - The name of the service.
*
- * availability-zone - The Availability Zone for the virtual private gateway (if applicable).
vpc-id - The ID of the VPC in which the endpoint resides.
*
- * state - The state of the virtual private gateway (pending | available | deleting | deleted).
vpc-endpoint-id - The ID of the endpoint.
*
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
vpc-endpoint-state - The state of the endpoint
+ * (pendingAcceptance | pending |
+ * available | deleting | deleted |
+ * rejected | failed).
*
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
*
- * type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * vpn-gateway-id - The ID of the virtual private gateway.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more virtual private gateway IDs.
- *Default: Describes all your virtual private gateways.
+ *The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
+ *Constraint: If the value is greater than 1,000, we return only 1,000 items.
*/ - VpnGatewayIds?: string[]; + MaxResults?: number; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The token for the next set of items to return. (You received this token from a prior call.)
*/ - DryRun?: boolean; + NextToken?: string; } -export namespace DescribeVpnGatewaysRequest { +export namespace DescribeVpcEndpointsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpnGatewaysRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeVpcEndpointsRequest): any => ({ ...obj, }); } /** - *Contains the output of DescribeVpnGateways.
+ *Contains the output of DescribeVpcEndpoints.
*/ -export interface DescribeVpnGatewaysResult { +export interface DescribeVpcEndpointsResult { + /** + *Information about the endpoints.
+ */ + VpcEndpoints?: VpcEndpoint[]; + /** - *Information about one or more virtual private gateways.
+ *The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/ - VpnGateways?: VpnGateway[]; + NextToken?: string; } -export namespace DescribeVpnGatewaysResult { +export namespace DescribeVpcEndpointsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpnGatewaysResult): any => ({ + export const filterSensitiveLog = (obj: DescribeVpcEndpointsResult): any => ({ ...obj, }); } diff --git a/clients/client-ec2/models/models_4.ts b/clients/client-ec2/models/models_4.ts index 46051b796c2fd..e6a2cb1308970 100644 --- a/clients/client-ec2/models/models_4.ts +++ b/clients/client-ec2/models/models_4.ts @@ -2,15 +2,12 @@ import { AddPrefixListEntry, AddressAttribute, Affinity, + AllowedPrincipal, ApplianceModeSupportValue, AssociationStatus, AttributeValue, AutoPlacement, - BlockDeviceMapping, - ByoipCidr, - CapacityReservationPreference, CapacityReservationState, - CapacityReservationTarget, ClientConnectOptions, ConnectionLogOptions, CurrencyCodeValues, @@ -21,6 +18,8 @@ import { FleetLaunchTemplateConfigRequest, HostRecovery, IamInstanceProfileAssociation, + InstanceEventWindow, + InstanceEventWindowTimeRangeRequest, Ipv6SupportValue, Placement, PlatformValues, @@ -38,14 +37,19 @@ import { TransitGatewayVpcAttachment, UnsuccessfulItem, VolumeType, + Vpc, VpcCidrBlockAssociation, VpcIpv6CidrBlockAssociation, + VpcPeeringConnection, _InstanceType, } from "./models_0"; import { AutoAcceptSharedAttachmentsValue, + CapacityReservationPreference, + CapacityReservationTarget, DefaultRouteTableAssociationValue, DefaultRouteTablePropagationValue, + DnsNameState, IKEVersionsRequestListValue, LaunchTemplate, ManagedPrefixList, @@ -56,6 +60,8 @@ import { Phase2EncryptionAlgorithmsRequestListValue, Phase2IntegrityAlgorithmsRequestListValue, ResponseLaunchTemplateData, + ServiceConfiguration, + ServiceTypeDetail, ShutdownBehavior, TrafficDirection, TrafficMirrorFilter, @@ -68,11 +74,11 @@ import { TransitGatewayPrefixListReference, VpnConnection, VpnEcmpSupportValue, + VpnGateway, } from "./models_1"; import { ArchitectureValues, AttributeBooleanValue, - BootModeValues, ConversionTask, ExportTaskS3Location, FastSnapshotRestoreStateCode, @@ -83,11 +89,7 @@ import { ImportImageLicenseConfigurationResponse, InstanceAttributeName, InstanceMetadataEndpointState, - InstanceMetadataOptionsResponse, - InstanceStatusEvent, - InstanceTagNotificationAttribute, LaunchPermission, - Monitoring, PaymentOption, PermissionGroup, SnapshotDetail, @@ -96,15 +98,17 @@ import { import { CreateVolumePermission, ExcessCapacityTerminationPolicy, + InstanceMetadataOptionsResponse, + InstanceStatusEvent, LaunchTemplateConfig, + Monitoring, ReservedInstancesConfiguration, - ScheduledInstance, SnapshotAttributeName, VolumeModification, } from "./models_3"; import { SENSITIVE_STRING } from "@aws-sdk/smithy-client"; -export interface DetachClassicLinkVpcRequest { +export interface DescribeVpcEndpointServiceConfigurationsRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -113,617 +117,797 @@ export interface DetachClassicLinkVpcRequest {
DryRun?: boolean;
/**
- *
The ID of the instance to unlink from the VPC.
+ *The IDs of one or more services.
*/ - InstanceId: string | undefined; + ServiceIds?: string[]; /** - *The ID of the VPC to which the instance is linked.
+ *One or more filters.
+ *
+ * service-name - The name of the service.
+ * service-id - The ID of the service.
+ * service-state - The state of the service (Pending |
+ * Available | Deleting | Deleted |
+ * Failed).
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of results to return for the request in a single page. The remaining
+ * results of the initial request can be seen by sending another request with the returned
+ * NextToken value. This value can be between 5 and 1,000; if
+ * MaxResults is given a value larger than 1,000, only 1,000 results are
+ * returned.
Returns true if the request succeeds; otherwise, it returns an error.
The token to retrieve the next page of results.
*/ - Return?: boolean; + NextToken?: string; } -export namespace DetachClassicLinkVpcResult { +export namespace DescribeVpcEndpointServiceConfigurationsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DetachClassicLinkVpcResult): any => ({ + export const filterSensitiveLog = (obj: DescribeVpcEndpointServiceConfigurationsRequest): any => ({ ...obj, }); } -export interface DetachInternetGatewayRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the internet gateway.
+ *Information about one or more services.
*/ - InternetGatewayId: string | undefined; + ServiceConfigurations?: ServiceConfiguration[]; /** - *The ID of the VPC.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for DetachNetworkInterface.
- */ -export interface DetachNetworkInterfaceRequest { - /** - *The ID of the attachment.
- */ - AttachmentId: string | undefined; - +export interface DescribeVpcEndpointServicePermissionsRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
/**
- * Specifies whether to force a detachment.
- *Use the Force parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata - * might not get updated. This means that the attributes associated - * with the detached network interface might still be visible. The - * instance metadata will get updated when you stop and start the - * instance.
- *The ID of the service.
*/ - Force?: boolean; -} + ServiceId: string | undefined; -export namespace DetachNetworkInterfaceRequest { /** - * @internal + *One or more filters.
+ *
+ * principal - The ARN of the principal.
+ * principal-type - The principal type (All |
+ * Service | OrganizationUnit | Account
+ * | User | Role).
The device name.
+ *The maximum number of results to return for the request in a single page. The remaining
+ * results of the initial request can be seen by sending another request with the returned
+ * NextToken value. This value can be between 5 and 1,000; if
+ * MaxResults is given a value larger than 1,000, only 1,000 results are
+ * returned.
Forces detachment if the previous detachment attempt did not occur cleanly (for example, - * logging into an instance, unmounting the volume, and detaching normally). This option can lead - * to data loss or a corrupted file system. Use this option only as a last resort to detach a - * volume from a failed instance. The instance won't have an opportunity to flush file system - * caches or file system metadata. If you use this option, you must perform file system check and - * repair procedures.
+ *The token to retrieve the next page of results.
*/ - Force?: boolean; + NextToken?: string; +} +export namespace DescribeVpcEndpointServicePermissionsRequest { /** - *The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.
+ * @internal */ - InstanceId?: string; + export const filterSensitiveLog = (obj: DescribeVpcEndpointServicePermissionsRequest): any => ({ + ...obj, + }); +} +export interface DescribeVpcEndpointServicePermissionsResult { /** - *The ID of the volume.
+ *Information about one or more allowed principals.
*/ - VolumeId: string | undefined; + AllowedPrincipals?: AllowedPrincipal[]; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for DetachVpnGateway.
+ *Contains the parameters for DescribeVpcEndpointServices.
*/ -export interface DetachVpnGatewayRequest { +export interface DescribeVpcEndpointServicesRequest { /** - *The ID of the VPC.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the virtual private gateway.
+ *One or more service names.
*/ - VpnGatewayId: string | undefined; + ServiceNames?: string[]; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more filters.
+ *
+ * service-name - The name of the service.
+ * service-type - The type of service (Interface |
+ * Gateway).
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
+ *Constraint: If the value is greater than 1,000, we return only 1,000 items.
*/ - export const filterSensitiveLog = (obj: DetachVpnGatewayRequest): any => ({ - ...obj, - }); -} + MaxResults?: number; -export interface DisableEbsEncryptionByDefaultRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The token for the next set of items to return. (You received this token from a prior call.)
*/ - DryRun?: boolean; + NextToken?: string; } -export namespace DisableEbsEncryptionByDefaultRequest { +export namespace DescribeVpcEndpointServicesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DisableEbsEncryptionByDefaultRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeVpcEndpointServicesRequest): any => ({ ...obj, }); } -export interface DisableEbsEncryptionByDefaultResult { +/** + *Information about the Private DNS name for interface endpoints.
+ */ +export interface PrivateDnsDetails { /** - *The updated status of encryption by default.
+ *The private DNS name assigned to the VPC endpoint service.
*/ - EbsEncryptionByDefault?: boolean; + PrivateDnsName?: string; } -export namespace DisableEbsEncryptionByDefaultResult { +export namespace PrivateDnsDetails { /** * @internal */ - export const filterSensitiveLog = (obj: DisableEbsEncryptionByDefaultResult): any => ({ + export const filterSensitiveLog = (obj: PrivateDnsDetails): any => ({ ...obj, }); } -export interface DisableFastSnapshotRestoresRequest { - /** - *One or more Availability Zones. For example, us-east-2a.
The IDs of one or more snapshots. For example, snap-1234567890abcdef0.
Describes a VPC endpoint service.
+ */ +export interface ServiceDetail { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The Amazon Resource Name (ARN) of the service.
*/ - DryRun?: boolean; -} + ServiceName?: string; -export namespace DisableFastSnapshotRestoresRequest { /** - * @internal + *The ID of the endpoint service.
*/ - export const filterSensitiveLog = (obj: DisableFastSnapshotRestoresRequest): any => ({ - ...obj, - }); -} + ServiceId?: string; -/** - *Describes fast snapshot restores that were successfully disabled.
- */ -export interface DisableFastSnapshotRestoreSuccessItem { /** - *The ID of the snapshot.
+ *The type of service.
*/ - SnapshotId?: string; + ServiceType?: ServiceTypeDetail[]; /** - *The Availability Zone.
+ *The Availability Zones in which the service is available.
*/ - AvailabilityZone?: string; + AvailabilityZones?: string[]; /** - *The state of fast snapshot restores for the snapshot.
+ *The AWS account ID of the service owner.
*/ - State?: FastSnapshotRestoreStateCode | string; + Owner?: string; /** - *The reason for the state transition. The possible values are as follows:
- *
- * Client.UserInitiated - The state successfully transitioned to enabling or
- * disabling.
- * Client.UserInitiated - Lifecycle state transition - The state successfully transitioned
- * to optimizing, enabled, or disabled.
The DNS names for the service.
*/ - StateTransitionReason?: string; + BaseEndpointDnsNames?: string[]; /** - *The ID of the AWS account that enabled fast snapshot restores on the snapshot.
+ *The private DNS name for the service.
*/ - OwnerId?: string; + PrivateDnsName?: string; /** - *The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
+ *The private DNS names assigned to the VPC endpoint service.
*/ - OwnerAlias?: string; + PrivateDnsNames?: PrivateDnsDetails[]; /** - *The time at which fast snapshot restores entered the enabling state.
Indicates whether the service supports endpoint policies.
*/ - EnablingTime?: Date; + VpcEndpointPolicySupported?: boolean; /** - *The time at which fast snapshot restores entered the optimizing state.
Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.
*/ - OptimizingTime?: Date; + AcceptanceRequired?: boolean; /** - *The time at which fast snapshot restores entered the enabled state.
Indicates whether the service manages its VPC endpoints. Management of the service VPC + * endpoints using the VPC endpoint API is restricted.
*/ - EnabledTime?: Date; + ManagesVpcEndpoints?: boolean; /** - *The time at which fast snapshot restores entered the disabling state.
Any tags assigned to the service.
*/ - DisablingTime?: Date; + Tags?: Tag[]; /** - *The time at which fast snapshot restores entered the disabled state.
The verification state of the VPC endpoint service.
+ *Consumers of the endpoint service cannot use the private name when the state is not verified.
Describes an error that occurred when disabling fast snapshot restores.
+ *Contains the output of DescribeVpcEndpointServices.
*/ -export interface DisableFastSnapshotRestoreStateError { +export interface DescribeVpcEndpointServicesResult { /** - *The error code.
+ *A list of supported services.
*/ - Code?: string; + ServiceNames?: string[]; /** - *The error message.
+ *Information about the service.
*/ - Message?: string; + ServiceDetails?: ServiceDetail[]; + + /** + *The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
+ */ + NextToken?: string; } -export namespace DisableFastSnapshotRestoreStateError { +export namespace DescribeVpcEndpointServicesResult { /** * @internal */ - export const filterSensitiveLog = (obj: DisableFastSnapshotRestoreStateError): any => ({ + export const filterSensitiveLog = (obj: DescribeVpcEndpointServicesResult): any => ({ ...obj, }); } -/** - *Contains information about an error that occurred when disabling fast snapshot restores.
- */ -export interface DisableFastSnapshotRestoreStateErrorItem { +export interface DescribeVpcPeeringConnectionsRequest { /** - *The Availability Zone.
+ *One or more filters.
+ *
+ * accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter
+ * VPC.
+ * accepter-vpc-info.owner-id - The AWS account ID of the owner of the
+ * accepter VPC.
+ * accepter-vpc-info.vpc-id - The ID of the accepter VPC.
+ * expiration-time - The expiration date and time for the VPC peering
+ * connection.
+ * requester-vpc-info.cidr-block - The IPv4 CIDR block of the
+ * requester's VPC.
+ * requester-vpc-info.owner-id - The AWS account ID of the owner of the
+ * requester VPC.
+ * requester-vpc-info.vpc-id - The ID of the requester VPC.
+ * status-code - The status of the VPC peering connection
+ * (pending-acceptance | failed |
+ * expired | provisioning | active |
+ * deleting | deleted |
+ * rejected).
+ * status-message - A message that provides more information about the status
+ * of the VPC peering connection, if applicable.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * vpc-peering-connection-id - The ID of the VPC peering connection.
The error.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more VPC peering connection IDs.
+ *Default: Describes all your VPC peering connections.
*/ - export const filterSensitiveLog = (obj: DisableFastSnapshotRestoreStateErrorItem): any => ({ - ...obj, - }); -} + VpcPeeringConnectionIds?: string[]; -/** - *Contains information about the errors that occurred when disabling fast snapshot restores.
- */ -export interface DisableFastSnapshotRestoreErrorItem { /** - *The ID of the snapshot.
+ *The token for the next page of results.
*/ - SnapshotId?: string; + NextToken?: string; /** - *The errors.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Information about the snapshots for which fast snapshot restores were successfully disabled.
+ *Information about the VPC peering connections.
*/ - Successful?: DisableFastSnapshotRestoreSuccessItem[]; + VpcPeeringConnections?: VpcPeeringConnection[]; /** - *Information about the snapshots for which fast snapshot restores could not be disabled.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the AMI.
+ *One or more filters.
+ *
+ * cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you
+ * specify must exactly match the VPC's CIDR block for information to be returned
+ * for the VPC. Must contain the slash followed by one or two digits (for example,
+ * /28).
+ * cidr-block-association.cidr-block - An IPv4 CIDR block associated with the
+ * VPC.
+ * cidr-block-association.association-id - The association ID for
+ * an IPv4 CIDR block associated with the VPC.
+ * cidr-block-association.state - The state of an IPv4 CIDR block
+ * associated with the VPC.
+ * dhcp-options-id - The ID of a set of DHCP options.
+ * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR
+ * block associated with the VPC.
+ * ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
+ * ipv6-cidr-block-association.association-id - The association
+ * ID for an IPv6 CIDR block associated with the VPC.
+ * ipv6-cidr-block-association.state - The state of an IPv6 CIDR
+ * block associated with the VPC.
+ * isDefault - Indicates whether the VPC is the default VPC.
+ * owner-id - The ID of the AWS account that owns the VPC.
+ * state - The state of the VPC (pending | available).
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * vpc-id - The ID of the VPC.
One or more VPC IDs.
+ *Default: Describes all your VPCs.
+ */ + VpcIds?: string[]; /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
-}
-export namespace DisableImageDeprecationRequest {
/**
- * @internal
+ * The token for the next page of results.
*/ - export const filterSensitiveLog = (obj: DisableImageDeprecationRequest): any => ({ - ...obj, - }); -} + NextToken?: string; -export interface DisableImageDeprecationResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about one or more VPCs.
*/ - export const filterSensitiveLog = (obj: DisableSerialConsoleAccessRequest): any => ({ - ...obj, - }); -} + Vpcs?: Vpc[]; -export interface DisableSerialConsoleAccessResult { /** - *If true, access to the EC2 serial console of all instances is enabled for
- * your account. If false, access to the EC2 serial console of all instances
- * is disabled for your account.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for DescribeVpnConnections.
+ */ +export interface DescribeVpnConnectionsRequest { /** - *The ID of the propagation route table.
+ *One or more filters.
+ *
+ * customer-gateway-configuration - The configuration information for the customer gateway.
+ * customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
+ * state - The state of the VPN connection (pending | available | deleting | deleted).
+ * option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
+ * route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
+ * bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * type - The type of VPN connection. Currently the only supported type is ipsec.1.
+ * vpn-connection-id - The ID of the VPN connection.
+ * vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
+ * transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
The ID of the attachment.
+ *One or more VPN connection IDs.
+ *Default: Describes your VPN connections.
*/ - TransitGatewayAttachmentId: string | undefined; + VpnConnectionIds?: string[]; /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
-export namespace DisableTransitGatewayRouteTablePropagationRequest {
+export namespace DescribeVpnConnectionsRequest {
/**
* @internal
*/
- export const filterSensitiveLog = (obj: DisableTransitGatewayRouteTablePropagationRequest): any => ({
+ export const filterSensitiveLog = (obj: DescribeVpnConnectionsRequest): any => ({
...obj,
});
}
-export type TransitGatewayPropagationState = "disabled" | "disabling" | "enabled" | "enabling";
-
/**
- * Describes route propagation.
+ *Contains the output of DescribeVpnConnections.
*/ -export interface TransitGatewayPropagation { - /** - *The ID of the attachment.
- */ - TransitGatewayAttachmentId?: string; - +export interface DescribeVpnConnectionsResult { /** - *The ID of the resource.
- */ - ResourceId?: string; - - /** - *The resource type. Note that the tgw-peering resource type has been deprecated.
Information about one or more VPN connections.
*/ - ResourceType?: TransitGatewayAttachmentResourceType | string; + VpnConnections?: VpnConnection[]; +} +export namespace DescribeVpnConnectionsResult { /** - *The ID of the transit gateway route table.
+ * @internal */ - TransitGatewayRouteTableId?: string; + export const filterSensitiveLog = (obj: DescribeVpnConnectionsResult): any => ({ + ...obj, + }); +} +/** + *Contains the parameters for DescribeVpnGateways.
+ */ +export interface DescribeVpnGatewaysRequest { /** - *The state.
+ *One or more filters.
+ *
+ * amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
+ * attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
+ * attachment.vpc-id - The ID of an attached VPC.
+ * availability-zone - The Availability Zone for the virtual private gateway (if applicable).
+ * state - The state of the virtual private gateway (pending | available | deleting | deleted).
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
+ * vpn-gateway-id - The ID of the virtual private gateway.
One or more virtual private gateway IDs.
+ *Default: Describes all your virtual private gateways.
*/ - export const filterSensitiveLog = (obj: TransitGatewayPropagation): any => ({ - ...obj, - }); -} + VpnGatewayIds?: string[]; -export interface DisableTransitGatewayRouteTablePropagationResult { /** - *Information about route propagation.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Contains the parameters for DisableVgwRoutePropagation.
+ *Contains the output of DescribeVpnGateways.
*/ -export interface DisableVgwRoutePropagationRequest { +export interface DescribeVpnGatewaysResult { /** - *The ID of the virtual private gateway.
- */ - GatewayId: string | undefined; - - /** - *The ID of the route table.
- */ - RouteTableId: string | undefined; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about one or more virtual private gateways.
*/ - DryRun?: boolean; + VpnGateways?: VpnGateway[]; } -export namespace DisableVgwRoutePropagationRequest { +export namespace DescribeVpnGatewaysResult { /** * @internal */ - export const filterSensitiveLog = (obj: DisableVgwRoutePropagationRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeVpnGatewaysResult): any => ({ ...obj, }); } -export interface DisableVpcClassicLinkRequest { +export interface DetachClassicLinkVpcRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -732,222 +916,235 @@ export interface DisableVpcClassicLinkRequest {
DryRun?: boolean;
/**
- *
The ID of the VPC.
+ *The ID of the instance to unlink from the VPC.
+ */ + InstanceId: string | undefined; + + /** + *The ID of the VPC to which the instance is linked.
*/ VpcId: string | undefined; } -export namespace DisableVpcClassicLinkRequest { +export namespace DetachClassicLinkVpcRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DisableVpcClassicLinkRequest): any => ({ + export const filterSensitiveLog = (obj: DetachClassicLinkVpcRequest): any => ({ ...obj, }); } -export interface DisableVpcClassicLinkResult { +export interface DetachClassicLinkVpcResult { /** *Returns true if the request succeeds; otherwise, it returns an error.
The ID of the VPC.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the internet gateway.
*/ - export const filterSensitiveLog = (obj: DisableVpcClassicLinkDnsSupportRequest): any => ({ - ...obj, - }); -} + InternetGatewayId: string | undefined; -export interface DisableVpcClassicLinkDnsSupportResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
The ID of the VPC.
*/ - Return?: boolean; + VpcId: string | undefined; } -export namespace DisableVpcClassicLinkDnsSupportResult { +export namespace DetachInternetGatewayRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DisableVpcClassicLinkDnsSupportResult): any => ({ + export const filterSensitiveLog = (obj: DetachInternetGatewayRequest): any => ({ ...obj, }); } -export interface DisassociateAddressRequest { +/** + *Contains the parameters for DetachNetworkInterface.
+ */ +export interface DetachNetworkInterfaceRequest { /** - *[EC2-VPC] The association ID. Required for EC2-VPC.
+ *The ID of the attachment.
*/ - AssociationId?: string; + AttachmentId: string | undefined; /** - *[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Specifies whether to force a detachment.
+ *Use the Force parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata + * might not get updated. This means that the attributes associated + * with the detached network interface might still be visible. The + * instance metadata will get updated when you stop and start the + * instance.
+ *The ID of the Client VPN endpoint from which to disassociate the target network.
- */ - ClientVpnEndpointId: string | undefined; - +export interface DetachVolumeRequest { /** - *The ID of the target network association.
+ *The device name.
*/ - AssociationId: string | undefined; + Device?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Forces detachment if the previous detachment attempt did not occur cleanly (for example, + * logging into an instance, unmounting the volume, and detaching normally). This option can lead + * to data loss or a corrupted file system. Use this option only as a last resort to detach a + * volume from a failed instance. The instance won't have an opportunity to flush file system + * caches or file system metadata. If you use this option, you must perform file system check and + * repair procedures.
*/ - DryRun?: boolean; -} + Force?: boolean; -export namespace DisassociateClientVpnTargetNetworkRequest { /** - * @internal + *The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.
*/ - export const filterSensitiveLog = (obj: DisassociateClientVpnTargetNetworkRequest): any => ({ - ...obj, - }); -} + InstanceId?: string; -export interface DisassociateClientVpnTargetNetworkResult { /** - *The ID of the target network association.
+ *The ID of the volume.
*/ - AssociationId?: string; + VolumeId: string | undefined; /** - *The current state of the target network association.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Contains the parameters for DetachVpnGateway.
+ */ +export interface DetachVpnGatewayRequest { /** - *The ARN of the ACM certificate from which to disassociate the IAM role.
+ *The ID of the VPC.
*/ - CertificateArn?: string; + VpcId: string | undefined; /** - *The ARN of the IAM role to disassociate.
+ *The ID of the virtual private gateway.
*/ - RoleArn?: string; + VpnGatewayId: string | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the IAM instance profile association.
+ *The updated status of encryption by default.
*/ - AssociationId: string | undefined; + EbsEncryptionByDefault?: boolean; } -export namespace DisassociateIamInstanceProfileRequest { +export namespace DisableEbsEncryptionByDefaultResult { /** * @internal */ - export const filterSensitiveLog = (obj: DisassociateIamInstanceProfileRequest): any => ({ + export const filterSensitiveLog = (obj: DisableEbsEncryptionByDefaultResult): any => ({ ...obj, }); } -export interface DisassociateIamInstanceProfileResult { +export interface DisableFastSnapshotRestoresRequest { /** - *Information about the IAM instance profile association.
+ *One or more Availability Zones. For example, us-east-2a.
The IDs of one or more snapshots. For example, snap-1234567890abcdef0.
The association ID representing the current association between the route table and subnet or gateway.
- */ - AssociationId: string | undefined; + SourceSnapshotIds: string[] | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -957,285 +1154,272 @@ export interface DisassociateRouteTableRequest { DryRun?: boolean; } -export namespace DisassociateRouteTableRequest { +export namespace DisableFastSnapshotRestoresRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DisassociateRouteTableRequest): any => ({ + export const filterSensitiveLog = (obj: DisableFastSnapshotRestoresRequest): any => ({ ...obj, }); } -export interface DisassociateSubnetCidrBlockRequest { +/** + *
Describes fast snapshot restores that were successfully disabled.
+ */ +export interface DisableFastSnapshotRestoreSuccessItem { /** - *The association ID for the CIDR block.
+ *The ID of the snapshot.
*/ - AssociationId: string | undefined; -} + SnapshotId?: string; -export namespace DisassociateSubnetCidrBlockRequest { /** - * @internal + *The Availability Zone.
*/ - export const filterSensitiveLog = (obj: DisassociateSubnetCidrBlockRequest): any => ({ - ...obj, - }); -} + AvailabilityZone?: string; -export interface DisassociateSubnetCidrBlockResult { /** - *Information about the IPv6 CIDR block association.
+ *The state of fast snapshot restores for the snapshot.
*/ - Ipv6CidrBlockAssociation?: SubnetIpv6CidrBlockAssociation; + State?: FastSnapshotRestoreStateCode | string; /** - *The ID of the subnet.
+ *The reason for the state transition. The possible values are as follows:
+ *
+ * Client.UserInitiated - The state successfully transitioned to enabling or
+ * disabling.
+ * Client.UserInitiated - Lifecycle state transition - The state successfully transitioned
+ * to optimizing, enabled, or disabled.
The ID of the AWS account that enabled fast snapshot restores on the snapshot.
*/ - export const filterSensitiveLog = (obj: DisassociateSubnetCidrBlockResult): any => ({ - ...obj, - }); -} + OwnerId?: string; -export interface DisassociateTransitGatewayMulticastDomainRequest { /** - *The ID of the transit gateway multicast domain.
+ *The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
*/ - TransitGatewayMulticastDomainId?: string; + OwnerAlias?: string; /** - *The ID of the attachment.
+ *The time at which fast snapshot restores entered the enabling state.
The IDs of the subnets;
+ *The time at which fast snapshot restores entered the optimizing state.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The time at which fast snapshot restores entered the enabled state.
The time at which fast snapshot restores entered the disabling state.
Information about the association.
+ *The time at which fast snapshot restores entered the disabled state.
The ID of the transit gateway route table.
- */ - TransitGatewayRouteTableId: string | undefined; - +/** + *Describes an error that occurred when disabling fast snapshot restores.
+ */ +export interface DisableFastSnapshotRestoreStateError { /** - *The ID of the attachment.
+ *The error code.
*/ - TransitGatewayAttachmentId: string | undefined; + Code?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The error message.
*/ - DryRun?: boolean; + Message?: string; } -export namespace DisassociateTransitGatewayRouteTableRequest { +export namespace DisableFastSnapshotRestoreStateError { /** * @internal */ - export const filterSensitiveLog = (obj: DisassociateTransitGatewayRouteTableRequest): any => ({ + export const filterSensitiveLog = (obj: DisableFastSnapshotRestoreStateError): any => ({ ...obj, }); } -export interface DisassociateTransitGatewayRouteTableResult { +/** + *Contains information about an error that occurred when disabling fast snapshot restores.
+ */ +export interface DisableFastSnapshotRestoreStateErrorItem { /** - *Information about the association.
+ *The Availability Zone.
*/ - Association?: TransitGatewayAssociation; + AvailabilityZone?: string; + + /** + *The error.
+ */ + Error?: DisableFastSnapshotRestoreStateError; } -export namespace DisassociateTransitGatewayRouteTableResult { +export namespace DisableFastSnapshotRestoreStateErrorItem { /** * @internal */ - export const filterSensitiveLog = (obj: DisassociateTransitGatewayRouteTableResult): any => ({ + export const filterSensitiveLog = (obj: DisableFastSnapshotRestoreStateErrorItem): any => ({ ...obj, }); } -export interface DisassociateTrunkInterfaceRequest { - /** - *The ID ofthe association
- */ - AssociationId: string | undefined; - +/** + *Contains information about the errors that occurred when disabling fast snapshot restores.
+ */ +export interface DisableFastSnapshotRestoreErrorItem { /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to Ensure - * Idempotency.
+ *The ID of the snapshot.
*/ - ClientToken?: string; + SnapshotId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The errors.
*/ - DryRun?: boolean; + FastSnapshotRestoreStateErrors?: DisableFastSnapshotRestoreStateErrorItem[]; } -export namespace DisassociateTrunkInterfaceRequest { +export namespace DisableFastSnapshotRestoreErrorItem { /** * @internal */ - export const filterSensitiveLog = (obj: DisassociateTrunkInterfaceRequest): any => ({ + export const filterSensitiveLog = (obj: DisableFastSnapshotRestoreErrorItem): any => ({ ...obj, }); } -export interface DisassociateTrunkInterfaceResult { +export interface DisableFastSnapshotRestoresResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
Information about the snapshots for which fast snapshot restores were successfully disabled.
*/ - Return?: boolean; + Successful?: DisableFastSnapshotRestoreSuccessItem[]; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to Ensure - * Idempotency.
+ *Information about the snapshots for which fast snapshot restores could not be disabled.
*/ - ClientToken?: string; + Unsuccessful?: DisableFastSnapshotRestoreErrorItem[]; } -export namespace DisassociateTrunkInterfaceResult { +export namespace DisableFastSnapshotRestoresResult { /** * @internal */ - export const filterSensitiveLog = (obj: DisassociateTrunkInterfaceResult): any => ({ + export const filterSensitiveLog = (obj: DisableFastSnapshotRestoresResult): any => ({ ...obj, }); } -export interface DisassociateVpcCidrBlockRequest { +export interface DisableImageDeprecationRequest { /** - *The association ID for the CIDR block.
+ *The ID of the AMI.
*/ - AssociationId: string | undefined; + ImageId: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the IPv6 CIDR block association.
- */ - Ipv6CidrBlockAssociation?: VpcIpv6CidrBlockAssociation; - - /** - *Information about the IPv4 CIDR block association.
- */ - CidrBlockAssociation?: VpcCidrBlockAssociation; - +export interface DisableImageDeprecationResult { /** - *The ID of the VPC.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The updated status of encryption by default.
+ *If true, access to the EC2 serial console of all instances is enabled for
+ * your account. If false, access to the EC2 serial console of all instances
+ * is disabled for your account.
One or more Availability Zones. For example, us-east-2a.
The ID of the propagation route table.
*/ - AvailabilityZones: string[] | undefined; + TransitGatewayRouteTableId: string | undefined; /** - *The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify
- * a snapshot that was shared with you from another AWS account.
The ID of the attachment.
*/ - SourceSnapshotIds: string[] | undefined; + TransitGatewayAttachmentId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -1245,371 +1429,354 @@ export interface EnableFastSnapshotRestoresRequest { DryRun?: boolean; } -export namespace EnableFastSnapshotRestoresRequest { +export namespace DisableTransitGatewayRouteTablePropagationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EnableFastSnapshotRestoresRequest): any => ({ + export const filterSensitiveLog = (obj: DisableTransitGatewayRouteTablePropagationRequest): any => ({ ...obj, }); } +export type TransitGatewayPropagationState = "disabled" | "disabling" | "enabled" | "enabling"; + /** - *
Describes fast snapshot restores that were successfully enabled.
+ *Describes route propagation.
*/ -export interface EnableFastSnapshotRestoreSuccessItem { +export interface TransitGatewayPropagation { /** - *The ID of the snapshot.
+ *The ID of the attachment.
*/ - SnapshotId?: string; + TransitGatewayAttachmentId?: string; /** - *The Availability Zone.
+ *The ID of the resource.
*/ - AvailabilityZone?: string; + ResourceId?: string; /** - *The state of fast snapshot restores.
+ *The resource type. Note that the tgw-peering resource type has been deprecated.
The reason for the state transition. The possible values are as follows:
- *
- * Client.UserInitiated - The state successfully transitioned to enabling or
- * disabling.
- * Client.UserInitiated - Lifecycle state transition - The state successfully transitioned
- * to optimizing, enabled, or disabled.
The ID of the transit gateway route table.
*/ - StateTransitionReason?: string; + TransitGatewayRouteTableId?: string; /** - *The ID of the AWS account that enabled fast snapshot restores on the snapshot.
+ *The state.
*/ - OwnerId?: string; + State?: TransitGatewayPropagationState | string; +} +export namespace TransitGatewayPropagation { /** - *The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
+ * @internal */ - OwnerAlias?: string; + export const filterSensitiveLog = (obj: TransitGatewayPropagation): any => ({ + ...obj, + }); +} +export interface DisableTransitGatewayRouteTablePropagationResult { /** - *The time at which fast snapshot restores entered the enabling state.
Information about route propagation.
*/ - EnablingTime?: Date; + Propagation?: TransitGatewayPropagation; +} +export namespace DisableTransitGatewayRouteTablePropagationResult { /** - *The time at which fast snapshot restores entered the optimizing state.
Contains the parameters for DisableVgwRoutePropagation.
+ */ +export interface DisableVgwRoutePropagationRequest { /** - *The time at which fast snapshot restores entered the enabled state.
The ID of the virtual private gateway.
*/ - EnabledTime?: Date; + GatewayId: string | undefined; /** - *The time at which fast snapshot restores entered the disabling state.
The ID of the route table.
*/ - DisablingTime?: Date; + RouteTableId: string | undefined; /** - *The time at which fast snapshot restores entered the disabled state.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes an error that occurred when enabling fast snapshot restores.
- */ -export interface EnableFastSnapshotRestoreStateError { +export interface DisableVpcClassicLinkRequest { /** - *The error code.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The error message.
+ *The ID of the VPC.
*/ - Message?: string; + VpcId: string | undefined; } -export namespace EnableFastSnapshotRestoreStateError { +export namespace DisableVpcClassicLinkRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreStateError): any => ({ + export const filterSensitiveLog = (obj: DisableVpcClassicLinkRequest): any => ({ ...obj, }); } -/** - *Contains information about an error that occurred when enabling fast snapshot restores.
- */ -export interface EnableFastSnapshotRestoreStateErrorItem { - /** - *The Availability Zone.
- */ - AvailabilityZone?: string; - +export interface DisableVpcClassicLinkResult { /** - *The error.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Contains information about the errors that occurred when enabling fast snapshot restores.
- */ -export interface EnableFastSnapshotRestoreErrorItem { - /** - *The ID of the snapshot.
- */ - SnapshotId?: string; - +export interface DisableVpcClassicLinkDnsSupportRequest { /** - *The errors.
+ *The ID of the VPC.
*/ - FastSnapshotRestoreStateErrors?: EnableFastSnapshotRestoreStateErrorItem[]; + VpcId?: string; } -export namespace EnableFastSnapshotRestoreErrorItem { +export namespace DisableVpcClassicLinkDnsSupportRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreErrorItem): any => ({ + export const filterSensitiveLog = (obj: DisableVpcClassicLinkDnsSupportRequest): any => ({ ...obj, }); } -export interface EnableFastSnapshotRestoresResult { - /** - *Information about the snapshots for which fast snapshot restores were successfully enabled.
- */ - Successful?: EnableFastSnapshotRestoreSuccessItem[]; - +export interface DisableVpcClassicLinkDnsSupportResult { /** - *Information about the snapshots for which fast snapshot restores could not be enabled.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The ID of the AMI.
+ *[EC2-VPC] The association ID. Required for EC2-VPC.
*/ - ImageId: string | undefined; + AssociationId?: string; /** - *The date and time to deprecate the AMI, in UTC, in the following format: - * YYYY-MM-DDTHH:MM:SSZ. - * If you specify a value for seconds, Amazon EC2 rounds the seconds to the - * nearest minute.
- *You can’t specify a date in the past. The upper limit for DeprecateAt is 10
- * years from now.
[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
*/ - DeprecateAt: Date | undefined; + PublicIp?: string; /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
-export namespace EnableImageDeprecationRequest {
+export namespace DisassociateAddressRequest {
/**
* @internal
*/
- export const filterSensitiveLog = (obj: EnableImageDeprecationRequest): any => ({
+ export const filterSensitiveLog = (obj: DisassociateAddressRequest): any => ({
...obj,
});
}
-export interface EnableImageDeprecationResult {
+export interface DisassociateClientVpnTargetNetworkRequest {
/**
- * Returns true if the request succeeds; otherwise, it returns an error.
The ID of the Client VPN endpoint from which to disassociate the target network.
*/ - Return?: boolean; -} + ClientVpnEndpointId: string | undefined; -export namespace EnableImageDeprecationResult { /** - * @internal + *The ID of the target network association.
*/ - export const filterSensitiveLog = (obj: EnableImageDeprecationResult): any => ({ - ...obj, - }); -} + AssociationId: string | undefined; -export interface EnableSerialConsoleAccessRequest { /** *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
If true, access to the EC2 serial console of all instances is enabled for
- * your account. If false, access to the EC2 serial console of all instances
- * is disabled for your account.
The ID of the target network association.
*/ - SerialConsoleAccessEnabled?: boolean; + AssociationId?: string; + + /** + *The current state of the target network association.
+ */ + Status?: AssociationStatus; } -export namespace EnableSerialConsoleAccessResult { +export namespace DisassociateClientVpnTargetNetworkResult { /** * @internal */ - export const filterSensitiveLog = (obj: EnableSerialConsoleAccessResult): any => ({ + export const filterSensitiveLog = (obj: DisassociateClientVpnTargetNetworkResult): any => ({ ...obj, }); } -export interface EnableTransitGatewayRouteTablePropagationRequest { +export interface DisassociateEnclaveCertificateIamRoleRequest { /** - *The ID of the propagation route table.
+ *The ARN of the ACM certificate from which to disassociate the IAM role.
*/ - TransitGatewayRouteTableId: string | undefined; + CertificateArn?: string; /** - *The ID of the attachment.
+ *The ARN of the IAM role to disassociate.
*/ - TransitGatewayAttachmentId: string | undefined; + RoleArn?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about route propagation.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Contains the parameters for EnableVgwRoutePropagation.
- */ -export interface EnableVgwRoutePropagationRequest { +export interface DisassociateIamInstanceProfileRequest { /** - *The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with.
+ *The ID of the IAM instance profile association.
*/ - GatewayId: string | undefined; + AssociationId: string | undefined; +} +export namespace DisassociateIamInstanceProfileRequest { /** - *The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.
+ * @internal */ - RouteTableId: string | undefined; + export const filterSensitiveLog = (obj: DisassociateIamInstanceProfileRequest): any => ({ + ...obj, + }); +} +export interface DisassociateIamInstanceProfileResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the IAM instance profile association.
*/ - DryRun?: boolean; + IamInstanceProfileAssociation?: IamInstanceProfileAssociation; } -export namespace EnableVgwRoutePropagationRequest { +export namespace DisassociateIamInstanceProfileResult { /** * @internal */ - export const filterSensitiveLog = (obj: EnableVgwRoutePropagationRequest): any => ({ + export const filterSensitiveLog = (obj: DisassociateIamInstanceProfileResult): any => ({ ...obj, }); } -export interface EnableVolumeIORequest { +/** + *The targets to disassociate from the specified event window.
+ */ +export interface InstanceEventWindowDisassociationRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The IDs of the instances to disassociate from the event window.
*/ - DryRun?: boolean; + InstanceIds?: string[]; /** - *The ID of the volume.
+ *The instance tags to disassociate from the event window. Any instances associated with + * the tags will be disassociated from the event window.
*/ - VolumeId: string | undefined; + InstanceTags?: Tag[]; + + /** + *The IDs of the Dedicated Hosts to disassociate from the event window.
+ */ + DedicatedHostIds?: string[]; } -export namespace EnableVolumeIORequest { +export namespace InstanceEventWindowDisassociationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EnableVolumeIORequest): any => ({ + export const filterSensitiveLog = (obj: InstanceEventWindowDisassociationRequest): any => ({ ...obj, }); } -export interface EnableVpcClassicLinkRequest { +export interface DisassociateInstanceEventWindowRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -1618,1176 +1785,1120 @@ export interface EnableVpcClassicLinkRequest {
DryRun?: boolean;
/**
- *
The ID of the VPC.
+ *The ID of the event window.
*/ - VpcId: string | undefined; + InstanceEventWindowId: string | undefined; + + /** + *One or more targets to disassociate from the specified event window.
+ */ + AssociationTarget: InstanceEventWindowDisassociationRequest | undefined; } -export namespace EnableVpcClassicLinkRequest { +export namespace DisassociateInstanceEventWindowRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EnableVpcClassicLinkRequest): any => ({ + export const filterSensitiveLog = (obj: DisassociateInstanceEventWindowRequest): any => ({ ...obj, }); } -export interface EnableVpcClassicLinkResult { +export interface DisassociateInstanceEventWindowResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
Information about the event window.
*/ - Return?: boolean; + InstanceEventWindow?: InstanceEventWindow; } -export namespace EnableVpcClassicLinkResult { +export namespace DisassociateInstanceEventWindowResult { /** * @internal */ - export const filterSensitiveLog = (obj: EnableVpcClassicLinkResult): any => ({ + export const filterSensitiveLog = (obj: DisassociateInstanceEventWindowResult): any => ({ ...obj, }); } -export interface EnableVpcClassicLinkDnsSupportRequest { +export interface DisassociateRouteTableRequest { /** - *The ID of the VPC.
+ *The association ID representing the current association between the route table and subnet or gateway.
*/ - VpcId?: string; + AssociationId: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
The association ID for the CIDR block.
*/ - Return?: boolean; + AssociationId: string | undefined; } -export namespace EnableVpcClassicLinkDnsSupportResult { +export namespace DisassociateSubnetCidrBlockRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EnableVpcClassicLinkDnsSupportResult): any => ({ + export const filterSensitiveLog = (obj: DisassociateSubnetCidrBlockRequest): any => ({ ...obj, }); } -export interface ExportClientVpnClientCertificateRevocationListRequest { +export interface DisassociateSubnetCidrBlockResult { /** - *The ID of the Client VPN endpoint.
+ *Information about the IPv6 CIDR block association.
*/ - ClientVpnEndpointId: string | undefined; + Ipv6CidrBlockAssociation?: SubnetIpv6CidrBlockAssociation; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the subnet.
*/ - DryRun?: boolean; + SubnetId?: string; } -export namespace ExportClientVpnClientCertificateRevocationListRequest { +export namespace DisassociateSubnetCidrBlockResult { /** * @internal */ - export const filterSensitiveLog = (obj: ExportClientVpnClientCertificateRevocationListRequest): any => ({ + export const filterSensitiveLog = (obj: DisassociateSubnetCidrBlockResult): any => ({ ...obj, }); } -export type ClientCertificateRevocationListStatusCode = "active" | "pending"; +export interface DisassociateTransitGatewayMulticastDomainRequest { + /** + *The ID of the transit gateway multicast domain.
+ */ + TransitGatewayMulticastDomainId?: string; -/** - *Describes the state of a client certificate revocation list.
- */ -export interface ClientCertificateRevocationListStatus { /** - *The state of the client certificate revocation list.
+ *The ID of the attachment.
*/ - Code?: ClientCertificateRevocationListStatusCode | string; + TransitGatewayAttachmentId?: string; /** - *A message about the status of the client certificate revocation list, if applicable.
+ *The IDs of the subnets;
*/ - Message?: string; + SubnetIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the client certificate revocation list.
- */ - CertificateRevocationList?: string; - +export interface DisassociateTransitGatewayMulticastDomainResult { /** - *The current state of the client certificate revocation list.
+ *Information about the association.
*/ - Status?: ClientCertificateRevocationListStatus; + Associations?: TransitGatewayMulticastDomainAssociations; } -export namespace ExportClientVpnClientCertificateRevocationListResult { +export namespace DisassociateTransitGatewayMulticastDomainResult { /** * @internal */ - export const filterSensitiveLog = (obj: ExportClientVpnClientCertificateRevocationListResult): any => ({ + export const filterSensitiveLog = (obj: DisassociateTransitGatewayMulticastDomainResult): any => ({ ...obj, }); } -export interface ExportClientVpnClientConfigurationRequest { +export interface DisassociateTransitGatewayRouteTableRequest { /** - *The ID of the Client VPN endpoint.
+ *The ID of the transit gateway route table.
*/ - ClientVpnEndpointId: string | undefined; + TransitGatewayRouteTableId: string | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the attachment.
+ */ + TransitGatewayAttachmentId: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The contents of the Client VPN endpoint configuration file.
+ *Information about the association.
*/ - ClientConfiguration?: string; + Association?: TransitGatewayAssociation; } -export namespace ExportClientVpnClientConfigurationResult { +export namespace DisassociateTransitGatewayRouteTableResult { /** * @internal */ - export const filterSensitiveLog = (obj: ExportClientVpnClientConfigurationResult): any => ({ + export const filterSensitiveLog = (obj: DisassociateTransitGatewayRouteTableResult): any => ({ ...obj, }); } -/** - *Describes the destination for an export image task.
- */ -export interface ExportTaskS3LocationRequest { +export interface DisassociateTrunkInterfaceRequest { /** - *The destination Amazon S3 bucket.
+ *The ID ofthe association
*/ - S3Bucket: string | undefined; + AssociationId: string | undefined; /** - *The prefix (logical hierarchy) in the bucket.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. For more information, see How to Ensure + * Idempotency.
*/ - S3Prefix?: string; + ClientToken?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Token to enable idempotency for export image requests.
+ *Returns true if the request succeeds; otherwise, it returns an error.
A description of the image being exported. The maximum length is 255 characters.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. For more information, see How to Ensure + * Idempotency.
*/ - Description?: string; + ClientToken?: string; +} +export namespace DisassociateTrunkInterfaceResult { /** - *The disk image format.
+ * @internal */ - DiskImageFormat: DiskImageFormat | string | undefined; + export const filterSensitiveLog = (obj: DisassociateTrunkInterfaceResult): any => ({ + ...obj, + }); +} +export interface DisassociateVpcCidrBlockRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The association ID for the CIDR block.
*/ - DryRun?: boolean; + AssociationId: string | undefined; +} +export namespace DisassociateVpcCidrBlockRequest { /** - *The ID of the image.
+ * @internal */ - ImageId: string | undefined; + export const filterSensitiveLog = (obj: DisassociateVpcCidrBlockRequest): any => ({ + ...obj, + }); +} +export interface DisassociateVpcCidrBlockResult { /** - *Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE - * and READ_ACP permissions to the AWS account vm-import-export@amazon.com.
+ *Information about the IPv6 CIDR block association.
*/ - S3ExportLocation: ExportTaskS3LocationRequest | undefined; + Ipv6CidrBlockAssociation?: VpcIpv6CidrBlockAssociation; /** - *The name of the role that grants VM Import/Export permission to export images to your Amazon - * S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
+ *Information about the IPv4 CIDR block association.
*/ - RoleName?: string; + CidrBlockAssociation?: VpcCidrBlockAssociation; /** - *The tags to apply to the export image task during creation.
+ *The ID of the VPC.
*/ - TagSpecifications?: TagSpecification[]; + VpcId?: string; } -export namespace ExportImageRequest { +export namespace DisassociateVpcCidrBlockResult { /** * @internal */ - export const filterSensitiveLog = (obj: ExportImageRequest): any => ({ + export const filterSensitiveLog = (obj: DisassociateVpcCidrBlockResult): any => ({ ...obj, }); } -export interface ExportImageResult { +export interface EnableEbsEncryptionByDefaultRequest { /** - *A description of the image being exported.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The disk image format for the exported image.
+ * @internal */ - DiskImageFormat?: DiskImageFormat | string; + export const filterSensitiveLog = (obj: EnableEbsEncryptionByDefaultRequest): any => ({ + ...obj, + }); +} +export interface EnableEbsEncryptionByDefaultResult { /** - *The ID of the export image task.
+ *The updated status of encryption by default.
*/ - ExportImageTaskId?: string; + EbsEncryptionByDefault?: boolean; +} +export namespace EnableEbsEncryptionByDefaultResult { /** - *The ID of the image.
- */ - ImageId?: string; - - /** - *The name of the role that grants VM Import/Export permission to export images to your Amazon - * S3 bucket.
+ * @internal */ - RoleName?: string; + export const filterSensitiveLog = (obj: EnableEbsEncryptionByDefaultResult): any => ({ + ...obj, + }); +} +export interface EnableFastSnapshotRestoresRequest { /** - *The percent complete of the export image task.
+ *One or more Availability Zones. For example, us-east-2a.
Information about the destination Amazon S3 bucket.
+ *The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify
+ * a snapshot that was shared with you from another AWS account.
The status of the export image task. The possible values are active, completed,
- * deleting, and deleted.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The status message for the export image task.
+ * @internal */ - StatusMessage?: string; + export const filterSensitiveLog = (obj: EnableFastSnapshotRestoresRequest): any => ({ + ...obj, + }); +} +/** + *Describes fast snapshot restores that were successfully enabled.
+ */ +export interface EnableFastSnapshotRestoreSuccessItem { /** - *Any tags assigned to the export image task.
+ *The ID of the snapshot.
*/ - Tags?: Tag[]; -} + SnapshotId?: string; -export namespace ExportImageResult { /** - * @internal + *The Availability Zone.
*/ - export const filterSensitiveLog = (obj: ExportImageResult): any => ({ - ...obj, - }); -} + AvailabilityZone?: string; -export interface ExportTransitGatewayRoutesRequest { /** - *The ID of the route table.
+ *The state of fast snapshot restores.
*/ - TransitGatewayRouteTableId: string | undefined; + State?: FastSnapshotRestoreStateCode | string; /** - *One or more filters. The possible values are:
+ *The reason for the state transition. The possible values are as follows:
*
- * attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
- * attachment.resource-id - The resource id of the transit gateway attachment.
- * route-search.exact-match - The exact match of the specified filter.
- * route-search.longest-prefix-match - The longest prefix that matches the route.
- * route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
- * route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
- * state - The state of the route (active | blackhole).
- * transit-gateway-route-destination-cidr-block - The CIDR range.
Client.UserInitiated - The state successfully transitioned to enabling or
+ * disabling.
*
- * type - The type of route (propagated |
- * static).
Client.UserInitiated - Lifecycle state transition - The state successfully transitioned
+ * to optimizing, enabled, or disabled.
* The name of the S3 bucket.
+ *The ID of the AWS account that enabled fast snapshot restores on the snapshot.
*/ - S3Bucket: string | undefined; + OwnerId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
*/ - DryRun?: boolean; -} + OwnerAlias?: string; -export namespace ExportTransitGatewayRoutesRequest { /** - * @internal + *The time at which fast snapshot restores entered the enabling state.
The URL of the exported file in Amazon S3. For example, - * s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.
+ *The time at which fast snapshot restores entered the optimizing state.
The time at which fast snapshot restores entered the enabled state.
The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon - * S3 object information.
+ *The time at which fast snapshot restores entered the disabling state.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The time at which fast snapshot restores entered the disabled state.
Information about the associated IAM roles.
+ *Describes an error that occurred when enabling fast snapshot restores.
*/ -export interface AssociatedRole { - /** - *The ARN of the associated IAM role.
- */ - AssociatedRoleArn?: string; - - /** - *The name of the Amazon S3 bucket in which the Amazon S3 object is stored.
- */ - CertificateS3BucketName?: string; - - /** - *The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle
- * is stored. The object key is formated as follows: role_arn/certificate_arn.
- *
The ID of the KMS customer master key (CMK) used to encrypt the private key.
- */ - EncryptionKmsKeyId?: string; -} - -export namespace AssociatedRole { +export interface EnableFastSnapshotRestoreStateError { /** - * @internal + *The error code.
*/ - export const filterSensitiveLog = (obj: AssociatedRole): any => ({ - ...obj, - }); -} + Code?: string; -export interface GetAssociatedEnclaveCertificateIamRolesResult { /** - *Information about the associated IAM roles.
+ *The error message.
*/ - AssociatedRoles?: AssociatedRole[]; + Message?: string; } -export namespace GetAssociatedEnclaveCertificateIamRolesResult { +export namespace EnableFastSnapshotRestoreStateError { /** * @internal */ - export const filterSensitiveLog = (obj: GetAssociatedEnclaveCertificateIamRolesResult): any => ({ + export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreStateError): any => ({ ...obj, }); } -export interface GetAssociatedIpv6PoolCidrsRequest { - /** - *The ID of the IPv6 address pool.
- */ - PoolId: string | undefined; - - /** - *The token for the next page of results.
- */ - NextToken?: string; - +/** + *Contains information about an error that occurred when enabling fast snapshot restores.
+ */ +export interface EnableFastSnapshotRestoreStateErrorItem { /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The Availability Zone.
*/ - MaxResults?: number; + AvailabilityZone?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The error.
*/ - DryRun?: boolean; + Error?: EnableFastSnapshotRestoreStateError; } -export namespace GetAssociatedIpv6PoolCidrsRequest { +export namespace EnableFastSnapshotRestoreStateErrorItem { /** * @internal */ - export const filterSensitiveLog = (obj: GetAssociatedIpv6PoolCidrsRequest): any => ({ + export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreStateErrorItem): any => ({ ...obj, }); } /** - *Describes an IPv6 CIDR block association.
+ *Contains information about the errors that occurred when enabling fast snapshot restores.
*/ -export interface Ipv6CidrAssociation { +export interface EnableFastSnapshotRestoreErrorItem { /** - *The IPv6 CIDR block.
+ *The ID of the snapshot.
*/ - Ipv6Cidr?: string; + SnapshotId?: string; /** - *The resource that's associated with the IPv6 CIDR block.
+ *The errors.
*/ - AssociatedResource?: string; + FastSnapshotRestoreStateErrors?: EnableFastSnapshotRestoreStateErrorItem[]; } -export namespace Ipv6CidrAssociation { +export namespace EnableFastSnapshotRestoreErrorItem { /** * @internal */ - export const filterSensitiveLog = (obj: Ipv6CidrAssociation): any => ({ + export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreErrorItem): any => ({ ...obj, }); } -export interface GetAssociatedIpv6PoolCidrsResult { +export interface EnableFastSnapshotRestoresResult { /** - *Information about the IPv6 CIDR block associations.
+ *Information about the snapshots for which fast snapshot restores were successfully enabled.
*/ - Ipv6CidrAssociations?: Ipv6CidrAssociation[]; + Successful?: EnableFastSnapshotRestoreSuccessItem[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the snapshots for which fast snapshot restores could not be enabled.
*/ - NextToken?: string; + Unsuccessful?: EnableFastSnapshotRestoreErrorItem[]; } -export namespace GetAssociatedIpv6PoolCidrsResult { +export namespace EnableFastSnapshotRestoresResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetAssociatedIpv6PoolCidrsResult): any => ({ + export const filterSensitiveLog = (obj: EnableFastSnapshotRestoresResult): any => ({ ...obj, }); } -export interface GetCapacityReservationUsageRequest { +export interface EnableImageDeprecationRequest { /** - *The ID of the Capacity Reservation.
+ *The ID of the AMI.
*/ - CapacityReservationId: string | undefined; - - /** - *The token to use to retrieve the next page of results.
- */ - NextToken?: string; + ImageId: string | undefined; /** - *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Valid range: Minimum value of 1. Maximum value of 1000.
+ *The date and time to deprecate the AMI, in UTC, in the following format: + * YYYY-MM-DDTHH:MM:SSZ. + * If you specify a value for seconds, Amazon EC2 rounds the seconds to the + * nearest minute.
+ *You can’t specify a date in the past. The upper limit for DeprecateAt is 10
+ * years from now.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the Capacity Reservation usage.
- */ -export interface InstanceUsage { +export interface EnableImageDeprecationResult { /** - *The ID of the account that is making use of the Capacity Reservation.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The number of instances the account currently has in the Capacity Reservation.
+ * @internal */ - UsedInstanceCount?: number; + export const filterSensitiveLog = (obj: EnableImageDeprecationResult): any => ({ + ...obj, + }); } -export namespace InstanceUsage { +export interface EnableSerialConsoleAccessRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
If true, access to the EC2 serial console of all instances is enabled for
+ * your account. If false, access to the EC2 serial console of all instances
+ * is disabled for your account.
The ID of the Capacity Reservation.
+ * @internal */ - CapacityReservationId?: string; + export const filterSensitiveLog = (obj: EnableSerialConsoleAccessResult): any => ({ + ...obj, + }); +} +export interface EnableTransitGatewayRouteTablePropagationRequest { /** - *The type of instance for which the Capacity Reservation reserves capacity.
+ *The ID of the propagation route table.
*/ - InstanceType?: string; + TransitGatewayRouteTableId: string | undefined; /** - *The number of instances for which the Capacity Reservation reserves capacity.
+ *The ID of the attachment.
*/ - TotalInstanceCount?: number; + TransitGatewayAttachmentId: string | undefined; /** - *The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
- *
- * active - The Capacity Reservation is active and the capacity is available for your use.
- * expired - The Capacity Reservation expired automatically at the date and time specified
- * in your request. The reserved capacity is no longer available for your use.
- * cancelled - The Capacity Reservation was cancelled. The reserved capacity is no
- * longer available for your use.
- * pending - The Capacity Reservation request was successful but the capacity
- * provisioning is still pending.
- * failed - The Capacity Reservation request has failed. A request might fail
- * due to invalid request parameters, capacity constraints, or instance limit constraints.
- * Failed requests are retained for 60 minutes.
Information about the Capacity Reservation usage.
+ *Information about route propagation.
*/ - InstanceUsages?: InstanceUsage[]; + Propagation?: TransitGatewayPropagation; } -export namespace GetCapacityReservationUsageResult { +export namespace EnableTransitGatewayRouteTablePropagationResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetCapacityReservationUsageResult): any => ({ + export const filterSensitiveLog = (obj: EnableTransitGatewayRouteTablePropagationResult): any => ({ ...obj, }); } -export interface GetCoipPoolUsageRequest { +/** + *Contains the parameters for EnableVgwRoutePropagation.
+ */ +export interface EnableVgwRoutePropagationRequest { /** - *The ID of the address pool.
+ *The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with.
*/ - PoolId: string | undefined; + GatewayId: string | undefined; /** - *The filters. The following are the possible values:
- *
- * coip-address-usage.allocation-id
- *
- * coip-address-usage.aws-account-id
- *
- * coip-address-usage.aws-service
- *
- * coip-address-usage.co-ip
- *
The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.
*/ - Filters?: Filter[]; + RouteTableId: string | undefined; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
+ * @internal */ - NextToken?: string; + export const filterSensitiveLog = (obj: EnableVgwRoutePropagationRequest): any => ({ + ...obj, + }); +} +export interface EnableVolumeIORequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the volume.
+ */ + VolumeId: string | undefined; } -export namespace GetCoipPoolUsageRequest { +export namespace EnableVolumeIORequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetCoipPoolUsageRequest): any => ({ + export const filterSensitiveLog = (obj: EnableVolumeIORequest): any => ({ ...obj, }); } -/** - *Describes address usage for a customer-owned address pool.
- */ -export interface CoipAddressUsage { +export interface EnableVpcClassicLinkRequest { /** - *The allocation ID of the address.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The AWS account ID.
+ *The ID of the VPC.
*/ - AwsAccountId?: string; + VpcId: string | undefined; +} +export namespace EnableVpcClassicLinkRequest { /** - *The AWS service.
+ * @internal */ - AwsService?: string; + export const filterSensitiveLog = (obj: EnableVpcClassicLinkRequest): any => ({ + ...obj, + }); +} +export interface EnableVpcClassicLinkResult { /** - *The customer-owned IP address.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The ID of the customer-owned address pool.
+ *The ID of the VPC.
*/ - CoipPoolId?: string; + VpcId?: string; +} +export namespace EnableVpcClassicLinkDnsSupportRequest { /** - *Information about the address usage.
+ * @internal */ - CoipAddressUsages?: CoipAddressUsage[]; + export const filterSensitiveLog = (obj: EnableVpcClassicLinkDnsSupportRequest): any => ({ + ...obj, + }); +} +export interface EnableVpcClassicLinkDnsSupportResult { /** - *The ID of the local gateway route table.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The ID of the instance.
+ *The ID of the Client VPN endpoint.
*/ - InstanceId: string | undefined; + ClientVpnEndpointId: string | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
When enabled, retrieves the latest console output for the instance.
- *Default: disabled (false)
The ID of the instance.
- */ - InstanceId?: string; +export type ClientCertificateRevocationListStatusCode = "active" | "pending"; +/** + *Describes the state of a client certificate revocation list.
+ */ +export interface ClientCertificateRevocationListStatus { /** - *The console output, base64-encoded. If you are using a command line tool, the tool - * decodes the output for you.
+ *The state of the client certificate revocation list.
*/ - Output?: string; + Code?: ClientCertificateRevocationListStatusCode | string; /** - *The time at which the output was last updated.
+ *A message about the status of the client certificate revocation list, if applicable.
*/ - Timestamp?: Date; + Message?: string; } -export namespace GetConsoleOutputResult { +export namespace ClientCertificateRevocationListStatus { /** * @internal */ - export const filterSensitiveLog = (obj: GetConsoleOutputResult): any => ({ + export const filterSensitiveLog = (obj: ClientCertificateRevocationListStatus): any => ({ ...obj, }); } -export interface GetConsoleScreenshotRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the instance.
+ *Information about the client certificate revocation list.
*/ - InstanceId: string | undefined; + CertificateRevocationList?: string; /** - *When set to true, acts as keystroke input and wakes up an instance that's
- * in standby or "sleep" mode.
The current state of the client certificate revocation list.
*/ - WakeUp?: boolean; + Status?: ClientCertificateRevocationListStatus; } -export namespace GetConsoleScreenshotRequest { +export namespace ExportClientVpnClientCertificateRevocationListResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetConsoleScreenshotRequest): any => ({ + export const filterSensitiveLog = (obj: ExportClientVpnClientCertificateRevocationListResult): any => ({ ...obj, }); } -export interface GetConsoleScreenshotResult { +export interface ExportClientVpnClientConfigurationRequest { /** - *The data that comprises the image.
+ *The ID of the Client VPN endpoint.
*/ - ImageData?: string; + ClientVpnEndpointId: string | undefined; /** - *The ID of the instance.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The instance family.
+ *The contents of the Client VPN endpoint configuration file.
*/ - InstanceFamily: UnlimitedSupportedInstanceFamily | string | undefined; + ClientConfiguration?: string; } -export namespace GetDefaultCreditSpecificationRequest { +export namespace ExportClientVpnClientConfigurationResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetDefaultCreditSpecificationRequest): any => ({ + export const filterSensitiveLog = (obj: ExportClientVpnClientConfigurationResult): any => ({ ...obj, }); } /** - *Describes the default credit option for CPU usage of a burstable performance instance family.
+ *Describes the destination for an export image task.
*/ -export interface InstanceFamilyCreditSpecification { +export interface ExportTaskS3LocationRequest { /** - *The instance family.
+ *The destination Amazon S3 bucket.
*/ - InstanceFamily?: UnlimitedSupportedInstanceFamily | string; + S3Bucket: string | undefined; /** - *The default credit option for CPU usage of the instance family. Valid values are standard and unlimited.
The prefix (logical hierarchy) in the bucket.
*/ - CpuCredits?: string; + S3Prefix?: string; } -export namespace InstanceFamilyCreditSpecification { +export namespace ExportTaskS3LocationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceFamilyCreditSpecification): any => ({ + export const filterSensitiveLog = (obj: ExportTaskS3LocationRequest): any => ({ ...obj, }); } -export interface GetDefaultCreditSpecificationResult { +export interface ExportImageRequest { /** - *The default credit option for CPU usage of the instance family.
+ *Token to enable idempotency for export image requests.
*/ - InstanceFamilyCreditSpecification?: InstanceFamilyCreditSpecification; -} + ClientToken?: string; -export namespace GetDefaultCreditSpecificationResult { /** - * @internal + *A description of the image being exported. The maximum length is 255 characters.
*/ - export const filterSensitiveLog = (obj: GetDefaultCreditSpecificationResult): any => ({ - ...obj, - }); -} + Description?: string; + + /** + *The disk image format.
+ */ + DiskImageFormat: DiskImageFormat | string | undefined; -export interface GetEbsDefaultKmsKeyIdRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the image.
*/ - export const filterSensitiveLog = (obj: GetEbsDefaultKmsKeyIdRequest): any => ({ - ...obj, - }); -} + ImageId: string | undefined; -export interface GetEbsDefaultKmsKeyIdResult { /** - *The Amazon Resource Name (ARN) of the default CMK for encryption by default.
+ *Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE + * and READ_ACP permissions to the AWS account vm-import-export@amazon.com.
*/ - KmsKeyId?: string; -} + S3ExportLocation: ExportTaskS3LocationRequest | undefined; -export namespace GetEbsDefaultKmsKeyIdResult { /** - * @internal + *The name of the role that grants VM Import/Export permission to export images to your Amazon + * S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
*/ - export const filterSensitiveLog = (obj: GetEbsDefaultKmsKeyIdResult): any => ({ - ...obj, - }); -} + RoleName?: string; -export interface GetEbsEncryptionByDefaultRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The tags to apply to the export image task during creation.
*/ - DryRun?: boolean; + TagSpecifications?: TagSpecification[]; } -export namespace GetEbsEncryptionByDefaultRequest { +export namespace ExportImageRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetEbsEncryptionByDefaultRequest): any => ({ + export const filterSensitiveLog = (obj: ExportImageRequest): any => ({ ...obj, }); } -export interface GetEbsEncryptionByDefaultResult { +export interface ExportImageResult { /** - *Indicates whether encryption by default is enabled.
+ *A description of the image being exported.
*/ - EbsEncryptionByDefault?: boolean; -} + Description?: string; -export namespace GetEbsEncryptionByDefaultResult { /** - * @internal + *The disk image format for the exported image.
*/ - export const filterSensitiveLog = (obj: GetEbsEncryptionByDefaultResult): any => ({ - ...obj, - }); -} + DiskImageFormat?: DiskImageFormat | string; -export enum PartitionLoadFrequency { - DAILY = "daily", - MONTHLY = "monthly", - NONE = "none", - WEEKLY = "weekly", -} + /** + *The ID of the export image task.
+ */ + ExportImageTaskId?: string; -/** - *Describes integration options for Amazon Athena.
- */ -export interface AthenaIntegration { /** - *The location in Amazon S3 to store the generated CloudFormation template.
+ *The ID of the image.
*/ - IntegrationResultS3DestinationArn: string | undefined; + ImageId?: string; /** - *The schedule for adding new partitions to the table.
+ *The name of the role that grants VM Import/Export permission to export images to your Amazon + * S3 bucket.
*/ - PartitionLoadFrequency: PartitionLoadFrequency | string | undefined; + RoleName?: string; /** - *The start date for the partition.
+ *The percent complete of the export image task.
*/ - PartitionStartDate?: Date; + Progress?: string; /** - *The end date for the partition.
+ *Information about the destination Amazon S3 bucket.
*/ - PartitionEndDate?: Date; -} + S3ExportLocation?: ExportTaskS3Location; -export namespace AthenaIntegration { /** - * @internal + *The status of the export image task. The possible values are active, completed,
+ * deleting, and deleted.
Describes service integrations with VPC Flow logs.
- */ -export interface IntegrateServices { /** - *Information about the integration with Amazon Athena.
+ *The status message for the export image task.
*/ - AthenaIntegrations?: AthenaIntegration[]; + StatusMessage?: string; + + /** + *Any tags assigned to the export image task.
+ */ + Tags?: Tag[]; } -export namespace IntegrateServices { +export namespace ExportImageResult { /** * @internal */ - export const filterSensitiveLog = (obj: IntegrateServices): any => ({ + export const filterSensitiveLog = (obj: ExportImageResult): any => ({ ...obj, }); } -export interface GetFlowLogsIntegrationTemplateRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the flow log.
+ *The ID of the route table.
*/ - FlowLogId: string | undefined; + TransitGatewayRouteTableId: string | undefined; /** - *To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.
- */ - ConfigDeliveryS3DestinationArn: string | undefined; + *One or more filters. The possible values are:
+ *
+ * attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
+ * attachment.resource-id - The resource id of the transit gateway attachment.
+ * route-search.exact-match - The exact match of the specified filter.
+ * route-search.longest-prefix-match - The longest prefix that matches the route.
+ * route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
+ * route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
+ * state - The state of the route (active | blackhole).
+ * transit-gateway-route-destination-cidr-block - The CIDR range.
+ * type - The type of route (propagated |
+ * static).
Information about the service integration.
+ *The name of the S3 bucket.
*/ - IntegrateServices: IntegrateServices | undefined; + S3Bucket: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The generated CloudFormation template.
+ *The URL of the exported file in Amazon S3. For example, + * s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.
*/ - Result?: string; + S3Location?: string; } -export namespace GetFlowLogsIntegrationTemplateResult { +export namespace ExportTransitGatewayRoutesResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetFlowLogsIntegrationTemplateResult): any => ({ + export const filterSensitiveLog = (obj: ExportTransitGatewayRoutesResult): any => ({ ...obj, }); } -export interface GetGroupsForCapacityReservationRequest { - /** - *The ID of the Capacity Reservation.
- */ - CapacityReservationId: string | undefined; - - /** - *The token to use to retrieve the next page of results.
- */ - NextToken?: string; - +export interface GetAssociatedEnclaveCertificateIamRolesRequest { /** - *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon + * S3 object information.
*/ - MaxResults?: number; + CertificateArn?: string; /** *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Describes a resource group to which a Capacity Reservation has been added.
+ *Information about the associated IAM roles.
*/ -export interface CapacityReservationGroup { +export interface AssociatedRole { /** - *The ARN of the resource group.
+ *The ARN of the associated IAM role.
*/ - GroupArn?: string; + AssociatedRoleArn?: string; /** - *The ID of the account that owns the resource group.
+ *The name of the Amazon S3 bucket in which the Amazon S3 object is stored.
*/ - OwnerId?: string; + CertificateS3BucketName?: string; + + /** + *The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle
+ * is stored. The object key is formated as follows: role_arn/certificate_arn.
+ *
The ID of the KMS customer master key (CMK) used to encrypt the private key.
+ */ + EncryptionKmsKeyId?: string; } -export namespace CapacityReservationGroup { +export namespace AssociatedRole { /** * @internal */ - export const filterSensitiveLog = (obj: CapacityReservationGroup): any => ({ + export const filterSensitiveLog = (obj: AssociatedRole): any => ({ ...obj, }); } -export interface GetGroupsForCapacityReservationResult { - /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the resource groups to which the Capacity Reservation has been added.
+ *Information about the associated IAM roles.
*/ - CapacityReservationGroups?: CapacityReservationGroup[]; + AssociatedRoles?: AssociatedRole[]; } -export namespace GetGroupsForCapacityReservationResult { +export namespace GetAssociatedEnclaveCertificateIamRolesResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetGroupsForCapacityReservationResult): any => ({ + export const filterSensitiveLog = (obj: GetAssociatedEnclaveCertificateIamRolesResult): any => ({ ...obj, }); } -export interface GetHostReservationPurchasePreviewRequest { +export interface GetAssociatedIpv6PoolCidrsRequest { /** - *The IDs of the Dedicated Hosts with which the reservation is associated.
+ *The ID of the IPv6 address pool.
*/ - HostIdSet: string[] | undefined; + PoolId: string | undefined; /** - *The offering ID of the reservation.
+ *The token for the next page of results.
*/ - OfferingId: string | undefined; + NextToken?: string; + + /** + *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the result of the purchase.
+ *Describes an IPv6 CIDR block association.
*/ -export interface Purchase { - /** - *The currency in which the UpfrontPrice and HourlyPrice
- * amounts are specified. At this time, the only supported currency is
- * USD.
The duration of the reservation's term in seconds.
- */ - Duration?: number; - - /** - *The IDs of the Dedicated Hosts associated with the reservation.
- */ - HostIdSet?: string[]; - +export interface Ipv6CidrAssociation { /** - *The ID of the reservation.
+ *The IPv6 CIDR block.
*/ - HostReservationId?: string; + Ipv6Cidr?: string; /** - *The hourly price of the reservation per hour.
+ *The resource that's associated with the IPv6 CIDR block.
*/ - HourlyPrice?: string; + AssociatedResource?: string; +} +export namespace Ipv6CidrAssociation { /** - *The instance family on the Dedicated Host that the reservation can be associated - * with.
+ * @internal */ - InstanceFamily?: string; + export const filterSensitiveLog = (obj: Ipv6CidrAssociation): any => ({ + ...obj, + }); +} +export interface GetAssociatedIpv6PoolCidrsResult { /** - *The payment option for the reservation.
+ *Information about the IPv6 CIDR block associations.
*/ - PaymentOption?: PaymentOption | string; + Ipv6CidrAssociations?: Ipv6CidrAssociation[]; /** - *The upfront price of the reservation.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The currency in which the totalUpfrontPrice and
- * totalHourlyPrice amounts are specified. At this time, the only
- * supported currency is USD.
The ID of the Capacity Reservation.
*/ - CurrencyCode?: CurrencyCodeValues | string; + CapacityReservationId: string | undefined; /** - *The purchase information of the Dedicated Host reservation and the Dedicated Hosts - * associated with it.
+ *The token to use to retrieve the next page of results.
*/ - Purchase?: Purchase[]; + NextToken?: string; /** - *The potential total hourly price of the reservation per hour.
+ *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Valid range: Minimum value of 1. Maximum value of 1000.
*/ - TotalHourlyPrice?: string; + MaxResults?: number; /** - *The potential total upfront price. This is billed immediately.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the Capacity Reservation usage.
+ */ +export interface InstanceUsage { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The ID of the account that is making use of the Capacity Reservation.
*/ - DryRun?: boolean; + AccountId?: string; /** - *The ID of the instance.
+ *The number of instances the account currently has in the Capacity Reservation.
*/ - InstanceId: string | undefined; + UsedInstanceCount?: number; } -export namespace GetLaunchTemplateDataRequest { +export namespace InstanceUsage { /** * @internal */ - export const filterSensitiveLog = (obj: GetLaunchTemplateDataRequest): any => ({ + export const filterSensitiveLog = (obj: InstanceUsage): any => ({ ...obj, }); } -export interface GetLaunchTemplateDataResult { +export interface GetCapacityReservationUsageResult { /** - *The instance data.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Capacity Reservation.
*/ - export const filterSensitiveLog = (obj: GetLaunchTemplateDataResult): any => ({ - ...obj, - }); -} + CapacityReservationId?: string; -export interface GetManagedPrefixListAssociationsRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The type of instance for which the Capacity Reservation reserves capacity.
*/ - DryRun?: boolean; + InstanceType?: string; /** - *The ID of the prefix list.
+ *The number of instances for which the Capacity Reservation reserves capacity.
*/ - PrefixListId: string | undefined; + TotalInstanceCount?: number; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
*/ - MaxResults?: number; + AvailableInstanceCount?: number; /** - *The token for the next page of results.
+ *The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
+ *
+ * active - The Capacity Reservation is active and the capacity is available for your use.
+ * expired - The Capacity Reservation expired automatically at the date and time specified
+ * in your request. The reserved capacity is no longer available for your use.
+ * cancelled - The Capacity Reservation was cancelled. The reserved capacity is no
+ * longer available for your use.
+ * pending - The Capacity Reservation request was successful but the capacity
+ * provisioning is still pending.
+ * failed - The Capacity Reservation request has failed. A request might fail
+ * due to invalid request parameters, capacity constraints, or instance limit constraints.
+ * Failed requests are retained for 60 minutes.
Information about the Capacity Reservation usage.
+ */ + InstanceUsages?: InstanceUsage[]; } -export namespace GetManagedPrefixListAssociationsRequest { +export namespace GetCapacityReservationUsageResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetManagedPrefixListAssociationsRequest): any => ({ + export const filterSensitiveLog = (obj: GetCapacityReservationUsageResult): any => ({ ...obj, }); } -/** - *Describes the resource with which a prefix list is associated.
- */ -export interface PrefixListAssociation { +export interface GetCoipPoolUsageRequest { /** - *The ID of the resource.
+ *The ID of the address pool.
*/ - ResourceId?: string; + PoolId: string | undefined; /** - *The owner of the resource.
+ *The filters. The following are the possible values:
+ *
+ * coip-address-usage.allocation-id
+ *
+ * coip-address-usage.aws-account-id
+ *
+ * coip-address-usage.aws-service
+ *
+ * coip-address-usage.co-ip
+ *
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Information about the associations.
+ *The token for the next page of results.
*/ - PrefixListAssociations?: PrefixListAssociation[]; + NextToken?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes address usage for a customer-owned address pool.
+ */ +export interface CoipAddressUsage { /** - *The ID of the prefix list.
+ *The allocation ID of the address.
*/ - PrefixListId: string | undefined; + AllocationId?: string; /** - *The version of the prefix list for which to return the entries. The default is the current version.
+ *The AWS account ID.
*/ - TargetVersion?: number; + AwsAccountId?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The AWS service.
*/ - MaxResults?: number; + AwsService?: string; /** - *The token for the next page of results.
+ *The customer-owned IP address.
*/ - NextToken?: string; + CoIp?: string; } -export namespace GetManagedPrefixListEntriesRequest { +export namespace CoipAddressUsage { /** * @internal */ - export const filterSensitiveLog = (obj: GetManagedPrefixListEntriesRequest): any => ({ + export const filterSensitiveLog = (obj: CoipAddressUsage): any => ({ ...obj, }); } -/** - *Describes a prefix list entry.
- */ -export interface PrefixListEntry { - /** - *The CIDR block.
- */ - Cidr?: string; - - /** - *The description.
- */ - Description?: string; -} - -export namespace PrefixListEntry { +export interface GetCoipPoolUsageResult { /** - * @internal + *The ID of the customer-owned address pool.
*/ - export const filterSensitiveLog = (obj: PrefixListEntry): any => ({ - ...obj, - }); -} + CoipPoolId?: string; -export interface GetManagedPrefixListEntriesResult { /** - *Information about the prefix list entries.
+ *Information about the address usage.
*/ - Entries?: PrefixListEntry[]; + CoipAddressUsages?: CoipAddressUsage[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the local gateway route table.
*/ - NextToken?: string; + LocalGatewayRouteTableId?: string; } -export namespace GetManagedPrefixListEntriesResult { +export namespace GetCoipPoolUsageResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetManagedPrefixListEntriesResult): any => ({ + export const filterSensitiveLog = (obj: GetCoipPoolUsageResult): any => ({ ...obj, }); } -export interface GetPasswordDataRequest { +export interface GetConsoleOutputRequest { /** - *The ID of the Windows instance.
+ *The ID of the instance.
*/ InstanceId: string | undefined; @@ -3176,715 +3314,582 @@ export interface GetPasswordDataRequest { * Otherwise, it isUnauthorizedOperation.
*/
DryRun?: boolean;
+
+ /**
+ * When enabled, retrieves the latest console output for the instance.
+ *Default: disabled (false)
The ID of the Windows instance.
+ *The ID of the instance.
*/ InstanceId?: string; /** - *The password of the instance. Returns an empty string if the password is not - * available.
+ *The console output, base64-encoded. If you are using a command line tool, the tool + * decodes the output for you.
*/ - PasswordData?: string; + Output?: string; /** - *The time the data was last updated.
+ *The time at which the output was last updated.
*/ Timestamp?: Date; } -export namespace GetPasswordDataResult { +export namespace GetConsoleOutputResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetPasswordDataResult): any => ({ + export const filterSensitiveLog = (obj: GetConsoleOutputResult): any => ({ ...obj, }); } -/** - *Contains the parameters for GetReservedInstanceExchangeQuote.
- */ -export interface GetReservedInstancesExchangeQuoteRequest { +export interface GetConsoleScreenshotRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
/**
- * The IDs of the Convertible Reserved Instances to exchange.
+ *The ID of the instance.
*/ - ReservedInstanceIds: string[] | undefined; + InstanceId: string | undefined; /** - *The configuration of the target Convertible Reserved Instance to exchange for your - * current Convertible Reserved Instances.
+ *When set to true, acts as keystroke input and wakes up an instance that's
+ * in standby or "sleep" mode.
The cost associated with the Reserved Instance.
- */ -export interface ReservationValue { - /** - *The hourly rate of the reservation.
- */ - HourlyPrice?: string; - +export interface GetConsoleScreenshotResult { /** - *The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
+ *The data that comprises the image.
*/ - RemainingTotalValue?: string; + ImageData?: string; /** - *The remaining upfront cost of the reservation.
+ *The ID of the instance.
*/ - RemainingUpfrontValue?: string; + InstanceId?: string; } -export namespace ReservationValue { +export namespace GetConsoleScreenshotResult { /** * @internal */ - export const filterSensitiveLog = (obj: ReservationValue): any => ({ + export const filterSensitiveLog = (obj: GetConsoleScreenshotResult): any => ({ ...obj, }); } -/** - *The total value of the Convertible Reserved Instance.
- */ -export interface ReservedInstanceReservationValue { +export type UnlimitedSupportedInstanceFamily = "t2" | "t3" | "t3a" | "t4g"; + +export interface GetDefaultCreditSpecificationRequest { /** - *The total value of the Convertible Reserved Instance that you are exchanging.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the Convertible Reserved Instance that you are exchanging.
+ *The instance family.
*/ - ReservedInstanceId?: string; + InstanceFamily: UnlimitedSupportedInstanceFamily | string | undefined; } -export namespace ReservedInstanceReservationValue { +export namespace GetDefaultCreditSpecificationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ReservedInstanceReservationValue): any => ({ + export const filterSensitiveLog = (obj: GetDefaultCreditSpecificationRequest): any => ({ ...obj, }); } /** - *Information about the Convertible Reserved Instance offering.
+ *Describes the default credit option for CPU usage of a burstable performance instance family.
*/ -export interface TargetConfiguration { +export interface InstanceFamilyCreditSpecification { /** - *The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is - * reserved and cannot be specified in a request
+ *The instance family.
*/ - InstanceCount?: number; + InstanceFamily?: UnlimitedSupportedInstanceFamily | string; /** - *The ID of the Convertible Reserved Instance offering.
+ *The default credit option for CPU usage of the instance family. Valid values are standard and unlimited.
The total value of the new Convertible Reserved Instances.
- */ -export interface TargetReservationValue { - /** - *The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of - * the list value, remaining upfront price, and additional upfront cost of the exchange.
- */ - ReservationValue?: ReservationValue; - +export interface GetDefaultCreditSpecificationResult { /** - *The configuration of the Convertible Reserved Instances that make up the exchange.
+ *The default credit option for CPU usage of the instance family.
*/ - TargetConfiguration?: TargetConfiguration; + InstanceFamilyCreditSpecification?: InstanceFamilyCreditSpecification; } -export namespace TargetReservationValue { +export namespace GetDefaultCreditSpecificationResult { /** * @internal */ - export const filterSensitiveLog = (obj: TargetReservationValue): any => ({ + export const filterSensitiveLog = (obj: GetDefaultCreditSpecificationResult): any => ({ ...obj, }); } -/** - *Contains the output of GetReservedInstancesExchangeQuote.
- */ -export interface GetReservedInstancesExchangeQuoteResult { - /** - *The currency of the transaction.
- */ - CurrencyCode?: string; - - /** - *If true, the exchange is valid. If false, the exchange cannot be completed.
The new end date of the reservation term.
- */ - OutputReservedInstancesWillExpireAt?: Date; - - /** - *The total true upfront charge for the exchange.
- */ - PaymentDue?: string; - - /** - *The cost associated with the Reserved Instance.
- */ - ReservedInstanceValueRollup?: ReservationValue; - - /** - *The configuration of your Convertible Reserved Instances.
- */ - ReservedInstanceValueSet?: ReservedInstanceReservationValue[]; - +export interface GetEbsDefaultKmsKeyIdRequest { /** - *The cost associated with the Reserved Instance.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The values of the target Convertible Reserved Instances.
+ * @internal */ - TargetConfigurationValueSet?: TargetReservationValue[]; + export const filterSensitiveLog = (obj: GetEbsDefaultKmsKeyIdRequest): any => ({ + ...obj, + }); +} +export interface GetEbsDefaultKmsKeyIdResult { /** - *Describes the reason why the exchange cannot be completed.
+ *The Amazon Resource Name (ARN) of the default CMK for encryption by default.
*/ - ValidationFailureReason?: string; + KmsKeyId?: string; } -export namespace GetReservedInstancesExchangeQuoteResult { +export namespace GetEbsDefaultKmsKeyIdResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetReservedInstancesExchangeQuoteResult): any => ({ + export const filterSensitiveLog = (obj: GetEbsDefaultKmsKeyIdResult): any => ({ ...obj, }); } -export interface GetSerialConsoleAccessStatusRequest { +export interface GetEbsEncryptionByDefaultRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
If true, access to the EC2 serial console of all instances is enabled for
- * your account. If false, access to the EC2 serial console of all instances
- * is disabled for your account.
Indicates whether encryption by default is enabled.
*/ - SerialConsoleAccessEnabled?: boolean; + EbsEncryptionByDefault?: boolean; } -export namespace GetSerialConsoleAccessStatusResult { +export namespace GetEbsEncryptionByDefaultResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetSerialConsoleAccessStatusResult): any => ({ + export const filterSensitiveLog = (obj: GetEbsEncryptionByDefaultResult): any => ({ ...obj, }); } -export interface GetTransitGatewayAttachmentPropagationsRequest { - /** - *The ID of the attachment.
- */ - TransitGatewayAttachmentId: string | undefined; +export enum PartitionLoadFrequency { + DAILY = "daily", + MONTHLY = "monthly", + NONE = "none", + WEEKLY = "weekly", +} +/** + *Describes integration options for Amazon Athena.
+ */ +export interface AthenaIntegration { /** - *One or more filters. The possible values are:
- *
- * transit-gateway-route-table-id - The ID of the transit gateway route table.
The location in Amazon S3 to store the generated CloudFormation template.
*/ - Filters?: Filter[]; + IntegrationResultS3DestinationArn: string | undefined; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The schedule for adding new partitions to the table.
*/ - MaxResults?: number; + PartitionLoadFrequency: PartitionLoadFrequency | string | undefined; /** - *The token for the next page of results.
+ *The start date for the partition.
*/ - NextToken?: string; + PartitionStartDate?: Date; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The end date for the partition.
*/ - DryRun?: boolean; + PartitionEndDate?: Date; } -export namespace GetTransitGatewayAttachmentPropagationsRequest { +export namespace AthenaIntegration { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayAttachmentPropagationsRequest): any => ({ + export const filterSensitiveLog = (obj: AthenaIntegration): any => ({ ...obj, }); } /** - *Describes a propagation route table.
+ *Describes service integrations with VPC Flow logs.
*/ -export interface TransitGatewayAttachmentPropagation { - /** - *The ID of the propagation route table.
- */ - TransitGatewayRouteTableId?: string; - +export interface IntegrateServices { /** - *The state of the propagation route table.
+ *Information about the integration with Amazon Athena.
*/ - State?: TransitGatewayPropagationState | string; + AthenaIntegrations?: AthenaIntegration[]; } -export namespace TransitGatewayAttachmentPropagation { +export namespace IntegrateServices { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayAttachmentPropagation): any => ({ + export const filterSensitiveLog = (obj: IntegrateServices): any => ({ ...obj, }); } -export interface GetTransitGatewayAttachmentPropagationsResult { +export interface GetFlowLogsIntegrationTemplateRequest { /** - *Information about the propagation route tables.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the flow log.
*/ - NextToken?: string; + FlowLogId: string | undefined; + + /** + *To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.
+ */ + ConfigDeliveryS3DestinationArn: string | undefined; + + /** + *Information about the service integration.
+ */ + IntegrateServices: IntegrateServices | undefined; } -export namespace GetTransitGatewayAttachmentPropagationsResult { +export namespace GetFlowLogsIntegrationTemplateRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayAttachmentPropagationsResult): any => ({ + export const filterSensitiveLog = (obj: GetFlowLogsIntegrationTemplateRequest): any => ({ ...obj, }); } -export interface GetTransitGatewayMulticastDomainAssociationsRequest { +export interface GetFlowLogsIntegrationTemplateResult { /** - *The ID of the transit gateway multicast domain.
+ *The generated CloudFormation template.
*/ - TransitGatewayMulticastDomainId?: string; + Result?: string; +} +export namespace GetFlowLogsIntegrationTemplateResult { /** - *One or more filters. The possible values are:
- *
- * resource-id - The ID of the resource.
- * resource-type - The type of resource. The valid value is: vpc.
- * state - The state of the subnet association. Valid values are
- * associated |
- * associating
- * | disassociated | disassociating.
- * subnet-id - The ID of the subnet.
- * transit-gateway-attachment-id - The id of the transit gateway attachment.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The ID of the Capacity Reservation.
*/ - MaxResults?: number; + CapacityReservationId: string | undefined; /** - *The token for the next page of results.
+ *The token to use to retrieve the next page of results.
*/ NextToken?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Describes the resources associated with the transit gateway multicast domain.
+ *Describes a resource group to which a Capacity Reservation has been added.
*/ -export interface TransitGatewayMulticastDomainAssociation { +export interface CapacityReservationGroup { /** - *The ID of the transit gateway attachment.
+ *The ARN of the resource group.
*/ - TransitGatewayAttachmentId?: string; + GroupArn?: string; /** - *The ID of the resource.
+ *The ID of the account that owns the resource group.
*/ - ResourceId?: string; + OwnerId?: string; +} +export namespace CapacityReservationGroup { /** - *The type of resource, for example a VPC attachment.
+ * @internal */ - ResourceType?: TransitGatewayAttachmentResourceType | string; + export const filterSensitiveLog = (obj: CapacityReservationGroup): any => ({ + ...obj, + }); +} +export interface GetGroupsForCapacityReservationResult { /** - *The ID of the AWS account that owns the transit gateway multicast domain association resource.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The subnet associated with the transit gateway multicast domain.
+ *Information about the resource groups to which the Capacity Reservation has been added.
*/ - Subnet?: SubnetAssociation; + CapacityReservationGroups?: CapacityReservationGroup[]; } -export namespace TransitGatewayMulticastDomainAssociation { +export namespace GetGroupsForCapacityReservationResult { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayMulticastDomainAssociation): any => ({ + export const filterSensitiveLog = (obj: GetGroupsForCapacityReservationResult): any => ({ ...obj, }); } -export interface GetTransitGatewayMulticastDomainAssociationsResult { +export interface GetHostReservationPurchasePreviewRequest { /** - *Information about the multicast domain associations.
+ *The IDs of the Dedicated Hosts with which the reservation is associated.
*/ - MulticastDomainAssociations?: TransitGatewayMulticastDomainAssociation[]; + HostIdSet: string[] | undefined; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The offering ID of the reservation.
*/ - NextToken?: string; + OfferingId: string | undefined; } -export namespace GetTransitGatewayMulticastDomainAssociationsResult { +export namespace GetHostReservationPurchasePreviewRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayMulticastDomainAssociationsResult): any => ({ + export const filterSensitiveLog = (obj: GetHostReservationPurchasePreviewRequest): any => ({ ...obj, }); } -export interface GetTransitGatewayPrefixListReferencesRequest { +/** + *Describes the result of the purchase.
+ */ +export interface Purchase { /** - *The ID of the transit gateway route table.
+ *The currency in which the UpfrontPrice and HourlyPrice
+ * amounts are specified. At this time, the only supported currency is
+ * USD.
One or more filters. The possible values are:
- *
- * attachment.resource-id - The ID of the resource for the attachment.
- * attachment.resource-type - The type of resource for the
- * attachment. Valid values are vpc | vpn |
- * direct-connect-gateway | peering.
- * attachment.transit-gateway-attachment-id - The ID of the attachment.
- * is-blackhole - Whether traffic matching the route is blocked (true | false).
- * prefix-list-id - The ID of the prefix list.
- * prefix-list-owner-id - The ID of the owner of the prefix list.
- * state - The state of the prefix list reference (pending | available | modifying | deleting).
The duration of the reservation's term in seconds.
*/ - Filters?: Filter[]; + Duration?: number; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The IDs of the Dedicated Hosts associated with the reservation.
*/ - MaxResults?: number; + HostIdSet?: string[]; /** - *The token for the next page of results.
+ *The ID of the reservation.
*/ - NextToken?: string; + HostReservationId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The hourly price of the reservation per hour.
*/ - DryRun?: boolean; -} + HourlyPrice?: string; -export namespace GetTransitGatewayPrefixListReferencesRequest { /** - * @internal + *The instance family on the Dedicated Host that the reservation can be associated + * with.
*/ - export const filterSensitiveLog = (obj: GetTransitGatewayPrefixListReferencesRequest): any => ({ - ...obj, - }); -} + InstanceFamily?: string; -export interface GetTransitGatewayPrefixListReferencesResult { /** - *Information about the prefix list references.
+ *The payment option for the reservation.
*/ - TransitGatewayPrefixListReferences?: TransitGatewayPrefixListReference[]; + PaymentOption?: PaymentOption | string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The upfront price of the reservation.
*/ - NextToken?: string; + UpfrontPrice?: string; } -export namespace GetTransitGatewayPrefixListReferencesResult { +export namespace Purchase { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayPrefixListReferencesResult): any => ({ + export const filterSensitiveLog = (obj: Purchase): any => ({ ...obj, }); } -export interface GetTransitGatewayRouteTableAssociationsRequest { - /** - *The ID of the transit gateway route table.
- */ - TransitGatewayRouteTableId: string | undefined; - +export interface GetHostReservationPurchasePreviewResult { /** - *One or more filters. The possible values are:
- *
- * resource-id - The ID of the resource.
- * resource-type - The resource type. Valid values are vpc
- * | vpn | direct-connect-gateway | peering
- * | connect.
- * transit-gateway-attachment-id - The ID of the attachment.
The currency in which the totalUpfrontPrice and
+ * totalHourlyPrice amounts are specified. At this time, the only
+ * supported currency is USD.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The purchase information of the Dedicated Host reservation and the Dedicated Hosts + * associated with it.
*/ - MaxResults?: number; + Purchase?: Purchase[]; /** - *The token for the next page of results.
+ *The potential total hourly price of the reservation per hour.
*/ - NextToken?: string; + TotalHourlyPrice?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The potential total upfront price. This is billed immediately.
*/ - DryRun?: boolean; + TotalUpfrontPrice?: string; } -export namespace GetTransitGatewayRouteTableAssociationsRequest { +export namespace GetHostReservationPurchasePreviewResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayRouteTableAssociationsRequest): any => ({ + export const filterSensitiveLog = (obj: GetHostReservationPurchasePreviewResult): any => ({ ...obj, }); } -/** - *Describes an association between a route table and a resource attachment.
- */ -export interface TransitGatewayRouteTableAssociation { +export interface GetLaunchTemplateDataRequest { /** - *The ID of the attachment.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The ID of the resource.
+ *The ID of the instance.
*/ - ResourceId?: string; - - /** - *The resource type. Note that the tgw-peering resource type has been deprecated.
The state of the association.
- */ - State?: TransitGatewayAssociationState | string; + InstanceId: string | undefined; } -export namespace TransitGatewayRouteTableAssociation { +export namespace GetLaunchTemplateDataRequest { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayRouteTableAssociation): any => ({ + export const filterSensitiveLog = (obj: GetLaunchTemplateDataRequest): any => ({ ...obj, }); } -export interface GetTransitGatewayRouteTableAssociationsResult { - /** - *Information about the associations.
- */ - Associations?: TransitGatewayRouteTableAssociation[]; - +export interface GetLaunchTemplateDataResult { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The instance data.
*/ - NextToken?: string; + LaunchTemplateData?: ResponseLaunchTemplateData; } -export namespace GetTransitGatewayRouteTableAssociationsResult { +export namespace GetLaunchTemplateDataResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayRouteTableAssociationsResult): any => ({ + export const filterSensitiveLog = (obj: GetLaunchTemplateDataResult): any => ({ ...obj, }); } -export interface GetTransitGatewayRouteTablePropagationsRequest { +export interface GetManagedPrefixListAssociationsRequest { /** - *The ID of the transit gateway route table.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters. The possible values are:
- *
- * resource-id - The ID of the resource.
- * resource-type - The resource type. Valid values are vpc
- * | vpn | direct-connect-gateway | peering
- * | connect.
- * transit-gateway-attachment-id - The ID of the attachment.
The ID of the prefix list.
*/ - Filters?: Filter[]; + PrefixListId: string | undefined; /** *The maximum number of results to return with a single call. @@ -3896,63 +3901,46 @@ export interface GetTransitGatewayRouteTablePropagationsRequest { *
The token for the next page of results.
*/ NextToken?: string; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes a route table propagation.
+ *Describes the resource with which a prefix list is associated.
*/ -export interface TransitGatewayRouteTablePropagation { - /** - *The ID of the attachment.
- */ - TransitGatewayAttachmentId?: string; - +export interface PrefixListAssociation { /** *The ID of the resource.
*/ ResourceId?: string; /** - *The type of resource. Note that the tgw-peering resource type has been deprecated.
The state of the resource.
+ *The owner of the resource.
*/ - State?: TransitGatewayPropagationState | string; + ResourceOwner?: string; } -export namespace TransitGatewayRouteTablePropagation { +export namespace PrefixListAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayRouteTablePropagation): any => ({ + export const filterSensitiveLog = (obj: PrefixListAssociation): any => ({ ...obj, }); } -export interface GetTransitGatewayRouteTablePropagationsResult { +export interface GetManagedPrefixListAssociationsResult { /** - *Information about the route table propagations.
+ *Information about the associations.
*/ - TransitGatewayRouteTablePropagations?: TransitGatewayRouteTablePropagation[]; + PrefixListAssociations?: PrefixListAssociation[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Client VPN endpoint to which the client certificate revocation list applies.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the - * AWS Client VPN Administrator Guide.
+ *The ID of the prefix list.
*/ - CertificateRevocationList: string | undefined; + PrefixListId: string | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The version of the prefix list for which to return the entries. The default is the current version.
*/ - DryRun?: boolean; -} + TargetVersion?: number; -export namespace ImportClientVpnClientCertificateRevocationListRequest { /** - * @internal + *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Returns true if the request succeeds; otherwise, it returns an error.
The token for the next page of results.
*/ - Return?: boolean; + NextToken?: string; } -export namespace ImportClientVpnClientCertificateRevocationListResult { +export namespace GetManagedPrefixListEntriesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ImportClientVpnClientCertificateRevocationListResult): any => ({ + export const filterSensitiveLog = (obj: GetManagedPrefixListEntriesRequest): any => ({ ...obj, }); } /** - *Describes the client-specific data.
+ *Describes a prefix list entry.
*/ -export interface ClientData { - /** - *A user-defined comment about the disk upload.
- */ - Comment?: string; - - /** - *The time that the disk upload ends.
- */ - UploadEnd?: Date; - +export interface PrefixListEntry { /** - *The size of the uploaded disk image, in GiB.
+ *The CIDR block.
*/ - UploadSize?: number; + Cidr?: string; /** - *The time that the disk upload starts.
+ *The description.
*/ - UploadStart?: Date; + Description?: string; } -export namespace ClientData { +export namespace PrefixListEntry { /** * @internal */ - export const filterSensitiveLog = (obj: ClientData): any => ({ + export const filterSensitiveLog = (obj: PrefixListEntry): any => ({ ...obj, }); } -/** - *Describes the Amazon S3 bucket for the disk image.
- */ -export interface UserBucket { +export interface GetManagedPrefixListEntriesResult { /** - *The name of the Amazon S3 bucket where the disk image is located.
+ *Information about the prefix list entries.
*/ - S3Bucket?: string; + Entries?: PrefixListEntry[]; /** - *The file name of the disk image.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the disk container object for an import image task.
- */ -export interface ImageDiskContainer { +export interface GetPasswordDataRequest { /** - *The description of the disk image.
+ *The ID of the Windows instance.
*/ - Description?: string; + InstanceId: string | undefined; /** - *The block device mapping for the disk.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The format of the disk image being imported.
- *Valid values: OVA | VHD | VHDX | VMDK | RAW
- *
The ID of the EBS snapshot to be used for importing the snapshot.
+ *The ID of the Windows instance.
*/ - SnapshotId?: string; + InstanceId?: string; /** - *The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an - * Amazon S3 URL (s3://..)
+ *The password of the instance. Returns an empty string if the password is not + * available.
*/ - Url?: string; + PasswordData?: string; /** - *The S3 bucket for the disk image.
+ *The time the data was last updated.
*/ - UserBucket?: UserBucket; + Timestamp?: Date; } -export namespace ImageDiskContainer { +export namespace GetPasswordDataResult { /** * @internal */ - export const filterSensitiveLog = (obj: ImageDiskContainer): any => ({ + export const filterSensitiveLog = (obj: GetPasswordDataResult): any => ({ ...obj, }); } /** - *The request information of license configurations.
+ *Contains the parameters for GetReservedInstanceExchangeQuote.
*/ -export interface ImportImageLicenseConfigurationRequest { +export interface GetReservedInstancesExchangeQuoteRequest { /** - *The ARN of a license configuration.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The IDs of the Convertible Reserved Instances to exchange.
+ */ + ReservedInstanceIds: string[] | undefined; + + /** + *The configuration of the target Convertible Reserved Instance to exchange for your + * current Convertible Reserved Instances.
+ */ + TargetConfigurations?: TargetConfigurationRequest[]; } -export namespace ImportImageLicenseConfigurationRequest { +export namespace GetReservedInstancesExchangeQuoteRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ImportImageLicenseConfigurationRequest): any => ({ + export const filterSensitiveLog = (obj: GetReservedInstancesExchangeQuoteRequest): any => ({ ...obj, }); } -export interface ImportImageRequest { +/** + *The cost associated with the Reserved Instance.
+ */ +export interface ReservationValue { /** - *The architecture of the virtual machine.
- *Valid values: i386 | x86_64 | arm64
- *
The client-specific data.
- */ - ClientData?: ClientData; - - /** - *The token to enable idempotency for VM import requests.
+ *The hourly rate of the reservation.
*/ - ClientToken?: string; + HourlyPrice?: string; /** - *A description string for the import image task.
+ *The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
*/ - Description?: string; + RemainingTotalValue?: string; /** - *Information about the disk containers.
+ *The remaining upfront cost of the reservation.
*/ - DiskContainers?: ImageDiskContainer[]; + RemainingUpfrontValue?: string; +} +export namespace ReservationValue { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The total value of the Convertible Reserved Instance.
+ */ +export interface ReservedInstanceReservationValue { /** - *Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used
- * unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the
- * Amazon Elastic Compute Cloud User Guide.
The total value of the Convertible Reserved Instance that you are exchanging.
*/ - Encrypted?: boolean; + ReservationValue?: ReservationValue; /** - *The target hypervisor platform.
- *Valid values: xen
- *
The ID of the Convertible Reserved Instance that you are exchanging.
*/ - Hypervisor?: string; + ReservedInstanceId?: string; +} +export namespace ReservedInstanceReservationValue { /** - *An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the
- * encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this
- * parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is
- * specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
- *Key ID
- *Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even
- * though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the AMI is being copied to.
- *Amazon EBS does not support asymmetric CMKs.
+ * @internal */ - KmsKeyId?: string; + export const filterSensitiveLog = (obj: ReservedInstanceReservationValue): any => ({ + ...obj, + }); +} +/** + *Information about the Convertible Reserved Instance offering.
+ */ +export interface TargetConfiguration { /** - *The license type to be used for the Amazon Machine Image (AMI) after importing.
- *By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify
- * AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL
- * to retain the source-system license, if appropriate.
To use BYOL, you must have existing licenses with rights to use these licenses in a third party
- * cloud, such as AWS. For more information, see Prerequisites in the
- * VM Import/Export User Guide.
The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is + * reserved and cannot be specified in a request
*/ - LicenseType?: string; + InstanceCount?: number; /** - *The operating system of the virtual machine.
- *Valid values: Windows | Linux
- *
The ID of the Convertible Reserved Instance offering.
*/ - Platform?: string; + OfferingId?: string; +} +export namespace TargetConfiguration { /** - *The name of the role to use when not using the default role, 'vmimport'.
+ * @internal */ - RoleName?: string; + export const filterSensitiveLog = (obj: TargetConfiguration): any => ({ + ...obj, + }); +} +/** + *The total value of the new Convertible Reserved Instances.
+ */ +export interface TargetReservationValue { /** - *The ARNs of the license configurations.
+ *The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of + * the list value, remaining upfront price, and additional upfront cost of the exchange.
*/ - LicenseSpecifications?: ImportImageLicenseConfigurationRequest[]; + ReservationValue?: ReservationValue; /** - *The tags to apply to the import image task during creation.
+ *The configuration of the Convertible Reserved Instances that make up the exchange.
*/ - TagSpecifications?: TagSpecification[]; + TargetConfiguration?: TargetConfiguration; } -export namespace ImportImageRequest { +export namespace TargetReservationValue { /** * @internal */ - export const filterSensitiveLog = (obj: ImportImageRequest): any => ({ + export const filterSensitiveLog = (obj: TargetReservationValue): any => ({ ...obj, }); } -export interface ImportImageResult { +/** + *Contains the output of GetReservedInstancesExchangeQuote.
+ */ +export interface GetReservedInstancesExchangeQuoteResult { /** - *The architecture of the virtual machine.
+ *The currency of the transaction.
*/ - Architecture?: string; + CurrencyCode?: string; /** - *A description of the import task.
+ *If true, the exchange is valid. If false, the exchange cannot be completed.
Indicates whether the AMI is encrypted.
+ *The new end date of the reservation term.
*/ - Encrypted?: boolean; + OutputReservedInstancesWillExpireAt?: Date; /** - *The target hypervisor of the import task.
+ *The total true upfront charge for the exchange.
*/ - Hypervisor?: string; + PaymentDue?: string; /** - *The ID of the Amazon Machine Image (AMI) created by the import task.
+ *The cost associated with the Reserved Instance.
*/ - ImageId?: string; + ReservedInstanceValueRollup?: ReservationValue; /** - *The task ID of the import image task.
+ *The configuration of your Convertible Reserved Instances.
*/ - ImportTaskId?: string; + ReservedInstanceValueSet?: ReservedInstanceReservationValue[]; /** - *The identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key - * (CMK) that was used to create the encrypted AMI.
+ *The cost associated with the Reserved Instance.
*/ - KmsKeyId?: string; + TargetConfigurationValueRollup?: ReservationValue; /** - *The license type of the virtual machine.
+ *The values of the target Convertible Reserved Instances.
*/ - LicenseType?: string; + TargetConfigurationValueSet?: TargetReservationValue[]; /** - *The operating system of the virtual machine.
+ *Describes the reason why the exchange cannot be completed.
*/ - Platform?: string; + ValidationFailureReason?: string; +} +export namespace GetReservedInstancesExchangeQuoteResult { /** - *The progress of the task.
+ * @internal */ - Progress?: string; + export const filterSensitiveLog = (obj: GetReservedInstancesExchangeQuoteResult): any => ({ + ...obj, + }); +} +export interface GetSerialConsoleAccessStatusRequest { /** - *Information about the snapshots.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
A brief status of the task.
+ * @internal */ - Status?: string; + export const filterSensitiveLog = (obj: GetSerialConsoleAccessStatusRequest): any => ({ + ...obj, + }); +} +export interface GetSerialConsoleAccessStatusResult { /** - *A detailed status message of the import task.
+ *If true, access to the EC2 serial console of all instances is enabled for
+ * your account. If false, access to the EC2 serial console of all instances
+ * is disabled for your account.
The ARNs of the license configurations.
+ * @internal */ - LicenseSpecifications?: ImportImageLicenseConfigurationResponse[]; + export const filterSensitiveLog = (obj: GetSerialConsoleAccessStatusResult): any => ({ + ...obj, + }); +} +export interface GetTransitGatewayAttachmentPropagationsRequest { /** - *Any tags assigned to the import image task.
+ *The ID of the attachment.
*/ - Tags?: Tag[]; -} + TransitGatewayAttachmentId: string | undefined; -export namespace ImportImageResult { /** - * @internal + *One or more filters. The possible values are:
+ *
+ * transit-gateway-route-table-id - The ID of the transit gateway route table.
Describes a disk image.
- */ -export interface DiskImageDetail { /** - *The size of the disk image, in GiB.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The disk image format.
+ *The token for the next page of results.
*/ - Format: DiskImageFormat | string | undefined; + NextToken?: string; /** - *A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. - * For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication - * Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer - * Guide.
- *For information about the import manifest referenced by this API action, see VM Import Manifest.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes an EBS volume.
+ *Describes a propagation route table.
*/ -export interface VolumeDetail { +export interface TransitGatewayAttachmentPropagation { /** - *The size of the volume, in GiB.
+ *The ID of the propagation route table.
*/ - Size: number | undefined; + TransitGatewayRouteTableId?: string; + + /** + *The state of the propagation route table.
+ */ + State?: TransitGatewayPropagationState | string; } -export namespace VolumeDetail { +export namespace TransitGatewayAttachmentPropagation { /** * @internal */ - export const filterSensitiveLog = (obj: VolumeDetail): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayAttachmentPropagation): any => ({ ...obj, }); } -/** - *Describes a disk image.
- */ -export interface DiskImage { - /** - *A description of the disk image.
- */ - Description?: string; - +export interface GetTransitGatewayAttachmentPropagationsResult { /** - *Information about the disk image.
+ *Information about the propagation route tables.
*/ - Image?: DiskImageDetail; + TransitGatewayAttachmentPropagations?: TransitGatewayAttachmentPropagation[]; /** - *Information about the volume.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the user data for an instance.
- */ -export interface UserData { +export interface GetTransitGatewayMulticastDomainAssociationsRequest { /** - *The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you - * can load the text from a file. Otherwise, you must provide Base64-encoded text.
+ *The ID of the transit gateway multicast domain.
*/ - Data?: string; -} + TransitGatewayMulticastDomainId?: string; -export namespace UserData { /** - * @internal + *One or more filters. The possible values are:
+ *
+ * resource-id - The ID of the resource.
+ * resource-type - The type of resource. The valid value is: vpc.
+ * state - The state of the subnet association. Valid values are
+ * associated |
+ * associating
+ * | disassociated | disassociating.
+ * subnet-id - The ID of the subnet.
+ * transit-gateway-attachment-id - The id of the transit gateway attachment.
Describes the launch specification for VM import.
- */ -export interface ImportInstanceLaunchSpecification { /** - *Reserved.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The architecture of the instance.
+ *The token for the next page of results.
*/ - Architecture?: ArchitectureValues | string; + NextToken?: string; /** - *The security group IDs.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The security group names.
+ * @internal */ - GroupNames?: string[]; + export const filterSensitiveLog = (obj: GetTransitGatewayMulticastDomainAssociationsRequest): any => ({ + ...obj, + }); +} +/** + *Describes the resources associated with the transit gateway multicast domain.
+ */ +export interface TransitGatewayMulticastDomainAssociation { /** - *Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the - * operating system command for system shutdown).
+ *The ID of the transit gateway attachment.
*/ - InstanceInitiatedShutdownBehavior?: ShutdownBehavior | string; + TransitGatewayAttachmentId?: string; /** - *The instance type. For more information about the instance types that you can import, see Instance Types in the - * VM Import/Export User Guide.
+ *The ID of the resource.
*/ - InstanceType?: _InstanceType | string; + ResourceId?: string; /** - *Indicates whether monitoring is enabled.
+ *The type of resource, for example a VPC attachment.
*/ - Monitoring?: boolean; + ResourceType?: TransitGatewayAttachmentResourceType | string; /** - *The placement information for the instance.
+ *The ID of the AWS account that owns the transit gateway multicast domain association resource.
*/ - Placement?: Placement; + ResourceOwnerId?: string; /** - *[EC2-VPC] An available IP address from the IP address range of the subnet.
+ *The subnet associated with the transit gateway multicast domain.
*/ - PrivateIpAddress?: string; + Subnet?: SubnetAssociation; +} +export namespace TransitGatewayMulticastDomainAssociation { /** - *[EC2-VPC] The ID of the subnet in which to launch the instance.
+ * @internal */ - SubnetId?: string; + export const filterSensitiveLog = (obj: TransitGatewayMulticastDomainAssociation): any => ({ + ...obj, + }); +} +export interface GetTransitGatewayMulticastDomainAssociationsResult { /** - *The Base64-encoded user data to make available to the instance.
+ *Information about the multicast domain associations.
*/ - UserData?: UserData; + MulticastDomainAssociations?: TransitGatewayMulticastDomainAssociation[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
A description for the instance being imported.
+ *The ID of the transit gateway route table.
*/ - Description?: string; + TransitGatewayRouteTableId: string | undefined; /** - *The disk image.
+ *One or more filters. The possible values are:
+ *
+ * attachment.resource-id - The ID of the resource for the attachment.
+ * attachment.resource-type - The type of resource for the
+ * attachment. Valid values are vpc | vpn |
+ * direct-connect-gateway | peering.
+ * attachment.transit-gateway-attachment-id - The ID of the attachment.
+ * is-blackhole - Whether traffic matching the route is blocked (true | false).
+ * prefix-list-id - The ID of the prefix list.
+ * prefix-list-owner-id - The ID of the owner of the prefix list.
+ * state - The state of the prefix list reference (pending | available | modifying | deleting).
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The launch specification.
+ *The token for the next page of results.
*/ - LaunchSpecification?: ImportInstanceLaunchSpecification; + NextToken?: string; /** - *The instance operating system.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the conversion task.
+ *Information about the prefix list references.
*/ - ConversionTask?: ConversionTask; + TransitGatewayPrefixListReferences?: TransitGatewayPrefixListReference[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
A unique name for the key pair.
+ *The ID of the transit gateway route table.
*/ - KeyName: string | undefined; + TransitGatewayRouteTableId: string | undefined; /** - *The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
- */ - PublicKeyMaterial: Uint8Array | undefined; - - /** - *The tags to apply to the imported key pair.
- */ - TagSpecifications?: TagSpecification[]; -} - -export namespace ImportKeyPairRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ImportKeyPairRequest): any => ({ - ...obj, - }); -} - -export interface ImportKeyPairResult { - /** - *The MD5 public key fingerprint as specified in section 4 of RFC 4716.
+ *One or more filters. The possible values are:
+ *
+ * resource-id - The ID of the resource.
+ * resource-type - The resource type. Valid values are vpc
+ * | vpn | direct-connect-gateway | peering
+ * | connect.
+ * transit-gateway-attachment-id - The ID of the attachment.
The key pair name that you provided.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The ID of the resulting key pair.
+ *The token for the next page of results.
*/ - KeyPairId?: string; + NextToken?: string; /** - *The tags applied to the imported key pair.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The disk container object for the import snapshot request.
+ *Describes an association between a route table and a resource attachment.
*/ -export interface SnapshotDiskContainer { +export interface TransitGatewayRouteTableAssociation { /** - *The description of the disk image being imported.
+ *The ID of the attachment.
*/ - Description?: string; + TransitGatewayAttachmentId?: string; /** - *The format of the disk image being imported.
- *Valid values: VHD | VMDK | RAW
- *
The ID of the resource.
*/ - Format?: string; + ResourceId?: string; /** - *The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon - * S3 URL (s3://..).
+ *The resource type. Note that the tgw-peering resource type has been deprecated.
The Amazon S3 bucket for the disk image.
+ *The state of the association.
*/ - UserBucket?: UserBucket; + State?: TransitGatewayAssociationState | string; } -export namespace SnapshotDiskContainer { +export namespace TransitGatewayRouteTableAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: SnapshotDiskContainer): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayRouteTableAssociation): any => ({ ...obj, }); } -export interface ImportSnapshotRequest { - /** - *The client-specific data.
- */ - ClientData?: ClientData; - - /** - *Token to enable idempotency for VM import requests.
- */ - ClientToken?: string; - +export interface GetTransitGatewayRouteTableAssociationsResult { /** - *The description string for the import snapshot task.
+ *Information about the associations.
*/ - Description?: string; + Associations?: TransitGatewayRouteTableAssociation[]; /** - *Information about the disk container.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is
- * used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the
- * Amazon Elastic Compute Cloud User Guide.
The ID of the transit gateway route table.
*/ - Encrypted?: boolean; + TransitGatewayRouteTableId: string | undefined; /** - *An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the
- * encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this
- * parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is
- * specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
+ *One or more filters. The possible values are:
*Key ID
- *Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
+ * resource-id - The ID of the resource.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
+ * resource-type - The resource type. Valid values are vpc
+ * | vpn | direct-connect-gateway | peering
+ * | connect.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
+ * transit-gateway-attachment-id - The ID of the attachment.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even
- * though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the snapshot is being copied to.
- *Amazon EBS does not support asymmetric CMKs.
*/ - KmsKeyId?: string; + Filters?: Filter[]; /** - *The name of the role to use when not using the default role, 'vmimport'.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The tags to apply to the import snapshot task during creation.
+ *The token for the next page of results.
*/ - TagSpecifications?: TagSpecification[]; + NextToken?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a route table propagation.
+ */ +export interface TransitGatewayRouteTablePropagation { /** - *A description of the import snapshot task.
+ *The ID of the attachment.
*/ - Description?: string; + TransitGatewayAttachmentId?: string; /** - *The ID of the import snapshot task.
+ *The ID of the resource.
*/ - ImportTaskId?: string; + ResourceId?: string; /** - *Information about the import snapshot task.
+ *The type of resource. Note that the tgw-peering resource type has been deprecated.
Any tags assigned to the import snapshot task.
+ *The state of the resource.
*/ - Tags?: Tag[]; + State?: TransitGatewayPropagationState | string; } -export namespace ImportSnapshotResult { +export namespace TransitGatewayRouteTablePropagation { /** * @internal */ - export const filterSensitiveLog = (obj: ImportSnapshotResult): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayRouteTablePropagation): any => ({ ...obj, }); } -export interface ImportVolumeRequest { +export interface GetTransitGatewayRouteTablePropagationsResult { /** - *The Availability Zone for the resulting EBS volume.
+ *Information about the route table propagations.
*/ - AvailabilityZone: string | undefined; + TransitGatewayRouteTablePropagations?: TransitGatewayRouteTablePropagation[]; /** - *A description of the volume.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The disk image.
+ *The ID of the Client VPN endpoint to which the client certificate revocation list applies.
*/ - Image: DiskImageDetail | undefined; + ClientVpnEndpointId: string | undefined; /** - *The volume size.
+ *The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the + * AWS Client VPN Administrator Guide.
*/ - Volume: VolumeDetail | undefined; + CertificateRevocationList: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the conversion task.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Describes the client-specific data.
+ */ +export interface ClientData { /** - *[EC2-VPC] The allocation ID.
+ *A user-defined comment about the disk upload.
*/ - AllocationId: string | undefined; + Comment?: string; /** - *The domain name to modify for the IP address.
- */ - DomainName?: string; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The time that the disk upload ends.
*/ - DryRun?: boolean; -} + UploadEnd?: Date; -export namespace ModifyAddressAttributeRequest { /** - * @internal + *The size of the uploaded disk image, in GiB.
*/ - export const filterSensitiveLog = (obj: ModifyAddressAttributeRequest): any => ({ - ...obj, - }); -} + UploadSize?: number; -export interface ModifyAddressAttributeResult { /** - *Information about the Elastic IP address.
+ *The time that the disk upload starts.
*/ - Address?: AddressAttribute; + UploadStart?: Date; } -export namespace ModifyAddressAttributeResult { +export namespace ClientData { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyAddressAttributeResult): any => ({ + export const filterSensitiveLog = (obj: ClientData): any => ({ ...obj, }); } -export type ModifyAvailabilityZoneOptInStatus = "not-opted-in" | "opted-in"; - -export interface ModifyAvailabilityZoneGroupRequest { - /** - *The name of the Availability Zone group, Local Zone group, or Wavelength Zone - * group.
- */ - GroupName: string | undefined; - +/** + *Describes the Amazon S3 bucket for the disk image.
+ */ +export interface UserBucket { /** - *Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The
- * only valid value is opted-in. You must contact AWS Support to opt out of a Local Zone group, or Wavelength Zone group.
The name of the Amazon S3 bucket where the disk image is located.
*/ - OptInStatus: ModifyAvailabilityZoneOptInStatus | string | undefined; + S3Bucket?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The file name of the disk image.
*/ - DryRun?: boolean; + S3Key?: string; } -export namespace ModifyAvailabilityZoneGroupRequest { +export namespace UserBucket { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyAvailabilityZoneGroupRequest): any => ({ + export const filterSensitiveLog = (obj: UserBucket): any => ({ ...obj, }); } -export interface ModifyAvailabilityZoneGroupResult { +/** + *Describes the disk container object for an import image task.
+ */ +export interface ImageDiskContainer { /** - *Is true if the request succeeds, and an error otherwise.
The description of the disk image.
*/ - Return?: boolean; -} + Description?: string; -export namespace ModifyAvailabilityZoneGroupResult { /** - * @internal + *The block device mapping for the disk.
*/ - export const filterSensitiveLog = (obj: ModifyAvailabilityZoneGroupResult): any => ({ - ...obj, - }); -} + DeviceName?: string; -export interface ModifyCapacityReservationRequest { /** - *The ID of the Capacity Reservation.
+ *The format of the disk image being imported.
+ *Valid values: OVA | VHD | VHDX | VMDK | RAW
+ *
The number of instances for which to reserve capacity.
+ *The ID of the EBS snapshot to be used for importing the snapshot.
*/ - InstanceCount?: number; + SnapshotId?: string; /** - *The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity
- * is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
- * expired when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify - * 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
- *You must provide an EndDate value if EndDateType is
- * limited. Omit EndDate if EndDateType is
- * unlimited.
The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an + * Amazon S3 URL (s3://..)
*/ - EndDate?: Date; + Url?: string; /** - *Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end - * types:
- *
- * unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not
- * provide an EndDate value if EndDateType is
- * unlimited.
- * limited - The Capacity Reservation expires automatically at a specified date and time. You must
- * provide an EndDate value if EndDateType is
- * limited.
The S3 bucket for the disk image.
*/ - EndDateType?: EndDateType | string; + UserBucket?: UserBucket; +} +export namespace ImageDiskContainer { /** - *Reserved. Capacity Reservations you have created are accepted by default.
+ * @internal */ - Accept?: boolean; + export const filterSensitiveLog = (obj: ImageDiskContainer): any => ({ + ...obj, + }); +} +/** + *The request information of license configurations.
+ */ +export interface ImportImageLicenseConfigurationRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ARN of a license configuration.
*/ - DryRun?: boolean; + LicenseConfigurationArn?: string; } -export namespace ModifyCapacityReservationRequest { +export namespace ImportImageLicenseConfigurationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyCapacityReservationRequest): any => ({ + export const filterSensitiveLog = (obj: ImportImageLicenseConfigurationRequest): any => ({ ...obj, }); } -export interface ModifyCapacityReservationResult { +export interface ImportImageRequest { /** - *Returns true if the request succeeds; otherwise, it returns an error.
The architecture of the virtual machine.
+ *Valid values: i386 | x86_64 | arm64
+ *
The client-specific data.
*/ - export const filterSensitiveLog = (obj: ModifyCapacityReservationResult): any => ({ - ...obj, - }); -} + ClientData?: ClientData; -/** - *Information about the DNS server to be used.
- */ -export interface DnsServersOptionsModifyStructure { /** - *The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to - * two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values - * overwrite the existing values.
+ *The token to enable idempotency for VM import requests.
*/ - CustomDnsServers?: string[]; + ClientToken?: string; /** - *Indicates whether DNS servers should be used. Specify False to delete the existing DNS
- * servers.
A description string for the import image task.
*/ - Enabled?: boolean; -} + Description?: string; -export namespace DnsServersOptionsModifyStructure { /** - * @internal + *Information about the disk containers.
*/ - export const filterSensitiveLog = (obj: DnsServersOptionsModifyStructure): any => ({ - ...obj, - }); -} + DiskContainers?: ImageDiskContainer[]; -export interface ModifyClientVpnEndpointRequest { /** - *The ID of the Client VPN endpoint to modify.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM).
+ *Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used
+ * unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the
+ * Amazon Elastic Compute Cloud User Guide.
Information about the client connection logging options.
- *If you enable client connection logging, data about client connections is sent to a - * Cloudwatch Logs log stream. The following information is logged:
- *The target hypervisor platform.
+ *Valid values: xen
+ *
An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the
+ * encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this
+ * parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is
+ * specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
+ *Client connection requests
+ *Key ID
*Client connection results (successful and unsuccessful)
+ *Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Reasons for unsuccessful client connection requests
+ *ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
Client connection termination time
+ *ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even
+ * though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the AMI is being copied to.
+ *Amazon EBS does not support asymmetric CMKs.
*/ - ConnectionLogOptions?: ConnectionLogOptions; + KmsKeyId?: string; /** - *Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have - * up to two DNS servers.
+ *The license type to be used for the Amazon Machine Image (AMI) after importing.
+ *By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify
+ * AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL
+ * to retain the source-system license, if appropriate.
To use BYOL, you must have existing licenses with rights to use these licenses in a third party
+ * cloud, such as AWS. For more information, see Prerequisites in the
+ * VM Import/Export User Guide.
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
- *Valid Values: 443 | 1194
- *
Default Value: 443
+ *
The operating system of the virtual machine.
+ *Valid values: Windows | Linux
*
A brief description of the Client VPN endpoint.
+ *The name of the role to use when not using the default role, 'vmimport'.
*/ - Description?: string; + RoleName?: string; /** - *Indicates whether the VPN is split-tunnel.
- *For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS - * Client VPN Administrator Guide.
+ *The ARNs of the license configurations.
*/ - SplitTunnel?: boolean; + LicenseSpecifications?: ImportImageLicenseConfigurationRequest[]; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The tags to apply to the import image task during creation.
*/ - DryRun?: boolean; - - /** - *The IDs of one or more security groups to apply to the target network.
- */ - SecurityGroupIds?: string[]; + TagSpecifications?: TagSpecification[]; +} +export namespace ImportImageRequest { /** - *The ID of the VPC to associate with the Client VPN endpoint.
+ * @internal */ - VpcId?: string; + export const filterSensitiveLog = (obj: ImportImageRequest): any => ({ + ...obj, + }); +} +export interface ImportImageResult { /** - *Specify whether to enable the self-service portal for the Client VPN endpoint.
+ *The architecture of the virtual machine.
*/ - SelfServicePortal?: SelfServicePortal | string; + Architecture?: string; /** - *The options for managing connection authorization for new client connections.
+ *A description of the import task.
*/ - ClientConnectOptions?: ClientConnectOptions; -} + Description?: string; -export namespace ModifyClientVpnEndpointRequest { /** - * @internal + *Indicates whether the AMI is encrypted.
*/ - export const filterSensitiveLog = (obj: ModifyClientVpnEndpointRequest): any => ({ - ...obj, - }); -} + Encrypted?: boolean; -export interface ModifyClientVpnEndpointResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
The target hypervisor of the import task.
*/ - Return?: boolean; -} + Hypervisor?: string; -export namespace ModifyClientVpnEndpointResult { /** - * @internal + *The ID of the Amazon Machine Image (AMI) created by the import task.
*/ - export const filterSensitiveLog = (obj: ModifyClientVpnEndpointResult): any => ({ - ...obj, - }); -} + ImageId?: string; -export interface ModifyDefaultCreditSpecificationRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The task ID of the import image task.
*/ - DryRun?: boolean; + ImportTaskId?: string; /** - *The instance family.
+ *The identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key + * (CMK) that was used to create the encrypted AMI.
*/ - InstanceFamily: UnlimitedSupportedInstanceFamily | string | undefined; + KmsKeyId?: string; /** - *The credit option for CPU usage of the instance family.
- *Valid Values: standard | unlimited
- *
The license type of the virtual machine.
*/ - CpuCredits: string | undefined; -} + LicenseType?: string; -export namespace ModifyDefaultCreditSpecificationRequest { /** - * @internal + *The operating system of the virtual machine.
*/ - export const filterSensitiveLog = (obj: ModifyDefaultCreditSpecificationRequest): any => ({ - ...obj, - }); -} + Platform?: string; -export interface ModifyDefaultCreditSpecificationResult { /** - *The default credit option for CPU usage of the instance family.
+ *The progress of the task.
*/ - InstanceFamilyCreditSpecification?: InstanceFamilyCreditSpecification; -} + Progress?: string; -export namespace ModifyDefaultCreditSpecificationResult { /** - * @internal + *Information about the snapshots.
*/ - export const filterSensitiveLog = (obj: ModifyDefaultCreditSpecificationResult): any => ({ - ...obj, - }); -} + SnapshotDetails?: SnapshotDetail[]; -export interface ModifyEbsDefaultKmsKeyIdRequest { /** - *The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption.
- * If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is
- * specified, the encrypted state must be true.
You can specify the CMK using any of the following:
- *Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
- *Key alias. For example, alias/ExampleAlias.
- *Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
- *Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
- *AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, - * the action can appear to complete, but eventually fails.
- *Amazon EBS does not support asymmetric CMKs.
+ *A brief status of the task.
*/ - KmsKeyId: string | undefined; + Status?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
A detailed status message of the import task.
*/ - DryRun?: boolean; -} + StatusMessage?: string; -export namespace ModifyEbsDefaultKmsKeyIdRequest { /** - * @internal + *The ARNs of the license configurations.
*/ - export const filterSensitiveLog = (obj: ModifyEbsDefaultKmsKeyIdRequest): any => ({ - ...obj, - }); -} + LicenseSpecifications?: ImportImageLicenseConfigurationResponse[]; -export interface ModifyEbsDefaultKmsKeyIdResult { /** - *The Amazon Resource Name (ARN) of the default CMK for encryption by default.
+ *Any tags assigned to the import image task.
*/ - KmsKeyId?: string; + Tags?: Tag[]; } -export namespace ModifyEbsDefaultKmsKeyIdResult { +export namespace ImportImageResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyEbsDefaultKmsKeyIdResult): any => ({ + export const filterSensitiveLog = (obj: ImportImageResult): any => ({ ...obj, }); } -export interface ModifyFleetRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Indicates whether running instances should be terminated if the total target capacity of - * the EC2 Fleet is decreased below the current size of the EC2 Fleet.
- */ - ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy | string; - - /** - *The launch template and overrides.
- */ - LaunchTemplateConfigs?: FleetLaunchTemplateConfigRequest[]; - +/** + *Describes a disk image.
+ */ +export interface DiskImageDetail { /** - *The ID of the EC2 Fleet.
+ *The size of the disk image, in GiB.
*/ - FleetId: string | undefined; + Bytes: number | undefined; /** - *The size of the EC2 Fleet.
+ *The disk image format.
*/ - TargetCapacitySpecification?: TargetCapacitySpecificationRequest; + Format: DiskImageFormat | string | undefined; /** - *Reserved.
+ *A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. + * For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication + * Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer + * Guide.
+ *For information about the import manifest referenced by this API action, see VM Import Manifest.
*/ - Context?: string; + ImportManifestUrl: string | undefined; } -export namespace ModifyFleetRequest { +export namespace DiskImageDetail { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyFleetRequest): any => ({ + export const filterSensitiveLog = (obj: DiskImageDetail): any => ({ ...obj, }); } -export interface ModifyFleetResult { +/** + *Describes an EBS volume.
+ */ +export interface VolumeDetail { /** - *Is true if the request succeeds, and an error otherwise.
The size of the volume, in GiB.
*/ - Return?: boolean; + Size: number | undefined; } -export namespace ModifyFleetResult { +export namespace VolumeDetail { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyFleetResult): any => ({ + export const filterSensitiveLog = (obj: VolumeDetail): any => ({ ...obj, }); } /** - *Describes a load permission.
+ *Describes a disk image.
*/ -export interface LoadPermissionRequest { +export interface DiskImage { /** - *The name of the group.
+ *A description of the disk image.
*/ - Group?: PermissionGroup | string; + Description?: string; /** - *The AWS account ID.
+ *Information about the disk image.
*/ - UserId?: string; + Image?: DiskImageDetail; + + /** + *Information about the volume.
+ */ + Volume?: VolumeDetail; } -export namespace LoadPermissionRequest { +export namespace DiskImage { /** * @internal */ - export const filterSensitiveLog = (obj: LoadPermissionRequest): any => ({ + export const filterSensitiveLog = (obj: DiskImage): any => ({ ...obj, }); } /** - *Describes modifications to the load permissions of an Amazon FPGA image (AFI).
+ *Describes the user data for an instance.
*/ -export interface LoadPermissionModifications { - /** - *The load permissions to add.
- */ - Add?: LoadPermissionRequest[]; - +export interface UserData { /** - *The load permissions to remove.
+ *The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you + * can load the text from a file. Otherwise, you must provide Base64-encoded text.
*/ - Remove?: LoadPermissionRequest[]; + Data?: string; } -export namespace LoadPermissionModifications { +export namespace UserData { /** * @internal */ - export const filterSensitiveLog = (obj: LoadPermissionModifications): any => ({ + export const filterSensitiveLog = (obj: UserData): any => ({ ...obj, }); } -export type OperationType = "add" | "remove"; - -export interface ModifyFpgaImageAttributeRequest { +/** + *Describes the launch specification for VM import.
+ */ +export interface ImportInstanceLaunchSpecification { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Reserved.
*/ - DryRun?: boolean; + AdditionalInfo?: string; /** - *The ID of the AFI.
+ *The architecture of the instance.
*/ - FpgaImageId: string | undefined; + Architecture?: ArchitectureValues | string; /** - *The name of the attribute.
+ *The security group IDs.
*/ - Attribute?: FpgaImageAttributeName | string; + GroupIds?: string[]; /** - *The operation type.
+ *The security group names.
*/ - OperationType?: OperationType | string; + GroupNames?: string[]; /** - *The AWS account IDs. This parameter is valid only when modifying the loadPermission attribute.
The user groups. This parameter is valid only when modifying the loadPermission attribute.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the + * operating system command for system shutdown).
*/ - UserGroups?: string[]; + InstanceInitiatedShutdownBehavior?: ShutdownBehavior | string; /** - *The product codes. After you add a product code to an AFI, it can't be removed.
- * This parameter is valid only when modifying the productCodes attribute.
The instance type. For more information about the instance types that you can import, see Instance Types in the + * VM Import/Export User Guide.
*/ - ProductCodes?: string[]; + InstanceType?: _InstanceType | string; /** - *The load permission for the AFI.
+ *Indicates whether monitoring is enabled.
*/ - LoadPermission?: LoadPermissionModifications; + Monitoring?: boolean; /** - *A description for the AFI.
+ *The placement information for the instance.
*/ - Description?: string; + Placement?: Placement; /** - *A name for the AFI.
+ *[EC2-VPC] An available IP address from the IP address range of the subnet.
*/ - Name?: string; -} + PrivateIpAddress?: string; -export namespace ModifyFpgaImageAttributeRequest { /** - * @internal + *[EC2-VPC] The ID of the subnet in which to launch the instance.
*/ - export const filterSensitiveLog = (obj: ModifyFpgaImageAttributeRequest): any => ({ - ...obj, - }); -} + SubnetId?: string; -export interface ModifyFpgaImageAttributeResult { /** - *Information about the attribute.
+ *The Base64-encoded user data to make available to the instance.
*/ - FpgaImageAttribute?: FpgaImageAttribute; + UserData?: UserData; } -export namespace ModifyFpgaImageAttributeResult { +export namespace ImportInstanceLaunchSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyFpgaImageAttributeResult): any => ({ + export const filterSensitiveLog = (obj: ImportInstanceLaunchSpecification): any => ({ ...obj, + ...(obj.UserData && { UserData: SENSITIVE_STRING }), }); } -export interface ModifyHostsRequest { +export interface ImportInstanceRequest { /** - *Specify whether to enable or disable auto-placement.
+ *A description for the instance being imported.
*/ - AutoPlacement?: AutoPlacement | string; + Description?: string; /** - *The IDs of the Dedicated Hosts to modify.
+ *The disk image.
*/ - HostIds: string[] | undefined; + DiskImages?: DiskImage[]; /** - *Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, - * see - * Host recovery in the Amazon EC2 User Guide.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to - * modify a Dedicated Host to support only a specific instance type.
- * - *If you want to modify a Dedicated Host to support multiple instance types in its current instance - * family, omit this parameter and specify InstanceFamily - * instead. You cannot specify InstanceType and - * InstanceFamily in the same request.
+ *The launch specification.
*/ - InstanceType?: string; + LaunchSpecification?: ImportInstanceLaunchSpecification; /** - *Specifies the instance family to be supported by the Dedicated Host. Specify this parameter - * to modify a Dedicated Host to support multiple instance types within its current - * instance family.
- * - *If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter - * and specify InstanceType instead. You cannot specify - * InstanceFamily and InstanceType - * in the same request.
+ *The instance operating system.
*/ - InstanceFamily?: string; + Platform: PlatformValues | string | undefined; } -export namespace ModifyHostsRequest { +export namespace ImportInstanceRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyHostsRequest): any => ({ + export const filterSensitiveLog = (obj: ImportInstanceRequest): any => ({ ...obj, + ...(obj.LaunchSpecification && { + LaunchSpecification: ImportInstanceLaunchSpecification.filterSensitiveLog(obj.LaunchSpecification), + }), }); } -export interface ModifyHostsResult { - /** - *The IDs of the Dedicated Hosts that were successfully modified.
- */ - Successful?: string[]; - +export interface ImportInstanceResult { /** - *The IDs of the Dedicated Hosts that could not be modified. Check whether the - * setting you requested can be used.
+ *Information about the conversion task.
*/ - Unsuccessful?: UnsuccessfulItem[]; + ConversionTask?: ConversionTask; } -export namespace ModifyHostsResult { +export namespace ImportInstanceResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyHostsResult): any => ({ + export const filterSensitiveLog = (obj: ImportInstanceResult): any => ({ ...obj, }); } -export interface ModifyIdentityIdFormatRequest { +export interface ImportKeyPairRequest { /** - *The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify
- * all to modify the ID format for all IAM users, IAM roles, and the root user of
- * the account.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |
- * elastic-ip-allocation | elastic-ip-association |
- * export-task | flow-log | image |
- * import-task | internet-gateway | network-acl
- * | network-acl-association | network-interface |
- * network-interface-attachment | prefix-list |
- * route-table | route-table-association |
- * security-group | subnet |
- * subnet-cidr-block-association | vpc |
- * vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are
- * currently within their opt-in period for longer IDs.
A unique name for the key pair.
*/ - Resource: string | undefined; + KeyName: string | undefined; /** - *Indicates whether the resource should use longer IDs (17-character IDs)
+ *The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
*/ - UseLongIds: boolean | undefined; + PublicKeyMaterial: Uint8Array | undefined; + + /** + *The tags to apply to the imported key pair.
+ */ + TagSpecifications?: TagSpecification[]; } -export namespace ModifyIdentityIdFormatRequest { +export namespace ImportKeyPairRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyIdentityIdFormatRequest): any => ({ + export const filterSensitiveLog = (obj: ImportKeyPairRequest): any => ({ ...obj, }); } -export interface ModifyIdFormatRequest { - /** - *The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |
- * elastic-ip-allocation | elastic-ip-association |
- * export-task | flow-log | image |
- * import-task | internet-gateway | network-acl
- * | network-acl-association | network-interface |
- * network-interface-attachment | prefix-list |
- * route-table | route-table-association |
- * security-group | subnet |
- * subnet-cidr-block-association | vpc |
- * vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are
- * currently within their opt-in period for longer IDs.
Indicate whether the resource should use longer IDs (17-character IDs).
+ *The MD5 public key fingerprint as specified in section 4 of RFC 4716.
*/ - UseLongIds: boolean | undefined; -} + KeyFingerprint?: string; -export namespace ModifyIdFormatRequest { /** - * @internal + *The key pair name that you provided.
*/ - export const filterSensitiveLog = (obj: ModifyIdFormatRequest): any => ({ - ...obj, - }); -} + KeyName?: string; -/** - *Describes a launch permission modification.
- */ -export interface LaunchPermissionModifications { /** - *The AWS account ID to add to the list of launch permissions for the AMI.
+ *The ID of the resulting key pair.
*/ - Add?: LaunchPermission[]; + KeyPairId?: string; /** - *The AWS account ID to remove from the list of launch permissions for the AMI.
+ *The tags applied to the imported key pair.
*/ - Remove?: LaunchPermission[]; + Tags?: Tag[]; } -export namespace LaunchPermissionModifications { +export namespace ImportKeyPairResult { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchPermissionModifications): any => ({ + export const filterSensitiveLog = (obj: ImportKeyPairResult): any => ({ ...obj, }); } /** - *Contains the parameters for ModifyImageAttribute.
+ *The disk container object for the import snapshot request.
*/ -export interface ModifyImageAttributeRequest { +export interface SnapshotDiskContainer { /** - *The name of the attribute to modify.
- * The valid values are description, launchPermission, and productCodes.
The description of the disk image being imported.
*/ - Attribute?: string; + Description?: string; /** - *A new description for the AMI.
+ *The format of the disk image being imported.
+ *Valid values: VHD | VMDK | RAW
+ *
The ID of the AMI.
+ *The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon + * S3 URL (s3://..).
*/ - ImageId: string | undefined; + Url?: string; /** - *A new launch permission for the AMI.
+ *The Amazon S3 bucket for the disk image.
*/ - LaunchPermission?: LaunchPermissionModifications; + UserBucket?: UserBucket; +} +export namespace SnapshotDiskContainer { /** - *The operation type.
- * This parameter can be used only when the Attribute parameter is launchPermission.
The DevPay product codes. After you add a product code to an AMI, it can't be removed.
+ *The client-specific data.
*/ - ProductCodes?: string[]; + ClientData?: ClientData; /** - *The user groups.
- * This parameter can be used only when the Attribute parameter is launchPermission.
Token to enable idempotency for VM import requests.
*/ - UserGroups?: string[]; + ClientToken?: string; /** - *The AWS account IDs.
- * This parameter can be used only when the Attribute parameter is launchPermission.
The description string for the import snapshot task.
*/ - UserIds?: string[]; + Description?: string; /** - *The value of the attribute being modified.
- * This parameter can be used only when the Attribute parameter is description or productCodes.
Information about the disk container.
*/ - Value?: string; + DiskContainer?: SnapshotDiskContainer; /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
-}
-export namespace ModifyImageAttributeRequest {
/**
- * @internal
- */
- export const filterSensitiveLog = (obj: ModifyImageAttributeRequest): any => ({
+ * Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is
+ * used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the
+ * Amazon Elastic Compute Cloud User Guide.
An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the
+ * encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this
+ * parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is
+ * specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
+ *Key ID
+ *Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even
+ * though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the snapshot is being copied to.
+ *Amazon EBS does not support asymmetric CMKs.
+ */ + KmsKeyId?: string; + + /** + *The name of the role to use when not using the default role, 'vmimport'.
+ */ + RoleName?: string; + + /** + *The tags to apply to the import snapshot task during creation.
+ */ + TagSpecifications?: TagSpecification[]; +} + +export namespace ImportSnapshotRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ImportSnapshotRequest): any => ({ ...obj, }); } -/** - *Describes information used to set up an EBS volume specified in a block device - * mapping.
- */ -export interface EbsInstanceBlockDeviceSpecification { +export interface ImportSnapshotResult { /** - *Indicates whether the volume is deleted on instance termination.
+ *A description of the import snapshot task.
*/ - DeleteOnTermination?: boolean; + Description?: string; /** - *The ID of the EBS volume.
+ *The ID of the import snapshot task.
*/ - VolumeId?: string; + ImportTaskId?: string; + + /** + *Information about the import snapshot task.
+ */ + SnapshotTaskDetail?: SnapshotTaskDetail; + + /** + *Any tags assigned to the import snapshot task.
+ */ + Tags?: Tag[]; } -export namespace EbsInstanceBlockDeviceSpecification { +export namespace ImportSnapshotResult { /** * @internal */ - export const filterSensitiveLog = (obj: EbsInstanceBlockDeviceSpecification): any => ({ + export const filterSensitiveLog = (obj: ImportSnapshotResult): any => ({ ...obj, }); } -/** - *Describes a block device mapping entry.
- */ -export interface InstanceBlockDeviceMappingSpecification { +export interface ImportVolumeRequest { /** - *The device name (for example, /dev/sdh or xvdh).
The Availability Zone for the resulting EBS volume.
*/ - DeviceName?: string; + AvailabilityZone: string | undefined; /** - *Parameters used to automatically set up EBS volumes when the instance is - * launched.
+ *A description of the volume.
*/ - Ebs?: EbsInstanceBlockDeviceSpecification; + Description?: string; /** - *suppress the specified device included in the block device mapping.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The virtual device name.
+ *The disk image.
*/ - VirtualName?: string; + Image: DiskImageDetail | undefined; + + /** + *The volume size.
+ */ + Volume: VolumeDetail | undefined; } -export namespace InstanceBlockDeviceMappingSpecification { +export namespace ImportVolumeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceBlockDeviceMappingSpecification): any => ({ + export const filterSensitiveLog = (obj: ImportVolumeRequest): any => ({ ...obj, }); } -export interface BlobAttributeValue { - Value?: Uint8Array; +export interface ImportVolumeResult { + /** + *Information about the conversion task.
+ */ + ConversionTask?: ConversionTask; } -export namespace BlobAttributeValue { +export namespace ImportVolumeResult { /** * @internal */ - export const filterSensitiveLog = (obj: BlobAttributeValue): any => ({ + export const filterSensitiveLog = (obj: ImportVolumeResult): any => ({ ...obj, }); } -export interface ModifyInstanceAttributeRequest { +export interface ModifyAddressAttributeRequest { /** - *Enable or disable source/destination checks, which ensure that the instance
- * is either the source or the destination of any traffic that it receives.
- * If the value is true, source/destination checks are enabled;
- * otherwise, they are disabled. The default value is true.
- * You must disable source/destination checks if the instance runs services
- * such as network address translation, routing, or firewalls.
[EC2-VPC] The allocation ID.
*/ - SourceDestCheck?: AttributeBooleanValue; + AllocationId: string | undefined; /** - *The name of the attribute.
+ *The domain name to modify for the IP address.
*/ - Attribute?: InstanceAttributeName | string; + DomainName?: string; /** - *Modifies the DeleteOnTermination attribute for volumes that are currently
- * attached. The volume must be owned by the caller. If no value is specified for
- * DeleteOnTermination, the default is true and the volume is
- * deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when - * you launch the instance. For more information, see Updating the block device mapping when launching an instance in the - * Amazon EC2 User Guide.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
If the value is true, you can't terminate the instance using the Amazon
- * EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot
- * Instances.
Information about the Elastic IP address.
+ */ + Address?: AddressAttribute; +} + +export namespace ModifyAddressAttributeResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyAddressAttributeResult): any => ({ + ...obj, + }); +} + +export type ModifyAvailabilityZoneOptInStatus = "not-opted-in" | "opted-in"; + +export interface ModifyAvailabilityZoneGroupRequest { + /** + *The name of the Availability Zone group, Local Zone group, or Wavelength Zone + * group.
+ */ + GroupName: string | undefined; + + /** + *Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The
+ * only valid value is opted-in. You must contact AWS Support to opt out of a Local Zone group, or Wavelength Zone group.
Checks whether you have the required permissions for the action, without actually making the request,
@@ -5795,205 +5782,250 @@ export interface ModifyInstanceAttributeRequest {
* Otherwise, it is UnauthorizedOperation.
Specifies whether the instance is optimized for Amazon EBS I/O. This optimization - * provides dedicated throughput to Amazon EBS and an optimized configuration stack to - * provide optimal EBS I/O performance. This optimization isn't available with all instance - * types. Additional usage charges apply when using an EBS Optimized instance.
+ * @internal */ - EbsOptimized?: AttributeBooleanValue; + export const filterSensitiveLog = (obj: ModifyAvailabilityZoneGroupRequest): any => ({ + ...obj, + }); +} +export interface ModifyAvailabilityZoneGroupResult { /** - *Set to true to enable enhanced networking with ENA for the
- * instance.
This option is supported only for HVM instances. Specifying this option with a PV - * instance can make it unreachable.
+ *Is true if the request succeeds, and an error otherwise.
[EC2-VPC] Replaces the security groups of the instance with the specified security groups. - * You must specify at least one security group, even if it's just the default security group for the VPC. You must - * specify the security group ID, not the security group name.
+ * @internal */ - Groups?: string[]; + export const filterSensitiveLog = (obj: ModifyAvailabilityZoneGroupResult): any => ({ + ...obj, + }); +} +export interface ModifyCapacityReservationRequest { /** - *The ID of the instance.
+ *The ID of the Capacity Reservation.
*/ - InstanceId: string | undefined; + CapacityReservationId: string | undefined; /** - *Specifies whether an instance stops or terminates when you initiate shutdown from the - * instance (using the operating system command for system shutdown).
+ *The number of instances for which to reserve capacity.
*/ - InstanceInitiatedShutdownBehavior?: AttributeValue; + InstanceCount?: number; /** - *Changes the instance type to the specified value. For more information, see Instance
- * types in the Amazon EC2 User Guide. If the instance type is not valid,
- * the error returned is InvalidInstanceAttributeValue.
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity
+ * is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
+ * expired when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify + * 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
+ *You must provide an EndDate value if EndDateType is
+ * limited. Omit EndDate if EndDateType is
+ * unlimited.
Changes the instance's kernel to the specified value. We recommend that you use - * PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
+ *Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end + * types:
+ *
+ * unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not
+ * provide an EndDate value if EndDateType is
+ * unlimited.
+ * limited - The Capacity Reservation expires automatically at a specified date and time. You must
+ * provide an EndDate value if EndDateType is
+ * limited.
Changes the instance's RAM disk to the specified value. We recommend that you use - * PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
+ *Reserved. Capacity Reservations you have created are accepted by default.
*/ - Ramdisk?: AttributeValue; + Accept?: boolean; /** - *Set to simple to enable enhanced networking with the Intel 82599 Virtual
- * Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function - * interface at this time.
- *This option is supported only for HVM instances. Specifying this option with a PV - * instance can make it unreachable.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK - * or command line tool, base64-encoding is performed for you, and you can load the text - * from a file. Otherwise, you must provide base64-encoded text.
+ * @internal */ - UserData?: BlobAttributeValue; + export const filterSensitiveLog = (obj: ModifyCapacityReservationRequest): any => ({ + ...obj, + }); +} +export interface ModifyCapacityReservationResult { /** - *A new value for the attribute. Use only with the kernel,
- * ramdisk, userData, disableApiTermination, or
- * instanceInitiatedShutdownBehavior attribute.
Returns true if the request succeeds; otherwise, it returns an error.
Describes an instance's Capacity Reservation targeting option. You can specify only one parameter
- * at a time. If you specify CapacityReservationPreference and
- * CapacityReservationTarget, the request fails.
Use the CapacityReservationPreference parameter to configure the instance
- * to run as an On-Demand Instance or to run in any open Capacity Reservation that has
- * matching attributes (instance type, platform, Availability Zone). Use the
- * CapacityReservationTarget parameter to explicitly target a specific
- * Capacity Reservation or a Capacity Reservation group.
Information about the DNS server to be used.
*/ -export interface CapacityReservationSpecification { +export interface DnsServersOptionsModifyStructure { /** - *Indicates the instance's Capacity Reservation preferences. Possible preferences include:
+ *The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to + * two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values + * overwrite the existing values.
+ */ + CustomDnsServers?: string[]; + + /** + *Indicates whether DNS servers should be used. Specify False to delete the existing DNS
+ * servers.
The ID of the Client VPN endpoint to modify.
+ */ + ClientVpnEndpointId: string | undefined; + + /** + *The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM).
+ */ + ServerCertificateArn?: string; + + /** + *Information about the client connection logging options.
+ *If you enable client connection logging, data about client connections is sent to a + * Cloudwatch Logs log stream. The following information is logged:
*
- * open - The instance can run in any open Capacity Reservation that has matching attributes
- * (instance type, platform, Availability Zone).
Client connection requests
*
- * none - The instance avoids running in a Capacity Reservation even if one is available. The
- * instance runs as an On-Demand Instance.
Client connection results (successful and unsuccessful)
+ *Reasons for unsuccessful client connection requests
+ *Client connection termination time
*Information about the target Capacity Reservation or Capacity Reservation group.
+ *Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have + * up to two DNS servers.
*/ - CapacityReservationTarget?: CapacityReservationTarget; -} + DnsServers?: DnsServersOptionsModifyStructure; -export namespace CapacityReservationSpecification { /** - * @internal + *The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
+ *Valid Values: 443 | 1194
+ *
Default Value: 443
+ *
A brief description of the Client VPN endpoint.
+ */ + Description?: string; + + /** + *Indicates whether the VPN is split-tunnel.
+ *For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS + * Client VPN Administrator Guide.
+ */ + SplitTunnel?: boolean; -export interface ModifyInstanceCapacityReservationAttributesRequest { /** - *The ID of the instance to be modified.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the Capacity Reservation targeting option.
+ *The IDs of one or more security groups to apply to the target network.
*/ - CapacityReservationSpecification: CapacityReservationSpecification | undefined; + SecurityGroupIds?: string[]; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the VPC to associate with the Client VPN endpoint.
*/ - DryRun?: boolean; -} + VpcId?: string; -export namespace ModifyInstanceCapacityReservationAttributesRequest { /** - * @internal + *Specify whether to enable the self-service portal for the Client VPN endpoint.
*/ - export const filterSensitiveLog = (obj: ModifyInstanceCapacityReservationAttributesRequest): any => ({ - ...obj, - }); -} + SelfServicePortal?: SelfServicePortal | string; -export interface ModifyInstanceCapacityReservationAttributesResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
The options for managing connection authorization for new client connections.
*/ - Return?: boolean; + ClientConnectOptions?: ClientConnectOptions; } -export namespace ModifyInstanceCapacityReservationAttributesResult { +export namespace ModifyClientVpnEndpointRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstanceCapacityReservationAttributesResult): any => ({ + export const filterSensitiveLog = (obj: ModifyClientVpnEndpointRequest): any => ({ ...obj, }); } -/** - *Describes the credit option for CPU usage of a burstable performance instance.
- */ -export interface InstanceCreditSpecificationRequest { - /** - *The ID of the instance.
- */ - InstanceId?: string; - +export interface ModifyClientVpnEndpointResult { /** - *The credit option for CPU usage of the instance. Valid values are
- * standard and unlimited.
Returns true if the request succeeds; otherwise, it returns an error.
Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -6002,513 +6034,605 @@ export interface ModifyInstanceCreditSpecificationRequest {
DryRun?: boolean;
/**
- *
A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring - * Idempotency.
+ *The instance family.
*/ - ClientToken?: string; + InstanceFamily: UnlimitedSupportedInstanceFamily | string | undefined; /** - *Information about the credit option for CPU usage.
+ *The credit option for CPU usage of the instance family.
+ *Valid Values: standard | unlimited
+ *
Describes the burstable performance instance whose credit option for CPU usage was - * successfully modified.
- */ -export interface SuccessfulInstanceCreditSpecificationItem { +export interface ModifyDefaultCreditSpecificationResult { /** - *The ID of the instance.
+ *The default credit option for CPU usage of the instance family.
*/ - InstanceId?: string; + InstanceFamilyCreditSpecification?: InstanceFamilyCreditSpecification; } -export namespace SuccessfulInstanceCreditSpecificationItem { +export namespace ModifyDefaultCreditSpecificationResult { /** * @internal */ - export const filterSensitiveLog = (obj: SuccessfulInstanceCreditSpecificationItem): any => ({ + export const filterSensitiveLog = (obj: ModifyDefaultCreditSpecificationResult): any => ({ ...obj, }); } -export enum UnsuccessfulInstanceCreditSpecificationErrorCode { - INCORRECT_INSTANCE_STATE = "IncorrectInstanceState", - INSTANCE_CREDIT_SPECIFICATION_NOT_SUPPORTED = "InstanceCreditSpecification.NotSupported", - INSTANCE_NOT_FOUND = "InvalidInstanceID.NotFound", - INVALID_INSTANCE_ID = "InvalidInstanceID.Malformed", -} - -/** - *Information about the error for the burstable performance instance whose credit option - * for CPU usage was not modified.
- */ -export interface UnsuccessfulInstanceCreditSpecificationItemError { +export interface ModifyEbsDefaultKmsKeyIdRequest { /** - *The error code.
+ *The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption.
+ * If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is
+ * specified, the encrypted state must be true.
You can specify the CMK using any of the following:
+ *Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
+ *Key alias. For example, alias/ExampleAlias.
+ *Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
+ *Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
+ *AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, + * the action can appear to complete, but eventually fails.
+ *Amazon EBS does not support asymmetric CMKs.
*/ - Code?: UnsuccessfulInstanceCreditSpecificationErrorCode | string; + KmsKeyId: string | undefined; /** - *The applicable error message.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the burstable performance instance whose credit option for CPU usage was not - * modified.
- */ -export interface UnsuccessfulInstanceCreditSpecificationItem { - /** - *The ID of the instance.
- */ - InstanceId?: string; - +export interface ModifyEbsDefaultKmsKeyIdResult { /** - *The applicable error for the burstable performance instance whose credit option for - * CPU usage was not modified.
+ *The Amazon Resource Name (ARN) of the default CMK for encryption by default.
*/ - Error?: UnsuccessfulInstanceCreditSpecificationItemError; + KmsKeyId?: string; } -export namespace UnsuccessfulInstanceCreditSpecificationItem { +export namespace ModifyEbsDefaultKmsKeyIdResult { /** * @internal */ - export const filterSensitiveLog = (obj: UnsuccessfulInstanceCreditSpecificationItem): any => ({ + export const filterSensitiveLog = (obj: ModifyEbsDefaultKmsKeyIdResult): any => ({ ...obj, }); } -export interface ModifyInstanceCreditSpecificationResult { +export interface ModifyFleetRequest { /** - *Information about the instances whose credit option for CPU usage was successfully - * modified.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the instances whose credit option for CPU usage was not - * modified.
+ *Indicates whether running instances should be terminated if the total target capacity of + * the EC2 Fleet is decreased below the current size of the EC2 Fleet.
*/ - UnsuccessfulInstanceCreditSpecifications?: UnsuccessfulInstanceCreditSpecificationItem[]; + ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy | string; + + /** + *The launch template and overrides.
+ */ + LaunchTemplateConfigs?: FleetLaunchTemplateConfigRequest[]; + + /** + *The ID of the EC2 Fleet.
+ */ + FleetId: string | undefined; + + /** + *The size of the EC2 Fleet.
+ */ + TargetCapacitySpecification?: TargetCapacitySpecificationRequest; + + /** + *Reserved.
+ */ + Context?: string; } -export namespace ModifyInstanceCreditSpecificationResult { +export namespace ModifyFleetRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstanceCreditSpecificationResult): any => ({ + export const filterSensitiveLog = (obj: ModifyFleetRequest): any => ({ ...obj, }); } -export interface ModifyInstanceEventStartTimeRequest { +export interface ModifyFleetResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Is true if the request succeeds, and an error otherwise.
The ID of the instance with the scheduled event.
+ * @internal */ - InstanceId: string | undefined; + export const filterSensitiveLog = (obj: ModifyFleetResult): any => ({ + ...obj, + }); +} +/** + *Describes a load permission.
+ */ +export interface LoadPermissionRequest { /** - *The ID of the event whose date and time you are modifying.
+ *The name of the group.
*/ - InstanceEventId: string | undefined; + Group?: PermissionGroup | string; /** - *The new date and time when the event will take place.
+ *The AWS account ID.
*/ - NotBefore: Date | undefined; + UserId?: string; } -export namespace ModifyInstanceEventStartTimeRequest { +export namespace LoadPermissionRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstanceEventStartTimeRequest): any => ({ + export const filterSensitiveLog = (obj: LoadPermissionRequest): any => ({ ...obj, }); } -export interface ModifyInstanceEventStartTimeResult { +/** + *Describes modifications to the load permissions of an Amazon FPGA image (AFI).
+ */ +export interface LoadPermissionModifications { /** - *Describes a scheduled event for an instance.
+ *The load permissions to add.
*/ - Event?: InstanceStatusEvent; + Add?: LoadPermissionRequest[]; + + /** + *The load permissions to remove.
+ */ + Remove?: LoadPermissionRequest[]; } -export namespace ModifyInstanceEventStartTimeResult { +export namespace LoadPermissionModifications { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstanceEventStartTimeResult): any => ({ + export const filterSensitiveLog = (obj: LoadPermissionModifications): any => ({ ...obj, }); } -export interface ModifyInstanceMetadataOptionsRequest { +export type OperationType = "add" | "remove"; + +export interface ModifyFpgaImageAttributeRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the AFI.
+ */ + FpgaImageId: string | undefined; + /** - *The ID of the instance.
+ *The name of the attribute.
*/ - InstanceId: string | undefined; + Attribute?: FpgaImageAttributeName | string; /** - *The state of token usage for your instance metadata requests. If the parameter is not
- * specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata
- * with or without a signed token header on your request. If you retrieve the IAM role
- * credentials without a token, the version 1.0 role credentials are returned. If you
- * retrieve the IAM role credentials using a valid signed token, the version 2.0 role
- * credentials are returned.
If the state is required, you must send a signed token header with any
- * instance metadata retrieval requests. In this state, retrieving the IAM role credential
- * always returns the version 2.0 credentials; the version 1.0 credentials are not
- * available.
The operation type.
*/ - HttpTokens?: HttpTokensState | string; + OperationType?: OperationType | string; /** - *The desired HTTP PUT response hop limit for instance metadata requests. The larger the - * number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
- *Possible values: Integers from 1 to 64
+ *The AWS account IDs. This parameter is valid only when modifying the loadPermission attribute.
This parameter enables or disables the HTTP metadata endpoint on your instances. If - * the parameter is not specified, the existing state is maintained.
- *If you specify a value of disabled, you will not be able to access your
- * instance metadata.
The user groups. This parameter is valid only when modifying the loadPermission attribute.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The product codes. After you add a product code to an AFI, it can't be removed.
+ * This parameter is valid only when modifying the productCodes attribute.
The load permission for the AFI.
*/ - export const filterSensitiveLog = (obj: ModifyInstanceMetadataOptionsRequest): any => ({ - ...obj, - }); -} + LoadPermission?: LoadPermissionModifications; -export interface ModifyInstanceMetadataOptionsResult { /** - *The ID of the instance.
+ *A description for the AFI.
*/ - InstanceId?: string; + Description?: string; /** - *The metadata options for the instance.
+ *A name for the AFI.
*/ - InstanceMetadataOptions?: InstanceMetadataOptionsResponse; + Name?: string; } -export namespace ModifyInstanceMetadataOptionsResult { +export namespace ModifyFpgaImageAttributeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstanceMetadataOptionsResult): any => ({ + export const filterSensitiveLog = (obj: ModifyFpgaImageAttributeRequest): any => ({ ...obj, }); } -export type HostTenancy = "dedicated" | "host"; - -export interface ModifyInstancePlacementRequest { +export interface ModifyFpgaImageAttributeResult { /** - *The affinity setting for the instance.
+ *Information about the attribute.
*/ - Affinity?: Affinity | string; + FpgaImageAttribute?: FpgaImageAttribute; +} +export namespace ModifyFpgaImageAttributeResult { /** - *The name of the placement group in which to place the instance. For spread placement
- * groups, the instance must have a tenancy of default. For cluster and
- * partition placement groups, the instance must have a tenancy of default or
- * dedicated.
To remove an instance from a placement group, specify an empty string - * ("").
+ * @internal */ - GroupName?: string; + export const filterSensitiveLog = (obj: ModifyFpgaImageAttributeResult): any => ({ + ...obj, + }); +} +export interface ModifyHostsRequest { /** - *The ID of the Dedicated Host with which to associate the instance.
+ *Specify whether to enable or disable auto-placement.
*/ - HostId?: string; + AutoPlacement?: AutoPlacement | string; /** - *The ID of the instance that you are modifying.
+ *The IDs of the Dedicated Hosts to modify.
*/ - InstanceId: string | undefined; + HostIds: string[] | undefined; /** - *The tenancy for the instance.
+ *Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, + * see + * Host recovery in the Amazon EC2 User Guide.
*/ - Tenancy?: HostTenancy | string; + HostRecovery?: HostRecovery | string; /** - *Reserved for future use.
+ *Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to + * modify a Dedicated Host to support only a specific instance type.
+ * + *If you want to modify a Dedicated Host to support multiple instance types in its current instance + * family, omit this parameter and specify InstanceFamily + * instead. You cannot specify InstanceType and + * InstanceFamily in the same request.
*/ - PartitionNumber?: number; + InstanceType?: string; /** - *The ARN of the host resource group in which to place the instance.
+ *Specifies the instance family to be supported by the Dedicated Host. Specify this parameter + * to modify a Dedicated Host to support multiple instance types within its current + * instance family.
+ * + *If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter + * and specify InstanceType instead. You cannot specify + * InstanceFamily and InstanceType + * in the same request.
*/ - HostResourceGroupArn?: string; + InstanceFamily?: string; } -export namespace ModifyInstancePlacementRequest { +export namespace ModifyHostsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstancePlacementRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyHostsRequest): any => ({ ...obj, }); } -export interface ModifyInstancePlacementResult { +export interface ModifyHostsResult { /** - *Is true if the request succeeds, and an error otherwise.
The IDs of the Dedicated Hosts that were successfully modified.
*/ - Return?: boolean; + Successful?: string[]; + + /** + *The IDs of the Dedicated Hosts that could not be modified. Check whether the + * setting you requested can be used.
+ */ + Unsuccessful?: UnsuccessfulItem[]; } -export namespace ModifyInstancePlacementResult { +export namespace ModifyHostsResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstancePlacementResult): any => ({ + export const filterSensitiveLog = (obj: ModifyHostsResult): any => ({ ...obj, }); } -export interface ModifyLaunchTemplateRequest { +export interface ModifyIdentityIdFormatRequest { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify
+ * all to modify the ID format for all IAM users, IAM roles, and the root user of
+ * the account.
Unique, case-sensitive identifier you provide to ensure the idempotency of the - * request. For more information, see Ensuring - * Idempotency.
- *Constraint: Maximum 128 ASCII characters.
+ *The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |
+ * elastic-ip-allocation | elastic-ip-association |
+ * export-task | flow-log | image |
+ * import-task | internet-gateway | network-acl
+ * | network-acl-association | network-interface |
+ * network-interface-attachment | prefix-list |
+ * route-table | route-table-association |
+ * security-group | subnet |
+ * subnet-cidr-block-association | vpc |
+ * vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are
+ * currently within their opt-in period for longer IDs.
The ID of the launch template. You must specify either the launch template ID or - * launch template name in the request.
+ *Indicates whether the resource should use longer IDs (17-character IDs)
*/ - LaunchTemplateId?: string; + UseLongIds: boolean | undefined; +} +export namespace ModifyIdentityIdFormatRequest { /** - *The name of the launch template. You must specify either the launch template ID or - * launch template name in the request.
+ * @internal */ - LaunchTemplateName?: string; + export const filterSensitiveLog = (obj: ModifyIdentityIdFormatRequest): any => ({ + ...obj, + }); +} +export interface ModifyIdFormatRequest { /** - *The version number of the launch template to set as the default version.
+ *The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |
+ * elastic-ip-allocation | elastic-ip-association |
+ * export-task | flow-log | image |
+ * import-task | internet-gateway | network-acl
+ * | network-acl-association | network-interface |
+ * network-interface-attachment | prefix-list |
+ * route-table | route-table-association |
+ * security-group | subnet |
+ * subnet-cidr-block-association | vpc |
+ * vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are
+ * currently within their opt-in period for longer IDs.
Indicate whether the resource should use longer IDs (17-character IDs).
+ */ + UseLongIds: boolean | undefined; } -export namespace ModifyLaunchTemplateRequest { +export namespace ModifyIdFormatRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyLaunchTemplateRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyIdFormatRequest): any => ({ ...obj, }); } -export interface ModifyLaunchTemplateResult { +/** + *Describes a launch permission modification.
+ */ +export interface LaunchPermissionModifications { /** - *Information about the launch template.
+ *The AWS account ID to add to the list of launch permissions for the AMI.
*/ - LaunchTemplate?: LaunchTemplate; + Add?: LaunchPermission[]; + + /** + *The AWS account ID to remove from the list of launch permissions for the AMI.
+ */ + Remove?: LaunchPermission[]; } -export namespace ModifyLaunchTemplateResult { +export namespace LaunchPermissionModifications { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyLaunchTemplateResult): any => ({ + export const filterSensitiveLog = (obj: LaunchPermissionModifications): any => ({ ...obj, }); } /** - *An entry for a prefix list.
+ *Contains the parameters for ModifyImageAttribute.
*/ -export interface RemovePrefixListEntry { +export interface ModifyImageAttributeRequest { /** - *The CIDR block.
+ *The name of the attribute to modify.
+ * The valid values are description, launchPermission, and productCodes.
A new description for the AMI.
*/ - export const filterSensitiveLog = (obj: RemovePrefixListEntry): any => ({ - ...obj, - }); -} + Description?: AttributeValue; -export interface ModifyManagedPrefixListRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the AMI.
*/ - DryRun?: boolean; + ImageId: string | undefined; /** - *The ID of the prefix list.
+ *A new launch permission for the AMI.
*/ - PrefixListId: string | undefined; + LaunchPermission?: LaunchPermissionModifications; /** - *The current version of the prefix list.
+ *The operation type.
+ * This parameter can be used only when the Attribute parameter is launchPermission.
A name for the prefix list.
+ *The DevPay product codes. After you add a product code to an AMI, it can't be removed.
*/ - PrefixListName?: string; + ProductCodes?: string[]; /** - *One or more entries to add to the prefix list.
+ *The user groups.
+ * This parameter can be used only when the Attribute parameter is launchPermission.
One or more entries to remove from the prefix list.
+ *The AWS account IDs.
+ * This parameter can be used only when the Attribute parameter is launchPermission.
The value of the attribute being modified.
+ * This parameter can be used only when the Attribute parameter is description or productCodes.
Information about the prefix list.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes an attachment change.
+ *Describes information used to set up an EBS volume specified in a block device + * mapping.
*/ -export interface NetworkInterfaceAttachmentChanges { +export interface EbsInstanceBlockDeviceSpecification { /** - *The ID of the network interface attachment.
+ *Indicates whether the volume is deleted on instance termination.
*/ - AttachmentId?: string; + DeleteOnTermination?: boolean; /** - *Indicates whether the network interface is deleted when the instance is terminated.
+ *The ID of the EBS volume.
*/ - DeleteOnTermination?: boolean; + VolumeId?: string; } -export namespace NetworkInterfaceAttachmentChanges { +export namespace EbsInstanceBlockDeviceSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: NetworkInterfaceAttachmentChanges): any => ({ + export const filterSensitiveLog = (obj: EbsInstanceBlockDeviceSpecification): any => ({ ...obj, }); } /** - *Contains the parameters for ModifyNetworkInterfaceAttribute.
+ *Describes a block device mapping entry.
*/ -export interface ModifyNetworkInterfaceAttributeRequest { +export interface InstanceBlockDeviceMappingSpecification { /** - *Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
+ *The device name (for example, /dev/sdh or xvdh).
A description for the network interface.
+ *Parameters used to automatically set up EBS volumes when the instance is + * launched.
*/ - Description?: AttributeValue; + Ebs?: EbsInstanceBlockDeviceSpecification; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
suppress the specified device included in the block device mapping.
*/ - DryRun?: boolean; + NoDevice?: string; /** - *Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
+ *The virtual device name.
*/ - Groups?: string[]; + VirtualName?: string; +} +export namespace InstanceBlockDeviceMappingSpecification { /** - *The ID of the network interface.
+ * @internal */ - NetworkInterfaceId: string | undefined; + export const filterSensitiveLog = (obj: InstanceBlockDeviceMappingSpecification): any => ({ + ...obj, + }); +} + +export interface BlobAttributeValue { + Value?: Uint8Array; +} + +export namespace BlobAttributeValue { + /** + * @internal + */ + export const filterSensitiveLog = (obj: BlobAttributeValue): any => ({ + ...obj, + }); +} +export interface ModifyInstanceAttributeRequest { /** *Enable or disable source/destination checks, which ensure that the instance * is either the source or the destination of any traffic that it receives. @@ -6518,726 +6642,725 @@ export interface ModifyNetworkInterfaceAttributeRequest { * such as network address translation, routing, or firewalls.
*/ SourceDestCheck?: AttributeBooleanValue; -} -export namespace ModifyNetworkInterfaceAttributeRequest { /** - * @internal + *The name of the attribute.
*/ - export const filterSensitiveLog = (obj: ModifyNetworkInterfaceAttributeRequest): any => ({ - ...obj, - }); -} + Attribute?: InstanceAttributeName | string; -/** - *Contains the parameters for ModifyReservedInstances.
- */ -export interface ModifyReservedInstancesRequest { /** - *The IDs of the Reserved Instances to modify.
+ *Modifies the DeleteOnTermination attribute for volumes that are currently
+ * attached. The volume must be owned by the caller. If no value is specified for
+ * DeleteOnTermination, the default is true and the volume is
+ * deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when + * you launch the instance. For more information, see Updating the block device mapping when launching an instance in the + * Amazon EC2 User Guide.
*/ - ReservedInstancesIds: string[] | undefined; + BlockDeviceMappings?: InstanceBlockDeviceMappingSpecification[]; /** - *A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see - * Ensuring Idempotency.
+ *If the value is true, you can't terminate the instance using the Amazon
+ * EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot
+ * Instances.
The configuration settings for the Reserved Instances to modify.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Specifies whether the instance is optimized for Amazon EBS I/O. This optimization + * provides dedicated throughput to Amazon EBS and an optimized configuration stack to + * provide optimal EBS I/O performance. This optimization isn't available with all instance + * types. Additional usage charges apply when using an EBS Optimized instance.
*/ - export const filterSensitiveLog = (obj: ModifyReservedInstancesRequest): any => ({ - ...obj, - }); -} + EbsOptimized?: AttributeBooleanValue; -/** - *Contains the output of ModifyReservedInstances.
- */ -export interface ModifyReservedInstancesResult { /** - *The ID for the modification.
+ *Set to true to enable enhanced networking with ENA for the
+ * instance.
This option is supported only for HVM instances. Specifying this option with a PV + * instance can make it unreachable.
*/ - ReservedInstancesModificationId?: string; -} + EnaSupport?: AttributeBooleanValue; -export namespace ModifyReservedInstancesResult { /** - * @internal + *[EC2-VPC] Replaces the security groups of the instance with the specified security groups. + * You must specify at least one security group, even if it's just the default security group for the VPC. You must + * specify the security group ID, not the security group name.
*/ - export const filterSensitiveLog = (obj: ModifyReservedInstancesResult): any => ({ - ...obj, - }); -} + Groups?: string[]; -/** - *Describes a security group rule.
- *You must specify exactly one of the following parameters, based on the rule type:
- *CidrIpv4
- *CidrIpv6
- *PrefixListId
- *ReferencedGroupId
- *When you modify a rule, you cannot change the rule type. For example, if the rule
- * uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4
- * address range.
The IP protocol name (tcp, udp, icmp,
- * icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
The ID of the instance.
*/ - IpProtocol?: string; + InstanceId: string | undefined; /** - *The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
+ *Specifies whether an instance stops or terminates when you initiate shutdown from the + * instance (using the operating system command for system shutdown).
*/ - FromPort?: number; + InstanceInitiatedShutdownBehavior?: AttributeValue; /** - *The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
Changes the instance type to the specified value. For more information, see Instance
+ * types in the Amazon EC2 User Guide. If the instance type is not valid,
+ * the error returned is InvalidInstanceAttributeValue.
The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
+ *Changes the instance's kernel to the specified value. We recommend that you use + * PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
*/ - CidrIpv4?: string; + Kernel?: AttributeValue; /** - *The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
+ *Changes the instance's RAM disk to the specified value. We recommend that you use + * PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
*/ - CidrIpv6?: string; + Ramdisk?: AttributeValue; /** - *The ID of the prefix list.
+ *Set to simple to enable enhanced networking with the Intel 82599 Virtual
+ * Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function + * interface at this time.
+ *This option is supported only for HVM instances. Specifying this option with a PV + * instance can make it unreachable.
*/ - PrefixListId?: string; + SriovNetSupport?: AttributeValue; /** - *The ID of the security group that is referenced in the security group rule.
+ *Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK + * or command line tool, base64-encoding is performed for you, and you can load the text + * from a file. Otherwise, you must provide base64-encoded text.
*/ - ReferencedGroupId?: string; + UserData?: BlobAttributeValue; /** - *The description of the security group rule.
+ *A new value for the attribute. Use only with the kernel,
+ * ramdisk, userData, disableApiTermination, or
+ * instanceInitiatedShutdownBehavior attribute.
Describes an update to a security group rule.
+ *Describes an instance's Capacity Reservation targeting option. You can specify only one parameter
+ * at a time. If you specify CapacityReservationPreference and
+ * CapacityReservationTarget, the request fails.
Use the CapacityReservationPreference parameter to configure the instance
+ * to run as an On-Demand Instance or to run in any open Capacity Reservation that has
+ * matching attributes (instance type, platform, Availability Zone). Use the
+ * CapacityReservationTarget parameter to explicitly target a specific
+ * Capacity Reservation or a Capacity Reservation group.
The ID of the security group rule.
+ *Indicates the instance's Capacity Reservation preferences. Possible preferences include:
+ *
+ * open - The instance can run in any open Capacity Reservation that has matching attributes
+ * (instance type, platform, Availability Zone).
+ * none - The instance avoids running in a Capacity Reservation even if one is available. The
+ * instance runs as an On-Demand Instance.
Information about the security group rule.
+ *Information about the target Capacity Reservation or Capacity Reservation group.
*/ - SecurityGroupRule?: SecurityGroupRuleRequest; + CapacityReservationTarget?: CapacityReservationTarget; } -export namespace SecurityGroupRuleUpdate { +export namespace CapacityReservationSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: SecurityGroupRuleUpdate): any => ({ + export const filterSensitiveLog = (obj: CapacityReservationSpecification): any => ({ ...obj, }); } -export interface ModifySecurityGroupRulesRequest { +export interface ModifyInstanceCapacityReservationAttributesRequest { /** - *The ID of the security group.
+ *The ID of the instance to be modified.
*/ - GroupId: string | undefined; + InstanceId: string | undefined; /** - *Information about the security group properties to update.
+ *Information about the Capacity Reservation targeting option.
*/ - SecurityGroupRules: SecurityGroupRuleUpdate[] | undefined; + CapacityReservationSpecification: CapacityReservationSpecification | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, returns an error.
Returns true if the request succeeds; otherwise, it returns an error.
Describes modifications to the list of create volume permissions for a volume.
+ *Describes the credit option for CPU usage of a burstable performance instance.
*/ -export interface CreateVolumePermissionModifications { +export interface InstanceCreditSpecificationRequest { /** - *Adds the specified AWS account ID or group to the list.
+ *The ID of the instance.
*/ - Add?: CreateVolumePermission[]; + InstanceId?: string; /** - *Removes the specified AWS account ID or group from the list.
+ *The credit option for CPU usage of the instance. Valid values are
+ * standard and unlimited.
The snapshot attribute to modify. Only volume creation permissions can be modified.
- */ - Attribute?: SnapshotAttributeName | string; - - /** - *A JSON representation of the snapshot attribute modification.
- */ - CreateVolumePermission?: CreateVolumePermissionModifications; - - /** - *The group to modify for the snapshot.
- */ - GroupNames?: string[]; - - /** - *The type of operation to perform to the attribute.
- */ - OperationType?: OperationType | string; - +export interface ModifyInstanceCreditSpecificationRequest { /** - *The ID of the snapshot.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The account ID to modify for the snapshot.
+ *A unique, case-sensitive token that you provide to ensure idempotency of your + * modification request. For more information, see Ensuring + * Idempotency.
*/ - UserIds?: string[]; + ClientToken?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the credit option for CPU usage.
*/ - DryRun?: boolean; + InstanceCreditSpecifications: InstanceCreditSpecificationRequest[] | undefined; } -export namespace ModifySnapshotAttributeRequest { +export namespace ModifyInstanceCreditSpecificationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifySnapshotAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyInstanceCreditSpecificationRequest): any => ({ ...obj, }); } /** - *Contains the parameters for ModifySpotFleetRequest.
+ *Describes the burstable performance instance whose credit option for CPU usage was + * successfully modified.
*/ -export interface ModifySpotFleetRequestRequest { - /** - *Indicates whether running Spot Instances should be terminated if the target capacity - * of the Spot Fleet request is decreased below the current size of the Spot Fleet.
- */ - ExcessCapacityTerminationPolicy?: ExcessCapacityTerminationPolicy | string; - +export interface SuccessfulInstanceCreditSpecificationItem { /** - *The launch template and overrides. You can only use this parameter if you specified a
- * launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you
- * specified LaunchSpecifications in your Spot Fleet request, then omit this
- * parameter.
The ID of the instance.
*/ - LaunchTemplateConfigs?: LaunchTemplateConfig[]; + InstanceId?: string; +} +export namespace SuccessfulInstanceCreditSpecificationItem { /** - *The ID of the Spot Fleet request.
+ * @internal */ - SpotFleetRequestId: string | undefined; + export const filterSensitiveLog = (obj: SuccessfulInstanceCreditSpecificationItem): any => ({ + ...obj, + }); +} - /** - *The size of the fleet.
- */ - TargetCapacity?: number; +export enum UnsuccessfulInstanceCreditSpecificationErrorCode { + INCORRECT_INSTANCE_STATE = "IncorrectInstanceState", + INSTANCE_CREDIT_SPECIFICATION_NOT_SUPPORTED = "InstanceCreditSpecification.NotSupported", + INSTANCE_NOT_FOUND = "InvalidInstanceID.NotFound", + INVALID_INSTANCE_ID = "InvalidInstanceID.Malformed", +} +/** + *Information about the error for the burstable performance instance whose credit option + * for CPU usage was not modified.
+ */ +export interface UnsuccessfulInstanceCreditSpecificationItemError { /** - *The number of On-Demand Instances in the fleet.
+ *The error code.
*/ - OnDemandTargetCapacity?: number; + Code?: UnsuccessfulInstanceCreditSpecificationErrorCode | string; /** - *Reserved.
+ *The applicable error message.
*/ - Context?: string; + Message?: string; } -export namespace ModifySpotFleetRequestRequest { +export namespace UnsuccessfulInstanceCreditSpecificationItemError { /** * @internal */ - export const filterSensitiveLog = (obj: ModifySpotFleetRequestRequest): any => ({ + export const filterSensitiveLog = (obj: UnsuccessfulInstanceCreditSpecificationItemError): any => ({ ...obj, }); } /** - *Contains the output of ModifySpotFleetRequest.
+ *Describes the burstable performance instance whose credit option for CPU usage was not + * modified.
*/ -export interface ModifySpotFleetRequestResponse { +export interface UnsuccessfulInstanceCreditSpecificationItem { /** - *Is true if the request succeeds, and an error otherwise.
The ID of the instance.
*/ - Return?: boolean; + InstanceId?: string; + + /** + *The applicable error for the burstable performance instance whose credit option for + * CPU usage was not modified.
+ */ + Error?: UnsuccessfulInstanceCreditSpecificationItemError; } -export namespace ModifySpotFleetRequestResponse { +export namespace UnsuccessfulInstanceCreditSpecificationItem { /** * @internal */ - export const filterSensitiveLog = (obj: ModifySpotFleetRequestResponse): any => ({ + export const filterSensitiveLog = (obj: UnsuccessfulInstanceCreditSpecificationItem): any => ({ ...obj, }); } -export interface ModifySubnetAttributeRequest { - /** - *Specify true to indicate that network interfaces created in the
- * specified subnet should be assigned an IPv6 address. This includes a network interface
- * that's created when launching an instance into the subnet (the instance therefore
- * receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface
- * or instance only receives an IPv6 address if it's created using version
- * 2016-11-15 or later of the Amazon EC2 API.
Specify true to indicate that network interfaces attached to instances created in the
- * specified subnet should be assigned a public IPv4 address.
The ID of the subnet.
- */ - SubnetId: string | undefined; - +export interface ModifyInstanceCreditSpecificationResult { /** - *Specify true to indicate that network interfaces attached to instances created in the
- * specified subnet should be assigned a customer-owned IPv4 address.
When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.
Information about the instances whose credit option for CPU usage was successfully + * modified.
*/ - MapCustomerOwnedIpOnLaunch?: AttributeBooleanValue; + SuccessfulInstanceCreditSpecifications?: SuccessfulInstanceCreditSpecificationItem[]; /** - *The customer-owned IPv4 address pool associated with the subnet.
- *You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.
Information about the instances whose credit option for CPU usage was not + * modified.
*/ - CustomerOwnedIpv4Pool?: string; + UnsuccessfulInstanceCreditSpecifications?: UnsuccessfulInstanceCreditSpecificationItem[]; } -export namespace ModifySubnetAttributeRequest { +export namespace ModifyInstanceCreditSpecificationResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifySubnetAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyInstanceCreditSpecificationResult): any => ({ ...obj, }); } -export interface ModifyTrafficMirrorFilterNetworkServicesRequest { +export interface ModifyInstanceEventStartTimeRequest { /** - *The ID of the Traffic Mirror filter.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The network service, for example Amazon DNS, that you want to mirror.
+ *The ID of the instance with the scheduled event.
*/ - AddNetworkServices?: (TrafficMirrorNetworkService | string)[]; + InstanceId: string | undefined; /** - *The network service, for example Amazon DNS, that you no longer want to mirror.
+ *The ID of the event whose date and time you are modifying.
*/ - RemoveNetworkServices?: (TrafficMirrorNetworkService | string)[]; + InstanceEventId: string | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The new date and time when the event will take place.
*/ - DryRun?: boolean; + NotBefore: Date | undefined; } -export namespace ModifyTrafficMirrorFilterNetworkServicesRequest { +export namespace ModifyInstanceEventStartTimeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterNetworkServicesRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyInstanceEventStartTimeRequest): any => ({ ...obj, }); } -export interface ModifyTrafficMirrorFilterNetworkServicesResult { +export interface ModifyInstanceEventStartTimeResult { /** - *The Traffic Mirror filter that the network service is associated with.
+ *Describes a scheduled event for an instance.
*/ - TrafficMirrorFilter?: TrafficMirrorFilter; + Event?: InstanceStatusEvent; } -export namespace ModifyTrafficMirrorFilterNetworkServicesResult { +export namespace ModifyInstanceEventStartTimeResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterNetworkServicesResult): any => ({ + export const filterSensitiveLog = (obj: ModifyInstanceEventStartTimeResult): any => ({ ...obj, }); } -export type TrafficMirrorFilterRuleField = "description" | "destination-port-range" | "protocol" | "source-port-range"; +export interface ModifyInstanceEventWindowRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the Traffic Mirror rule.
+ *The name of the event window.
*/ - TrafficMirrorFilterRuleId: string | undefined; + Name?: string; /** - *The type of traffic (ingress | egress) to assign to the rule.
The ID of the event window.
*/ - TrafficDirection?: TrafficDirection | string; + InstanceEventWindowId: string | undefined; /** - *The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given - * direction. The rules are processed in ascending order by rule number.
+ *The time ranges of the event window.
*/ - RuleNumber?: number; + TimeRanges?: InstanceEventWindowTimeRangeRequest[]; /** - *The action to assign to the rule.
+ *The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.
Constraints:
+ *Only hour and day of the week values are supported.
+ *For day of the week values, you can specify either integers 0 through
+ * 6, or alternative single values SUN through
+ * SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or
+ * 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or
+ * 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event + * window must be >= 4 hours.
+ *For more information about cron expressions, see cron on the Wikipedia + * website.
*/ - RuleAction?: TrafficMirrorRuleAction | string; + CronExpression?: string; +} +export namespace ModifyInstanceEventWindowRequest { /** - *The destination ports that are associated with the Traffic Mirror rule.
+ * @internal */ - DestinationPortRange?: TrafficMirrorPortRangeRequest; + export const filterSensitiveLog = (obj: ModifyInstanceEventWindowRequest): any => ({ + ...obj, + }); +} +export interface ModifyInstanceEventWindowResult { /** - *The port range to assign to the Traffic Mirror rule.
+ *Information about the event window.
*/ - SourcePortRange?: TrafficMirrorPortRangeRequest; + InstanceEventWindow?: InstanceEventWindow; +} +export namespace ModifyInstanceEventWindowResult { /** - *The protocol, for example TCP, to assign to the Traffic Mirror rule.
+ * @internal */ - Protocol?: number; + export const filterSensitiveLog = (obj: ModifyInstanceEventWindowResult): any => ({ + ...obj, + }); +} +export interface ModifyInstanceMetadataOptionsRequest { /** - *The destination CIDR block to assign to the Traffic Mirror rule.
+ *The ID of the instance.
*/ - DestinationCidrBlock?: string; + InstanceId: string | undefined; /** - *The source CIDR block to assign to the Traffic Mirror rule.
+ *The state of token usage for your instance metadata requests. If the parameter is not
+ * specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata
+ * with or without a signed token header on your request. If you retrieve the IAM role
+ * credentials without a token, the version 1.0 role credentials are returned. If you
+ * retrieve the IAM role credentials using a valid signed token, the version 2.0 role
+ * credentials are returned.
If the state is required, you must send a signed token header with any
+ * instance metadata retrieval requests. In this state, retrieving the IAM role credential
+ * always returns the version 2.0 credentials; the version 1.0 credentials are not
+ * available.
The description to assign to the Traffic Mirror rule.
+ *The desired HTTP PUT response hop limit for instance metadata requests. The larger the + * number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
+ *Possible values: Integers from 1 to 64
*/ - Description?: string; + HttpPutResponseHopLimit?: number; /** - *The properties that you want to remove from the Traffic Mirror filter rule.
- *When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
+ *This parameter enables or disables the HTTP metadata endpoint on your instances. If + * the parameter is not specified, the existing state is maintained.
+ *If you specify a value of disabled, you will not be able to access your
+ * instance metadata.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Modifies a Traffic Mirror rule.
+ *The ID of the instance.
*/ - TrafficMirrorFilterRule?: TrafficMirrorFilterRule; + InstanceId?: string; + + /** + *The metadata options for the instance.
+ */ + InstanceMetadataOptions?: InstanceMetadataOptionsResponse; } -export namespace ModifyTrafficMirrorFilterRuleResult { +export namespace ModifyInstanceMetadataOptionsResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterRuleResult): any => ({ + export const filterSensitiveLog = (obj: ModifyInstanceMetadataOptionsResult): any => ({ ...obj, }); } -export type TrafficMirrorSessionField = "description" | "packet-length" | "virtual-network-id"; - -export interface ModifyTrafficMirrorSessionRequest { - /** - *The ID of the Traffic Mirror session.
- */ - TrafficMirrorSessionId: string | undefined; - - /** - *The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.
- */ - TrafficMirrorTargetId?: string; +export type HostTenancy = "dedicated" | "host"; +export interface ModifyInstancePlacementRequest { /** - *The ID of the Traffic Mirror filter.
+ *The affinity setting for the instance.
*/ - TrafficMirrorFilterId?: string; + Affinity?: Affinity | string; /** - *The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.
+ *The name of the placement group in which to place the instance. For spread placement
+ * groups, the instance must have a tenancy of default. For cluster and
+ * partition placement groups, the instance must have a tenancy of default or
+ * dedicated.
To remove an instance from a placement group, specify an empty string + * ("").
*/ - PacketLength?: number; + GroupName?: string; /** - *The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
- *Valid values are 1-32766.
+ *The ID of the Dedicated Host with which to associate the instance.
*/ - SessionNumber?: number; + HostId?: string; /** - *The virtual network ID of the Traffic Mirror session.
+ *The ID of the instance that you are modifying.
*/ - VirtualNetworkId?: number; + InstanceId: string | undefined; /** - *The description to assign to the Traffic Mirror session.
+ *The tenancy for the instance.
*/ - Description?: string; + Tenancy?: HostTenancy | string; /** - *The properties that you want to remove from the Traffic Mirror session.
- *When you remove a property from a Traffic Mirror session, the property is set to the default.
+ *Reserved for future use.
*/ - RemoveFields?: (TrafficMirrorSessionField | string)[]; + PartitionNumber?: number; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ARN of the host resource group in which to place the instance.
*/ - DryRun?: boolean; + HostResourceGroupArn?: string; } -export namespace ModifyTrafficMirrorSessionRequest { +export namespace ModifyInstancePlacementRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTrafficMirrorSessionRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyInstancePlacementRequest): any => ({ ...obj, }); } -export interface ModifyTrafficMirrorSessionResult { +export interface ModifyInstancePlacementResult { /** - *Information about the Traffic Mirror session.
+ *Is true if the request succeeds, and an error otherwise.
The transit gateway options.
- */ -export interface ModifyTransitGatewayOptions { - /** - *Adds IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
- */ - AddTransitGatewayCidrBlocks?: string[]; - - /** - *Removes CIDR blocks for the transit gateway.
- */ - RemoveTransitGatewayCidrBlocks?: string[]; - - /** - *Enable or disable Equal Cost Multipath Protocol support.
- */ - VpnEcmpSupport?: VpnEcmpSupportValue | string; - - /** - *Enable or disable DNS support.
- */ - DnsSupport?: DnsSupportValue | string; - +export interface ModifyLaunchTemplateRequest { /** - *Enable or disable automatic acceptance of attachment requests.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Enable or disable automatic association with the default association route table.
+ *Unique, case-sensitive identifier you provide to ensure the idempotency of the + * request. For more information, see Ensuring + * Idempotency.
+ *Constraint: Maximum 128 ASCII characters.
*/ - DefaultRouteTableAssociation?: DefaultRouteTableAssociationValue | string; + ClientToken?: string; /** - *The ID of the default association route table.
+ *The ID of the launch template. You must specify either the launch template ID or + * launch template name in the request.
*/ - AssociationDefaultRouteTableId?: string; + LaunchTemplateId?: string; /** - *Enable or disable automatic propagation of routes to the default propagation route table.
+ *The name of the launch template. You must specify either the launch template ID or + * launch template name in the request.
*/ - DefaultRouteTablePropagation?: DefaultRouteTablePropagationValue | string; + LaunchTemplateName?: string; /** - *The ID of the default propagation route table.
+ *The version number of the launch template to set as the default version.
*/ - PropagationDefaultRouteTableId?: string; + DefaultVersion?: string; } -export namespace ModifyTransitGatewayOptions { +export namespace ModifyLaunchTemplateRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTransitGatewayOptions): any => ({ + export const filterSensitiveLog = (obj: ModifyLaunchTemplateRequest): any => ({ ...obj, }); } -export interface ModifyTransitGatewayRequest { - /** - *The ID of the transit gateway.
- */ - TransitGatewayId: string | undefined; - - /** - *The description for the transit gateway.
- */ - Description?: string; - - /** - *The options to modify.
- */ - Options?: ModifyTransitGatewayOptions; - +export interface ModifyLaunchTemplateResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the launch template.
*/ - DryRun?: boolean; + LaunchTemplate?: LaunchTemplate; } -export namespace ModifyTransitGatewayRequest { +export namespace ModifyLaunchTemplateResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTransitGatewayRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyLaunchTemplateResult): any => ({ ...obj, }); } -export interface ModifyTransitGatewayResult { +/** + *An entry for a prefix list.
+ */ +export interface RemovePrefixListEntry { /** - *Describes a transit gateway.
+ *The CIDR block.
*/ - TransitGateway?: TransitGateway; + Cidr: string | undefined; } -export namespace ModifyTransitGatewayResult { +export namespace RemovePrefixListEntry { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTransitGatewayResult): any => ({ + export const filterSensitiveLog = (obj: RemovePrefixListEntry): any => ({ ...obj, }); } -export interface ModifyTransitGatewayPrefixListReferenceRequest { +export interface ModifyManagedPrefixListRequest { /** - *The ID of the transit gateway route table.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the prefix list.
@@ -7245,254 +7368,283 @@ export interface ModifyTransitGatewayPrefixListReferenceRequest { PrefixListId: string | undefined; /** - *The ID of the attachment to which traffic is routed.
+ *The current version of the prefix list.
*/ - TransitGatewayAttachmentId?: string; + CurrentVersion?: number; /** - *Indicates whether to drop traffic that matches this route.
+ *A name for the prefix list.
*/ - Blackhole?: boolean; + PrefixListName?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more entries to add to the prefix list.
*/ - DryRun?: boolean; + AddEntries?: AddPrefixListEntry[]; + + /** + *One or more entries to remove from the prefix list.
+ */ + RemoveEntries?: RemovePrefixListEntry[]; } -export namespace ModifyTransitGatewayPrefixListReferenceRequest { +export namespace ModifyManagedPrefixListRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTransitGatewayPrefixListReferenceRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyManagedPrefixListRequest): any => ({ ...obj, }); } -export interface ModifyTransitGatewayPrefixListReferenceResult { +export interface ModifyManagedPrefixListResult { /** - *Information about the prefix list reference.
+ *Information about the prefix list.
*/ - TransitGatewayPrefixListReference?: TransitGatewayPrefixListReference; + PrefixList?: ManagedPrefixList; } -export namespace ModifyTransitGatewayPrefixListReferenceResult { +export namespace ModifyManagedPrefixListResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTransitGatewayPrefixListReferenceResult): any => ({ + export const filterSensitiveLog = (obj: ModifyManagedPrefixListResult): any => ({ ...obj, }); } /** - *Describes the options for a VPC attachment.
+ *Describes an attachment change.
*/ -export interface ModifyTransitGatewayVpcAttachmentRequestOptions { - /** - *Enable or disable DNS support. The default is enable.
Enable or disable IPv6 support. The default is enable.
The ID of the network interface attachment.
*/ - Ipv6Support?: Ipv6SupportValue | string; + AttachmentId?: string; /** - *Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.
Indicates whether the network interface is deleted when the instance is terminated.
*/ - ApplianceModeSupport?: ApplianceModeSupportValue | string; + DeleteOnTermination?: boolean; } -export namespace ModifyTransitGatewayVpcAttachmentRequestOptions { +export namespace NetworkInterfaceAttachmentChanges { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTransitGatewayVpcAttachmentRequestOptions): any => ({ + export const filterSensitiveLog = (obj: NetworkInterfaceAttachmentChanges): any => ({ ...obj, }); } -export interface ModifyTransitGatewayVpcAttachmentRequest { +/** + *Contains the parameters for ModifyNetworkInterfaceAttribute.
+ */ +export interface ModifyNetworkInterfaceAttributeRequest { /** - *The ID of the attachment.
+ *Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
*/ - TransitGatewayAttachmentId: string | undefined; + Attachment?: NetworkInterfaceAttachmentChanges; /** - *The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
+ *A description for the network interface.
*/ - AddSubnetIds?: string[]; + Description?: AttributeValue; /** - *The IDs of one or more subnets to remove.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The new VPC attachment options.
- *You cannot modify the IPv6 options.
- *Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
*/ - Options?: ModifyTransitGatewayVpcAttachmentRequestOptions; + Groups?: string[]; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the network interface.
*/ - DryRun?: boolean; + NetworkInterfaceId: string | undefined; + + /** + *Enable or disable source/destination checks, which ensure that the instance
+ * is either the source or the destination of any traffic that it receives.
+ * If the value is true, source/destination checks are enabled;
+ * otherwise, they are disabled. The default value is true.
+ * You must disable source/destination checks if the instance runs services
+ * such as network address translation, routing, or firewalls.
Contains the parameters for ModifyReservedInstances.
+ */ +export interface ModifyReservedInstancesRequest { /** - *Information about the modified attachment.
+ *The IDs of the Reserved Instances to modify.
*/ - TransitGatewayVpcAttachment?: TransitGatewayVpcAttachment; + ReservedInstancesIds: string[] | undefined; + + /** + *A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see + * Ensuring Idempotency.
+ */ + ClientToken?: string; + + /** + *The configuration settings for the Reserved Instances to modify.
+ */ + TargetConfigurations: ReservedInstancesConfiguration[] | undefined; } -export namespace ModifyTransitGatewayVpcAttachmentResult { +export namespace ModifyReservedInstancesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTransitGatewayVpcAttachmentResult): any => ({ + export const filterSensitiveLog = (obj: ModifyReservedInstancesRequest): any => ({ ...obj, }); } -export interface ModifyVolumeRequest { +/** + *Contains the output of ModifyReservedInstances.
+ */ +export interface ModifyReservedInstancesResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID for the modification.
*/ - DryRun?: boolean; + ReservedInstancesModificationId?: string; +} +export namespace ModifyReservedInstancesResult { /** - *The ID of the volume.
+ * @internal */ - VolumeId: string | undefined; + export const filterSensitiveLog = (obj: ModifyReservedInstancesResult): any => ({ + ...obj, + }); +} + +/** + *Describes a security group rule.
+ *You must specify exactly one of the following parameters, based on the rule type:
+ *CidrIpv4
+ *CidrIpv6
+ *PrefixListId
+ *ReferencedGroupId
+ *When you modify a rule, you cannot change the rule type. For example, if the rule
+ * uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4
+ * address range.
The IP protocol name (tcp, udp, icmp,
+ * icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
The target size of the volume, in GiB. The target volume size must be greater than or - * equal to the existing size of the volume.
- *The following are the supported volumes sizes for each volume type:
- *
- * gp2 and gp3: 1-16,384
- * io1 and io2: 4-16,384
- * st1 and sc1: 125-16,384
- * standard: 1-1,024
Default: If no size is specified, the existing size is retained.
+ *The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
*/ - Size?: number; + FromPort?: number; /** - *The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
- *Default: If no type is specified, the existing type is retained.
+ *The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.
The following are the supported values for each volume type:
- *
- * gp3: 3,000-16,000 IOPS
- * io1: 100-64,000 IOPS
- * io2: 100-64,000 IOPS
Default: If no IOPS value is specified, the existing value is retained, unless a volume type is modified that supports different values.
+ *The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
+ */ + CidrIpv4?: string; + + /** + *The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
+ */ + CidrIpv6?: string; + + /** + *The ID of the prefix list.
*/ - Iops?: number; + PrefixListId?: string; /** - *The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes.
- * The maximum value is 1,000.
Default: If no throughput value is specified, the existing value is retained.
- *Valid Range: Minimum value of 125. Maximum value of 1000.
+ *The ID of the security group that is referenced in the security group rule.
*/ - Throughput?: number; + ReferencedGroupId?: string; /** - *Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the
- * volume to up to 16
- * Nitro-based instances in the same Availability Zone. This parameter is
- * supported with io1 and io2 volumes only. For more information, see
- *
- * Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.
The description of the security group rule.
*/ - MultiAttachEnabled?: boolean; + Description?: string; } -export namespace ModifyVolumeRequest { +export namespace SecurityGroupRuleRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVolumeRequest): any => ({ + export const filterSensitiveLog = (obj: SecurityGroupRuleRequest): any => ({ ...obj, }); } -export interface ModifyVolumeResult { +/** + *Describes an update to a security group rule.
+ */ +export interface SecurityGroupRuleUpdate { /** - *Information about the volume modification.
+ *The ID of the security group rule.
*/ - VolumeModification?: VolumeModification; + SecurityGroupRuleId?: string; + + /** + *Information about the security group rule.
+ */ + SecurityGroupRule?: SecurityGroupRuleRequest; } -export namespace ModifyVolumeResult { +export namespace SecurityGroupRuleUpdate { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVolumeResult): any => ({ + export const filterSensitiveLog = (obj: SecurityGroupRuleUpdate): any => ({ ...obj, }); } -export interface ModifyVolumeAttributeRequest { +export interface ModifySecurityGroupRulesRequest { /** - *Indicates whether the volume should be auto-enabled for I/O operations.
+ *The ID of the security group.
*/ - AutoEnableIO?: AttributeBooleanValue; + GroupId: string | undefined; /** - *The ID of the volume.
+ *Information about the security group properties to update.
*/ - VolumeId: string | undefined; + SecurityGroupRules: SecurityGroupRuleUpdate[] | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -7502,446 +7654,564 @@ export interface ModifyVolumeAttributeRequest { DryRun?: boolean; } -export namespace ModifyVolumeAttributeRequest { +export namespace ModifySecurityGroupRulesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVolumeAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: ModifySecurityGroupRulesRequest): any => ({ ...obj, }); } -export interface ModifyVpcAttributeRequest { +export interface ModifySecurityGroupRulesResult { /** - *
Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
- *You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.
+ *Returns true if the request succeeds; otherwise, returns an error.
Describes modifications to the list of create volume permissions for a volume.
+ */ +export interface CreateVolumePermissionModifications { /** - *Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to - * the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP - * address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon - * provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is - * not enabled.
- *You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
+ *Adds the specified AWS account ID or group to the list.
*/ - EnableDnsSupport?: AttributeBooleanValue; + Add?: CreateVolumePermission[]; /** - *The ID of the VPC.
+ *Removes the specified AWS account ID or group from the list.
*/ - VpcId: string | undefined; + Remove?: CreateVolumePermission[]; } -export namespace ModifyVpcAttributeRequest { +export namespace CreateVolumePermissionModifications { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: CreateVolumePermissionModifications): any => ({ ...obj, }); } -/** - *Contains the parameters for ModifyVpcEndpoint.
- */ -export interface ModifyVpcEndpointRequest { +export interface ModifySnapshotAttributeRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The snapshot attribute to modify. Only volume creation permissions can be modified.
*/ - DryRun?: boolean; + Attribute?: SnapshotAttributeName | string; /** - *The ID of the endpoint.
+ *A JSON representation of the snapshot attribute modification.
*/ - VpcEndpointId: string | undefined; + CreateVolumePermission?: CreateVolumePermissionModifications; /** - *(Gateway endpoint) Specify true to reset the policy document to the
- * default policy. The default policy allows full access to the service.
The group to modify for the snapshot.
*/ - ResetPolicy?: boolean; + GroupNames?: string[]; /** - *(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must - * be in valid JSON format.
+ *The type of operation to perform to the attribute.
*/ - PolicyDocument?: string; + OperationType?: OperationType | string; /** - *(Gateway endpoint) One or more route tables IDs to associate with the endpoint.
+ *The ID of the snapshot.
*/ - AddRouteTableIds?: string[]; + SnapshotId: string | undefined; /** - *(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
+ *The account ID to modify for the snapshot.
*/ - RemoveRouteTableIds?: string[]; + UserIds?: string[]; /** - *(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
(Interface endpoint) One or more subnets IDs in which to remove the endpoint.
+ * @internal */ - RemoveSubnetIds?: string[]; + export const filterSensitiveLog = (obj: ModifySnapshotAttributeRequest): any => ({ + ...obj, + }); +} +/** + *Contains the parameters for ModifySpotFleetRequest.
+ */ +export interface ModifySpotFleetRequestRequest { /** - *(Interface endpoint) One or more security group IDs to associate with the network interface.
+ *Indicates whether running Spot Instances should be terminated if the target capacity + * of the Spot Fleet request is decreased below the current size of the Spot Fleet.
*/ - AddSecurityGroupIds?: string[]; + ExcessCapacityTerminationPolicy?: ExcessCapacityTerminationPolicy | string; /** - *(Interface endpoint) One or more security group IDs to disassociate from the network interface.
+ *The launch template and overrides. You can only use this parameter if you specified a
+ * launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you
+ * specified LaunchSpecifications in your Spot Fleet request, then omit this
+ * parameter.
(Interface endpoint) Indicates whether a private hosted zone is associated with the - * VPC.
+ *The ID of the Spot Fleet request.
*/ - PrivateDnsEnabled?: boolean; + SpotFleetRequestId: string | undefined; + + /** + *The size of the fleet.
+ */ + TargetCapacity?: number; + + /** + *The number of On-Demand Instances in the fleet.
+ */ + OnDemandTargetCapacity?: number; + + /** + *Reserved.
+ */ + Context?: string; } -export namespace ModifyVpcEndpointRequest { +export namespace ModifySpotFleetRequestRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcEndpointRequest): any => ({ + export const filterSensitiveLog = (obj: ModifySpotFleetRequestRequest): any => ({ ...obj, }); } -export interface ModifyVpcEndpointResult { +/** + *Contains the output of ModifySpotFleetRequest.
+ */ +export interface ModifySpotFleetRequestResponse { /** - *Returns true if the request succeeds; otherwise, it returns an error.
Is true if the request succeeds, and an error otherwise.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Specify true to indicate that network interfaces created in the
+ * specified subnet should be assigned an IPv6 address. This includes a network interface
+ * that's created when launching an instance into the subnet (the instance therefore
+ * receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface
+ * or instance only receives an IPv6 address if it's created using version
+ * 2016-11-15 or later of the Amazon EC2 API.
The ID of the notification.
+ *Specify true to indicate that network interfaces attached to instances created in the
+ * specified subnet should be assigned a public IPv4 address.
The ARN for the SNS topic for the notification.
+ *The ID of the subnet.
*/ - ConnectionNotificationArn?: string; + SubnetId: string | undefined; /** - *One or more events for the endpoint. Valid values are Accept,
- * Connect, Delete, and Reject.
Specify true to indicate that network interfaces attached to instances created in the
+ * specified subnet should be assigned a customer-owned IPv4 address.
When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.
The customer-owned IPv4 address pool associated with the subnet.
+ *You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.
The ID of the Traffic Mirror filter.
+ */ + TrafficMirrorFilterId: string | undefined; + + /** + *The network service, for example Amazon DNS, that you want to mirror.
+ */ + AddNetworkServices?: (TrafficMirrorNetworkService | string)[]; + + /** + *The network service, for example Amazon DNS, that you no longer want to mirror.
+ */ + RemoveNetworkServices?: (TrafficMirrorNetworkService | string)[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
The Traffic Mirror filter that the network service is associated with.
*/ - ReturnValue?: boolean; + TrafficMirrorFilter?: TrafficMirrorFilter; } -export namespace ModifyVpcEndpointConnectionNotificationResult { +export namespace ModifyTrafficMirrorFilterNetworkServicesResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcEndpointConnectionNotificationResult): any => ({ + export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterNetworkServicesResult): any => ({ ...obj, }); } -export interface ModifyVpcEndpointServiceConfigurationRequest { +export type TrafficMirrorFilterRuleField = "description" | "destination-port-range" | "protocol" | "source-port-range"; + +export interface ModifyTrafficMirrorFilterRuleRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the Traffic Mirror rule.
*/ - DryRun?: boolean; + TrafficMirrorFilterRuleId: string | undefined; /** - *The ID of the service.
+ *The type of traffic (ingress | egress) to assign to the rule.
(Interface endpoint configuration) The private DNS name to assign to the endpoint service.
+ *The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given + * direction. The rules are processed in ascending order by rule number.
*/ - PrivateDnsName?: string; + RuleNumber?: number; /** - *(Interface endpoint configuration) Removes the private DNS name of the endpoint service.
+ *The action to assign to the rule.
*/ - RemovePrivateDnsName?: boolean; + RuleAction?: TrafficMirrorRuleAction | string; /** - *Indicates whether requests to create an endpoint to your service must be accepted.
+ *The destination ports that are associated with the Traffic Mirror rule.
*/ - AcceptanceRequired?: boolean; + DestinationPortRange?: TrafficMirrorPortRangeRequest; /** - *The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service - * configuration.
+ *The port range to assign to the Traffic Mirror rule.
*/ - AddNetworkLoadBalancerArns?: string[]; + SourcePortRange?: TrafficMirrorPortRangeRequest; /** - *The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service - * configuration.
+ *The protocol, for example TCP, to assign to the Traffic Mirror rule.
*/ - RemoveNetworkLoadBalancerArns?: string[]; + Protocol?: number; /** - *The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service - * configuration.
+ *The destination CIDR block to assign to the Traffic Mirror rule.
*/ - AddGatewayLoadBalancerArns?: string[]; + DestinationCidrBlock?: string; /** - *The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service - * configuration.
+ *The source CIDR block to assign to the Traffic Mirror rule.
*/ - RemoveGatewayLoadBalancerArns?: string[]; + SourceCidrBlock?: string; + + /** + *The description to assign to the Traffic Mirror rule.
+ */ + Description?: string; + + /** + *The properties that you want to remove from the Traffic Mirror filter rule.
+ *When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
+ */ + RemoveFields?: (TrafficMirrorFilterRuleField | string)[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
Modifies a Traffic Mirror rule.
*/ - Return?: boolean; + TrafficMirrorFilterRule?: TrafficMirrorFilterRule; } -export namespace ModifyVpcEndpointServiceConfigurationResult { +export namespace ModifyTrafficMirrorFilterRuleResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcEndpointServiceConfigurationResult): any => ({ + export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterRuleResult): any => ({ ...obj, }); } -export interface ModifyVpcEndpointServicePermissionsRequest { +export type TrafficMirrorSessionField = "description" | "packet-length" | "virtual-network-id"; + +export interface ModifyTrafficMirrorSessionRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the Traffic Mirror session.
*/ - DryRun?: boolean; + TrafficMirrorSessionId: string | undefined; /** - *The ID of the service.
+ *The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.
*/ - ServiceId: string | undefined; + TrafficMirrorTargetId?: string; /** - *The Amazon Resource Names (ARN) of one or more principals. - * Permissions are granted to the principals in this list. - * To grant permissions to all principals, specify an asterisk (*).
+ *The ID of the Traffic Mirror filter.
*/ - AddAllowedPrincipals?: string[]; + TrafficMirrorFilterId?: string; /** - *The Amazon Resource Names (ARN) of one or more principals. - * Permissions are revoked for principals in this list.
+ *The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.
*/ - RemoveAllowedPrincipals?: string[]; + PacketLength?: number; + + /** + *The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
+ *Valid values are 1-32766.
+ */ + SessionNumber?: number; + + /** + *The virtual network ID of the Traffic Mirror session.
+ */ + VirtualNetworkId?: number; + + /** + *The description to assign to the Traffic Mirror session.
+ */ + Description?: string; + + /** + *The properties that you want to remove from the Traffic Mirror session.
+ *When you remove a property from a Traffic Mirror session, the property is set to the default.
+ */ + RemoveFields?: (TrafficMirrorSessionField | string)[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
Information about the Traffic Mirror session.
*/ - ReturnValue?: boolean; + TrafficMirrorSession?: TrafficMirrorSession; } -export namespace ModifyVpcEndpointServicePermissionsResult { +export namespace ModifyTrafficMirrorSessionResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcEndpointServicePermissionsResult): any => ({ + export const filterSensitiveLog = (obj: ModifyTrafficMirrorSessionResult): any => ({ ...obj, }); } /** - *The VPC peering connection options.
+ *The transit gateway options.
*/ -export interface PeeringConnectionOptionsRequest { +export interface ModifyTransitGatewayOptions { /** - *If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
+ *Adds IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
*/ - AllowDnsResolutionFromRemoteVpc?: boolean; + AddTransitGatewayCidrBlocks?: string[]; /** - *If true, enables outbound communication from an EC2-Classic instance that's linked to - * a local VPC using ClassicLink to instances in a peer VPC.
+ *Removes CIDR blocks for the transit gateway.
*/ - AllowEgressFromLocalClassicLinkToRemoteVpc?: boolean; + RemoveTransitGatewayCidrBlocks?: string[]; /** - *If true, enables outbound communication from instances in a local VPC to an - * EC2-Classic instance that's linked to a peer VPC using ClassicLink.
+ *Enable or disable Equal Cost Multipath Protocol support.
*/ - AllowEgressFromLocalVpcToRemoteClassicLink?: boolean; -} + VpnEcmpSupport?: VpnEcmpSupportValue | string; -export namespace PeeringConnectionOptionsRequest { /** - * @internal + *Enable or disable DNS support.
*/ - export const filterSensitiveLog = (obj: PeeringConnectionOptionsRequest): any => ({ - ...obj, - }); -} + DnsSupport?: DnsSupportValue | string; -export interface ModifyVpcPeeringConnectionOptionsRequest { /** - *The VPC peering connection options for the accepter VPC.
+ *Enable or disable automatic acceptance of attachment requests.
*/ - AccepterPeeringConnectionOptions?: PeeringConnectionOptionsRequest; + AutoAcceptSharedAttachments?: AutoAcceptSharedAttachmentsValue | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Enable or disable automatic association with the default association route table.
*/ - DryRun?: boolean; + DefaultRouteTableAssociation?: DefaultRouteTableAssociationValue | string; /** - *The VPC peering connection options for the requester VPC.
+ *The ID of the default association route table.
*/ - RequesterPeeringConnectionOptions?: PeeringConnectionOptionsRequest; + AssociationDefaultRouteTableId?: string; /** - *The ID of the VPC peering connection.
+ *Enable or disable automatic propagation of routes to the default propagation route table.
*/ - VpcPeeringConnectionId: string | undefined; + DefaultRouteTablePropagation?: DefaultRouteTablePropagationValue | string; + + /** + *The ID of the default propagation route table.
+ */ + PropagationDefaultRouteTableId?: string; } -export namespace ModifyVpcPeeringConnectionOptionsRequest { +export namespace ModifyTransitGatewayOptions { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcPeeringConnectionOptionsRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyTransitGatewayOptions): any => ({ ...obj, }); } -/** - *Describes the VPC peering connection options.
- */ -export interface PeeringConnectionOptions { +export interface ModifyTransitGatewayRequest { /** - *If true, the public DNS hostnames of instances in the specified VPC resolve to private - * IP addresses when queried from instances in the peer VPC.
+ *The ID of the transit gateway.
*/ - AllowDnsResolutionFromRemoteVpc?: boolean; + TransitGatewayId: string | undefined; /** - *If true, enables outbound communication from an EC2-Classic instance that's linked to - * a local VPC using ClassicLink to instances in a peer VPC.
+ *The description for the transit gateway.
*/ - AllowEgressFromLocalClassicLinkToRemoteVpc?: boolean; + Description?: string; /** - *If true, enables outbound communication from instances in a local VPC to an - * EC2-Classic instance that's linked to a peer VPC using ClassicLink.
+ *The options to modify.
*/ - AllowEgressFromLocalVpcToRemoteClassicLink?: boolean; -} + Options?: ModifyTransitGatewayOptions; -export namespace PeeringConnectionOptions { /** - * @internal + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the VPC peering connection options for the accepter VPC.
+ * @internal */ - AccepterPeeringConnectionOptions?: PeeringConnectionOptions; + export const filterSensitiveLog = (obj: ModifyTransitGatewayRequest): any => ({ + ...obj, + }); +} +export interface ModifyTransitGatewayResult { /** - *Information about the VPC peering connection options for the requester VPC.
+ *Describes a transit gateway.
*/ - RequesterPeeringConnectionOptions?: PeeringConnectionOptions; + TransitGateway?: TransitGateway; } -export namespace ModifyVpcPeeringConnectionOptionsResult { +export namespace ModifyTransitGatewayResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcPeeringConnectionOptionsResult): any => ({ + export const filterSensitiveLog = (obj: ModifyTransitGatewayResult): any => ({ ...obj, }); } -export type VpcTenancy = "default"; +export interface ModifyTransitGatewayPrefixListReferenceRequest { + /** + *The ID of the transit gateway route table.
+ */ + TransitGatewayRouteTableId: string | undefined; -export interface ModifyVpcTenancyRequest { /** - *The ID of the VPC.
+ *The ID of the prefix list.
*/ - VpcId: string | undefined; + PrefixListId: string | undefined; /** - *The instance tenancy attribute for the VPC.
+ *The ID of the attachment to which traffic is routed.
*/ - InstanceTenancy: VpcTenancy | string | undefined; + TransitGatewayAttachmentId?: string; + + /** + *Indicates whether to drop traffic that matches this route.
+ */ + Blackhole?: boolean; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -7951,498 +8221,506 @@ export interface ModifyVpcTenancyRequest { DryRun?: boolean; } -export namespace ModifyVpcTenancyRequest { +export namespace ModifyTransitGatewayPrefixListReferenceRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcTenancyRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyTransitGatewayPrefixListReferenceRequest): any => ({ ...obj, }); } -export interface ModifyVpcTenancyResult { +export interface ModifyTransitGatewayPrefixListReferenceResult { /** - *
Returns true if the request succeeds; otherwise, returns an
- * error.
Information about the prefix list reference.
*/ - ReturnValue?: boolean; + TransitGatewayPrefixListReference?: TransitGatewayPrefixListReference; } -export namespace ModifyVpcTenancyResult { +export namespace ModifyTransitGatewayPrefixListReferenceResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpcTenancyResult): any => ({ + export const filterSensitiveLog = (obj: ModifyTransitGatewayPrefixListReferenceResult): any => ({ ...obj, }); } -export interface ModifyVpnConnectionRequest { +/** + *Describes the options for a VPC attachment.
+ */ +export interface ModifyTransitGatewayVpcAttachmentRequestOptions { /** - *The ID of the VPN connection.
+ *Enable or disable DNS support. The default is enable.
The ID of the transit gateway.
+ *Enable or disable IPv6 support. The default is enable.
The ID of the customer gateway at your end of the VPN connection.
+ *Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.
The ID of the virtual private gateway at the AWS side of the VPN connection.
+ * @internal */ - VpnGatewayId?: string; + export const filterSensitiveLog = (obj: ModifyTransitGatewayVpcAttachmentRequestOptions): any => ({ + ...obj, + }); +} + +export interface ModifyTransitGatewayVpcAttachmentRequest { + /** + *The ID of the attachment.
+ */ + TransitGatewayAttachmentId: string | undefined; + + /** + *The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
+ */ + AddSubnetIds?: string[]; + + /** + *The IDs of one or more subnets to remove.
+ */ + RemoveSubnetIds?: string[]; + + /** + *The new VPC attachment options.
+ *You cannot modify the IPv6 options.
+ *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
-export namespace ModifyVpnConnectionRequest {
+export namespace ModifyTransitGatewayVpcAttachmentRequest {
/**
* @internal
*/
- export const filterSensitiveLog = (obj: ModifyVpnConnectionRequest): any => ({
+ export const filterSensitiveLog = (obj: ModifyTransitGatewayVpcAttachmentRequest): any => ({
...obj,
});
}
-export interface ModifyVpnConnectionResult {
+export interface ModifyTransitGatewayVpcAttachmentResult {
/**
- * Describes a VPN connection.
+ *Information about the modified attachment.
*/ - VpnConnection?: VpnConnection; + TransitGatewayVpcAttachment?: TransitGatewayVpcAttachment; } -export namespace ModifyVpnConnectionResult { +export namespace ModifyTransitGatewayVpcAttachmentResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpnConnectionResult): any => ({ + export const filterSensitiveLog = (obj: ModifyTransitGatewayVpcAttachmentResult): any => ({ ...obj, }); } -export interface ModifyVpnConnectionOptionsRequest { +export interface ModifyVolumeRequest { /** - *The ID of the Site-to-Site VPN connection. - *
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
- *Default: 0.0.0.0/0
- *
The ID of the volume.
*/ - LocalIpv4NetworkCidr?: string; + VolumeId: string | undefined; /** - *The IPv4 CIDR on the AWS side of the VPN connection.
- *Default: 0.0.0.0/0
- *
The target size of the volume, in GiB. The target volume size must be greater than or + * equal to the existing size of the volume.
+ *The following are the supported volumes sizes for each volume type:
+ *
+ * gp2 and gp3: 1-16,384
+ * io1 and io2: 4-16,384
+ * st1 and sc1: 125-16,384
+ * standard: 1-1,024
Default: If no size is specified, the existing size is retained.
*/ - RemoteIpv4NetworkCidr?: string; + Size?: number; /** - *The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
- *Default: ::/0
- *
The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
+ *Default: If no type is specified, the existing type is retained.
*/ - LocalIpv6NetworkCidr?: string; + VolumeType?: VolumeType | string; /** - *The IPv6 CIDR on the AWS side of the VPN connection.
- *Default: ::/0
- *
The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.
The following are the supported values for each volume type:
+ *
+ * gp3: 3,000-16,000 IOPS
+ * io1: 100-64,000 IOPS
+ * io2: 100-64,000 IOPS
Default: If no IOPS value is specified, the existing value is retained, unless a volume type is modified that supports different values.
*/ - RemoteIpv6NetworkCidr?: string; + Iops?: number; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes.
+ * The maximum value is 1,000.
Default: If no throughput value is specified, the existing value is retained.
+ *Valid Range: Minimum value of 125. Maximum value of 1000.
*/ - DryRun?: boolean; + Throughput?: number; + + /** + *Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the
+ * volume to up to 16
+ * Nitro-based instances in the same Availability Zone. This parameter is
+ * supported with io1 and io2 volumes only. For more information, see
+ *
+ * Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.
Describes a VPN connection.
+ *Information about the volume modification.
*/ - VpnConnection?: VpnConnection; + VolumeModification?: VolumeModification; } -export namespace ModifyVpnConnectionOptionsResult { +export namespace ModifyVolumeResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpnConnectionOptionsResult): any => ({ + export const filterSensitiveLog = (obj: ModifyVolumeResult): any => ({ ...obj, }); } -export interface ModifyVpnTunnelCertificateRequest { +export interface ModifyVolumeAttributeRequest { /** - *The ID of the AWS Site-to-Site VPN connection.
+ *Indicates whether the volume should be auto-enabled for I/O operations.
*/ - VpnConnectionId: string | undefined; + AutoEnableIO?: AttributeBooleanValue; /** - *The external IP address of the VPN tunnel.
+ *The ID of the volume.
*/ - VpnTunnelOutsideIpAddress: string | undefined; + VolumeId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
-export namespace ModifyVpnTunnelCertificateRequest {
+export namespace ModifyVolumeAttributeRequest {
/**
* @internal
*/
- export const filterSensitiveLog = (obj: ModifyVpnTunnelCertificateRequest): any => ({
+ export const filterSensitiveLog = (obj: ModifyVolumeAttributeRequest): any => ({
...obj,
});
}
-export interface ModifyVpnTunnelCertificateResult {
+export interface ModifyVpcAttributeRequest {
/**
- * Describes a VPN connection.
+ *Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
+ *You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.
+ */ + EnableDnsHostnames?: AttributeBooleanValue; + + /** + *Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to + * the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP + * address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon + * provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is + * not enabled.
+ *You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
+ */ + EnableDnsSupport?: AttributeBooleanValue; + + /** + *The ID of the VPC.
*/ - VpnConnection?: VpnConnection; + VpcId: string | undefined; } -export namespace ModifyVpnTunnelCertificateResult { +export namespace ModifyVpcAttributeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyVpnTunnelCertificateResult): any => ({ + export const filterSensitiveLog = (obj: ModifyVpcAttributeRequest): any => ({ ...obj, }); } /** - *The AWS Site-to-Site VPN tunnel options to modify.
+ *Contains the parameters for ModifyVpcEndpoint.
*/ -export interface ModifyVpnTunnelOptionsSpecification { +export interface ModifyVpcEndpointRequest { /** - *The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique - * across all VPN connections that use the same virtual private gateway.
- *Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The
- * following CIDR blocks are reserved and cannot be used:
- * 169.254.0.0/30
- *
- * 169.254.1.0/30
- *
- * 169.254.2.0/30
- *
- * 169.254.3.0/30
- *
- * 169.254.4.0/30
- *
- * 169.254.5.0/30
- *
- * 169.254.169.252/30
- *
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.
- *Constraints: A size /126 CIDR block from the local fd00::/8 range.
The ID of the endpoint.
*/ - TunnelInsideIpv6Cidr?: string; + VpcEndpointId: string | undefined; /** - *The pre-shared key (PSK) to establish initial authentication between the virtual - * private gateway and the customer gateway.
- *Constraints: Allowed characters are alphanumeric characters, periods (.), and - * underscores (_). Must be between 8 and 64 characters in length and cannot start with - * zero (0).
+ *(Gateway endpoint) Specify true to reset the policy document to the
+ * default policy. The default policy allows full access to the service.
The lifetime for phase 1 of the IKE negotiation, in seconds.
- *Constraints: A value between 900 and 28,800.
- *Default: 28800
- *
(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must + * be in valid JSON format.
*/ - Phase1LifetimeSeconds?: number; + PolicyDocument?: string; /** - *The lifetime for phase 2 of the IKE negotiation, in seconds.
- *Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.
Default: 3600
- *
(Gateway endpoint) One or more route tables IDs to associate with the endpoint.
*/ - Phase2LifetimeSeconds?: number; + AddRouteTableIds?: string[]; /** - *The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 540
- *
(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
*/ - RekeyMarginTimeSeconds?: number; + RemoveRouteTableIds?: string[]; /** - *The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
- *Default: 100
- *
(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
*/ - RekeyFuzzPercentage?: number; + AddSubnetIds?: string[]; /** - *The number of packets in an IKE replay window.
- *Constraints: A value between 64 and 2048.
- *Default: 1024
- *
(Interface endpoint) One or more subnets IDs in which to remove the endpoint.
*/ - ReplayWindowSize?: number; + RemoveSubnetIds?: string[]; /** - *The number of seconds after which a DPD timeout occurs.
- *Constraints: A value between 0 and 30.
- *Default: 30
- *
(Interface endpoint) One or more security group IDs to associate with the network interface.
*/ - DPDTimeoutSeconds?: number; + AddSecurityGroupIds?: string[]; /** - *The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
- *
Default: clear
- *
(Interface endpoint) One or more security group IDs to disassociate from the network interface.
*/ - DPDTimeoutAction?: string; + RemoveSecurityGroupIds?: string[]; /** - *One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
- *Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
- *
(Interface endpoint) Indicates whether a private hosted zone is associated with the + * VPC.
*/ - Phase1EncryptionAlgorithms?: Phase1EncryptionAlgorithmsRequestListValue[]; + PrivateDnsEnabled?: boolean; +} +export namespace ModifyVpcEndpointRequest { /** - *One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
- *Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
- *
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
- *Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
- *
Returns true if the request succeeds; otherwise, it returns an error.
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
- *Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
- *
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
- *Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
- *
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
- *Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
- *
The ID of the notification.
*/ - Phase2DHGroupNumbers?: Phase2DHGroupNumbersRequestListValue[]; + ConnectionNotificationId: string | undefined; /** - *The IKE versions that are permitted for the VPN tunnel.
- *Valid values: ikev1 | ikev2
- *
The ARN for the SNS topic for the notification.
*/ - IKEVersions?: IKEVersionsRequestListValue[]; + ConnectionNotificationArn?: string; /** - *The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for AWS to initiate the IKE negotiation.
Valid Values: add | start
- *
Default: add
- *
One or more events for the endpoint. Valid values are Accept,
+ * Connect, Delete, and Reject.
The ID of the AWS Site-to-Site VPN connection.
- */ - VpnConnectionId: string | undefined; - +export interface ModifyVpcEndpointConnectionNotificationResult { /** - *The external IP address of the VPN tunnel.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The tunnel options to modify.
+ * @internal */ - TunnelOptions: ModifyVpnTunnelOptionsSpecification | undefined; + export const filterSensitiveLog = (obj: ModifyVpcEndpointConnectionNotificationResult): any => ({ + ...obj, + }); +} +export interface ModifyVpcEndpointServiceConfigurationRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
-}
-export namespace ModifyVpnTunnelOptionsRequest {
/**
- * @internal
+ * The ID of the service.
*/ - export const filterSensitiveLog = (obj: ModifyVpnTunnelOptionsRequest): any => ({ - ...obj, - }); -} + ServiceId: string | undefined; -export interface ModifyVpnTunnelOptionsResult { /** - *Describes a VPN connection.
+ *(Interface endpoint configuration) The private DNS name to assign to the endpoint service.
*/ - VpnConnection?: VpnConnection; -} + PrivateDnsName?: string; -export namespace ModifyVpnTunnelOptionsResult { /** - * @internal + *(Interface endpoint configuration) Removes the private DNS name of the endpoint service.
*/ - export const filterSensitiveLog = (obj: ModifyVpnTunnelOptionsResult): any => ({ - ...obj, - }); -} + RemovePrivateDnsName?: boolean; -export interface MonitorInstancesRequest { /** - *The IDs of the instances.
+ *Indicates whether requests to create an endpoint to your service must be accepted.
*/ - InstanceIds: string[] | undefined; + AcceptanceRequired?: boolean; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service + * configuration.
*/ - DryRun?: boolean; -} + AddNetworkLoadBalancerArns?: string[]; -export namespace MonitorInstancesRequest { /** - * @internal + *The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service + * configuration.
*/ - export const filterSensitiveLog = (obj: MonitorInstancesRequest): any => ({ - ...obj, - }); -} + RemoveNetworkLoadBalancerArns?: string[]; -/** - *Describes the monitoring of an instance.
- */ -export interface InstanceMonitoring { /** - *The ID of the instance.
+ *The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service + * configuration.
*/ - InstanceId?: string; + AddGatewayLoadBalancerArns?: string[]; /** - *The monitoring for the instance.
+ *The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service + * configuration.
*/ - Monitoring?: Monitoring; + RemoveGatewayLoadBalancerArns?: string[]; } -export namespace InstanceMonitoring { +export namespace ModifyVpcEndpointServiceConfigurationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceMonitoring): any => ({ + export const filterSensitiveLog = (obj: ModifyVpcEndpointServiceConfigurationRequest): any => ({ ...obj, }); } -export interface MonitorInstancesResult { +export interface ModifyVpcEndpointServiceConfigurationResult { /** - *The monitoring information.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -8451,659 +8729,697 @@ export interface MoveAddressToVpcRequest {
DryRun?: boolean;
/**
- *
The Elastic IP address.
+ *The ID of the service.
*/ - PublicIp: string | undefined; -} + ServiceId: string | undefined; -export namespace MoveAddressToVpcRequest { /** - * @internal + *The Amazon Resource Names (ARN) of one or more principals. + * Permissions are granted to the principals in this list. + * To grant permissions to all principals, specify an asterisk (*).
*/ - export const filterSensitiveLog = (obj: MoveAddressToVpcRequest): any => ({ - ...obj, - }); -} + AddAllowedPrincipals?: string[]; -export enum Status { - inClassic = "InClassic", - inVpc = "InVpc", - moveInProgress = "MoveInProgress", + /** + *The Amazon Resource Names (ARN) of one or more principals. + * Permissions are revoked for principals in this list.
+ */ + RemoveAllowedPrincipals?: string[]; } -export interface MoveAddressToVpcResult { +export namespace ModifyVpcEndpointServicePermissionsRequest { /** - *The allocation ID for the Elastic IP address.
+ * @internal */ - AllocationId?: string; + export const filterSensitiveLog = (obj: ModifyVpcEndpointServicePermissionsRequest): any => ({ + ...obj, + }); +} +export interface ModifyVpcEndpointServicePermissionsResult { /** - *The status of the move of the IP address.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Provides authorization for Amazon to bring a specific IP address range to a specific - * account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon Elastic Compute Cloud User Guide.
+ *The VPC peering connection options.
*/ -export interface CidrAuthorizationContext { +export interface PeeringConnectionOptionsRequest { + /** + *If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
+ */ + AllowDnsResolutionFromRemoteVpc?: boolean; + /** - *The plain-text authorization message for the prefix and account.
+ *If true, enables outbound communication from an EC2-Classic instance that's linked to + * a local VPC using ClassicLink to instances in a peer VPC.
*/ - Message: string | undefined; + AllowEgressFromLocalClassicLinkToRemoteVpc?: boolean; /** - *The signed authorization message for the prefix and account.
+ *If true, enables outbound communication from instances in a local VPC to an + * EC2-Classic instance that's linked to a peer VPC using ClassicLink.
*/ - Signature: string | undefined; + AllowEgressFromLocalVpcToRemoteClassicLink?: boolean; } -export namespace CidrAuthorizationContext { +export namespace PeeringConnectionOptionsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CidrAuthorizationContext): any => ({ + export const filterSensitiveLog = (obj: PeeringConnectionOptionsRequest): any => ({ ...obj, }); } -export interface ProvisionByoipCidrRequest { +export interface ModifyVpcPeeringConnectionOptionsRequest { /** - *The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can - * specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you've - * brought to this or another Region.
+ *The VPC peering connection options for the accepter VPC.
*/ - Cidr: string | undefined; + AccepterPeeringConnectionOptions?: PeeringConnectionOptionsRequest; /** - *A signed document that proves that you are authorized to bring the specified IP address - * range to Amazon using BYOIP.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
(IPv6 only) Indicate whether the address range will be publicly advertised to the - * internet.
- *Default: true
+ *The VPC peering connection options for the requester VPC.
*/ - PubliclyAdvertisable?: boolean; + RequesterPeeringConnectionOptions?: PeeringConnectionOptionsRequest; /** - *A description for the address range and the address pool.
+ *The ID of the VPC peering connection.
*/ - Description?: string; + VpcPeeringConnectionId: string | undefined; +} +export namespace ModifyVpcPeeringConnectionOptionsRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes the VPC peering connection options.
+ */ +export interface PeeringConnectionOptions { + /** + *If true, the public DNS hostnames of instances in the specified VPC resolve to private + * IP addresses when queried from instances in the peer VPC.
+ */ + AllowDnsResolutionFromRemoteVpc?: boolean; /** - *The tags to apply to the address pool.
+ *If true, enables outbound communication from an EC2-Classic instance that's linked to + * a local VPC using ClassicLink to instances in a peer VPC.
*/ - PoolTagSpecifications?: TagSpecification[]; + AllowEgressFromLocalClassicLinkToRemoteVpc?: boolean; /** - *If true, enables outbound communication from instances in a local VPC to an + * EC2-Classic instance that's linked to a peer VPC using ClassicLink.
*/ - MultiRegion?: boolean; + AllowEgressFromLocalVpcToRemoteClassicLink?: boolean; } -export namespace ProvisionByoipCidrRequest { +export namespace PeeringConnectionOptions { /** * @internal */ - export const filterSensitiveLog = (obj: ProvisionByoipCidrRequest): any => ({ + export const filterSensitiveLog = (obj: PeeringConnectionOptions): any => ({ ...obj, }); } -export interface ProvisionByoipCidrResult { +export interface ModifyVpcPeeringConnectionOptionsResult { + /** + *Information about the VPC peering connection options for the accepter VPC.
+ */ + AccepterPeeringConnectionOptions?: PeeringConnectionOptions; + /** - *Information about the address range.
+ *Information about the VPC peering connection options for the requester VPC.
*/ - ByoipCidr?: ByoipCidr; + RequesterPeeringConnectionOptions?: PeeringConnectionOptions; } -export namespace ProvisionByoipCidrResult { +export namespace ModifyVpcPeeringConnectionOptionsResult { /** * @internal */ - export const filterSensitiveLog = (obj: ProvisionByoipCidrResult): any => ({ + export const filterSensitiveLog = (obj: ModifyVpcPeeringConnectionOptionsResult): any => ({ ...obj, }); } -export interface PurchaseHostReservationRequest { - /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
- */ - ClientToken?: string; +export type VpcTenancy = "default"; +export interface ModifyVpcTenancyRequest { /** - *The currency in which the totalUpfrontPrice, LimitPrice,
- * and totalHourlyPrice amounts are specified. At this time, the only
- * supported currency is USD.
The ID of the VPC.
*/ - CurrencyCode?: CurrencyCodeValues | string; + VpcId: string | undefined; /** - *The IDs of the Dedicated Hosts with which the reservation will be associated.
+ *The instance tenancy attribute for the VPC.
*/ - HostIdSet: string[] | undefined; + InstanceTenancy: VpcTenancy | string | undefined; /** - *The specified limit is checked against the total upfront cost of the reservation
- * (calculated as the offering's upfront cost multiplied by the host count). If the total
- * upfront cost is greater than the specified price limit, the request fails. This is used
- * to ensure that the purchase does not exceed the expected upfront cost of the purchase.
- * At this time, the only supported currency is USD. For example, to indicate
- * a limit price of USD 100, specify 100.00.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the offering.
+ * @internal */ - OfferingId: string | undefined; + export const filterSensitiveLog = (obj: ModifyVpcTenancyRequest): any => ({ + ...obj, + }); +} +export interface ModifyVpcTenancyResult { /** - *The tags to apply to the Dedicated Host Reservation during purchase.
+ *Returns true if the request succeeds; otherwise, returns an
+ * error.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
+ *The ID of the VPN connection.
*/ - ClientToken?: string; + VpnConnectionId: string | undefined; /** - *The currency in which the totalUpfrontPrice and
- * totalHourlyPrice amounts are specified. At this time, the only
- * supported currency is USD.
The ID of the transit gateway.
*/ - CurrencyCode?: CurrencyCodeValues | string; + TransitGatewayId?: string; /** - *Describes the details of the purchase.
+ *The ID of the customer gateway at your end of the VPN connection.
*/ - Purchase?: Purchase[]; + CustomerGatewayId?: string; /** - *The total hourly price of the reservation calculated per hour.
+ *The ID of the virtual private gateway at the AWS side of the VPN connection.
*/ - TotalHourlyPrice?: string; + VpnGatewayId?: string; /** - *The total amount charged to your account when you purchase the reservation.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the limit price of a Reserved Instance offering.
- */ -export interface ReservedInstanceLimitPrice { - /** - *Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
- */ - Amount?: number; - +export interface ModifyVpnConnectionResult { /** - *The currency in which the limitPrice amount is specified.
- * At this time, the only supported currency is USD.
Describes a VPN connection.
*/ - CurrencyCode?: CurrencyCodeValues | string; + VpnConnection?: VpnConnection; } -export namespace ReservedInstanceLimitPrice { +export namespace ModifyVpnConnectionResult { /** * @internal */ - export const filterSensitiveLog = (obj: ReservedInstanceLimitPrice): any => ({ + export const filterSensitiveLog = (obj: ModifyVpnConnectionResult): any => ({ ...obj, }); } -/** - *Contains the parameters for PurchaseReservedInstancesOffering.
- */ -export interface PurchaseReservedInstancesOfferingRequest { - /** - *The number of Reserved Instances to purchase.
- */ - InstanceCount: number | undefined; - +export interface ModifyVpnConnectionOptionsRequest { /** - *The ID of the Reserved Instance offering to purchase.
+ *The ID of the Site-to-Site VPN connection. + *
*/ - ReservedInstancesOfferingId: string | undefined; + VpnConnectionId: string | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
+ *Default: 0.0.0.0/0
+ *
Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
+ *The IPv4 CIDR on the AWS side of the VPN connection.
+ *Default: 0.0.0.0/0
+ *
The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
+ *The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
+ *Default: ::/0
+ *
The IPv6 CIDR on the AWS side of the VPN connection.
+ *Default: ::/0
+ *
Contains the output of PurchaseReservedInstancesOffering.
- */ -export interface PurchaseReservedInstancesOfferingResult { /** - *The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted - * pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing - * pricing tiers in the Amazon Elastic Compute Cloud User Guide.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Describes a request to purchase Scheduled Instances.
- */ -export interface PurchaseRequest { - /** - *The number of instances.
- */ - InstanceCount: number | undefined; - +export interface ModifyVpnConnectionOptionsResult { /** - *The purchase token.
+ *Describes a VPN connection.
*/ - PurchaseToken: string | undefined; + VpnConnection?: VpnConnection; } -export namespace PurchaseRequest { +export namespace ModifyVpnConnectionOptionsResult { /** * @internal */ - export const filterSensitiveLog = (obj: PurchaseRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyVpnConnectionOptionsResult): any => ({ ...obj, }); } -/** - *Contains the parameters for PurchaseScheduledInstances.
- */ -export interface PurchaseScheduledInstancesRequest { +export interface ModifyVpnTunnelCertificateRequest { + /** + *The ID of the AWS Site-to-Site VPN connection.
+ */ + VpnConnectionId: string | undefined; + /** - *Unique, case-sensitive identifier that ensures the idempotency of the request. - * For more information, see Ensuring Idempotency.
+ *The external IP address of the VPN tunnel.
*/ - ClientToken?: string; + VpnTunnelOutsideIpAddress: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
-
- /**
- * The purchase requests.
- */ - PurchaseRequests: PurchaseRequest[] | undefined; } -export namespace PurchaseScheduledInstancesRequest { +export namespace ModifyVpnTunnelCertificateRequest { /** * @internal */ - export const filterSensitiveLog = (obj: PurchaseScheduledInstancesRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyVpnTunnelCertificateRequest): any => ({ ...obj, }); } -/** - *Contains the output of PurchaseScheduledInstances.
- */ -export interface PurchaseScheduledInstancesResult { +export interface ModifyVpnTunnelCertificateResult { /** - *Information about the Scheduled Instances.
+ *Describes a VPN connection.
*/ - ScheduledInstanceSet?: ScheduledInstance[]; + VpnConnection?: VpnConnection; } -export namespace PurchaseScheduledInstancesResult { +export namespace ModifyVpnTunnelCertificateResult { /** * @internal */ - export const filterSensitiveLog = (obj: PurchaseScheduledInstancesResult): any => ({ + export const filterSensitiveLog = (obj: ModifyVpnTunnelCertificateResult): any => ({ ...obj, }); } -export interface RebootInstancesRequest { +/** + *The AWS Site-to-Site VPN tunnel options to modify.
+ */ +export interface ModifyVpnTunnelOptionsSpecification { + /** + *The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique + * across all VPN connections that use the same virtual private gateway.
+ *Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The
+ * following CIDR blocks are reserved and cannot be used:
+ * 169.254.0.0/30
+ *
+ * 169.254.1.0/30
+ *
+ * 169.254.2.0/30
+ *
+ * 169.254.3.0/30
+ *
+ * 169.254.4.0/30
+ *
+ * 169.254.5.0/30
+ *
+ * 169.254.169.252/30
+ *
The instance IDs.
+ *The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.
+ *Constraints: A size /126 CIDR block from the local fd00::/8 range.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The pre-shared key (PSK) to establish initial authentication between the virtual + * private gateway and the customer gateway.
+ *Constraints: Allowed characters are alphanumeric characters, periods (.), and + * underscores (_). Must be between 8 and 64 characters in length and cannot start with + * zero (0).
*/ - DryRun?: boolean; -} + PreSharedKey?: string; -export namespace RebootInstancesRequest { /** - * @internal + *The lifetime for phase 1 of the IKE negotiation, in seconds.
+ *Constraints: A value between 900 and 28,800.
+ *Default: 28800
+ *
Contains the parameters for RegisterImage.
- */ -export interface RegisterImageRequest { /** - *The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the
- * aws-exec-read canned access control list (ACL) to ensure that it can be accessed
- * by Amazon EC2. For more information, see Canned ACLs in the
- * Amazon S3 Service Developer Guide.
The lifetime for phase 2 of the IKE negotiation, in seconds.
+ *Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.
Default: 3600
+ *
The architecture of the AMI.
- *Default: For Amazon EBS-backed AMIs, i386.
- * For instance store-backed AMIs, the architecture specified in the manifest file.
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 540
+ *
The block device mapping entries.
- *If you specify an EBS volume using the ID of an EBS snapshot, you can't specify the encryption state of the volume.
- *If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region - * of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost - * only. For more information, - * Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
+ *The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
+ *Default: 100
+ *
A description for your AMI.
+ *The number of packets in an IKE replay window.
+ *Constraints: A value between 64 and 2048.
+ *Default: 1024
+ *
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The number of seconds after which a DPD timeout occurs.
+ *Constraints: A value between 0 and 30.
+ *Default: 30
+ *
Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
+ *The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
+ *
Default: clear
+ *
The ID of the kernel.
+ *One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
+ *Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
+ *
A name for your AMI.
- *Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
+ *One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
+ *Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
+ *
The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, - * you can use the AWS Marketplace to bill for the use of an AMI.
+ *One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
+ *Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
+ *
The ID of the RAM disk.
+ *One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
+ *Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
+ *
The device name of the root device volume (for example, /dev/sda1).
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
+ *Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
+ *
Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
+ *One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
+ *Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
+ *
The type of virtualization (hvm | paravirtual).
Default: paravirtual
+ *
The IKE versions that are permitted for the VPN tunnel.
+ *Valid values: ikev1 | ikev2
*
The boot mode of the AMI. For more information, see Boot modes in the - * Amazon Elastic Compute Cloud User Guide.
+ *The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for AWS to initiate the IKE negotiation.
Valid Values: add | start
+ *
Default: add
+ *
Contains the output of RegisterImage.
- */ -export interface RegisterImageResult { +export interface ModifyVpnTunnelOptionsRequest { /** - *The ID of the newly registered AMI.
+ *The ID of the AWS Site-to-Site VPN connection.
*/ - ImageId?: string; -} + VpnConnectionId: string | undefined; -export namespace RegisterImageResult { /** - * @internal + *The external IP address of the VPN tunnel.
*/ - export const filterSensitiveLog = (obj: RegisterImageResult): any => ({ - ...obj, - }); -} + VpnTunnelOutsideIpAddress: string | undefined; -/** - *Information about the tag keys to register for the current Region. You can either specify
- * individual tag keys or register all tag keys in the current Region. You must specify either
- * IncludeAllTagsOfInstance or InstanceTagKeys in the request
Indicates whether to register all tag keys in the current Region. Specify true
- * to register all tag keys.
The tunnel options to modify.
*/ - IncludeAllTagsOfInstance?: boolean; + TunnelOptions: ModifyVpnTunnelOptionsSpecification | undefined; /** - *The tag keys to register.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the tag keys to register.
+ *Describes a VPN connection.
*/ - InstanceTagAttribute?: RegisterInstanceTagAttributeRequest; + VpnConnection?: VpnConnection; } -export namespace RegisterInstanceEventNotificationAttributesRequest { +export namespace ModifyVpnTunnelOptionsResult { /** * @internal */ - export const filterSensitiveLog = (obj: RegisterInstanceEventNotificationAttributesRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyVpnTunnelOptionsResult): any => ({ ...obj, }); } -export interface RegisterInstanceEventNotificationAttributesResult { +export interface MonitorInstancesRequest { + /** + *The IDs of the instances.
+ */ + InstanceIds: string[] | undefined; + /** - *The resulting set of tag keys.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the monitoring of an instance.
+ */ +export interface InstanceMonitoring { /** - *The ID of the transit gateway multicast domain.
+ *The ID of the instance.
*/ - TransitGatewayMulticastDomainId?: string; + InstanceId?: string; /** - *The IP address assigned to the transit gateway multicast group.
+ *The monitoring for the instance.
*/ - GroupIpAddress?: string; + Monitoring?: Monitoring; +} +export namespace InstanceMonitoring { /** - *The group members' network interface IDs to register with the transit gateway multicast group.
+ * @internal */ - NetworkInterfaceIds?: string[]; + export const filterSensitiveLog = (obj: InstanceMonitoring): any => ({ + ...obj, + }); +} +export interface MonitorInstancesResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The monitoring information.
*/ - DryRun?: boolean; + InstanceMonitorings?: InstanceMonitoring[]; } -export namespace RegisterTransitGatewayMulticastGroupMembersRequest { +export namespace MonitorInstancesResult { /** * @internal */ - export const filterSensitiveLog = (obj: RegisterTransitGatewayMulticastGroupMembersRequest): any => ({ + export const filterSensitiveLog = (obj: MonitorInstancesResult): any => ({ ...obj, }); } -/** - *Describes the registered transit gateway multicast group members.
- */ -export interface TransitGatewayMulticastRegisteredGroupMembers { - /** - *The ID of the transit gateway multicast domain.
- */ - TransitGatewayMulticastDomainId?: string; - +export interface MoveAddressToVpcRequest { /** - *The ID of the registered network interfaces.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The IP address assigned to the transit gateway multicast group.
+ *The Elastic IP address.
*/ - GroupIpAddress?: string; + PublicIp: string | undefined; } -export namespace TransitGatewayMulticastRegisteredGroupMembers { +export namespace MoveAddressToVpcRequest { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayMulticastRegisteredGroupMembers): any => ({ + export const filterSensitiveLog = (obj: MoveAddressToVpcRequest): any => ({ ...obj, }); } diff --git a/clients/client-ec2/models/models_5.ts b/clients/client-ec2/models/models_5.ts index a945e1e05aca9..1de07fed6abc4 100644 --- a/clients/client-ec2/models/models_5.ts +++ b/clients/client-ec2/models/models_5.ts @@ -4,8 +4,7 @@ import { BlockDeviceMapping, ByoipCidr, ClientVpnAuthorizationRuleStatus, - CreditSpecificationRequest, - ElasticGpuSpecification, + CurrencyCodeValues, IamInstanceProfileAssociation, IamInstanceProfileSpecification, IpPermission, @@ -20,6 +19,8 @@ import { _InstanceType, } from "./models_0"; import { + CreditSpecificationRequest, + ElasticGpuSpecification, IcmpTypeCode, InstanceInterruptionBehavior, InstanceIpv6Address, @@ -33,28 +34,670 @@ import { TransitGatewayRoute, } from "./models_1"; import { + ArchitectureValues, + BootModeValues, ClientVpnConnectionStatus, Filter, HttpTokensState, InstanceAttributeName, InstanceMetadataEndpointState, - InstanceState, + InstanceTagNotificationAttribute, } from "./models_2"; import { InstanceNetworkInterfaceSpecification, + InstanceState, NetworkInsightsAnalysis, RunInstancesMonitoringEnabled, + ScheduledInstance, SnapshotAttributeName, SpotFleetRequestConfigData, SpotInstanceRequest, SpotPlacement, } from "./models_3"; -import { - CapacityReservationSpecification, - InstanceMonitoring, - Status, - TransitGatewayMulticastRegisteredGroupMembers, -} from "./models_4"; +import { CapacityReservationSpecification, InstanceMonitoring, Purchase } from "./models_4"; + +export enum Status { + inClassic = "InClassic", + inVpc = "InVpc", + moveInProgress = "MoveInProgress", +} + +export interface MoveAddressToVpcResult { + /** + *The allocation ID for the Elastic IP address.
+ */ + AllocationId?: string; + + /** + *The status of the move of the IP address.
+ */ + Status?: Status | string; +} + +export namespace MoveAddressToVpcResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: MoveAddressToVpcResult): any => ({ + ...obj, + }); +} + +/** + *Provides authorization for Amazon to bring a specific IP address range to a specific + * account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon Elastic Compute Cloud User Guide.
+ */ +export interface CidrAuthorizationContext { + /** + *The plain-text authorization message for the prefix and account.
+ */ + Message: string | undefined; + + /** + *The signed authorization message for the prefix and account.
+ */ + Signature: string | undefined; +} + +export namespace CidrAuthorizationContext { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CidrAuthorizationContext): any => ({ + ...obj, + }); +} + +export interface ProvisionByoipCidrRequest { + /** + *The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can + * specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you've + * brought to this or another Region.
+ */ + Cidr: string | undefined; + + /** + *A signed document that proves that you are authorized to bring the specified IP address + * range to Amazon using BYOIP.
+ */ + CidrAuthorizationContext?: CidrAuthorizationContext; + + /** + *(IPv6 only) Indicate whether the address range will be publicly advertised to the + * internet.
+ *Default: true
+ */ + PubliclyAdvertisable?: boolean; + + /** + *A description for the address range and the address pool.
+ */ + Description?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The tags to apply to the address pool.
+ */ + PoolTagSpecifications?: TagSpecification[]; + + /** + *Information about the address range.
+ */ + ByoipCidr?: ByoipCidr; +} + +export namespace ProvisionByoipCidrResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ProvisionByoipCidrResult): any => ({ + ...obj, + }); +} + +export interface PurchaseHostReservationRequest { + /** + *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
+ */ + ClientToken?: string; + + /** + *The currency in which the totalUpfrontPrice, LimitPrice,
+ * and totalHourlyPrice amounts are specified. At this time, the only
+ * supported currency is USD.
The IDs of the Dedicated Hosts with which the reservation will be associated.
+ */ + HostIdSet: string[] | undefined; + + /** + *The specified limit is checked against the total upfront cost of the reservation
+ * (calculated as the offering's upfront cost multiplied by the host count). If the total
+ * upfront cost is greater than the specified price limit, the request fails. This is used
+ * to ensure that the purchase does not exceed the expected upfront cost of the purchase.
+ * At this time, the only supported currency is USD. For example, to indicate
+ * a limit price of USD 100, specify 100.00.
The ID of the offering.
+ */ + OfferingId: string | undefined; + + /** + *The tags to apply to the Dedicated Host Reservation during purchase.
+ */ + TagSpecifications?: TagSpecification[]; +} + +export namespace PurchaseHostReservationRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: PurchaseHostReservationRequest): any => ({ + ...obj, + }); +} + +export interface PurchaseHostReservationResult { + /** + *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
+ */ + ClientToken?: string; + + /** + *The currency in which the totalUpfrontPrice and
+ * totalHourlyPrice amounts are specified. At this time, the only
+ * supported currency is USD.
Describes the details of the purchase.
+ */ + Purchase?: Purchase[]; + + /** + *The total hourly price of the reservation calculated per hour.
+ */ + TotalHourlyPrice?: string; + + /** + *The total amount charged to your account when you purchase the reservation.
+ */ + TotalUpfrontPrice?: string; +} + +export namespace PurchaseHostReservationResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: PurchaseHostReservationResult): any => ({ + ...obj, + }); +} + +/** + *Describes the limit price of a Reserved Instance offering.
+ */ +export interface ReservedInstanceLimitPrice { + /** + *Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
+ */ + Amount?: number; + + /** + *The currency in which the limitPrice amount is specified.
+ * At this time, the only supported currency is USD.
Contains the parameters for PurchaseReservedInstancesOffering.
+ */ +export interface PurchaseReservedInstancesOfferingRequest { + /** + *The number of Reserved Instances to purchase.
+ */ + InstanceCount: number | undefined; + + /** + *The ID of the Reserved Instance offering to purchase.
+ */ + ReservedInstancesOfferingId: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
+ */ + LimitPrice?: ReservedInstanceLimitPrice; + + /** + *The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
+ */ + PurchaseTime?: Date; +} + +export namespace PurchaseReservedInstancesOfferingRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: PurchaseReservedInstancesOfferingRequest): any => ({ + ...obj, + }); +} + +/** + *Contains the output of PurchaseReservedInstancesOffering.
+ */ +export interface PurchaseReservedInstancesOfferingResult { + /** + *The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted + * pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing + * pricing tiers in the Amazon Elastic Compute Cloud User Guide.
+ */ + ReservedInstancesId?: string; +} + +export namespace PurchaseReservedInstancesOfferingResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: PurchaseReservedInstancesOfferingResult): any => ({ + ...obj, + }); +} + +/** + *Describes a request to purchase Scheduled Instances.
+ */ +export interface PurchaseRequest { + /** + *The number of instances.
+ */ + InstanceCount: number | undefined; + + /** + *The purchase token.
+ */ + PurchaseToken: string | undefined; +} + +export namespace PurchaseRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: PurchaseRequest): any => ({ + ...obj, + }); +} + +/** + *Contains the parameters for PurchaseScheduledInstances.
+ */ +export interface PurchaseScheduledInstancesRequest { + /** + *Unique, case-sensitive identifier that ensures the idempotency of the request. + * For more information, see Ensuring Idempotency.
+ */ + ClientToken?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The purchase requests.
+ */ + PurchaseRequests: PurchaseRequest[] | undefined; +} + +export namespace PurchaseScheduledInstancesRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: PurchaseScheduledInstancesRequest): any => ({ + ...obj, + }); +} + +/** + *Contains the output of PurchaseScheduledInstances.
+ */ +export interface PurchaseScheduledInstancesResult { + /** + *Information about the Scheduled Instances.
+ */ + ScheduledInstanceSet?: ScheduledInstance[]; +} + +export namespace PurchaseScheduledInstancesResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: PurchaseScheduledInstancesResult): any => ({ + ...obj, + }); +} + +export interface RebootInstancesRequest { + /** + *The instance IDs.
+ */ + InstanceIds: string[] | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Contains the parameters for RegisterImage.
+ */ +export interface RegisterImageRequest { + /** + *The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the
+ * aws-exec-read canned access control list (ACL) to ensure that it can be accessed
+ * by Amazon EC2. For more information, see Canned ACLs in the
+ * Amazon S3 Service Developer Guide.
The architecture of the AMI.
+ *Default: For Amazon EBS-backed AMIs, i386.
+ * For instance store-backed AMIs, the architecture specified in the manifest file.
The block device mapping entries.
+ *If you specify an EBS volume using the ID of an EBS snapshot, you can't specify the encryption state of the volume.
+ *If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region + * of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost + * only. For more information, + * Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.
+ */ + BlockDeviceMappings?: BlockDeviceMapping[]; + + /** + *A description for your AMI.
+ */ + Description?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
+ */ + EnaSupport?: boolean; + + /** + *The ID of the kernel.
+ */ + KernelId?: string; + + /** + *A name for your AMI.
+ *Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
+ */ + Name: string | undefined; + + /** + *The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, + * you can use the AWS Marketplace to bill for the use of an AMI.
+ */ + BillingProducts?: string[]; + + /** + *The ID of the RAM disk.
+ */ + RamdiskId?: string; + + /** + *The device name of the root device volume (for example, /dev/sda1).
Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
+ */ + SriovNetSupport?: string; + + /** + *The type of virtualization (hvm | paravirtual).
Default: paravirtual
+ *
The boot mode of the AMI. For more information, see Boot modes in the + * Amazon Elastic Compute Cloud User Guide.
+ */ + BootMode?: BootModeValues | string; +} + +export namespace RegisterImageRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RegisterImageRequest): any => ({ + ...obj, + }); +} + +/** + *Contains the output of RegisterImage.
+ */ +export interface RegisterImageResult { + /** + *The ID of the newly registered AMI.
+ */ + ImageId?: string; +} + +export namespace RegisterImageResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RegisterImageResult): any => ({ + ...obj, + }); +} + +/** + *Information about the tag keys to register for the current Region. You can either specify
+ * individual tag keys or register all tag keys in the current Region. You must specify either
+ * IncludeAllTagsOfInstance or InstanceTagKeys in the request
Indicates whether to register all tag keys in the current Region. Specify true
+ * to register all tag keys.
The tag keys to register.
+ */ + InstanceTagKeys?: string[]; +} + +export namespace RegisterInstanceTagAttributeRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RegisterInstanceTagAttributeRequest): any => ({ + ...obj, + }); +} + +export interface RegisterInstanceEventNotificationAttributesRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the tag keys to register.
+ */ + InstanceTagAttribute?: RegisterInstanceTagAttributeRequest; +} + +export namespace RegisterInstanceEventNotificationAttributesRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RegisterInstanceEventNotificationAttributesRequest): any => ({ + ...obj, + }); +} + +export interface RegisterInstanceEventNotificationAttributesResult { + /** + *The resulting set of tag keys.
+ */ + InstanceTagAttribute?: InstanceTagNotificationAttribute; +} + +export namespace RegisterInstanceEventNotificationAttributesResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RegisterInstanceEventNotificationAttributesResult): any => ({ + ...obj, + }); +} + +export interface RegisterTransitGatewayMulticastGroupMembersRequest { + /** + *The ID of the transit gateway multicast domain.
+ */ + TransitGatewayMulticastDomainId?: string; + + /** + *The IP address assigned to the transit gateway multicast group.
+ */ + GroupIpAddress?: string; + + /** + *The group members' network interface IDs to register with the transit gateway multicast group.
+ */ + NetworkInterfaceIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the registered transit gateway multicast group members.
+ */ +export interface TransitGatewayMulticastRegisteredGroupMembers { + /** + *The ID of the transit gateway multicast domain.
+ */ + TransitGatewayMulticastDomainId?: string; + + /** + *The ID of the registered network interfaces.
+ */ + RegisteredNetworkInterfaceIds?: string[]; + + /** + *The IP address assigned to the transit gateway multicast group.
+ */ + GroupIpAddress?: string; +} + +export namespace TransitGatewayMulticastRegisteredGroupMembers { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TransitGatewayMulticastRegisteredGroupMembers): any => ({ + ...obj, + }); +} export interface RegisterTransitGatewayMulticastGroupMembersResult { /** @@ -1889,16 +2532,7 @@ export interface SpotMarketOptions { SpotInstanceType?: SpotInstanceType | string; /** - *The required duration for the Spot Instances (also known as Spot blocks), in minutes. - * This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
- *The duration period starts as soon as your Spot Instance receives its instance ID. At - * the end of the duration period, Amazon EC2 marks the Spot Instance for termination and - * provides a Spot Instance termination notice, which gives the instance a two-minute - * warning before it terminates.
- *You can't specify an Availability Zone group or a launch group if you specify a - * duration.
- *New accounts or accounts with no previous billing history with Amazon Web Services are not eligible - * for Spot Instances with a defined duration (also known as Spot blocks).
+ *Deprecated.
*/ BlockDurationMinutes?: number; diff --git a/clients/client-ec2/pagination/DescribeInstanceEventWindowsPaginator.ts b/clients/client-ec2/pagination/DescribeInstanceEventWindowsPaginator.ts new file mode 100644 index 0000000000000..7bff29e147d88 --- /dev/null +++ b/clients/client-ec2/pagination/DescribeInstanceEventWindowsPaginator.ts @@ -0,0 +1,58 @@ +import { EC2 } from "../EC2"; +import { EC2Client } from "../EC2Client"; +import { + DescribeInstanceEventWindowsCommand, + DescribeInstanceEventWindowsCommandInput, + DescribeInstanceEventWindowsCommandOutput, +} from "../commands/DescribeInstanceEventWindowsCommand"; +import { EC2PaginationConfiguration } from "./Interfaces"; +import { Paginator } from "@aws-sdk/types"; + +/** + * @private + */ +const makePagedClientRequest = async ( + client: EC2Client, + input: DescribeInstanceEventWindowsCommandInput, + ...args: any +): PromiseAmazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes * it easy to run, stop, and manage Docker containers on a cluster. You can host your * cluster on a serverless infrastructure that is managed by Amazon ECS by launching your - * services or tasks on AWS Fargate. For more control, you can host your tasks on a cluster + * services or tasks on Fargate. For more control, you can host your tasks on a cluster * of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage.
*Amazon ECS makes it easy to launch and stop container-based applications with simple API * calls, allows you to get the state of your cluster from a centralized service, and gives @@ -262,9 +262,9 @@ export class ECS extends ECSClient { * cluster and are used in capacity provider strategies to facilitate cluster auto * scaling.
*Only capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on
- * AWS Fargate use the FARGATE and FARGATE_SPOT capacity providers
+ * Fargate use the FARGATE and FARGATE_SPOT capacity providers
* which are already created and available to all accounts in Regions supported by
- * AWS Fargate.
When you call the CreateCluster API operation, Amazon ECS attempts to * create the Amazon ECS service-linked role for your account so that required resources in - * other AWS services can be managed on your behalf. However, if the IAM user that + * other Amazon Web Services services can be managed on your behalf. However, if the IAM user that * makes the call does not have permissions to create the service-linked role, it is * not created. For more information, see Using * Service-Linked Roles for Amazon ECS in the @@ -1651,7 +1651,7 @@ export class ECS extends ECSClient { * Definitions in the Amazon Elastic Container Service Developer Guide.
*You can specify an IAM role for your task with the taskRoleArn parameter.
* When you specify an IAM role for a task, its containers can then use the latest versions
- * of the AWS CLI or SDKs to make API requests to the AWS services that are specified in
+ * of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in
* the IAM policy associated with the role. For more information, see IAM
* Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition @@ -2220,8 +2220,8 @@ export class ECS extends ECSClient { *
For services using the blue/green (CODE_DEPLOY) deployment controller,
* only the desired count, deployment configuration, task placement constraints and
* strategies, and health check grace period can be updated using this API. If the network
- * configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy
- * deployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired * count, task placement constraints and strategies, and health check grace period using * this API. If the launch type, load balancer, network configuration, platform version, or diff --git a/clients/client-ecs/ECSClient.ts b/clients/client-ecs/ECSClient.ts index ed929cc101340..825c23b0a2d8e 100644 --- a/clients/client-ecs/ECSClient.ts +++ b/clients/client-ecs/ECSClient.ts @@ -432,7 +432,7 @@ export interface ECSClientResolvedConfig extends ECSClientResolvedConfigType {} *
Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes * it easy to run, stop, and manage Docker containers on a cluster. You can host your * cluster on a serverless infrastructure that is managed by Amazon ECS by launching your - * services or tasks on AWS Fargate. For more control, you can host your tasks on a cluster + * services or tasks on Fargate. For more control, you can host your tasks on a cluster * of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage.
*Amazon ECS makes it easy to launch and stop container-based applications with simple API * calls, allows you to get the state of your cluster from a centralized service, and gives diff --git a/clients/client-ecs/README.md b/clients/client-ecs/README.md index 6a749958d81dd..5d13d13f04239 100644 --- a/clients/client-ecs/README.md +++ b/clients/client-ecs/README.md @@ -12,7 +12,7 @@ AWS SDK for JavaScript ECS Client for Node.js, Browser and React Native.
Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your -services or tasks on AWS Fargate. For more control, you can host your tasks on a cluster +services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage.
Amazon ECS makes it easy to launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives diff --git a/clients/client-ecs/commands/CreateCapacityProviderCommand.ts b/clients/client-ecs/commands/CreateCapacityProviderCommand.ts index 59121af1f47c1..82a8335b23625 100644 --- a/clients/client-ecs/commands/CreateCapacityProviderCommand.ts +++ b/clients/client-ecs/commands/CreateCapacityProviderCommand.ts @@ -25,9 +25,9 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi * cluster and are used in capacity provider strategies to facilitate cluster auto * scaling.
*Only capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on
- * AWS Fargate use the FARGATE and FARGATE_SPOT capacity providers
+ * Fargate use the FARGATE and FARGATE_SPOT capacity providers
* which are already created and available to all accounts in Regions supported by
- * AWS Fargate.
When you call the CreateCluster API operation, Amazon ECS attempts to * create the Amazon ECS service-linked role for your account so that required resources in - * other AWS services can be managed on your behalf. However, if the IAM user that + * other Amazon Web Services services can be managed on your behalf. However, if the IAM user that * makes the call does not have permissions to create the service-linked role, it is * not created. For more information, see Using * Service-Linked Roles for Amazon ECS in the diff --git a/clients/client-ecs/commands/RegisterTaskDefinitionCommand.ts b/clients/client-ecs/commands/RegisterTaskDefinitionCommand.ts index e00453b4f2cd8..988026a6695aa 100644 --- a/clients/client-ecs/commands/RegisterTaskDefinitionCommand.ts +++ b/clients/client-ecs/commands/RegisterTaskDefinitionCommand.ts @@ -28,7 +28,7 @@ export interface RegisterTaskDefinitionCommandOutput extends RegisterTaskDefinit * Definitions in the Amazon Elastic Container Service Developer Guide.
*You can specify an IAM role for your task with the taskRoleArn parameter.
* When you specify an IAM role for a task, its containers can then use the latest versions
- * of the AWS CLI or SDKs to make API requests to the AWS services that are specified in
+ * of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in
* the IAM policy associated with the role. For more information, see IAM
* Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition diff --git a/clients/client-ecs/commands/UpdateServiceCommand.ts b/clients/client-ecs/commands/UpdateServiceCommand.ts index 84b468ceb5c46..7b0aa9d7d9211 100644 --- a/clients/client-ecs/commands/UpdateServiceCommand.ts +++ b/clients/client-ecs/commands/UpdateServiceCommand.ts @@ -34,8 +34,8 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met *
For services using the blue/green (CODE_DEPLOY) deployment controller,
* only the desired count, deployment configuration, task placement constraints and
* strategies, and health check grace period can be updated using this API. If the network
- * configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy
- * deployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired * count, task placement constraints and strategies, and health check grace period using * this API. If the launch type, load balancer, network configuration, platform version, or diff --git a/clients/client-ecs/models/models_0.ts b/clients/client-ecs/models/models_0.ts index a59521728300f..16e06463deb1a 100644 --- a/clients/client-ecs/models/models_0.ts +++ b/clients/client-ecs/models/models_0.ts @@ -136,7 +136,7 @@ export interface AutoScalingGroupProvider { *
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in * an Auto Scaling group that contain tasks from being terminated during a scale-in action. * The Auto Scaling group and each instance in the Auto Scaling group must have instance - * protection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide.
+ * protection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide. *When managed termination protection is disabled, your Amazon EC2 instances are not * protected from termination when the Auto Scaling group scales in.
*/ @@ -182,7 +182,7 @@ export namespace AutoScalingGroupProvider { *Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
Specify an AWS Key Management Service key ID to encrypt the data between the local - * client and the container.
+ *Specify an Key Management Service key ID to encrypt the data between the local client + * and the container.
*/ kmsKeyId?: string; @@ -616,8 +616,8 @@ export namespace ClusterConfiguration { *If specifying a capacity provider that uses an Auto Scaling group, the capacity * provider must already be created. New Auto Scaling group capacity providers can be * created with the CreateCapacityProvider API operation.
- *To use a AWS Fargate capacity provider, specify either the FARGATE or
- * FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are
+ *
To use a Fargate capacity provider, specify either the FARGATE or
+ * FARGATE_SPOT capacity providers. The Fargate capacity providers are
* available to all accounts and only need to be associated with a cluster to be used in a
* capacity provider strategy.
Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
If specifying a capacity provider that uses an Auto Scaling group, the capacity * provider must already be created and not already associated with another cluster. New * Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
- *To use a AWS Fargate capacity provider, specify either the FARGATE or
- * FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are
+ *
To use a Fargate capacity provider, specify either the FARGATE or
+ * FARGATE_SPOT capacity providers. The Fargate capacity providers are
* available to all accounts and only need to be associated with a cluster to be
* used.
The PutClusterCapacityProviders API operation is used to update the @@ -870,7 +870,7 @@ export namespace Attachment { */ export interface Cluster { /** - *
The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.
The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.
Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
The blue/green (CODE_DEPLOY) deployment type uses the
- * blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a
+ * blue/green deployment model powered by CodeDeploy, which allows you to verify a
* new deployment of a service before sending production traffic to it.
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is - * AWS Cloud Map. For more information, see CreateService.
+ * Cloud Map. For more information, see CreateService. */ registryArn?: string; @@ -1573,9 +1573,9 @@ export interface CreateServiceRequest { * multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the * Amazon Elastic Container Service Developer Guide. *If the service is using the CODE_DEPLOY deployment controller, the
- * service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment
+ * service is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment
* group, you specify two target groups (referred to as a targetGroupPair).
- * During a deployment, AWS CodeDeploy determines which task set in your service has the status
+ * During a deployment, CodeDeploy determines which task set in your service has the status
* PRIMARY and associates one target group with it, and then associates
* the other target group with the replacement task set. The load balancer can also have up
* to two listeners: a required listener for production traffic and an optional listener
@@ -1633,12 +1633,12 @@ export interface CreateServiceRequest {
/**
*
The infrastructure on which to run your service. For more information, see Amazon ECS * launch types in the Amazon Elastic Container Service Developer Guide.
- *The FARGATE launch type runs your tasks on AWS Fargate On-Demand
+ *
The FARGATE launch type runs your tasks on Fargate On-Demand
* infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider - * strategy must be used. For more information, see AWS Fargate capacity providers in the - * Amazon ECS User Guide for AWS Fargate.
+ * strategy must be used. For more information, see Fargate capacity providers in the + * Amazon ECS User Guide for Fargate. *The EC2 launch type runs your tasks on Amazon EC2 instances registered to your
* cluster.
The platform version that your tasks in the service are running on. A platform version
* is specified only for tasks using the Fargate launch type. If one isn't
* specified, the LATEST platform version is used by default. For more
- * information, see AWS Fargate platform
+ * information, see Fargate platform
* versions in the Amazon Elastic Container Service Developer Guide.
Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
The platform version on which your tasks in the service are running. A platform
* version is only specified for tasks using the Fargate launch type. If one
* is not specified, the LATEST platform version is used by default. For more
- * information, see AWS Fargate Platform
+ * information, see Fargate Platform
* Versions in the Amazon Elastic Container Service Developer Guide.
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL
+ *
Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL
* deployment. An Amazon ECS task set includes details such as the desired number of tasks, how
* many tasks are running, and whether the task set serves production traffic.
The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy + *
The tag specified when a task set is started. If the task set is created by an CodeDeploy
* deployment, the startedBy parameter is CODE_DEPLOY. For a task
* set created for an external deployment, the startedBy field isn't used.
The external ID associated with the task set.
- *If a task set is created by an AWS CodeDeploy deployment, the externalId parameter
- * contains the AWS CodeDeploy deployment ID.
If a task set is created by an CodeDeploy deployment, the externalId parameter
+ * contains the CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service
* discovery registry, the externalId parameter contains the
- * ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.
ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.
*/
externalId?: string;
@@ -2161,9 +2161,9 @@ export interface TaskSet {
capacityProviderStrategy?: CapacityProviderStrategyItem[];
/**
- * The AWS Fargate platform version on which the tasks in the task set are running. A
- * platform version is only specified for tasks run on AWS Fargate. For more information, see
- * AWS Fargate platform
+ * The Fargate platform version on which the tasks in the task set are running. A
+ * platform version is only specified for tasks run on Fargate. For more information, see
+ * Fargate platform
* versions in the Amazon Elastic Container Service Developer Guide. Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.
The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.
The infrastructure on which your service is running. For more information, see Amazon ECS - * launch types in the Amazon Elastic Container Service Developer Guide.
+ *The launch type the service is using. When using the DescribeServices API, this field + * is omitted if the service was created using a capacity provider strategy.
*/ launchType?: LaunchType | string; /** - *The capacity provider strategy associated with the service.
+ *The capacity provider strategy the service is using. When using the DescribeServices + * API, this field is omitted if the service was created using a launch type.
*/ capacityProviderStrategy?: CapacityProviderStrategyItem[]; /** *The platform version on which to run your service. A platform version is only
- * specified for tasks using the Fargate launch type. If one is not
- * specified, the LATEST platform version is used by default. For more
- * information, see AWS Fargate Platform
+ * specified for tasks hosted on Fargate. If one is not specified, the
+ * LATEST platform version is used by default. For more information, see
+ * Fargate Platform
* Versions in the Amazon Elastic Container Service Developer Guide.
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL
+ *
Information about a set of Amazon ECS tasks in either an CodeDeploy or an EXTERNAL
* deployment. An Amazon ECS task set includes details such as the desired number of tasks, how
* many tasks are running, and whether the task set serves production traffic.
Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
The full description of your service following the create call.
+ *A service will return either a capacityProviderStrategy or
+ * launchType parameter, but not both, depending on which one was
+ * specified during creation.
If a service is using the ECS deployment controller, the
* deploymentController and taskSets parameters will not be
* returned.
An optional non-unique tag that identifies this task set in external systems. If the
* task set is associated with a service discovery registry, the tasks in this task set
- * will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided
+ * will have the ECS_TASK_SET_EXTERNAL_ID Cloud Map attribute set to the provided
* value.
defaultCapacityProviderStrategy for the cluster is used.
* If specifying a capacity provider that uses an Auto Scaling group, the capacity * provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
- *To use a AWS Fargate capacity provider, specify either the FARGATE or
- * FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are
+ *
To use a Fargate capacity provider, specify either the FARGATE or
+ * FARGATE_SPOT capacity providers. The Fargate capacity providers are
* available to all accounts and only need to be associated with a cluster to be
* used.
The PutClusterCapacityProviders API operation is used to update the @@ -2719,7 +2723,7 @@ export interface CreateTaskSetRequest { *
Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an + *
Information about a set of Amazon ECS tasks in either an CodeDeploy or an
* EXTERNAL deployment. A task set includes details such as the desired
* number of tasks, how many tasks are running, and whether the task set serves production
* traffic.
The container instance ID or full ARN of the container instance to deregister.
- * The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
arn:aws:ecs namespace, followed by the Region of the container instance, the account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
*/
containerInstance: string | undefined;
@@ -3348,13 +3352,13 @@ export namespace VersionInfo {
*/
export interface ContainerInstance {
/**
- * The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
The ID of the container instance. For Amazon EC2 instances, this value is the Amazon EC2 - * instance ID. For external instances, this value is the AWS Systems Manager managed instance ID.
+ * instance ID. For external instances, this value is the Amazon Web Services Systems Manager managed instance ID. */ ec2InstanceId?: string; @@ -3502,7 +3506,7 @@ export interface ContainerInstance { *Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
Tasks hosted on AWS Fargate only support the file configuration file
+ *
Tasks hosted on Fargate only support the file configuration file
* type.
Container health checks are supported for Fargate tasks if you - * are using platform version 1.1.0 or greater. For more information, see AWS Fargate + * are using platform version 1.1.0 or greater. For more information, see Fargate * Platform Versions.
*--cap-add option to docker
* run.
* Tasks launched on AWS Fargate only support adding the SYS_PTRACE kernel
+ *
Tasks launched on Fargate only support adding the SYS_PTRACE kernel
* capability.
Valid values: The secret to expose to the container. The supported values are either the full ARN of
- * the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store."ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" |
@@ -4133,9 +4137,9 @@ export interface Secret {
/**
*
If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you + *
If the SSM Parameter Store parameter exists in the same Region as the task you * are launching, then you can use either the full ARN or name of the parameter. If the * parameter exists in a different Region, then the full ARN must be specified.
*For tasks on AWS Fargate, because you do not have access to the underlying + *
For tasks on Fargate, because you do not have access to the underlying * infrastructure your tasks are hosted on, any additional software needed will * have to be installed outside of the task. For example, the Fluentd output * aggregators or a remote host running Logstash to send Gelf logs to.
@@ -4195,7 +4199,7 @@ export namespace Secret { export interface LogConfiguration { /** *The log driver to use for the container.
- *For tasks on AWS Fargate, the supported log drivers are awslogs,
+ *
For tasks on Fargate, the supported log drivers are awslogs,
* splunk, and awsfirelens.
For tasks hosted on Amazon EC2 instances, the supported log drivers are
* awslogs, fluentd, gelf,
@@ -4362,9 +4366,9 @@ export interface RepositoryCredentials {
*
The Amazon Resource Name (ARN) of the secret containing the private repository * credentials.
*When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the + *
When you are using the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the * same Region as the task that you are launching then you can use either the full ARN - * or the name of the secret. When you are using the AWS Management Console, you must specify the + * or the name of the secret. When you are using the Amazon Web Services Management Console, you must specify the * full ARN of the secret.
*Privileged in the Create a container section of the
* Docker Remote API and the --privileged option to docker run.
* This parameter is not supported for Windows containers or tasks run on AWS Fargate.
+ *This parameter is not supported for Windows containers or tasks run on Fargate.
*The amount of ephemeral storage to allocate for the task. This parameter is used to * expand the total amount of ephemeral storage available, beyond the default amount, for - * tasks hosted on AWS Fargate. For more information, see Fargate task - * storage in the Amazon ECS User Guide for AWS Fargate.
+ * tasks hosted on Fargate. For more information, see Fargate task + * storage in the Amazon ECS User Guide for Fargate. *This parameter is only supported for tasks hosted on AWS Fargate using platform + *
This parameter is only supported for tasks hosted on Fargate using platform
* version 1.4.0 or later.
Task placement constraints are not supported for tasks run on AWS Fargate.
+ *Task placement constraints are not supported for tasks run on Fargate.
*The authorization credential option to use. The authorization credential options can - * be provided using either the Amazon Resource Name (ARN) of an AWS Secrets Manager secret or AWS Systems Manager + * be provided using either the Amazon Resource Name (ARN) of an Secrets Manager secret or SSM * Parameter Store parameter. The ARNs refer to the stored credentials.
*/ credentialsParameter: string | undefined; /** - *A fully qualified domain name hosted by an AWS Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on + *
A fully qualified domain name hosted by an Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on * Amazon EC2.
*/ domain: string | undefined; @@ -5702,7 +5706,7 @@ export interface Volume { *Windows containers only support the use of the local driver. To use bind
* mounts, specify the host parameter instead.
Docker volumes are not supported by tasks run on AWS Fargate.
+ *Docker volumes are not supported by tasks run on Fargate.
*The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants containers in the
- * task permission to call AWS APIs on your behalf. For more information, see Amazon ECS
+ * The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the
+ * task permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS
* Task Role in the Amazon Elastic Container Service Developer Guide. IAM roles for tasks on Windows require that the The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent
- * permission to make AWS API calls on your behalf. The task execution IAM role is required
+ * permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required
* depending on the requirements of your task. For more information, see Amazon ECS task
* execution IAM role in the Amazon Elastic Container Service Developer Guide.-EnableTaskIAMRole option
* is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some
@@ -5772,7 +5776,7 @@ export interface TaskDefinition {
/**
* none, bridge, awsvpc, and host.
* If no network mode is specified, the default is bridge.
For Amazon ECS tasks on Fargate, the awsvpc network mode is required.
- * For Amazon ECS tasks on Amazon EC2 instances, any network mode can be used. If the network
+ * For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, awsvpc can be used. If the network
* mode is set to none, you cannot specify port mappings in your container
* definitions, and the tasks containers do not have external connectivity. The
* host and awsvpc network modes offer the highest networking
@@ -5803,17 +5807,8 @@ export interface TaskDefinition {
* interface, and you must specify a NetworkConfiguration value when you create
* a service or run a task with the task definition. For more information, see Task Networking in the
* Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the
- * ecs-init package, or AWS Fargate infrastructure support the
- * awsvpc network mode.
If the network mode is host, you cannot run multiple instantiations of the
* same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you
- * register a task definition with Windows containers, you must not specify a network mode.
- * If you use the console to register a task definition with Windows containers, you must
- * choose the
For more information, see Network * settings in the Docker run reference.
*/ @@ -5833,7 +5828,7 @@ export interface TaskDefinition { * Amazon Elastic Container Service Developer Guide. *The host and sourcePath parameters are not supported for
- * tasks run on AWS Fargate.
This parameter is not supported for tasks run on AWS Fargate.
+ *This parameter is not supported for tasks run on Fargate.
*An array of placement constraint objects to use for tasks.
*This parameter is not supported for tasks run on AWS Fargate.
+ *This parameter is not supported for tasks run on Fargate.
*If your tasks will be run on AWS Fargate, this field is required and you must use one of + *
If your tasks will be run on Fargate, this field is required and you must use one of
* the following values, which determines your range of valid values for the
* cpu parameter:
This parameter is not supported for Windows containers or tasks run on AWS Fargate.
+ *This parameter is not supported for Windows containers or tasks run on Fargate.
*This parameter is not supported for Windows containers or tasks run on AWS Fargate.
+ *This parameter is not supported for Windows containers or tasks run on Fargate.
*Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
The ephemeral storage setting override for the task.
*This parameter is only supported for tasks hosted on AWS Fargate using platform + *
This parameter is only supported for tasks hosted on Fargate using platform
* version 1.4.0 or later.
The platform version on which your task is running. A platform version is only
* specified for tasks using the Fargate launch type. If one is not
* specified, the LATEST platform version is used by default. For more
- * information, see AWS Fargate Platform
+ * information, see Fargate Platform
* Versions in the Amazon Elastic Container Service Developer Guide.
Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
The container instance ID or full ARN of the container instance.
- * The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
arn:aws:ecs namespace, followed by the Region of the container instance, the account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
*/
containerInstance?: string;
@@ -8323,8 +8318,8 @@ export interface PutClusterCapacityProvidersRequest {
* The name of one or more capacity providers to associate with the cluster.
*If specifying a capacity provider that uses an Auto Scaling group, the capacity * provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
- *To use a AWS Fargate capacity provider, specify either the FARGATE or
- * FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are
+ *
To use a Fargate capacity provider, specify either the FARGATE or
+ * FARGATE_SPOT capacity providers. The Fargate capacity providers are
* available to all accounts and only need to be associated with a cluster to be
* used.
UPDATING status can be used.
* If specifying a capacity provider that uses an Auto Scaling group, the capacity * provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
- *To use a AWS Fargate capacity provider, specify either the FARGATE or
- * FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are
+ *
To use a Fargate capacity provider, specify either the FARGATE or
+ * FARGATE_SPOT capacity providers. The Fargate capacity providers are
* available to all accounts and only need to be associated with a cluster to be
* used.
Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent - * permission to make AWS API calls on your behalf. The task execution IAM role is required + * permission to make Amazon Web Services API calls on your behalf. The task execution IAM role is required * depending on the requirements of your task. For more information, see Amazon ECS task * execution IAM role in the Amazon Elastic Container Service Developer Guide.
*/ @@ -8569,7 +8564,7 @@ export interface RegisterTaskDefinitionRequest { *none, bridge, awsvpc, and host.
* If no network mode is specified, the default is bridge.
* For Amazon ECS tasks on Fargate, the awsvpc network mode is required.
- * For Amazon ECS tasks on Amazon EC2 instances, any network mode can be used. If the network
+ * For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, awsvpc can be used. If the network
* mode is set to none, you cannot specify port mappings in your container
* definitions, and the tasks containers do not have external connectivity. The
* host and awsvpc network modes offer the highest networking
@@ -8589,17 +8584,8 @@ export interface RegisterTaskDefinitionRequest {
* interface, and you must specify a NetworkConfiguration value when you create
* a service or run a task with the task definition. For more information, see Task Networking in the
* Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the
- * ecs-init package, or AWS Fargate infrastructure support the
- * awsvpc network mode.
If the network mode is host, you cannot run multiple instantiations of the
* same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you
- * register a task definition with Windows containers, you must not specify a network mode.
- * If you use the console to register a task definition with Windows containers, you must
- * choose the
For more information, see Network * settings in the Docker run reference.
*/ @@ -8732,7 +8718,7 @@ export interface RegisterTaskDefinitionRequest { *Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
This parameter is not supported for Windows containers or tasks run on AWS Fargate.
+ *This parameter is not supported for Windows containers or tasks run on Fargate.
*This parameter is not supported for Windows containers or tasks run on AWS Fargate.
+ *This parameter is not supported for Windows containers or tasks run on Fargate.
*The amount of ephemeral storage to allocate for the task. This parameter is used to * expand the total amount of ephemeral storage available, beyond the default amount, for - * tasks hosted on AWS Fargate. For more information, see Fargate task - * storage in the Amazon ECS User Guide for AWS Fargate.
+ * tasks hosted on Fargate. For more information, see Fargate task + * storage in the Amazon ECS User Guide for Fargate. *This parameter is only supported for tasks hosted on AWS Fargate using platform + *
This parameter is only supported for tasks hosted on Fargate using platform
* version 1.4.0 or later.
Your AWS account has been blocked. For more information, contact AWS Support.
+ *Your Amazon Web Services account has been blocked. For more information, contact + * Amazon Web Services Support.
*/ export interface BlockedException extends __SmithyException, $MetadataBearer { name: "BlockedException"; @@ -8880,6 +8867,7 @@ export interface RunTaskRequest { * parameter must be omitted. If nocapacityProviderStrategy or
* launchType is specified, the
* defaultCapacityProviderStrategy for the cluster is used.
+ * When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.
The infrastructure on which to run your standalone task. For more information, see * Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
- *The FARGATE launch type runs your tasks on AWS Fargate On-Demand
+ *
The FARGATE launch type runs your tasks on Fargate On-Demand
* infrastructure.
Fargate Spot infrastructure is available for use but a capacity provider - * strategy must be used. For more information, see AWS Fargate capacity providers in the - * Amazon ECS User Guide for AWS Fargate.
+ * strategy must be used. For more information, see Fargate capacity providers in the + * Amazon ECS User Guide for Fargate. *The EC2 launch type runs your tasks on Amazon EC2 instances registered to your
* cluster.
A task can use either a launch type or a capacity provider strategy. If a
* launchType is specified, the capacityProviderStrategy
* parameter must be omitted.
When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.
The platform version the task should run. A platform version is only specified for
* tasks using the Fargate launch type. If one is not specified, the
* LATEST platform version is used by default. For more information, see
- * AWS Fargate Platform
+ * Fargate Platform
* Versions in the Amazon Elastic Container Service Developer Guide.
Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
Do not use aws:, AWS:, or any upper or lowercase
* combination of such as a prefix for either keys or values as it is reserved for
- * AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with
+ * Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with
* this prefix do not count against your tags per resource limit.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in * an Auto Scaling group that contain tasks from being terminated during a scale-in action. * The Auto Scaling group and each instance in the Auto Scaling group must have instance - * protection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide.
+ * protection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide. *When managed termination protection is disabled, your Amazon EC2 instances are not * protected from termination when the Auto Scaling group scales in.
*/ @@ -10021,8 +10010,8 @@ export interface UpdateServiceRequest { *UPDATING status can be used.
* If specifying a capacity provider that uses an Auto Scaling group, the capacity * provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
- *To use a AWS Fargate capacity provider, specify either the FARGATE or
- * FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are
+ *
To use a Fargate capacity provider, specify either the FARGATE or
+ * FARGATE_SPOT capacity providers. The Fargate capacity providers are
* available to all accounts and only need to be associated with a cluster to be
* used.
The PutClusterCapacityProviders API operation is used to update the @@ -10066,7 +10055,7 @@ export interface UpdateServiceRequest { *
The platform version on which your tasks in the service are running. A platform
* version is only specified for tasks using the Fargate launch type. If a
* platform version is not specified, the LATEST platform version is used by
- * default. For more information, see AWS Fargate Platform
+ * default. For more information, see Fargate Platform
* Versions in the Amazon Elastic Container Service Developer Guide.
Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on - * AWS without needing to stand up or maintain your own Kubernetes control plane. + * Amazon Web Services without needing to stand up or maintain your own Kubernetes control plane. * Kubernetes is an open-source system for automating the deployment, scaling, and * management of containerized applications.
*Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use @@ -154,7 +154,7 @@ export class EKS extends EKSClient { *
Associate encryption configuration to an existing cluster.
*You can use this API to enable encryption on existing clusters which do not have * encryption already enabled. This allows you to implement a defense-in-depth security - * strategy without migrating applications to new EKS clusters.
+ * strategy without migrating applications to new Amazon EKS clusters. */ public associateEncryptionConfig( args: AssociateEncryptionConfigCommandInput, @@ -259,7 +259,7 @@ export class EKS extends EKSClient { *Creates an Amazon EKS control plane.
*The Amazon EKS control plane consists of control plane instances that run the Kubernetes
* software, such as etcd and the API server. The control plane runs in an
- * account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server
+ * account managed by Amazon Web Services, and the Kubernetes API is exposed via the Amazon EKS API server
* endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and runs on its
* own set of Amazon EC2 instances.
The cluster control plane is provisioned across multiple Availability Zones and
@@ -267,7 +267,7 @@ export class EKS extends EKSClient {
* subnets to provide connectivity from the control plane instances to the nodes (for
* example, to support kubectl exec, logs, and proxy
* data flows).
Amazon EKS nodes run in your AWS account and connect to your cluster's control plane via + *
Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane via * the Kubernetes API server endpoint and a certificate file that is created for your * cluster.
* @@ -306,7 +306,7 @@ export class EKS extends EKSClient { } /** - *Creates an AWS Fargate profile for your Amazon EKS cluster. You must have at least one Fargate + *
Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate * profile in a cluster to be able to run pods on Fargate.
*The Fargate profile allows an administrator to declare which pods run on Fargate and specify * which pods run on which Fargate profile. This declaration is done through the profile’s @@ -329,7 +329,7 @@ export class EKS extends EKSClient { *
If any Fargate profiles in a cluster are in the DELETING status, you must
* wait for that Fargate profile to finish deleting before you can create any other profiles
* in that cluster.
For more information, see AWS Fargate Profile in the Amazon EKS User Guide.
+ *For more information, see Fargate Profile in the Amazon EKS User Guide.
*/ public createFargateProfile( args: CreateFargateProfileCommandInput, @@ -368,7 +368,7 @@ export class EKS extends EKSClient { * template. For more information about using launch templates, see Launch * template support. *An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that - * are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS + * are managed by Amazon Web Services for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS * optimized Amazon Linux 2 AMI. For more information, see Managed * Node Groups in the Amazon EKS User Guide.
*/ @@ -469,7 +469,7 @@ export class EKS extends EKSClient { } /** - *Deletes an AWS Fargate profile.
+ *Deletes an Fargate profile.
*When you delete a Fargate profile, any pods running on Fargate that were created with the * profile are deleted. If those pods match another Fargate profile, then they are scheduled * on Fargate with that profile. If they no longer match any Fargate profiles, then they are not @@ -644,7 +644,7 @@ export class EKS extends EKSClient { } /** - *
Returns descriptive information about an AWS Fargate profile.
+ *Returns descriptive information about an Fargate profile.
*/ public describeFargateProfile( args: DescribeFargateProfileCommandInput, @@ -778,7 +778,7 @@ export class EKS extends EKSClient { /** *Disassociates an identity provider configuration from a cluster. If you disassociate * an identity provider from your cluster, users included in the provider can no longer - * access the cluster. However, you can still access the cluster with AWS IAM + * access the cluster. However, you can still access the cluster with Amazon Web Services IAM * users.
*/ public disassociateIdentityProviderConfig( @@ -837,7 +837,7 @@ export class EKS extends EKSClient { } /** - *Lists the Amazon EKS clusters in your AWS account in the specified Region.
+ *Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
*/ public listClusters( args: ListClustersCommandInput, @@ -866,7 +866,7 @@ export class EKS extends EKSClient { } /** - *Lists the AWS Fargate profiles associated with the specified cluster in your AWS + *
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services * account in the specified Region.
*/ public listFargateProfiles( @@ -932,7 +932,7 @@ export class EKS extends EKSClient { /** *Lists the Amazon EKS managed node groups associated with the specified cluster in your - * AWS account in the specified Region. Self-managed node groups are not listed.
+ * Amazon Web Services account in the specified Region. Self-managed node groups are not listed. */ public listNodegroups( args: ListNodegroupsCommandInput, @@ -996,7 +996,7 @@ export class EKS extends EKSClient { } /** - *Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS + *
Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services * account, in the specified Region.
*/ public listUpdates(args: ListUpdatesCommandInput, options?: __HttpHandlerOptions): PromiseCloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported - * control plane logs. For more information, see Amazon CloudWatch Pricing.
+ * control plane logs. For more information, see CloudWatch Pricing. *You can also use this API operation to enable or disable public and private access to * your cluster's Kubernetes API server endpoint. By default, public access is enabled, and - * private access is disabled. For more information, see Amazon EKS Cluster - * Endpoint Access Control in the + * private access is disabled. For more information, see Amazon EKS cluster + * endpoint access control in the * Amazon EKS User Guide * .
*Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on - * AWS without needing to stand up or maintain your own Kubernetes control plane. + * Amazon Web Services without needing to stand up or maintain your own Kubernetes control plane. * Kubernetes is an open-source system for automating the deployment, scaling, and * management of containerized applications.
*Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use diff --git a/clients/client-eks/README.md b/clients/client-eks/README.md index 0033716210891..d10762cc615db 100644 --- a/clients/client-eks/README.md +++ b/clients/client-eks/README.md @@ -8,7 +8,7 @@ AWS SDK for JavaScript EKS Client for Node.js, Browser and React Native.
Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on -AWS without needing to stand up or maintain your own Kubernetes control plane. +Amazon Web Services without needing to stand up or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications.
Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use diff --git a/clients/client-eks/commands/AssociateEncryptionConfigCommand.ts b/clients/client-eks/commands/AssociateEncryptionConfigCommand.ts index a68fa5cc1fe13..707958493ea49 100644 --- a/clients/client-eks/commands/AssociateEncryptionConfigCommand.ts +++ b/clients/client-eks/commands/AssociateEncryptionConfigCommand.ts @@ -24,7 +24,7 @@ export interface AssociateEncryptionConfigCommandOutput extends AssociateEncrypt *
Associate encryption configuration to an existing cluster.
*You can use this API to enable encryption on existing clusters which do not have * encryption already enabled. This allows you to implement a defense-in-depth security - * strategy without migrating applications to new EKS clusters.
+ * strategy without migrating applications to new Amazon EKS clusters. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eks/commands/CreateClusterCommand.ts b/clients/client-eks/commands/CreateClusterCommand.ts index f26498de96bc6..11bed582b74a9 100644 --- a/clients/client-eks/commands/CreateClusterCommand.ts +++ b/clients/client-eks/commands/CreateClusterCommand.ts @@ -24,7 +24,7 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met *Creates an Amazon EKS control plane.
*The Amazon EKS control plane consists of control plane instances that run the Kubernetes
* software, such as etcd and the API server. The control plane runs in an
- * account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server
+ * account managed by Amazon Web Services, and the Kubernetes API is exposed via the Amazon EKS API server
* endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and runs on its
* own set of Amazon EC2 instances.
The cluster control plane is provisioned across multiple Availability Zones and
@@ -32,7 +32,7 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
* subnets to provide connectivity from the control plane instances to the nodes (for
* example, to support kubectl exec, logs, and proxy
* data flows).
Amazon EKS nodes run in your AWS account and connect to your cluster's control plane via + *
Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane via * the Kubernetes API server endpoint and a certificate file that is created for your * cluster.
* diff --git a/clients/client-eks/commands/CreateFargateProfileCommand.ts b/clients/client-eks/commands/CreateFargateProfileCommand.ts index ea7738e50623b..db823404991fa 100644 --- a/clients/client-eks/commands/CreateFargateProfileCommand.ts +++ b/clients/client-eks/commands/CreateFargateProfileCommand.ts @@ -21,7 +21,7 @@ export interface CreateFargateProfileCommandInput extends CreateFargateProfileRe export interface CreateFargateProfileCommandOutput extends CreateFargateProfileResponse, __MetadataBearer {} /** - *Creates an AWS Fargate profile for your Amazon EKS cluster. You must have at least one Fargate + *
Creates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate * profile in a cluster to be able to run pods on Fargate.
*The Fargate profile allows an administrator to declare which pods run on Fargate and specify * which pods run on which Fargate profile. This declaration is done through the profile’s @@ -44,7 +44,7 @@ export interface CreateFargateProfileCommandOutput extends CreateFargateProfileR *
If any Fargate profiles in a cluster are in the DELETING status, you must
* wait for that Fargate profile to finish deleting before you can create any other profiles
* in that cluster.
For more information, see AWS Fargate Profile in the Amazon EKS User Guide.
+ *For more information, see Fargate Profile in the Amazon EKS User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eks/commands/CreateNodegroupCommand.ts b/clients/client-eks/commands/CreateNodegroupCommand.ts index f9e081cf0b0f2..05d73f0438559 100644 --- a/clients/client-eks/commands/CreateNodegroupCommand.ts +++ b/clients/client-eks/commands/CreateNodegroupCommand.ts @@ -28,7 +28,7 @@ export interface CreateNodegroupCommandOutput extends CreateNodegroupResponse, _ * template. For more information about using launch templates, see Launch * template support. *An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that - * are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS + * are managed by Amazon Web Services for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS * optimized Amazon Linux 2 AMI. For more information, see Managed * Node Groups in the Amazon EKS User Guide.
* @example diff --git a/clients/client-eks/commands/DeleteFargateProfileCommand.ts b/clients/client-eks/commands/DeleteFargateProfileCommand.ts index c69d9f1090e90..98b359f3bfd77 100644 --- a/clients/client-eks/commands/DeleteFargateProfileCommand.ts +++ b/clients/client-eks/commands/DeleteFargateProfileCommand.ts @@ -21,7 +21,7 @@ export interface DeleteFargateProfileCommandInput extends DeleteFargateProfileRe export interface DeleteFargateProfileCommandOutput extends DeleteFargateProfileResponse, __MetadataBearer {} /** - *Deletes an AWS Fargate profile.
+ *Deletes an Fargate profile.
*When you delete a Fargate profile, any pods running on Fargate that were created with the * profile are deleted. If those pods match another Fargate profile, then they are scheduled * on Fargate with that profile. If they no longer match any Fargate profiles, then they are not diff --git a/clients/client-eks/commands/DescribeFargateProfileCommand.ts b/clients/client-eks/commands/DescribeFargateProfileCommand.ts index c930ccb015c21..46eb9256c701c 100644 --- a/clients/client-eks/commands/DescribeFargateProfileCommand.ts +++ b/clients/client-eks/commands/DescribeFargateProfileCommand.ts @@ -21,7 +21,7 @@ export interface DescribeFargateProfileCommandInput extends DescribeFargateProfi export interface DescribeFargateProfileCommandOutput extends DescribeFargateProfileResponse, __MetadataBearer {} /** - *
Returns descriptive information about an AWS Fargate profile.
+ *Returns descriptive information about an Fargate profile.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eks/commands/DisassociateIdentityProviderConfigCommand.ts b/clients/client-eks/commands/DisassociateIdentityProviderConfigCommand.ts index 2be0fa94cbdc0..88bc390f5aa73 100644 --- a/clients/client-eks/commands/DisassociateIdentityProviderConfigCommand.ts +++ b/clients/client-eks/commands/DisassociateIdentityProviderConfigCommand.ts @@ -28,7 +28,7 @@ export interface DisassociateIdentityProviderConfigCommandOutput /** *Disassociates an identity provider configuration from a cluster. If you disassociate * an identity provider from your cluster, users included in the provider can no longer - * access the cluster. However, you can still access the cluster with AWS IAM + * access the cluster. However, you can still access the cluster with Amazon Web Services IAM * users.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-eks/commands/ListClustersCommand.ts b/clients/client-eks/commands/ListClustersCommand.ts index 52fb1b850dcb1..b712155dcde32 100644 --- a/clients/client-eks/commands/ListClustersCommand.ts +++ b/clients/client-eks/commands/ListClustersCommand.ts @@ -21,7 +21,7 @@ export interface ListClustersCommandInput extends ListClustersRequest {} export interface ListClustersCommandOutput extends ListClustersResponse, __MetadataBearer {} /** - *Lists the Amazon EKS clusters in your AWS account in the specified Region.
+ *Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eks/commands/ListFargateProfilesCommand.ts b/clients/client-eks/commands/ListFargateProfilesCommand.ts index 0a2b521d35baf..3919e183b02c7 100644 --- a/clients/client-eks/commands/ListFargateProfilesCommand.ts +++ b/clients/client-eks/commands/ListFargateProfilesCommand.ts @@ -21,7 +21,7 @@ export interface ListFargateProfilesCommandInput extends ListFargateProfilesRequ export interface ListFargateProfilesCommandOutput extends ListFargateProfilesResponse, __MetadataBearer {} /** - *Lists the AWS Fargate profiles associated with the specified cluster in your AWS + *
Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services * account in the specified Region.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-eks/commands/ListNodegroupsCommand.ts b/clients/client-eks/commands/ListNodegroupsCommand.ts index fa0ad7a5ac572..3fa4213576c20 100644 --- a/clients/client-eks/commands/ListNodegroupsCommand.ts +++ b/clients/client-eks/commands/ListNodegroupsCommand.ts @@ -22,7 +22,7 @@ export interface ListNodegroupsCommandOutput extends ListNodegroupsResponse, __M /** *Lists the Amazon EKS managed node groups associated with the specified cluster in your - * AWS account in the specified Region. Self-managed node groups are not listed.
+ * Amazon Web Services account in the specified Region. Self-managed node groups are not listed. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-eks/commands/ListUpdatesCommand.ts b/clients/client-eks/commands/ListUpdatesCommand.ts index 896949766f7fa..4f9d14ec24372 100644 --- a/clients/client-eks/commands/ListUpdatesCommand.ts +++ b/clients/client-eks/commands/ListUpdatesCommand.ts @@ -21,7 +21,7 @@ export interface ListUpdatesCommandInput extends ListUpdatesRequest {} export interface ListUpdatesCommandOutput extends ListUpdatesResponse, __MetadataBearer {} /** - *Lists the updates associated with an Amazon EKS cluster or managed node group in your AWS + *
Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services * account, in the specified Region.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-eks/commands/UpdateClusterConfigCommand.ts b/clients/client-eks/commands/UpdateClusterConfigCommand.ts index e10942450ced4..e482c389b96d2 100644 --- a/clients/client-eks/commands/UpdateClusterConfigCommand.ts +++ b/clients/client-eks/commands/UpdateClusterConfigCommand.ts @@ -33,12 +33,12 @@ export interface UpdateClusterConfigCommandOutput extends UpdateClusterConfigRes * . *CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported - * control plane logs. For more information, see Amazon CloudWatch Pricing.
+ * control plane logs. For more information, see CloudWatch Pricing. *You can also use this API operation to enable or disable public and private access to * your cluster's Kubernetes API server endpoint. By default, public access is enabled, and - * private access is disabled. For more information, see Amazon EKS Cluster - * Endpoint Access Control in the + * private access is disabled. For more information, see Amazon EKS cluster + * endpoint access control in the * Amazon EKS User Guide * .
*Identifies the AWS Key Management Service (AWS KMS) key used to encrypt the secrets.
+ *Identifies the Key Management Service (KMS) key used to encrypt the secrets.
*/ export interface Provider { /** *Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same * region as the cluster, and if the KMS key was created in a different account, the user * must have access to the KMS key. For more information, see Allowing - * Users in Other Accounts to Use a KMS key in the AWS Key Management Service + * Users in Other Accounts to Use a KMS key in the Key Management Service * Developer Guide.
*/ keyArn?: string; @@ -258,7 +258,7 @@ export interface EncryptionConfig { resources?: string[]; /** - *AWS Key Management Service (AWS KMS) key. Either the ARN or the alias can be used.
+ *Key Management Service (KMS) key. Either the ARN or the alias can be used.
*/ provider?: Provider; } @@ -865,8 +865,8 @@ export interface CreateAddonRequest { clusterName: string | undefined; /** - *The name of the add-on. The name must match one of the names returned by
- * The name of the add-on. The name must match one of the names returned by
+ * Specify one or more security groups for the cross-account elastic network interfaces
- * that Amazon EKS creates to use to allow communication between your nodes and the Kubernetes
+ * that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes
* control plane. If you don't specify any security groups, then familiarize yourself with
* the difference between Amazon EKS defaults for clusters deployed with Kubernetes:ListAddons
+ * DescribeAddonVersions
* .
@@ -1064,8 +1064,8 @@ export interface VpcConfigRequest {
* Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes
* API server can only receive requests from within the cluster VPC. The default value for
* this parameter is
true, which enables public access for your Kubernetes API
- * server. For more information, see Amazon EKS Cluster
- * Endpoint Access Control in the
+ * server. For more information, see Amazon EKS cluster
+ * endpoint access control in the
* Amazon EKS User Guide
* .
false, which disables private access for your Kubernetes API
- * server. If you disable private access and you have nodes or AWS Fargate pods in the
+ * server. If you disable private access and you have nodes or Fargate pods in the
* cluster, then ensure that publicAccessCidrs includes the necessary CIDR
- * blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS Cluster
- * Endpoint Access Control in the
+ * blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster
+ * endpoint access control in the
* Amazon EKS User Guide
* .
*/
@@ -1089,9 +1089,9 @@ export interface VpcConfigRequest {
* The CIDR blocks that are allowed access to your cluster's public Kubernetes API server
* endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that
* you specify is denied. The default value is 0.0.0.0/0. If you've disabled
- * private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure
- * that you specify the necessary CIDR blocks. For more information, see Amazon EKS Cluster
- * Endpoint Access Control in the
+ * private endpoint access and you have nodes or Fargate pods in the cluster, then ensure
+ * that you specify the necessary CIDR blocks. For more information, see Amazon EKS cluster
+ * endpoint access control in the
* Amazon EKS User Guide
* .
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control - * plane to make calls to AWS API operations on your behalf. For more information, see + * plane to make calls to Amazon Web Services API operations on your behalf. For more information, see * Amazon EKS * Service IAM Role in the * Amazon EKS User Guide @@ -1147,13 +1147,13 @@ export interface CreateClusterRequest { /** *
Enable or disable exporting the Kubernetes control plane logs for your cluster to * CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more - * information, see Amazon EKS Cluster Control Plane Logs in the + * information, see Amazon EKS Cluster control plane logs in the * * Amazon EKS User Guide * .
*CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported - * control plane logs. For more information, see Amazon CloudWatch Pricing.
+ * control plane logs. For more information, see CloudWatch Pricing. *This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If
* the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate
* from within your cluster's VPC use the private VPC endpoint instead of traversing the
- * internet. If this value is disabled and you have nodes or AWS Fargate pods in the cluster,
+ * internet. If this value is disabled and you have nodes or Fargate pods in the cluster,
* then ensure that publicAccessCidrs includes the necessary CIDR blocks for
- * communication with the nodes or Fargate pods. For more information, see Amazon EKS Cluster
- * Endpoint Access Control in the
+ * communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster
+ * endpoint access control in the
* Amazon EKS User Guide
* .
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server
* endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks
* is denied. The default value is 0.0.0.0/0. If you've disabled private
- * endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that the
- * necessary CIDR blocks are listed. For more information, see Amazon EKS Cluster
- * Endpoint Access Control in the
+ * endpoint access and you have nodes or Fargate pods in the cluster, then ensure that the
+ * necessary CIDR blocks are listed. For more information, see Amazon EKS cluster
+ * endpoint access control in the
* Amazon EKS User Guide
* .
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control - * plane to make calls to AWS API operations on your behalf.
+ * plane to make calls to Amazon Web Services API operations on your behalf. */ roleArn?: string; @@ -1543,7 +1543,7 @@ export namespace UnsupportedAvailabilityZoneException { } /** - *An object representing an AWS Fargate profile selector.
+ *An object representing an Fargate profile selector.
*/ export interface FargateProfileSelector { /** @@ -1628,7 +1628,7 @@ export namespace CreateFargateProfileRequest { export type FargateProfileStatus = "ACTIVE" | "CREATE_FAILED" | "CREATING" | "DELETE_FAILED" | "DELETING"; /** - *An object representing an AWS Fargate profile.
+ *An object representing an Fargate profile.
*/ export interface FargateProfile { /** @@ -1762,8 +1762,8 @@ export namespace LaunchTemplateSpecification { export interface RemoteAccessConfig { /** *The Amazon EC2 SSH key that provides access for SSH communication with the nodes in the - * managed node group. For more information, see Amazon EC2 Key - * Pairs in the Amazon Elastic Compute Cloud User Guide for Linux Instances.
+ * managed node group. For more information, see Amazon EC2 key + * pairs and Linux instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances. */ ec2SshKey?: string; @@ -1794,8 +1794,7 @@ export namespace RemoteAccessConfig { */ export interface NodegroupScalingConfig { /** - *The minimum number of nodes that the managed node group can scale in to. This number - * must be greater than zero.
+ *The minimum number of nodes that the managed node group can scale in to.
*/ minSize?: number; @@ -1856,8 +1855,21 @@ export namespace Taint { }); } +/** + *The node group update configuration.
+ */ export interface NodegroupUpdateConfig { + /** + *The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel.
+ * This value or maxUnavailablePercentage is required to have a value.The maximum number
+ * is 100.
The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be
+ * updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.
The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker
- * node kubelet daemon makes calls to AWS APIs on your behalf. Nodes receive
+ * node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive
* permissions for these API calls through an IAM instance profile and associated
* policies. Before you can launch nodes and register them into a cluster, you must create
* an IAM role for those nodes to use when they are launched. For more information, see
@@ -1984,7 +1996,11 @@ export interface CreateNodegroupRequest {
*/
launchTemplate?: LaunchTemplateSpecification;
+ /**
+ *
The node group update configuration.
+ */ updateConfig?: NodegroupUpdateConfig; + /** *The capacity type for your node group.
*/ @@ -2119,7 +2135,7 @@ export interface Issue { * *- * InstanceLimitExceeded: Your AWS account is + * InstanceLimitExceeded: Your Amazon Web Services account is * unable to launch any more instances of the specified instance type. You may be * able to request an Amazon EC2 instance limit increase to recover.
*The AWS resources that are afflicted by this issue.
+ *The Amazon Web Services resources that are afflicted by this issue.
*/ resourceIds?: string[]; } @@ -2308,7 +2324,7 @@ export interface Nodegroup { /** *The IAM role associated with your node group. The Amazon EKS node kubelet
- * daemon makes calls to AWS APIs on your behalf. Nodes receive permissions for these API
+ * daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API
* calls through an IAM instance profile and associated policies.
The Kubernetes taints to be applied to the nodes in the node group when they are
- * created. Effect is one of NoSchedule, PreferNoSchedule, or NoExecute. Kubernetes taints
+ * created. Effect is one of No_Schedule, Prefer_No_Schedule, or No_Execute. Kubernetes taints
* can be used together with tolerations to control how workloads are scheduled to your
* nodes.
The node group update configuration.
+ */ updateConfig?: NodegroupUpdateConfig; + /** *If a launch template was used to create the node group, then this is the launch * template that was used.
@@ -3145,7 +3165,7 @@ export namespace ListClustersResponse { export interface ListFargateProfilesRequest { /** - *The name of the Amazon EKS cluster that you would like to listFargate profiles in.
+ *The name of the Amazon EKS cluster that you would like to list Fargate profiles in.
*/ clusterName: string | undefined; @@ -3620,13 +3640,13 @@ export interface UpdateClusterConfigRequest { /** *Enable or disable exporting the Kubernetes control plane logs for your cluster to * CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more - * information, see Amazon EKS Cluster Control Plane Logs in the + * information, see Amazon EKS cluster control plane logs in the * * Amazon EKS User Guide * .
*CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported - * control plane logs. For more information, see Amazon CloudWatch Pricing.
+ * control plane logs. For more information, see CloudWatch Pricing. *The node group update configuration.
+ */ updateConfig?: NodegroupUpdateConfig; + /** *Unique, case-sensitive identifier that you provide to ensure the idempotency of the * request.
diff --git a/clients/client-frauddetector/models/models_0.ts b/clients/client-frauddetector/models/models_0.ts index 561d7e6f27b54..a138f350fc31a 100644 --- a/clients/client-frauddetector/models/models_0.ts +++ b/clients/client-frauddetector/models/models_0.ts @@ -1619,6 +1619,54 @@ export namespace TrainingMetrics { }); } +/** + *The logit metric details.
+ */ +export interface LogitMetric { + /** + *The name of the variable.
+ */ + variableName: string | undefined; + + /** + *The type of variable.
+ */ + variableType: string | undefined; + + /** + *The relative importance of the variable.
+ */ + variableImportance: number | undefined; +} + +export namespace LogitMetric { + /** + * @internal + */ + export const filterSensitiveLog = (obj: LogitMetric): any => ({ + ...obj, + }); +} + +/** + *The variable importance metrics details.
+ */ +export interface VariableImportanceMetrics { + /** + *List of variable metrics.
+ */ + LogitMetrics?: LogitMetric[]; +} + +export namespace VariableImportanceMetrics { + /** + * @internal + */ + export const filterSensitiveLog = (obj: VariableImportanceMetrics): any => ({ + ...obj, + }); +} + /** *The training result details.
*/ @@ -1632,6 +1680,11 @@ export interface TrainingResult { *The training metric details.
*/ trainingMetrics?: TrainingMetrics; + + /** + *The variable importance metrics.
+ */ + variableImportanceMetrics?: VariableImportanceMetrics; } export namespace TrainingResult { @@ -2218,7 +2271,32 @@ export interface GetEventPredictionRequest { eventTimestamp: string | undefined; /** - *Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.
+ *Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and + * their corresponding values for the event you are sending for evaluation.
+ *You must provide at least one eventVariable
+ *If detectorVersion is associated with a modelVersion, you must provide at least one associated eventVariable
+ *To ensure highest possible fraud prediction and to simplify your data preparation, Amazon Fraud Detector will replace all missing variables or values as follows:
+ * + *+ * For Amazon Fraud Detector trained models: + *
+ *If a null value is provided explicitly for a variable or if a variable is missing, model will replace the null value or the missing variable (no variable name in the eventVariables map) + * with calculated default mean/medians for numeric variables and with special values for categorical variables.
+ * + *+ * For External models ( for example, imported SageMaker): + *
+ *If a null value is provided explicitly for a variable, the model and rules will use “null” as the value. If a variable is not provided (no variable name in the eventVariables map), model and rules + * will use the default value that is provided for the variable.
*/ eventVariables: { [key: string]: string } | undefined; diff --git a/clients/client-frauddetector/protocols/Aws_json1_1.ts b/clients/client-frauddetector/protocols/Aws_json1_1.ts index 13839847fba09..7f0d7f43db7b5 100644 --- a/clients/client-frauddetector/protocols/Aws_json1_1.ts +++ b/clients/client-frauddetector/protocols/Aws_json1_1.ts @@ -200,6 +200,7 @@ import { LabelSchema, ListTagsForResourceRequest, ListTagsForResourceResult, + LogitMetric, MetricDataPoint, Model, ModelEndpointDataBlob, @@ -257,6 +258,7 @@ import { ValidationException, Variable, VariableEntry, + VariableImportanceMetrics, } from "../models/models_0"; import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; import { @@ -1293,6 +1295,14 @@ const deserializeAws_json1_1CreateBatchPredictionJobCommandError = async ( $metadata: deserializeMetadata(output), }; break; + case "ResourceNotFoundException": + case "com.amazonaws.frauddetector#ResourceNotFoundException": + response = { + ...(await deserializeAws_json1_1ResourceNotFoundExceptionResponse(parsedOutput, context)), + name: errorCode, + $metadata: deserializeMetadata(output), + }; + break; case "ValidationException": case "com.amazonaws.frauddetector#ValidationException": response = { @@ -7243,6 +7253,17 @@ const deserializeAws_json1_1LabelSchema = (output: any, context: __SerdeContext) } as any; }; +const deserializeAws_json1_1ListOfLogitMetrics = (output: any, context: __SerdeContext): LogitMetric[] => { + return (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + if (entry === null) { + return null as any; + } + return deserializeAws_json1_1LogitMetric(entry, context); + }); +}; + const deserializeAws_json1_1ListOfModelScores = (output: any, context: __SerdeContext): ModelScores[] => { return (output || []) .filter((e: any) => e != null) @@ -7300,6 +7321,14 @@ const deserializeAws_json1_1ListTagsForResourceResult = ( } as any; }; +const deserializeAws_json1_1LogitMetric = (output: any, context: __SerdeContext): LogitMetric => { + return { + variableImportance: __handleFloat(output.variableImportance), + variableName: __expectString(output.variableName), + variableType: __expectString(output.variableType), + } as any; +}; + const deserializeAws_json1_1MetricDataPoint = (output: any, context: __SerdeContext): MetricDataPoint => { return { fpr: __handleFloat(output.fpr), @@ -7634,6 +7663,10 @@ const deserializeAws_json1_1TrainingResult = (output: any, context: __SerdeConte output.trainingMetrics !== undefined && output.trainingMetrics !== null ? deserializeAws_json1_1TrainingMetrics(output.trainingMetrics, context) : undefined, + variableImportanceMetrics: + output.variableImportanceMetrics !== undefined && output.variableImportanceMetrics !== null + ? deserializeAws_json1_1VariableImportanceMetrics(output.variableImportanceMetrics, context) + : undefined, } as any; }; @@ -7726,6 +7759,18 @@ const deserializeAws_json1_1Variable = (output: any, context: __SerdeContext): V } as any; }; +const deserializeAws_json1_1VariableImportanceMetrics = ( + output: any, + context: __SerdeContext +): VariableImportanceMetrics => { + return { + LogitMetrics: + output.LogitMetrics !== undefined && output.LogitMetrics !== null + ? deserializeAws_json1_1ListOfLogitMetrics(output.LogitMetrics, context) + : undefined, + } as any; +}; + const deserializeAws_json1_1VariableList = (output: any, context: __SerdeContext): Variable[] => { return (output || []) .filter((e: any) => e != null) diff --git a/clients/client-glue/commands/GetJobBookmarkCommand.ts b/clients/client-glue/commands/GetJobBookmarkCommand.ts index c3a2799e769b2..a01a38a1410e2 100644 --- a/clients/client-glue/commands/GetJobBookmarkCommand.ts +++ b/clients/client-glue/commands/GetJobBookmarkCommand.ts @@ -1,6 +1,5 @@ import { GlueClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GlueClient"; -import { GetJobBookmarkRequest } from "../models/models_0"; -import { GetJobBookmarkResponse } from "../models/models_1"; +import { GetJobBookmarkRequest, GetJobBookmarkResponse } from "../models/models_1"; import { deserializeAws_json1_1GetJobBookmarkCommand, serializeAws_json1_1GetJobBookmarkCommand, diff --git a/clients/client-glue/models/models_0.ts b/clients/client-glue/models/models_0.ts index 8144663e4ec4d..438364db6d5d7 100644 --- a/clients/client-glue/models/models_0.ts +++ b/clients/client-glue/models/models_0.ts @@ -2093,6 +2093,31 @@ export namespace BatchGetTriggersRequest { }); } +/** + *Batch condition that must be met (specified number of events received or batch time window expired) + * before EventBridge event trigger fires.
+ */ +export interface EventBatchingCondition { + /** + *Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.
+ */ + BatchSize: number | undefined; + + /** + *Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.
+ */ + BatchWindow?: number; +} + +export namespace EventBatchingCondition { + /** + * @internal + */ + export const filterSensitiveLog = (obj: EventBatchingCondition): any => ({ + ...obj, + }); +} + export enum CrawlState { CANCELLED = "CANCELLED", CANCELLING = "CANCELLING", @@ -2198,6 +2223,7 @@ export enum TriggerState { export enum TriggerType { CONDITIONAL = "CONDITIONAL", + EVENT = "EVENT", ON_DEMAND = "ON_DEMAND", SCHEDULED = "SCHEDULED", } @@ -2253,6 +2279,12 @@ export interface Trigger { *The predicate of this trigger, which defines when it will fire.
*/ Predicate?: Predicate; + + /** + *Batch condition that must be met (specified number of events received or batch time window expired) + * before EventBridge event trigger fires.
+ */ + EventBatchingCondition?: EventBatchingCondition; } export namespace Trigger { @@ -2307,8 +2339,8 @@ export namespace BatchGetWorkflowsRequest { } /** - *An edge represents a directed connection between two Glue components that are part of the workflow the - * edge belongs to.
+ *An edge represents a directed connection between two components + * on a workflow graph.
*/ export interface Edge { /** @@ -2643,7 +2675,7 @@ export enum NodeType { } /** - *A node represents an Glue component such as a trigger, or job, etc., that is part of a workflow.
+ *A node represents an Glue component (trigger, crawler, or job) on a workflow graph.
*/ export interface Node { /** @@ -2711,6 +2743,32 @@ export namespace WorkflowGraph { }); } +/** + *The batch condition that started the workflow run. Either the number of events in the batch size arrived, + * in which case the BatchSize member is non-zero, or the batch window expired, in which case the BatchWindow + * member is non-zero.
+ */ +export interface StartingEventBatchCondition { + /** + *Number of events in the batch.
+ */ + BatchSize?: number; + + /** + *Duration of the batch window in seconds.
+ */ + BatchWindow?: number; +} + +export namespace StartingEventBatchCondition { + /** + * @internal + */ + export const filterSensitiveLog = (obj: StartingEventBatchCondition): any => ({ + ...obj, + }); +} + /** *Workflow run statistics provides statistics about the workflow run.
*/ @@ -2817,6 +2875,11 @@ export interface WorkflowRun { * connections between them as edges. */ Graph?: WorkflowGraph; + + /** + *The batch condition that started the workflow run.
+ */ + StartingEventBatchCondition?: StartingEventBatchCondition; } export namespace WorkflowRun { @@ -2829,12 +2892,13 @@ export namespace WorkflowRun { } /** - *A workflow represents a flow in which Glue components should be run to complete a logical - * task.
+ *A workflow is a collection of multiple dependent Glue + * jobs and crawlers that are run to complete a complex ETL task. A + * workflow manages the execution and monitoring of all its jobs and crawlers.
*/ export interface Workflow { /** - *The name of the workflow representing the flow.
+ *The name of the workflow.
*/ Name?: string; @@ -2844,7 +2908,9 @@ export interface Workflow { Description?: string; /** - *A collection of properties to be used as part of each execution of the workflow.
+ *A collection of properties to be used as part of each execution of the workflow. + * The run properties are made available to each job in the workflow. A job can modify + * the properties for the next jobs in the flow.
*/ DefaultRunProperties?: { [key: string]: string }; @@ -5566,6 +5632,12 @@ export interface CreateTriggerRequest { * Amazon Web Services Tags in Glue in the developer guide. */ Tags?: { [key: string]: string }; + + /** + *Batch condition that must be met (specified number of events received or batch time window expired) + * before EventBridge event trigger fires.
+ */ + EventBatchingCondition?: EventBatchingCondition; } export namespace CreateTriggerRequest { @@ -8472,73 +8544,3 @@ export namespace GetJobResponse { ...obj, }); } - -export interface GetJobBookmarkRequest { - /** - *The name of the job in question.
- */ - JobName: string | undefined; - - /** - *The unique run identifier associated with this job run.
- */ - RunId?: string; -} - -export namespace GetJobBookmarkRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: GetJobBookmarkRequest): any => ({ - ...obj, - }); -} - -/** - *Defines a point that a job can resume processing.
- */ -export interface JobBookmarkEntry { - /** - *The name of the job in question.
- */ - JobName?: string; - - /** - *The version of the job.
- */ - Version?: number; - - /** - *The run ID number.
- */ - Run?: number; - - /** - *The attempt ID number.
- */ - Attempt?: number; - - /** - *The unique run identifier associated with the previous job run.
- */ - PreviousRunId?: string; - - /** - *The run ID number.
- */ - RunId?: string; - - /** - *The bookmark itself.
- */ - JobBookmark?: string; -} - -export namespace JobBookmarkEntry { - /** - * @internal - */ - export const filterSensitiveLog = (obj: JobBookmarkEntry): any => ({ - ...obj, - }); -} diff --git a/clients/client-glue/models/models_1.ts b/clients/client-glue/models/models_1.ts index 782e31de14935..7faa02c8bdccb 100644 --- a/clients/client-glue/models/models_1.ts +++ b/clients/client-glue/models/models_1.ts @@ -13,10 +13,10 @@ import { DatabaseInput, EncryptionConfiguration, ErrorDetail, + EventBatchingCondition, ExecutionProperty, GlueTable, Job, - JobBookmarkEntry, JobCommand, JobRun, Language, @@ -51,6 +51,76 @@ import { } from "./models_0"; import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types"; +export interface GetJobBookmarkRequest { + /** + *The name of the job in question.
+ */ + JobName: string | undefined; + + /** + *The unique run identifier associated with this job run.
+ */ + RunId?: string; +} + +export namespace GetJobBookmarkRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetJobBookmarkRequest): any => ({ + ...obj, + }); +} + +/** + *Defines a point that a job can resume processing.
+ */ +export interface JobBookmarkEntry { + /** + *The name of the job in question.
+ */ + JobName?: string; + + /** + *The version of the job.
+ */ + Version?: number; + + /** + *The run ID number.
+ */ + Run?: number; + + /** + *The attempt ID number.
+ */ + Attempt?: number; + + /** + *The unique run identifier associated with the previous job run.
+ */ + PreviousRunId?: string; + + /** + *The run ID number.
+ */ + RunId?: string; + + /** + *The bookmark itself.
+ */ + JobBookmark?: string; +} + +export namespace JobBookmarkEntry { + /** + * @internal + */ + export const filterSensitiveLog = (obj: JobBookmarkEntry): any => ({ + ...obj, + }); +} + export interface GetJobBookmarkResponse { /** *A structure that defines a point that a job can resume processing.
@@ -6595,6 +6665,12 @@ export interface TriggerUpdate { *The predicate of this trigger, which defines when it will fire.
*/ Predicate?: Predicate; + + /** + *Batch condition that must be met (specified number of events received or batch time window expired) + * before EventBridge event trigger fires.
+ */ + EventBatchingCondition?: EventBatchingCondition; } export namespace TriggerUpdate { diff --git a/clients/client-glue/protocols/Aws_json1_1.ts b/clients/client-glue/protocols/Aws_json1_1.ts index dde550b8f3309..244fde6e384c4 100644 --- a/clients/client-glue/protocols/Aws_json1_1.ts +++ b/clients/client-glue/protocols/Aws_json1_1.ts @@ -460,6 +460,7 @@ import { EntityNotFoundException, ErrorDetail, ErrorDetails, + EventBatchingCondition, ExecutionProperty, FindMatchesParameters, GetCatalogImportStatusRequest, @@ -495,7 +496,6 @@ import { GetDevEndpointResponse, GetDevEndpointsRequest, GetDevEndpointsResponse, - GetJobBookmarkRequest, GetJobRequest, GetJobResponse, GlueEncryptionException, @@ -506,7 +506,6 @@ import { InvalidInputException, JdbcTarget, Job, - JobBookmarkEntry, JobBookmarksEncryption, JobCommand, JobNodeDetails, @@ -545,6 +544,7 @@ import { SchemaVersionErrorItem, SerDeInfo, SkewedInfo, + StartingEventBatchCondition, StorageDescriptor, StringColumnStatisticsData, TableError, @@ -577,6 +577,7 @@ import { ExportLabelsTaskRunProperties, FindMatchesMetrics, FindMatchesTaskRunProperties, + GetJobBookmarkRequest, GetJobBookmarkResponse, GetJobRunRequest, GetJobRunResponse, @@ -651,6 +652,7 @@ import { ImportCatalogToGlueRequest, ImportCatalogToGlueResponse, ImportLabelsTaskRunProperties, + JobBookmarkEntry, JobUpdate, KeySchemaElement, LabelingSetGenerationTaskRunProperties, @@ -16831,6 +16833,10 @@ const serializeAws_json1_1CreateTriggerRequest = (input: CreateTriggerRequest, c ...(input.Actions !== undefined && input.Actions !== null && { Actions: serializeAws_json1_1ActionList(input.Actions, context) }), ...(input.Description !== undefined && input.Description !== null && { Description: input.Description }), + ...(input.EventBatchingCondition !== undefined && + input.EventBatchingCondition !== null && { + EventBatchingCondition: serializeAws_json1_1EventBatchingCondition(input.EventBatchingCondition, context), + }), ...(input.Name !== undefined && input.Name !== null && { Name: input.Name }), ...(input.Predicate !== undefined && input.Predicate !== null && { Predicate: serializeAws_json1_1Predicate(input.Predicate, context) }), @@ -17293,6 +17299,13 @@ const serializeAws_json1_1EncryptionConfiguration = (input: EncryptionConfigurat }; }; +const serializeAws_json1_1EventBatchingCondition = (input: EventBatchingCondition, context: __SerdeContext): any => { + return { + ...(input.BatchSize !== undefined && input.BatchSize !== null && { BatchSize: input.BatchSize }), + ...(input.BatchWindow !== undefined && input.BatchWindow !== null && { BatchWindow: input.BatchWindow }), + }; +}; + const serializeAws_json1_1ExecutionProperty = (input: ExecutionProperty, context: __SerdeContext): any => { return { ...(input.MaxConcurrentRuns !== undefined && @@ -19076,6 +19089,10 @@ const serializeAws_json1_1TriggerUpdate = (input: TriggerUpdate, context: __Serd ...(input.Actions !== undefined && input.Actions !== null && { Actions: serializeAws_json1_1ActionList(input.Actions, context) }), ...(input.Description !== undefined && input.Description !== null && { Description: input.Description }), + ...(input.EventBatchingCondition !== undefined && + input.EventBatchingCondition !== null && { + EventBatchingCondition: serializeAws_json1_1EventBatchingCondition(input.EventBatchingCondition, context), + }), ...(input.Name !== undefined && input.Name !== null && { Name: input.Name }), ...(input.Predicate !== undefined && input.Predicate !== null && { Predicate: serializeAws_json1_1Predicate(input.Predicate, context) }), @@ -21173,6 +21190,13 @@ const deserializeAws_json1_1EvaluationMetrics = (output: any, context: __SerdeCo } as any; }; +const deserializeAws_json1_1EventBatchingCondition = (output: any, context: __SerdeContext): EventBatchingCondition => { + return { + BatchSize: __expectNumber(output.BatchSize), + BatchWindow: __expectNumber(output.BatchWindow), + } as any; +}; + const deserializeAws_json1_1ExecutionProperty = (output: any, context: __SerdeContext): ExecutionProperty => { return { MaxConcurrentRuns: __expectNumber(output.MaxConcurrentRuns), @@ -23316,6 +23340,16 @@ const deserializeAws_json1_1StartImportLabelsTaskRunResponse = ( } as any; }; +const deserializeAws_json1_1StartingEventBatchCondition = ( + output: any, + context: __SerdeContext +): StartingEventBatchCondition => { + return { + BatchSize: __expectNumber(output.BatchSize), + BatchWindow: __expectNumber(output.BatchWindow), + } as any; +}; + const deserializeAws_json1_1StartJobRunResponse = (output: any, context: __SerdeContext): StartJobRunResponse => { return { JobRunId: __expectString(output.JobRunId), @@ -23701,6 +23735,10 @@ const deserializeAws_json1_1Trigger = (output: any, context: __SerdeContext): Tr ? deserializeAws_json1_1ActionList(output.Actions, context) : undefined, Description: __expectString(output.Description), + EventBatchingCondition: + output.EventBatchingCondition !== undefined && output.EventBatchingCondition !== null + ? deserializeAws_json1_1EventBatchingCondition(output.EventBatchingCondition, context) + : undefined, Id: __expectString(output.Id), Name: __expectString(output.Name), Predicate: @@ -23997,6 +24035,10 @@ const deserializeAws_json1_1WorkflowRun = (output: any, context: __SerdeContext) output.StartedOn !== undefined && output.StartedOn !== null ? new Date(Math.round(output.StartedOn * 1000)) : undefined, + StartingEventBatchCondition: + output.StartingEventBatchCondition !== undefined && output.StartingEventBatchCondition !== null + ? deserializeAws_json1_1StartingEventBatchCondition(output.StartingEventBatchCondition, context) + : undefined, Statistics: output.Statistics !== undefined && output.Statistics !== null ? deserializeAws_json1_1WorkflowRunStatistics(output.Statistics, context) diff --git a/clients/client-healthlake/HealthLake.ts b/clients/client-healthlake/HealthLake.ts index d9cf05a15f53d..56d8c902da76d 100644 --- a/clients/client-healthlake/HealthLake.ts +++ b/clients/client-healthlake/HealthLake.ts @@ -29,6 +29,21 @@ import { ListFHIRDatastoresCommandInput, ListFHIRDatastoresCommandOutput, } from "./commands/ListFHIRDatastoresCommand"; +import { + ListFHIRExportJobsCommand, + ListFHIRExportJobsCommandInput, + ListFHIRExportJobsCommandOutput, +} from "./commands/ListFHIRExportJobsCommand"; +import { + ListFHIRImportJobsCommand, + ListFHIRImportJobsCommandInput, + ListFHIRImportJobsCommandOutput, +} from "./commands/ListFHIRImportJobsCommand"; +import { + ListTagsForResourceCommand, + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, +} from "./commands/ListTagsForResourceCommand"; import { StartFHIRExportJobCommand, StartFHIRExportJobCommandInput, @@ -39,6 +54,12 @@ import { StartFHIRImportJobCommandInput, StartFHIRImportJobCommandOutput, } from "./commands/StartFHIRImportJobCommand"; +import { TagResourceCommand, TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; +import { + UntagResourceCommand, + UntagResourceCommandInput, + UntagResourceCommandOutput, +} from "./commands/UntagResourceCommand"; import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; /** @@ -177,7 +198,7 @@ export class HealthLake extends HealthLakeClient { } /** - *Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
+ *Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
*/ public describeFHIRImportJob( args: DescribeFHIRImportJobCommandInput, @@ -241,6 +262,108 @@ export class HealthLake extends HealthLakeClient { } } + /** + *+ * Lists all FHIR export jobs associated with an account and their statuses. + *
+ */ + public listFHIRExportJobs( + args: ListFHIRExportJobsCommandInput, + options?: __HttpHandlerOptions + ): Promise+ * Lists all FHIR import jobs associated with an account and their statuses. + *
+ */ + public listFHIRImportJobs( + args: ListFHIRImportJobsCommandInput, + options?: __HttpHandlerOptions + ): Promise+ * Returns a list of all existing tags associated with a Data Store. + *
+ */ + public listTagsForResource( + args: ListTagsForResourceCommandInput, + options?: __HttpHandlerOptions + ): PromiseBegins a FHIR export job.
*/ @@ -304,4 +427,66 @@ export class HealthLake extends HealthLakeClient { return this.send(command, optionsOrCb); } } + + /** + *+ * Adds a user specifed key and value tag to a Data Store. + *
+ */ + public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise+ * Removes tags from a Data Store. + *
+ */ + public untagResource( + args: UntagResourceCommandInput, + options?: __HttpHandlerOptions + ): PromiseDisplays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
+ *Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the job.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-healthlake/commands/ListFHIRExportJobsCommand.ts b/clients/client-healthlake/commands/ListFHIRExportJobsCommand.ts new file mode 100644 index 0000000000000..ddf9438293d67 --- /dev/null +++ b/clients/client-healthlake/commands/ListFHIRExportJobsCommand.ts @@ -0,0 +1,96 @@ +import { HealthLakeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthLakeClient"; +import { ListFHIRExportJobsRequest, ListFHIRExportJobsResponse } from "../models/models_0"; +import { + deserializeAws_json1_0ListFHIRExportJobsCommand, + serializeAws_json1_0ListFHIRExportJobsCommand, +} from "../protocols/Aws_json1_0"; +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + MiddlewareStack, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +export interface ListFHIRExportJobsCommandInput extends ListFHIRExportJobsRequest {} +export interface ListFHIRExportJobsCommandOutput extends ListFHIRExportJobsResponse, __MetadataBearer {} + +/** + *+ * Lists all FHIR export jobs associated with an account and their statuses. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthLakeClient, ListFHIRExportJobsCommand } from "@aws-sdk/client-healthlake"; // ES Modules import + * // const { HealthLakeClient, ListFHIRExportJobsCommand } = require("@aws-sdk/client-healthlake"); // CommonJS import + * const client = new HealthLakeClient(config); + * const command = new ListFHIRExportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFHIRExportJobsCommandInput} for command's `input` shape. + * @see {@link ListFHIRExportJobsCommandOutput} for command's `response` shape. + * @see {@link HealthLakeClientResolvedConfig | config} for command's `input` shape. + * + */ +export class ListFHIRExportJobsCommand extends $Command< + ListFHIRExportJobsCommandInput, + ListFHIRExportJobsCommandOutput, + HealthLakeClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListFHIRExportJobsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack+ * Lists all FHIR import jobs associated with an account and their statuses. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthLakeClient, ListFHIRImportJobsCommand } from "@aws-sdk/client-healthlake"; // ES Modules import + * // const { HealthLakeClient, ListFHIRImportJobsCommand } = require("@aws-sdk/client-healthlake"); // CommonJS import + * const client = new HealthLakeClient(config); + * const command = new ListFHIRImportJobsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListFHIRImportJobsCommandInput} for command's `input` shape. + * @see {@link ListFHIRImportJobsCommandOutput} for command's `response` shape. + * @see {@link HealthLakeClientResolvedConfig | config} for command's `input` shape. + * + */ +export class ListFHIRImportJobsCommand extends $Command< + ListFHIRImportJobsCommandInput, + ListFHIRImportJobsCommandOutput, + HealthLakeClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListFHIRImportJobsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack+ * Returns a list of all existing tags associated with a Data Store. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthLakeClient, ListTagsForResourceCommand } from "@aws-sdk/client-healthlake"; // ES Modules import + * // const { HealthLakeClient, ListTagsForResourceCommand } = require("@aws-sdk/client-healthlake"); // CommonJS import + * const client = new HealthLakeClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link HealthLakeClientResolvedConfig | config} for command's `input` shape. + * + */ +export class ListTagsForResourceCommand extends $Command< + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, + HealthLakeClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListTagsForResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack+ * Adds a user specifed key and value tag to a Data Store. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthLakeClient, TagResourceCommand } from "@aws-sdk/client-healthlake"; // ES Modules import + * // const { HealthLakeClient, TagResourceCommand } = require("@aws-sdk/client-healthlake"); // CommonJS import + * const client = new HealthLakeClient(config); + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link HealthLakeClientResolvedConfig | config} for command's `input` shape. + * + */ +export class TagResourceCommand extends $Command< + TagResourceCommandInput, + TagResourceCommandOutput, + HealthLakeClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: TagResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack+ * Removes tags from a Data Store. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { HealthLakeClient, UntagResourceCommand } from "@aws-sdk/client-healthlake"; // ES Modules import + * // const { HealthLakeClient, UntagResourceCommand } = require("@aws-sdk/client-healthlake"); // CommonJS import + * const client = new HealthLakeClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link HealthLakeClientResolvedConfig | config} for command's `input` shape. + * + */ +export class UntagResourceCommand extends $Command< + UntagResourceCommandInput, + UntagResourceCommandOutput, + HealthLakeClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: UntagResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe Data Store is in a transition state and the user requested action can not be performed.
*/ @@ -63,6 +68,89 @@ export namespace PreloadDataConfig { }); } +/** + *+ * The customer-managed-key(CMK) used when creating a Data Store. If a customer owned key is not specified, an AWS owned key will be used for encryption. + *
+ */ +export interface KmsEncryptionConfig { + /** + *+ * The type of customer-managed-key(CMK) used for encyrption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs. + *
+ */ + CmkType: CmkType | string | undefined; + + /** + *+ * The KMS encryption key id/alias used to encrypt the Data Store contents at rest. + *
+ */ + KmsKeyId?: string; +} + +export namespace KmsEncryptionConfig { + /** + * @internal + */ + export const filterSensitiveLog = (obj: KmsEncryptionConfig): any => ({ + ...obj, + }); +} + +/** + *+ * The server-side encryption key configuration for a customer provided encryption key. + *
+ */ +export interface SseConfiguration { + /** + *+ * The KMS encryption configuration used to provide details for data encryption. + *
+ */ + KmsEncryptionConfig: KmsEncryptionConfig | undefined; +} + +export namespace SseConfiguration { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SseConfiguration): any => ({ + ...obj, + }); +} + +/** + *+ * A tag is a label consisting of a user-defined key and value. The form for tags is {"Key", "Value"} + *
+ */ +export interface Tag { + /** + *+ * The key portion of a tag. Tag keys are case sensitive. + *
+ */ + Key: string | undefined; + + /** + *+ * The value portion of tag. Tag values are case sensitive. + *
+ */ + Value: string | undefined; +} + +export namespace Tag { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Tag): any => ({ + ...obj, + }); +} + export interface CreateFHIRDatastoreRequest { /** *The user generated name for the Data Store.
@@ -74,6 +162,13 @@ export interface CreateFHIRDatastoreRequest { */ DatastoreTypeVersion: FHIRVersion | string | undefined; + /** + *+ * The server-side encryption key configuration for a customer provided encryption key specified for creating a Data Store. + *
+ */ + SseConfiguration?: SseConfiguration; + /** *Optional parameter to preload data upon creation of the Data Store. Currently, the only * supported preloaded data is synthetic data generated from Synthea.
@@ -84,6 +179,13 @@ export interface CreateFHIRDatastoreRequest { *Optional user provided token used for ensuring idempotency.
*/ ClientToken?: string; + + /** + *+ * Resource tags that are applied to a Data Store when it is created. + *
+ */ + Tags?: Tag[]; } export namespace CreateFHIRDatastoreRequest { @@ -266,6 +368,13 @@ export interface DatastoreProperties { */ DatastoreEndpoint: string | undefined; + /** + *+ * The server-side encryption key configuration for a customer provided encryption key (CMK). + *
+ */ + SseConfiguration?: SseConfiguration; + /** *The preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.
*/ @@ -404,37 +513,70 @@ export namespace DescribeFHIRExportJobRequest { export enum JobStatus { COMPLETED = "COMPLETED", + COMPLETED_WITH_ERRORS = "COMPLETED_WITH_ERRORS", FAILED = "FAILED", IN_PROGRESS = "IN_PROGRESS", SUBMITTED = "SUBMITTED", } +/** + *+ * The configuration of the S3 bucket for either an import or export job. This includes assigning permissions for access. + *
+ */ +export interface S3Configuration { + /** + *+ * The S3Uri is the user specified S3 location of the FHIR data to be imported into Amazon HealthLake. + *
+ */ + S3Uri: string | undefined; + + /** + *+ * The KMS key ID used to access the S3 bucket. + *
+ */ + KmsKeyId: string | undefined; +} + +export namespace S3Configuration { + /** + * @internal + */ + export const filterSensitiveLog = (obj: S3Configuration): any => ({ + ...obj, + }); +} + /** *The output data configuration that was supplied when the export job was created.
*/ -export type OutputDataConfig = OutputDataConfig.S3UriMember | OutputDataConfig.$UnknownMember; +export type OutputDataConfig = OutputDataConfig.S3ConfigurationMember | OutputDataConfig.$UnknownMember; export namespace OutputDataConfig { /** - *The S3Uri is the user specified S3 location to which data will be exported from a FHIR Data Store.
+ *+ * The output data configuration that was supplied when the export job was created. + *
*/ - export interface S3UriMember { - S3Uri: string; + export interface S3ConfigurationMember { + S3Configuration: S3Configuration; $unknown?: never; } export interface $UnknownMember { - S3Uri?: never; + S3Configuration?: never; $unknown: [string, any]; } export interface VisitorThe input data configuration that was supplied when the Import job was created.
+ *The input data configuration that was supplied when the Import job was created.
*/ InputDataConfig: InputDataConfig | undefined; + /** + *The output data configuration that was supplied when the export job was created.
+ */ + JobOutputDataConfig?: OutputDataConfig; + /** *The Amazon Resource Name (ARN) that gives Amazon HealthLake access to your input data.
*/ @@ -642,6 +790,9 @@ export namespace ImportJobProperties { export const filterSensitiveLog = (obj: ImportJobProperties): any => ({ ...obj, ...(obj.InputDataConfig && { InputDataConfig: InputDataConfig.filterSensitiveLog(obj.InputDataConfig) }), + ...(obj.JobOutputDataConfig && { + JobOutputDataConfig: OutputDataConfig.filterSensitiveLog(obj.JobOutputDataConfig), + }), }); } @@ -712,6 +863,218 @@ export namespace ListFHIRDatastoresResponse { }); } +export interface ListFHIRExportJobsRequest { + /** + *+ * This parameter limits the response to the export job with the specified Data Store ID. + *
+ */ + DatastoreId: string | undefined; + + /** + *+ * A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query. + *
+ */ + NextToken?: string; + + /** + *+ * This parameter limits the number of results returned for a ListFHIRExportJobs to a maximum quantity specified by the user. + *
+ */ + MaxResults?: number; + + /** + *+ * This parameter limits the response to the export job with the specified job name. + *
+ */ + JobName?: string; + + /** + *+ * This parameter limits the response to the export jobs with the specified job status. + *
+ */ + JobStatus?: JobStatus | string; + + /** + *+ * This parameter limits the response to FHIR export jobs submitted before a user specified date. + *
+ */ + SubmittedBefore?: Date; + + /** + *+ * This parameter limits the response to FHIR export jobs submitted after a user specified date. + *
+ */ + SubmittedAfter?: Date; +} + +export namespace ListFHIRExportJobsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListFHIRExportJobsRequest): any => ({ + ...obj, + }); +} + +export interface ListFHIRExportJobsResponse { + /** + *+ * The properties of listed FHIR export jobs, including the ID, ARN, name, and the status of the job. + *
+ */ + ExportJobPropertiesList: ExportJobProperties[] | undefined; + + /** + *+ * A pagination token used to identify the next page of results to return for a ListFHIRExportJobs query. + *
+ */ + NextToken?: string; +} + +export namespace ListFHIRExportJobsResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListFHIRExportJobsResponse): any => ({ + ...obj, + ...(obj.ExportJobPropertiesList && { + ExportJobPropertiesList: obj.ExportJobPropertiesList.map((item) => ExportJobProperties.filterSensitiveLog(item)), + }), + }); +} + +export interface ListFHIRImportJobsRequest { + /** + *+ * This parameter limits the response to the import job with the specified Data Store ID. + *
+ */ + DatastoreId: string | undefined; + + /** + *+ * A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query. + *
+ */ + NextToken?: string; + + /** + *+ * This parameter limits the number of results returned for a ListFHIRImportJobs to a maximum quantity specified by the user. + *
+ */ + MaxResults?: number; + + /** + *+ * This parameter limits the response to the import job with the specified job name. + *
+ */ + JobName?: string; + + /** + *+ * This parameter limits the response to the import job with the specified job status. + *
+ */ + JobStatus?: JobStatus | string; + + /** + *+ * This parameter limits the response to FHIR import jobs submitted before a user specified date. + *
+ */ + SubmittedBefore?: Date; + + /** + *+ * This parameter limits the response to FHIR import jobs submitted after a user specified date. + *
+ */ + SubmittedAfter?: Date; +} + +export namespace ListFHIRImportJobsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListFHIRImportJobsRequest): any => ({ + ...obj, + }); +} + +export interface ListFHIRImportJobsResponse { + /** + *+ * The properties of a listed FHIR import jobs, including the ID, ARN, name, and the status of the job. + *
+ */ + ImportJobPropertiesList: ImportJobProperties[] | undefined; + + /** + *+ * A pagination token used to identify the next page of results to return for a ListFHIRImportJobs query. + *
+ */ + NextToken?: string; +} + +export namespace ListFHIRImportJobsResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListFHIRImportJobsResponse): any => ({ + ...obj, + ...(obj.ImportJobPropertiesList && { + ImportJobPropertiesList: obj.ImportJobPropertiesList.map((item) => ImportJobProperties.filterSensitiveLog(item)), + }), + }); +} + +export interface ListTagsForResourceRequest { + /** + *+ * The Amazon Resource Name(ARN) of the Data Store for which tags are being added. + *
+ */ + ResourceARN: string | undefined; +} + +export namespace ListTagsForResourceRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({ + ...obj, + }); +} + +export interface ListTagsForResourceResponse { + /** + *+ * Returns a list of tags associated with a Data Store. + *
+ */ + Tags?: Tag[]; +} + +export namespace ListTagsForResourceResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({ + ...obj, + }); +} + export interface StartFHIRExportJobRequest { /** *The user generated name for an export job.
@@ -786,6 +1149,11 @@ export interface StartFHIRImportJobRequest { */ InputDataConfig: InputDataConfig | undefined; + /** + *The output data configuration that was supplied when the export job was created.
+ */ + JobOutputDataConfig: OutputDataConfig | undefined; + /** *The AWS-generated Data Store ID.
*/ @@ -809,6 +1177,9 @@ export namespace StartFHIRImportJobRequest { export const filterSensitiveLog = (obj: StartFHIRImportJobRequest): any => ({ ...obj, ...(obj.InputDataConfig && { InputDataConfig: InputDataConfig.filterSensitiveLog(obj.InputDataConfig) }), + ...(obj.JobOutputDataConfig && { + JobOutputDataConfig: OutputDataConfig.filterSensitiveLog(obj.JobOutputDataConfig), + }), }); } @@ -837,3 +1208,75 @@ export namespace StartFHIRImportJobResponse { ...obj, }); } + +export interface TagResourceRequest { + /** + *+ * The Amazon Resource Name(ARN)that gives Amazon HealthLake access to the Data Store which tags are being added to. + *
+ */ + ResourceARN: string | undefined; + + /** + *+ * The user specified key and value pair tags being added to a Data Store. + *
+ */ + Tags: Tag[] | undefined; +} + +export namespace TagResourceRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ + ...obj, + }); +} + +export interface TagResourceResponse {} + +export namespace TagResourceResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ + ...obj, + }); +} + +export interface UntagResourceRequest { + /** + *+ * "The Amazon Resource Name(ARN) of the Data Store for which tags are being removed + *
+ */ + ResourceARN: string | undefined; + + /** + *+ * The keys for the tags to be removed from the Healthlake Data Store. + *
+ */ + TagKeys: string[] | undefined; +} + +export namespace UntagResourceRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ + ...obj, + }); +} + +export interface UntagResourceResponse {} + +export namespace UntagResourceResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ + ...obj, + }); +} diff --git a/clients/client-healthlake/pagination/ListFHIRExportJobsPaginator.ts b/clients/client-healthlake/pagination/ListFHIRExportJobsPaginator.ts new file mode 100644 index 0000000000000..67b0ecc5e66c2 --- /dev/null +++ b/clients/client-healthlake/pagination/ListFHIRExportJobsPaginator.ts @@ -0,0 +1,58 @@ +import { HealthLake } from "../HealthLake"; +import { HealthLakeClient } from "../HealthLakeClient"; +import { + ListFHIRExportJobsCommand, + ListFHIRExportJobsCommandInput, + ListFHIRExportJobsCommandOutput, +} from "../commands/ListFHIRExportJobsCommand"; +import { HealthLakePaginationConfiguration } from "./Interfaces"; +import { Paginator } from "@aws-sdk/types"; + +/** + * @private + */ +const makePagedClientRequest = async ( + client: HealthLakeClient, + input: ListFHIRExportJobsCommandInput, + ...args: any +): PromiseRemoves one or more documents from an index. The documents must have
* been added with the BatchPutDocument operation.
The documents are deleted asynchronously. You can see the progress of - * the deletion by using AWS CloudWatch. Any error messages related to the + * the deletion by using Amazon Web Services CloudWatch. Any error messages related to the * processing of the batch are sent to you CloudWatch log.
*/ public batchDeleteDocument( @@ -248,8 +268,8 @@ export class Kendra extends KendraClient { * add custom attributes to the documents, and to attach an access control * list to the documents added to the index. *The documents are indexed asynchronously. You can see the progress of - * the batch using AWS CloudWatch. Any error messages related to processing - * the batch are sent to your AWS CloudWatch log.
+ * the batch using Amazon Web Services CloudWatch. Any error messages related to processing + * the batch are sent to your Amazon Web Services CloudWatch log. */ public batchPutDocument( args: BatchPutDocumentCommandInput, @@ -582,6 +602,49 @@ export class Kendra extends KendraClient { } } + /** + *Deletes a group so that all users and sub groups that belong to the group can + * no longer access documents only available to that group.
+ *For example, after deleting the group "Summer Interns", all interns who + * belonged to that group no longer see intern-only documents in their search + * results.
+ *If you want to delete or replace users or sub groups of a group, you need to
+ * use the PutPrincipalMapping operation. For example, if a user in
+ * the group "Engineering" leaves the engineering team and another user takes
+ * their place, you provide an updated list of users or sub groups that belong
+ * to the "Engineering" group when calling PutPrincipalMapping. You
+ * can update your internal list of users or sub groups and input this list
+ * when calling PutPrincipalMapping.
Deletes a block list used for query suggestions for an index.
*A deleted block list might not take effect right away. Amazon Kendra @@ -740,6 +803,43 @@ export class Kendra extends KendraClient { } } + /** + *
Describes the processing of PUT and DELETE actions
+ * for mapping users to their groups. This includes information on the status of
+ * actions currently processing or yet to be processed, when actions were last updated,
+ * when actions were received by Amazon Kendra, the latest action that should process
+ * and apply after other actions, and useful error messages if an action could
+ * not be processed.
Describes a block list used for query suggestions for an index.
*This is used to check the current settings that are applied to a @@ -963,6 +1063,39 @@ export class Kendra extends KendraClient { } } + /** + *
Provides a list of groups that are mapped to users before a + * given ordering or timestamp identifier.
+ */ + public listGroupsOlderThanOrderingId( + args: ListGroupsOlderThanOrderingIdCommandInput, + options?: __HttpHandlerOptions + ): PromiseLists the Amazon Kendra indexes that you have created.
*/ @@ -1086,6 +1219,51 @@ export class Kendra extends KendraClient { } } + /** + *Maps users to their groups. You can also map sub groups to groups. + * For example, the group "Company Intellectual Property Teams" includes + * sub groups "Research" and "Engineering". These sub groups include their + * own list of users or people who work in these teams. Only users who work + * in research and engineering, and therefore belong in the intellectual + * property group, can see top-secret company documents in their search + * results.
+ *You map users to their groups when you want to filter search results + * for different users based on their group’s access to documents. For more + * information on filtering search results for different users, see + * Filtering + * on user context.
+ *If more than five PUT actions for a group are currently
+ * processing, a validation exception is thrown.
Searches an active index. Use this API to search your documents
* using query. The Query operation enables to do faceted
diff --git a/clients/client-kendra/KendraClient.ts b/clients/client-kendra/KendraClient.ts
index 08460d2e596f9..4ecd5ebab87de 100644
--- a/clients/client-kendra/KendraClient.ts
+++ b/clients/client-kendra/KendraClient.ts
@@ -22,6 +22,10 @@ import { CreateThesaurusCommandInput, CreateThesaurusCommandOutput } from "./com
import { DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput } from "./commands/DeleteDataSourceCommand";
import { DeleteFaqCommandInput, DeleteFaqCommandOutput } from "./commands/DeleteFaqCommand";
import { DeleteIndexCommandInput, DeleteIndexCommandOutput } from "./commands/DeleteIndexCommand";
+import {
+ DeletePrincipalMappingCommandInput,
+ DeletePrincipalMappingCommandOutput,
+} from "./commands/DeletePrincipalMappingCommand";
import {
DeleteQuerySuggestionsBlockListCommandInput,
DeleteQuerySuggestionsBlockListCommandOutput,
@@ -30,6 +34,10 @@ import { DeleteThesaurusCommandInput, DeleteThesaurusCommandOutput } from "./com
import { DescribeDataSourceCommandInput, DescribeDataSourceCommandOutput } from "./commands/DescribeDataSourceCommand";
import { DescribeFaqCommandInput, DescribeFaqCommandOutput } from "./commands/DescribeFaqCommand";
import { DescribeIndexCommandInput, DescribeIndexCommandOutput } from "./commands/DescribeIndexCommand";
+import {
+ DescribePrincipalMappingCommandInput,
+ DescribePrincipalMappingCommandOutput,
+} from "./commands/DescribePrincipalMappingCommand";
import {
DescribeQuerySuggestionsBlockListCommandInput,
DescribeQuerySuggestionsBlockListCommandOutput,
@@ -49,6 +57,10 @@ import {
} from "./commands/ListDataSourceSyncJobsCommand";
import { ListDataSourcesCommandInput, ListDataSourcesCommandOutput } from "./commands/ListDataSourcesCommand";
import { ListFaqsCommandInput, ListFaqsCommandOutput } from "./commands/ListFaqsCommand";
+import {
+ ListGroupsOlderThanOrderingIdCommandInput,
+ ListGroupsOlderThanOrderingIdCommandOutput,
+} from "./commands/ListGroupsOlderThanOrderingIdCommand";
import { ListIndicesCommandInput, ListIndicesCommandOutput } from "./commands/ListIndicesCommand";
import {
ListQuerySuggestionsBlockListsCommandInput,
@@ -59,6 +71,10 @@ import {
ListTagsForResourceCommandOutput,
} from "./commands/ListTagsForResourceCommand";
import { ListThesauriCommandInput, ListThesauriCommandOutput } from "./commands/ListThesauriCommand";
+import {
+ PutPrincipalMappingCommandInput,
+ PutPrincipalMappingCommandOutput,
+} from "./commands/PutPrincipalMappingCommand";
import { QueryCommandInput, QueryCommandOutput } from "./commands/QueryCommand";
import {
StartDataSourceSyncJobCommandInput,
@@ -147,11 +163,13 @@ export type ServiceInputTypes =
| DeleteDataSourceCommandInput
| DeleteFaqCommandInput
| DeleteIndexCommandInput
+ | DeletePrincipalMappingCommandInput
| DeleteQuerySuggestionsBlockListCommandInput
| DeleteThesaurusCommandInput
| DescribeDataSourceCommandInput
| DescribeFaqCommandInput
| DescribeIndexCommandInput
+ | DescribePrincipalMappingCommandInput
| DescribeQuerySuggestionsBlockListCommandInput
| DescribeQuerySuggestionsConfigCommandInput
| DescribeThesaurusCommandInput
@@ -159,10 +177,12 @@ export type ServiceInputTypes =
| ListDataSourceSyncJobsCommandInput
| ListDataSourcesCommandInput
| ListFaqsCommandInput
+ | ListGroupsOlderThanOrderingIdCommandInput
| ListIndicesCommandInput
| ListQuerySuggestionsBlockListsCommandInput
| ListTagsForResourceCommandInput
| ListThesauriCommandInput
+ | PutPrincipalMappingCommandInput
| QueryCommandInput
| StartDataSourceSyncJobCommandInput
| StopDataSourceSyncJobCommandInput
@@ -188,11 +208,13 @@ export type ServiceOutputTypes =
| DeleteDataSourceCommandOutput
| DeleteFaqCommandOutput
| DeleteIndexCommandOutput
+ | DeletePrincipalMappingCommandOutput
| DeleteQuerySuggestionsBlockListCommandOutput
| DeleteThesaurusCommandOutput
| DescribeDataSourceCommandOutput
| DescribeFaqCommandOutput
| DescribeIndexCommandOutput
+ | DescribePrincipalMappingCommandOutput
| DescribeQuerySuggestionsBlockListCommandOutput
| DescribeQuerySuggestionsConfigCommandOutput
| DescribeThesaurusCommandOutput
@@ -200,10 +222,12 @@ export type ServiceOutputTypes =
| ListDataSourceSyncJobsCommandOutput
| ListDataSourcesCommandOutput
| ListFaqsCommandOutput
+ | ListGroupsOlderThanOrderingIdCommandOutput
| ListIndicesCommandOutput
| ListQuerySuggestionsBlockListsCommandOutput
| ListTagsForResourceCommandOutput
| ListThesauriCommandOutput
+ | PutPrincipalMappingCommandOutput
| QueryCommandOutput
| StartDataSourceSyncJobCommandOutput
| StopDataSourceSyncJobCommandOutput
diff --git a/clients/client-kendra/commands/BatchDeleteDocumentCommand.ts b/clients/client-kendra/commands/BatchDeleteDocumentCommand.ts
index fd24e784bed75..93b71b11d461b 100644
--- a/clients/client-kendra/commands/BatchDeleteDocumentCommand.ts
+++ b/clients/client-kendra/commands/BatchDeleteDocumentCommand.ts
@@ -24,7 +24,7 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
*
Removes one or more documents from an index. The documents must have
* been added with the BatchPutDocument operation.
The documents are deleted asynchronously. You can see the progress of - * the deletion by using AWS CloudWatch. Any error messages related to the + * the deletion by using Amazon Web Services CloudWatch. Any error messages related to the * processing of the batch are sent to you CloudWatch log.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-kendra/commands/BatchPutDocumentCommand.ts b/clients/client-kendra/commands/BatchPutDocumentCommand.ts index fe448aa35d792..0f3f4df0faf5e 100644 --- a/clients/client-kendra/commands/BatchPutDocumentCommand.ts +++ b/clients/client-kendra/commands/BatchPutDocumentCommand.ts @@ -28,8 +28,8 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse, * add custom attributes to the documents, and to attach an access control * list to the documents added to the index. *The documents are indexed asynchronously. You can see the progress of - * the batch using AWS CloudWatch. Any error messages related to processing - * the batch are sent to your AWS CloudWatch log.
+ * the batch using Amazon Web Services CloudWatch. Any error messages related to processing + * the batch are sent to your Amazon Web Services CloudWatch log. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-kendra/commands/DeletePrincipalMappingCommand.ts b/clients/client-kendra/commands/DeletePrincipalMappingCommand.ts new file mode 100644 index 0000000000000..64327d7d82e4e --- /dev/null +++ b/clients/client-kendra/commands/DeletePrincipalMappingCommand.ts @@ -0,0 +1,105 @@ +import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient"; +import { DeletePrincipalMappingRequest } from "../models/models_0"; +import { + deserializeAws_json1_1DeletePrincipalMappingCommand, + serializeAws_json1_1DeletePrincipalMappingCommand, +} from "../protocols/Aws_json1_1"; +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + MiddlewareStack, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +export interface DeletePrincipalMappingCommandInput extends DeletePrincipalMappingRequest {} +export interface DeletePrincipalMappingCommandOutput extends __MetadataBearer {} + +/** + *Deletes a group so that all users and sub groups that belong to the group can + * no longer access documents only available to that group.
+ *For example, after deleting the group "Summer Interns", all interns who + * belonged to that group no longer see intern-only documents in their search + * results.
+ *If you want to delete or replace users or sub groups of a group, you need to
+ * use the PutPrincipalMapping operation. For example, if a user in
+ * the group "Engineering" leaves the engineering team and another user takes
+ * their place, you provide an updated list of users or sub groups that belong
+ * to the "Engineering" group when calling PutPrincipalMapping. You
+ * can update your internal list of users or sub groups and input this list
+ * when calling PutPrincipalMapping.
Describes the processing of PUT and DELETE actions
+ * for mapping users to their groups. This includes information on the status of
+ * actions currently processing or yet to be processed, when actions were last updated,
+ * when actions were received by Amazon Kendra, the latest action that should process
+ * and apply after other actions, and useful error messages if an action could
+ * not be processed.
Provides a list of groups that are mapped to users before a + * given ordering or timestamp identifier.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KendraClient, ListGroupsOlderThanOrderingIdCommand } from "@aws-sdk/client-kendra"; // ES Modules import + * // const { KendraClient, ListGroupsOlderThanOrderingIdCommand } = require("@aws-sdk/client-kendra"); // CommonJS import + * const client = new KendraClient(config); + * const command = new ListGroupsOlderThanOrderingIdCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListGroupsOlderThanOrderingIdCommandInput} for command's `input` shape. + * @see {@link ListGroupsOlderThanOrderingIdCommandOutput} for command's `response` shape. + * @see {@link KendraClientResolvedConfig | config} for command's `input` shape. + * + */ +export class ListGroupsOlderThanOrderingIdCommand extends $Command< + ListGroupsOlderThanOrderingIdCommandInput, + ListGroupsOlderThanOrderingIdCommandOutput, + KendraClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListGroupsOlderThanOrderingIdCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackMaps users to their groups. You can also map sub groups to groups. + * For example, the group "Company Intellectual Property Teams" includes + * sub groups "Research" and "Engineering". These sub groups include their + * own list of users or people who work in these teams. Only users who work + * in research and engineering, and therefore belong in the intellectual + * property group, can see top-secret company documents in their search + * results.
+ *You map users to their groups when you want to filter search results + * for different users based on their group’s access to documents. For more + * information on filtering search results for different users, see + * Filtering + * on user context.
+ *If more than five PUT actions for a group are currently
+ * processing, a validation exception is thrown.
Path to the AWS S3 bucket that contains the ACL files.
+ *Path to the Amazon Web Services S3 bucket that contains the ACL files.
*/ KeyPath?: string; } @@ -792,6 +792,12 @@ export interface Principal { *Whether to allow or deny access to the principal.
*/ Access: ReadAccessType | string | undefined; + + /** + *The identifier of the data source the principal should + * access documents from.
+ */ + DataSourceId?: string; } export namespace Principal { @@ -811,6 +817,30 @@ export enum ContentType { PPT = "PPT", } +/** + *+ * Information to define the hierarchy for which documents users should have access to. + *
+ */ +export interface HierarchicalPrincipal { + /** + *A list of principal lists + * that define the hierarchy for which documents users should have access to. + * Each hierarchical list specifies which user or group has allow or deny + * access for each document.
+ */ + PrincipalList: Principal[] | undefined; +} + +export namespace HierarchicalPrincipal { + /** + * @internal + */ + export const filterSensitiveLog = (obj: HierarchicalPrincipal): any => ({ + ...obj, + }); +} + /** *Information required to find a specific file in an Amazon S3 * bucket.
@@ -854,7 +884,7 @@ export interface Document { *The contents of the document.
*Documents passed to the Blob parameter must be base64
* encoded. Your code might not need to encode the document file bytes
- * if you're using an AWS SDK to call Amazon Kendra operations. If you are
+ * if you're using an Amazon Web Services SDK to call Amazon Kendra operations. If you are
* calling the Amazon Kendra endpoint directly using REST, you must base64
* encode the contents before sending.
Information to use for user context filtering.
+ *Information on user and group access rights, which is used for + * user context filtering.
*/ AccessControlList?: Principal[]; + /** + *The list of principal lists + * that define the hierarchy for which documents users should have access to.
+ */ + HierarchicalAccessControlList?: HierarchicalPrincipal[]; + /** *The file type of the document in the Blob
* field.
If there was an error adding a document to an index the error is - * reported in your AWS CloudWatch log. For more information, see Monitoring + * reported in your Amazon Web Services CloudWatch log. For more information, see Monitoring * Amazon Kendra with Amazon CloudWatch Logs *
*/ @@ -1423,7 +1460,7 @@ export interface ConfluenceConfiguration { ServerUrl: string | undefined; /** - *The Amazon Resource Name (ARN) of an AWS Secrets Manager secret + *
The Amazon Resource Name (ARN) of an Secrets Managersecret * that contains the key/value pairs required to connect to your * Confluence server. The secret must contain a JSON structure with the * following keys:
@@ -1613,8 +1650,8 @@ export interface ConnectionConfiguration { * more information, see Using a * Database Data Source. For more information about AWS * Secrets Manager, see What Is AWS - * Secrets Manager in the AWS Secrets - * Manager user guide. + * Secrets Manager in the Secrets Manager + * user guide. */ SecretArn: string | undefined; } @@ -1725,7 +1762,7 @@ export namespace DatabaseConfiguration { */ export interface GoogleDriveConfiguration { /** - *The Amazon Resource Name (ARN) of a AWS Secrets Manager secret + *
The Amazon Resource Name (ARN) of a Secrets Managersecret * that contains the credentials required to connect to Google Drive. * For more information, see Using a Google Workspace Drive data * source.
@@ -1835,7 +1872,7 @@ export interface OneDriveConfiguration { TenantDomain: string | undefined; /** - *The Amazon Resource Name (ARN) of an AWS Secrets Manager secret + *
The Amazon Resource Name (ARN) of an Secrets Managersecret * that contains the user name and password to connect to OneDrive. The * user namd should be the application ID for the OneDrive application, * and the password is the application key for the OneDrive @@ -1900,7 +1937,7 @@ export namespace OneDriveConfiguration { */ export interface DocumentsMetadataConfiguration { /** - *
A prefix used to filter metadata configuration files in the AWS S3 + *
A prefix used to filter metadata configuration files in the Amazon Web Services S3
* bucket. The S3 bucket might contain multiple metadata files. Use
* S3Prefix to include only the desired metadata
* files.
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret + *
The Amazon Resource Name (ARN) of an Secrets Managersecret * that contains the key/value pairs required to connect to your * Salesforce instance. The secret must contain a JSON structure with * the following keys:
@@ -2518,7 +2555,7 @@ export interface ServiceNowConfiguration { HostUrl: string | undefined; /** - *The Amazon Resource Name (ARN) of the AWS Secret Manager secret + *
The Amazon Resource Name (ARN) of the Secrets Manager secret * that contains the user name and password required to connect to the * ServiceNow instance.
*/ @@ -2594,12 +2631,14 @@ export interface SharePointConfiguration { /** *The Amazon Resource Name (ARN) of credentials stored in AWS - * Secrets Manager. The credentials should be a user/password pair. For + * Secrets Manager. The credentials should be a user/password pair. + * If you use SharePoint Sever, you also need to provide the sever + * domain name as part of the credentials. For * more information, see Using a * Microsoft SharePoint Data Source. For more information * about AWS Secrets Manager, see What Is AWS - * Secrets Manager in the AWS Secrets - * Manager user guide.
+ * Secrets Manager in the Secrets Manager + * user guide. */ SecretArn: string | undefined; @@ -3268,13 +3307,13 @@ export enum IndexEdition { } /** - *Provides the identifier of the AWS KMS customer master key (CMK) + *
Provides the identifier of the KMScustomer master key (CMK) * used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support * asymmetric CMKs.
*/ export interface ServerSideEncryptionConfiguration { /** - *The identifier of the AWS KMS customer master key (CMK). Amazon Kendra + *
The identifier of the KMScustomer master key (CMK). Amazon Kendra * doesn't support asymmetric CMKs.
*/ KmsKeyId?: string; @@ -3411,13 +3450,11 @@ export interface CreateIndexRequest { * changed. *The Edition parameter is optional. If you don't supply a
* value, the default is ENTERPRISE_EDITION.
For more information on quota limits for enterprise and developer editions, - * see Quotas.
*/ Edition?: IndexEdition | string; /** - *An AWS Identity and Access Management (IAM) role that gives + *
An Identity and Access Management(IAM) role that gives
* Amazon Kendra permissions to access your Amazon CloudWatch logs and
* metrics. This is also the role used when you use the
* BatchPutDocument operation to index documents from an
@@ -3426,7 +3463,7 @@ export interface CreateIndexRequest {
RoleArn: string | undefined;
/**
- *
The identifier of the AWS KMS customer managed key (CMK) to use to + *
The identifier of the KMScustomer managed key (CMK) to use to * encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support * asymmetric CMKs.
*/ @@ -3720,6 +3757,58 @@ export namespace DeleteIndexRequest { }); } +export interface DeletePrincipalMappingRequest { + /** + *The identifier of the index you want to delete a group from.
+ */ + IndexId: string | undefined; + + /** + *The identifier of the data source you want to delete a group from.
+ *This is useful if a group is tied to multiple data sources and you want + * to delete a group from accessing documents in a certain data source. For example, + * the groups "Research", "Engineering", and "Sales and Marketing" are all tied to + * the company's documents stored in the data sources Confluence and Salesforce. + * You want to delete "Research" and "Engineering" groups from Salesforce, so that + * these groups cannot access customer-related documents stored in Salesforce. + * Only "Sales and Marketing" should access documents in the Salesforce data source.
+ */ + DataSourceId?: string; + + /** + *The identifier of the group you want to delete.
+ */ + GroupId: string | undefined; + + /** + *The timestamp identifier you specify to ensure Amazon Kendra does not
+ * override the latest DELETE action with previous actions.
+ * The highest number ID, which is the ordering ID, is the latest action
+ * you want to process and apply on top of other actions with lower number
+ * IDs. This prevents previous actions with lower number IDs from possibly
+ * overriding the latest action.
The ordering ID can be the UNIX time of the last update you made to a group
+ * members list. You would then provide this list when calling
+ * PutPrincipalMapping. This ensures your DELETE action
+ * for that updated group with the latest members list doesn't get overwritten
+ * by earlier DELETE actions for the same group which are yet to
+ * be processed.
The default ordering ID is the current UNIX time in milliseconds that the + * action was received by Amazon Kendra. + *
+ */ + OrderingId?: number; +} + +export namespace DeletePrincipalMappingRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeletePrincipalMappingRequest): any => ({ + ...obj, + }); +} + export interface DeleteQuerySuggestionsBlockListRequest { /** *The identifier of the you want to delete a block list from.
@@ -3992,9 +4081,9 @@ export namespace DescribeIndexRequest { */ export interface CapacityUnitsConfiguration { /** - *The amount of extra storage capacity for an index. - * A single capacity unit provides 30 GB of storage space or 100,000 documents, - * whichever is reached first.
+ *The amount of extra storage capacity for an index. A single capacity + * unit for an index provides 150 GB of storage space or + * 500,000 documents, whichever is reached first.
*/ StorageCapacityUnits: number | undefined; @@ -4002,16 +4091,14 @@ export interface CapacityUnitsConfiguration { *The amount of extra query capacity for an index and * GetQuerySuggestions * capacity.
- *A single extra capacity unit for an index provides 0.1 queries per second or approximately - * 8,000 queries per day.
+ *A single extra capacity unit for an index provides 0.5 queries per second or + * approximately 40,000 queries per day.
*
- * GetQuerySuggestions capacity is five times the
- * provisioned query capacity for an index, or the base capacity of 2.5 calls per second,
- * whichever is higher. For example, the base capacity for an index is 0.1 queries per
- * second, and GetQuerySuggestions capacity has a base of 2.5 calls per second.
- * If you add another 0.1 queries per second to total 0.2 queries per second for an index, the
- * GetQuerySuggestions capacity is 2.5 calls per second
- * (higher than five times 0.2 queries per second).
GetQuerySuggestions capacity is 5 times the provisioned query
+ * capacity for an index. For example, the base capacity for an index is 0.5
+ * queries per second, so GetQuerySuggestions capacity is 2.5 calls per second.
+ * If adding another 0.5 queries per second to total 1 queries per second for an
+ * index, the GetQuerySuggestions capacity is 5 calls per second.
*/
QueryCapacityUnits: number | undefined;
}
@@ -4297,7 +4384,7 @@ export interface DescribeIndexResponse {
RoleArn?: string;
/**
- * The identifier of the AWS KMS customer master key (CMK) used to + *
The identifier of the KMScustomer master key (CMK) used to * encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
*/ ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration; @@ -4379,6 +4466,154 @@ export namespace DescribeIndexResponse { }); } +export interface DescribePrincipalMappingRequest { + /** + *The identifier of the index required to check the processing of
+ * PUT and DELETE actions for mapping users
+ * to their groups.
The identifier of the data source to check the processing of
+ * PUT and DELETE actions for mapping
+ * users to their groups.
The identifier of the group required to check the processing of
+ * PUT and DELETE actions for mapping users
+ * to their groups.
Information on the processing of PUT and DELETE actions
+ * for mapping users to their groups.
The current processing status of actions for mapping users to their groups.
+ * The status can be either PROCESSING, SUCCEEDED,
+ * DELETING, DELETED, or FAILED.
The last date-time an action was updated. An action can be a
+ * PUT or DELETE action for mapping users
+ * to their groups.
The date-time an action was received by Amazon Kendra. An action can be a
+ * PUT or DELETE action for mapping users to
+ * their groups.
The order in which actions should complete processing. An action can
+ * be a PUT or DELETE action for mapping users
+ * to their groups.
The reason an action could not be processed. An action can be a
+ * PUT or DELETE action for mapping users
+ * to their groups.
Shows the identifier of the index to see information on the
+ * processing of PUT and DELETE actions
+ * for mapping users to their groups.
Shows the identifier of the data source to see information on
+ * the processing of PUT and DELETE actions
+ * for mapping users to their groups.
Shows the identifier of the group to see information on the
+ * processing of PUT and DELETE actions
+ * for mapping users to their groups.
Shows the following information on the processing of PUT and
+ * DELETE actions for mapping users to their groups:
Status – the status can be either
+ * PROCESSING, SUCCEEDED, DELETING,
+ * DELETED, or FAILED.
Last updated – the last date-time an action was updated.
+ *Received – the last date-time an action was received or submitted.
+ *Ordering ID – the latest action that should process and apply + * after other actions.
+ *Failure reason – the reason an action could not be processed.
+ *The identifier of the index for the block list.
@@ -5283,6 +5518,107 @@ export namespace ListFaqsResponse { }); } +export interface ListGroupsOlderThanOrderingIdRequest { + /** + *The identifier of the index for getting a list of groups mapped + * to users before a given ordering or timestamp identifier.
+ */ + IndexId: string | undefined; + + /** + *The identifier of the data source for getting a list of groups mapped + * to users before a given ordering timestamp identifier.
+ */ + DataSourceId?: string; + + /** + *The timestamp identifier used for the latest PUT or
+ * DELETE action for mapping users to their groups.
+ * The next items in the list of groups that go beyond the maximum. + *
+ */ + NextToken?: string; + + /** + *+ * The maximum results shown for a list of groups that are mapped to users before a + * given ordering or timestamp identifier. + *
+ */ + MaxResults?: number; +} + +export namespace ListGroupsOlderThanOrderingIdRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListGroupsOlderThanOrderingIdRequest): any => ({ + ...obj, + }); +} + +/** + *+ * Group summary information. + *
+ */ +export interface GroupSummary { + /** + *+ * The identifier of the group you want group summary information on. + *
+ */ + GroupId?: string; + + /** + *
+ * The timestamp identifier used for the latest PUT or DELETE
+ * action.
+ *
+ * Summary information for list of groups that are mapped to users before a + * given ordering or timestamp identifier. + *
+ */ + GroupsSummaries?: GroupSummary[]; + + /** + *+ * The next items in the list of groups that go beyond the maximum. + *
+ */ + NextToken?: string; +} + +export namespace ListGroupsOlderThanOrderingIdResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListGroupsOlderThanOrderingIdResponse): any => ({ + ...obj, + }); +} + export interface ListIndicesRequest { /** *If the previous response was incomplete (because there is more data to @@ -5634,6 +5970,157 @@ export namespace ListThesauriResponse { }); } +/** + *
The sub groups that belong to a group.
+ */ +export interface MemberGroup { + /** + *The identifier of the sub group you want to map to a group.
+ */ + GroupId: string | undefined; + + /** + *The identifier of the data source for the sub group + * you want to map to a group.
+ */ + DataSourceId?: string; +} + +export namespace MemberGroup { + /** + * @internal + */ + export const filterSensitiveLog = (obj: MemberGroup): any => ({ + ...obj, + }); +} + +/** + *The users that belong to a group.
+ */ +export interface MemberUser { + /** + *The identifier of the user you want to map to a group.
+ */ + UserId: string | undefined; +} + +export namespace MemberUser { + /** + * @internal + */ + export const filterSensitiveLog = (obj: MemberUser): any => ({ + ...obj, + }); +} + +/** + *A list of users or sub groups that belong to a group. Users and groups + * are useful for filtering search results to different users based on their + * group's access to documents.
+ */ +export interface GroupMembers { + /** + *A list of sub groups that belong to a group. For example, the sub + * groups "Research", "Engineering", and "Sales and Marketing" all belong + * to the group "Company".
+ */ + MemberGroups?: MemberGroup[]; + + /** + *A list of users that belong to a group. For example, a list of interns + * all belong to the "Interns" group.
+ */ + MemberUsers?: MemberUser[]; + + /** + *If you have more than 1000 users and/or sub groups for a single group, + * you need to provide the path to the S3 file that lists your users and sub + * groups for a group. Your sub groups can contain more than 1000 users, but + * the list of sub groups that belong to a group (and/or users) must be no + * more than 1000.
+ */ + S3PathforGroupMembers?: S3Path; +} + +export namespace GroupMembers { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GroupMembers): any => ({ + ...obj, + }); +} + +export interface PutPrincipalMappingRequest { + /** + *The identifier of the index you want to map users to their groups.
+ */ + IndexId: string | undefined; + + /** + *The identifier of the data source you want to map users to their groups.
+ *This is useful if a group is tied to multiple data sources, but you only want + * the group to access documents of a certain data source. For example, the groups + * "Research", "Engineering", and "Sales and Marketing" are all tied to the company's + * documents stored in the data sources Confluence and Salesforce. However, + * "Sales and Marketing" team only needs access to customer-related documents + * stored in Salesforce.
+ */ + DataSourceId?: string; + + /** + *The identifier of the group you want to map its users to.
+ */ + GroupId: string | undefined; + + /** + *The list that contains your users or sub groups that belong + * the same group.
+ *For example, the group "Company" includes the user "CEO" and the + * sub groups "Research", "Engineering", and "Sales and Marketing".
+ *If you have more than 1000 users and/or sub groups for a single group, + * you need to provide the path to the S3 file that lists your users and + * sub groups for a group. Your sub groups can contain more than 1000 users, + * but the list of sub groups that belong to a group (and/or users) must be + * no more than 1000.
+ */ + GroupMembers: GroupMembers | undefined; + + /** + *The timestamp identifier you specify to ensure Amazon Kendra does not override
+ * the latest PUT action with previous actions. The highest number
+ * ID, which is the ordering ID, is the latest action you want to process and
+ * apply on top of other actions with lower number IDs. This prevents previous
+ * actions with lower number IDs from possibly overriding the latest action.
The ordering ID can be the UNIX time of the last update you made to a
+ * group members list. You would then provide this list when calling
+ * PutPrincipalMapping. This ensures your PUT action
+ * for that updated group with the latest members list doesn't get overwritten
+ * by earlier PUT actions for the same group which are yet to
+ * be processed.
The default ordering ID is the current UNIX time in milliseconds that the + * action was received by Amazon Kendra.
+ */ + OrderingId?: number; + + /** + *The Amazon Resource Name (ARN) of a role that has access to the S3 file + * that contains your list of users or sub groups that belong to a group.
+ *For more information, see IAM roles for Amazon Kendra.
+ */ + RoleArn?: string; +} + +export namespace PutPrincipalMappingRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: PutPrincipalMappingRequest): any => ({ + ...obj, + }); +} + /** *Overrides the document relevance properties of a custom index field.
*/ @@ -5760,14 +6247,77 @@ export namespace SortingConfiguration { }); } +/** + *+ * Data source information for user context filtering. + *
+ */ +export interface DataSourceGroup { + /** + *The identifier of the group you want to add to your list + * of groups. This is for filtering search results based on the + * groups' access to documents.
+ */ + GroupId: string | undefined; + + /** + *The identifier of the data source group you want to add + * to your list of data source groups. This is for filtering + * search results based on the groups' access to documents in + * that data source.
+ */ + DataSourceId: string | undefined; +} + +export namespace DataSourceGroup { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DataSourceGroup): any => ({ + ...obj, + }); +} + /** *Provides information about the user context for a Amazon Kendra index.
+ *This is used for filtering search results for different users based on their access + * to documents.
+ *You provide one of the following:
+ *User token
+ *User ID, the groups the user belongs to, and the data sources + * the groups can access
+ *If you provide both, an exception is thrown.
*/ export interface UserContext { /** - *The user context token. It must be a JWT or a JSON token.
+ *The user context token for filtering search results for a user. It must + * be a JWT or a JSON token.
*/ Token?: string; + + /** + *The identifier of the user you want to filter search results based on their + * access to documents.
+ */ + UserId?: string; + + /** + *The list of groups you want to filter search results based on the + * groups' access to documents.
+ */ + Groups?: string[]; + + /** + *The list of data source groups you want to filter search results + * based on groups' access to documents in that data source.
+ */ + DataSourceGroups?: DataSourceGroup[]; } export namespace UserContext { diff --git a/clients/client-kendra/protocols/Aws_json1_1.ts b/clients/client-kendra/protocols/Aws_json1_1.ts index acb90a276fa71..1ee75f331165a 100644 --- a/clients/client-kendra/protocols/Aws_json1_1.ts +++ b/clients/client-kendra/protocols/Aws_json1_1.ts @@ -22,6 +22,10 @@ import { CreateThesaurusCommandInput, CreateThesaurusCommandOutput } from "../co import { DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput } from "../commands/DeleteDataSourceCommand"; import { DeleteFaqCommandInput, DeleteFaqCommandOutput } from "../commands/DeleteFaqCommand"; import { DeleteIndexCommandInput, DeleteIndexCommandOutput } from "../commands/DeleteIndexCommand"; +import { + DeletePrincipalMappingCommandInput, + DeletePrincipalMappingCommandOutput, +} from "../commands/DeletePrincipalMappingCommand"; import { DeleteQuerySuggestionsBlockListCommandInput, DeleteQuerySuggestionsBlockListCommandOutput, @@ -30,6 +34,10 @@ import { DeleteThesaurusCommandInput, DeleteThesaurusCommandOutput } from "../co import { DescribeDataSourceCommandInput, DescribeDataSourceCommandOutput } from "../commands/DescribeDataSourceCommand"; import { DescribeFaqCommandInput, DescribeFaqCommandOutput } from "../commands/DescribeFaqCommand"; import { DescribeIndexCommandInput, DescribeIndexCommandOutput } from "../commands/DescribeIndexCommand"; +import { + DescribePrincipalMappingCommandInput, + DescribePrincipalMappingCommandOutput, +} from "../commands/DescribePrincipalMappingCommand"; import { DescribeQuerySuggestionsBlockListCommandInput, DescribeQuerySuggestionsBlockListCommandOutput, @@ -49,6 +57,10 @@ import { } from "../commands/ListDataSourceSyncJobsCommand"; import { ListDataSourcesCommandInput, ListDataSourcesCommandOutput } from "../commands/ListDataSourcesCommand"; import { ListFaqsCommandInput, ListFaqsCommandOutput } from "../commands/ListFaqsCommand"; +import { + ListGroupsOlderThanOrderingIdCommandInput, + ListGroupsOlderThanOrderingIdCommandOutput, +} from "../commands/ListGroupsOlderThanOrderingIdCommand"; import { ListIndicesCommandInput, ListIndicesCommandOutput } from "../commands/ListIndicesCommand"; import { ListQuerySuggestionsBlockListsCommandInput, @@ -59,6 +71,10 @@ import { ListTagsForResourceCommandOutput, } from "../commands/ListTagsForResourceCommand"; import { ListThesauriCommandInput, ListThesauriCommandOutput } from "../commands/ListThesauriCommand"; +import { + PutPrincipalMappingCommandInput, + PutPrincipalMappingCommandOutput, +} from "../commands/PutPrincipalMappingCommand"; import { QueryCommandInput, QueryCommandOutput } from "../commands/QueryCommand"; import { StartDataSourceSyncJobCommandInput, @@ -126,6 +142,7 @@ import { CreateThesaurusRequest, CreateThesaurusResponse, DataSourceConfiguration, + DataSourceGroup, DataSourceSummary, DataSourceSyncJob, DataSourceSyncJobMetricTarget, @@ -136,6 +153,7 @@ import { DeleteDataSourceRequest, DeleteFaqRequest, DeleteIndexRequest, + DeletePrincipalMappingRequest, DeleteQuerySuggestionsBlockListRequest, DeleteThesaurusRequest, DescribeDataSourceRequest, @@ -144,6 +162,8 @@ import { DescribeFaqResponse, DescribeIndexRequest, DescribeIndexResponse, + DescribePrincipalMappingRequest, + DescribePrincipalMappingResponse, DescribeQuerySuggestionsBlockListRequest, DescribeQuerySuggestionsBlockListResponse, DescribeQuerySuggestionsConfigRequest, @@ -165,6 +185,10 @@ import { GetQuerySuggestionsRequest, GetQuerySuggestionsResponse, GoogleDriveConfiguration, + GroupMembers, + GroupOrderingIdSummary, + GroupSummary, + HierarchicalPrincipal, Highlight, IndexConfigurationSummary, IndexStatistics, @@ -177,6 +201,8 @@ import { ListDataSourcesResponse, ListFaqsRequest, ListFaqsResponse, + ListGroupsOlderThanOrderingIdRequest, + ListGroupsOlderThanOrderingIdResponse, ListIndicesRequest, ListIndicesResponse, ListQuerySuggestionsBlockListsRequest, @@ -185,10 +211,13 @@ import { ListTagsForResourceResponse, ListThesauriRequest, ListThesauriResponse, + MemberGroup, + MemberUser, OneDriveConfiguration, OneDriveUsers, Principal, ProxyConfiguration, + PutPrincipalMappingRequest, QueryRequest, QueryResult, QueryResultItem, @@ -426,6 +455,19 @@ export const serializeAws_json1_1DeleteIndexCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1DeletePrincipalMappingCommand = async ( + input: DeletePrincipalMappingCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AWSKendraFrontendService.DeletePrincipalMapping", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DeletePrincipalMappingRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1DeleteQuerySuggestionsBlockListCommand = async ( input: DeleteQuerySuggestionsBlockListCommandInput, context: __SerdeContext @@ -491,6 +533,19 @@ export const serializeAws_json1_1DescribeIndexCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1DescribePrincipalMappingCommand = async ( + input: DescribePrincipalMappingCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AWSKendraFrontendService.DescribePrincipalMapping", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DescribePrincipalMappingRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1DescribeQuerySuggestionsBlockListCommand = async ( input: DescribeQuerySuggestionsBlockListCommandInput, context: __SerdeContext @@ -582,6 +637,19 @@ export const serializeAws_json1_1ListFaqsCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1ListGroupsOlderThanOrderingIdCommand = async ( + input: ListGroupsOlderThanOrderingIdCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AWSKendraFrontendService.ListGroupsOlderThanOrderingId", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1ListGroupsOlderThanOrderingIdRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1ListIndicesCommand = async ( input: ListIndicesCommandInput, context: __SerdeContext @@ -634,6 +702,19 @@ export const serializeAws_json1_1ListThesauriCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1PutPrincipalMappingCommand = async ( + input: PutPrincipalMappingCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AWSKendraFrontendService.PutPrincipalMapping", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1PutPrincipalMappingRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1QueryCommand = async ( input: QueryCommandInput, context: __SerdeContext @@ -1949,6 +2030,97 @@ const deserializeAws_json1_1DeleteIndexCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_json1_1DeletePrincipalMappingCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseProvides details about an ongoing or complete migration from an + * Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration + * alerts and warnings related to the migration.
+ */ + public getMigration( + args: GetMigrationCommandInput, + options?: __HttpHandlerOptions + ): PromiseGets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
+ */ + public getMigrations( + args: GetMigrationsCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns information about a specific version of a slot type. In * addition to specifying the slot type name, you must specify the slot type @@ -1290,8 +1368,9 @@ export class LexModelBuildingService extends LexModelBuildingServiceClient { * received by the bot in the last 15 days. The response contains information * about a maximum of 100 utterances for each version.
*If you set childDirected field to true when you
- * created your bot, or if you opted out of participating in improving Amazon Lex,
- * utterances are not available.
This operation requires permissions for the
* lex:GetUtterancesView action.
Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when + * you want to take advantage of the new features of Amazon Lex V2.
+ *For more information, see Migrating a bot in the Amazon Lex + * developer guide.
+ */ + public startMigration( + args: StartMigrationCommandInput, + options?: __HttpHandlerOptions + ): PromiseAdds the specified tags to the specified resource. If a tag key * already exists, the existing value is replaced with the new value.
diff --git a/clients/client-lex-model-building-service/LexModelBuildingServiceClient.ts b/clients/client-lex-model-building-service/LexModelBuildingServiceClient.ts index 27c8f2673aacd..e5e4f4063e77a 100644 --- a/clients/client-lex-model-building-service/LexModelBuildingServiceClient.ts +++ b/clients/client-lex-model-building-service/LexModelBuildingServiceClient.ts @@ -49,6 +49,8 @@ import { GetImportCommandInput, GetImportCommandOutput } from "./commands/GetImp import { GetIntentCommandInput, GetIntentCommandOutput } from "./commands/GetIntentCommand"; import { GetIntentVersionsCommandInput, GetIntentVersionsCommandOutput } from "./commands/GetIntentVersionsCommand"; import { GetIntentsCommandInput, GetIntentsCommandOutput } from "./commands/GetIntentsCommand"; +import { GetMigrationCommandInput, GetMigrationCommandOutput } from "./commands/GetMigrationCommand"; +import { GetMigrationsCommandInput, GetMigrationsCommandOutput } from "./commands/GetMigrationsCommand"; import { GetSlotTypeCommandInput, GetSlotTypeCommandOutput } from "./commands/GetSlotTypeCommand"; import { GetSlotTypeVersionsCommandInput, @@ -65,6 +67,7 @@ import { PutBotCommandInput, PutBotCommandOutput } from "./commands/PutBotComman import { PutIntentCommandInput, PutIntentCommandOutput } from "./commands/PutIntentCommand"; import { PutSlotTypeCommandInput, PutSlotTypeCommandOutput } from "./commands/PutSlotTypeCommand"; import { StartImportCommandInput, StartImportCommandOutput } from "./commands/StartImportCommand"; +import { StartMigrationCommandInput, StartMigrationCommandOutput } from "./commands/StartMigrationCommand"; import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; import { ClientDefaultValues as __ClientDefaultValues } from "./runtimeConfig"; @@ -147,6 +150,8 @@ export type ServiceInputTypes = | GetIntentCommandInput | GetIntentVersionsCommandInput | GetIntentsCommandInput + | GetMigrationCommandInput + | GetMigrationsCommandInput | GetSlotTypeCommandInput | GetSlotTypeVersionsCommandInput | GetSlotTypesCommandInput @@ -157,6 +162,7 @@ export type ServiceInputTypes = | PutIntentCommandInput | PutSlotTypeCommandInput | StartImportCommandInput + | StartMigrationCommandInput | TagResourceCommandInput | UntagResourceCommandInput; @@ -188,6 +194,8 @@ export type ServiceOutputTypes = | GetIntentCommandOutput | GetIntentVersionsCommandOutput | GetIntentsCommandOutput + | GetMigrationCommandOutput + | GetMigrationsCommandOutput | GetSlotTypeCommandOutput | GetSlotTypeVersionsCommandOutput | GetSlotTypesCommandOutput @@ -198,6 +206,7 @@ export type ServiceOutputTypes = | PutIntentCommandOutput | PutSlotTypeCommandOutput | StartImportCommandOutput + | StartMigrationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput; diff --git a/clients/client-lex-model-building-service/commands/GetMigrationCommand.ts b/clients/client-lex-model-building-service/commands/GetMigrationCommand.ts new file mode 100644 index 0000000000000..d4746de3c404a --- /dev/null +++ b/clients/client-lex-model-building-service/commands/GetMigrationCommand.ts @@ -0,0 +1,100 @@ +import { + LexModelBuildingServiceClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes, +} from "../LexModelBuildingServiceClient"; +import { GetMigrationRequest, GetMigrationResponse } from "../models/models_0"; +import { + deserializeAws_restJson1GetMigrationCommand, + serializeAws_restJson1GetMigrationCommand, +} from "../protocols/Aws_restJson1"; +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + MiddlewareStack, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +export interface GetMigrationCommandInput extends GetMigrationRequest {} +export interface GetMigrationCommandOutput extends GetMigrationResponse, __MetadataBearer {} + +/** + *Provides details about an ongoing or complete migration from an + * Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration + * alerts and warnings related to the migration.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetMigrationCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetMigrationCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetMigrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMigrationCommandInput} for command's `input` shape. + * @see {@link GetMigrationCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * + */ +export class GetMigrationCommand extends $Command< + GetMigrationCommandInput, + GetMigrationCommandOutput, + LexModelBuildingServiceClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: GetMigrationCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, GetMigrationsCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, GetMigrationsCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new GetMigrationsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMigrationsCommandInput} for command's `input` shape. + * @see {@link GetMigrationsCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * + */ +export class GetMigrationsCommand extends $Command< + GetMigrationsCommandInput, + GetMigrationsCommandOutput, + LexModelBuildingServiceClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: GetMigrationsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackIf you set childDirected field to true when you
- * created your bot, or if you opted out of participating in improving Amazon Lex,
- * utterances are not available.
This operation requires permissions for the
* lex:GetUtterancesView action.
Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when + * you want to take advantage of the new features of Amazon Lex V2.
+ *For more information, see Migrating a bot in the Amazon Lex + * developer guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LexModelBuildingServiceClient, StartMigrationCommand } from "@aws-sdk/client-lex-model-building-service"; // ES Modules import + * // const { LexModelBuildingServiceClient, StartMigrationCommand } = require("@aws-sdk/client-lex-model-building-service"); // CommonJS import + * const client = new LexModelBuildingServiceClient(config); + * const command = new StartMigrationCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link StartMigrationCommandInput} for command's `input` shape. + * @see {@link StartMigrationCommandOutput} for command's `response` shape. + * @see {@link LexModelBuildingServiceClientResolvedConfig | config} for command's `input` shape. + * + */ +export class StartMigrationCommand extends $Command< + StartMigrationCommandInput, + StartMigrationCommandOutput, + LexModelBuildingServiceClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: StartMigrationCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackYour IAM user or role does not have permission to call the Amazon Lex V2 APIs + * required to migrate your bot.
+ */ +export interface AccessDeniedException extends __SmithyException, $MetadataBearer { + name: "AccessDeniedException"; + $fault: "client"; + message?: string; +} + +export namespace AccessDeniedException { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AccessDeniedException): any => ({ + ...obj, + }); +} + /** *The request is not well formed. For example, a value is invalid or * a required field is missing. Check the field values, and try @@ -197,6 +216,7 @@ export enum Locale { DE_DE = "de-DE", EN_AU = "en-AU", EN_GB = "en-GB", + EN_IN = "en-IN", EN_US = "en-US", ES_419 = "es-419", ES_ES = "es-ES", @@ -3024,6 +3044,319 @@ export namespace GetIntentVersionsResponse { }); } +export interface GetMigrationRequest { + /** + *
The unique identifier of the migration to view. The
+ * migrationID is returned by the operation.
Provides information about alerts and warnings that Amazon Lex sends during + * a migration. The alerts include information about how to resolve the + * issue.
+ */ +export interface MigrationAlert { + /** + *The type of alert. There are two kinds of alerts:
+ *
+ * ERROR - There was an issue with the migration that
+ * can't be resolved. The migration stops.
+ * WARN - There was an issue with the migration that
+ * requires manual changes to the new Amazon Lex V2 bot. The migration
+ * continues.
A message that describes why the alert was issued.
+ */ + message?: string; + + /** + *Additional details about the alert.
+ */ + details?: string[]; + + /** + *A link to the Amazon Lex documentation that describes how to resolve + * the alert.
+ */ + referenceURLs?: string[]; +} + +export namespace MigrationAlert { + /** + * @internal + */ + export const filterSensitiveLog = (obj: MigrationAlert): any => ({ + ...obj, + }); +} + +export enum MigrationStatus { + COMPLETED = "COMPLETED", + FAILED = "FAILED", + IN_PROGRESS = "IN_PROGRESS", +} + +export enum MigrationStrategy { + CREATE_NEW = "CREATE_NEW", + UPDATE_EXISTING = "UPDATE_EXISTING", +} + +export interface GetMigrationResponse { + /** + *The unique identifier of the migration. This is the same as the
+ * identifier used when calling the GetMigration
+ * operation.
The name of the Amazon Lex V1 bot migrated to Amazon Lex V2.
+ */ + v1BotName?: string; + + /** + *The version of the Amazon Lex V1 bot migrated to Amazon Lex V2.
+ */ + v1BotVersion?: string; + + /** + *The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2.
+ */ + v1BotLocale?: Locale | string; + + /** + *The unique identifier of the Amazon Lex V2 bot that the Amazon Lex V1 is being + * migrated to.
+ */ + v2BotId?: string; + + /** + *The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
+ */ + v2BotRole?: string; + + /** + *Indicates the status of the migration. When the status is
+ * COMPLETE the migration is finished and the bot is available
+ * in Amazon Lex V2. There may be alerts and warnings that need to be resolved to
+ * complete the migration.
The strategy used to conduct the migration.
+ *
+ * CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates
+ * the Amazon Lex V1 bot to the new bot.
+ * UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot
+ * metadata and the locale being migrated. It doesn't change any other
+ * locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale
+ * is created in the Amazon Lex V2 bot.
The date and time that the migration started.
+ */ + migrationTimestamp?: Date; + + /** + *A list of alerts and warnings that indicate issues with the migration + * for the Amazon Lex V1 bot to Amazon Lex V2. You receive a warning when an Amazon Lex V1 + * feature has a different implementation if Amazon Lex V2.
+ *For more information, see Migrating a bot in the Amazon Lex V2 + * developer guide.
+ */ + alerts?: MigrationAlert[]; +} + +export namespace GetMigrationResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetMigrationResponse): any => ({ + ...obj, + }); +} + +export enum MigrationSortAttribute { + MIGRATION_DATE_TIME = "MIGRATION_DATE_TIME", + V1_BOT_NAME = "V1_BOT_NAME", +} + +export enum SortOrder { + ASCENDING = "ASCENDING", + DESCENDING = "DESCENDING", +} + +export interface GetMigrationsRequest { + /** + *The field to sort the list of migrations by. You can sort by the + * Amazon Lex V1 bot name or the date and time that the migration was + * started.
+ */ + sortByAttribute?: MigrationSortAttribute | string; + + /** + *The order so sort the list.
+ */ + sortByOrder?: SortOrder | string; + + /** + *Filters the list to contain only bots whose name contains the + * specified string. The string is matched anywhere in bot name.
+ */ + v1BotNameContains?: string; + + /** + *Filters the list to contain only migrations in the specified state.
+ */ + migrationStatusEquals?: MigrationStatus | string; + + /** + *The maximum number of migrations to return in the response. The + * default is 10.
+ */ + maxResults?: number; + + /** + *A pagination token that fetches the next page of migrations. If the + * response to this operation is truncated, Amazon Lex returns a pagination token + * in the response. To fetch the next page of migrations, specify the + * pagination token in the request.
+ */ + nextToken?: string; +} + +export namespace GetMigrationsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetMigrationsRequest): any => ({ + ...obj, + }); +} + +/** + *Provides information about migrating a bot from Amazon Lex V1 to Amazon Lex V2.
+ */ +export interface MigrationSummary { + /** + *The unique identifier that Amazon Lex assigned to the migration.
+ */ + migrationId?: string; + + /** + *The name of the Amazon Lex V1 bot that is the source of the migration.
+ */ + v1BotName?: string; + + /** + *The version of the Amazon Lex V1 bot that is the source of the migration.
+ */ + v1BotVersion?: string; + + /** + *The locale of the Amazon Lex V1 bot that is the source of the migration.
+ */ + v1BotLocale?: Locale | string; + + /** + *The unique identifier of the Amazon Lex V2 that is the destination of the migration.
+ */ + v2BotId?: string; + + /** + *The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
+ */ + v2BotRole?: string; + + /** + *The status of the operation. When the status is COMPLETE
+ * the bot is available in Amazon Lex V2. There may be alerts and warnings that
+ * need to be resolved to complete the migration.
The strategy used to conduct the migration.
+ */ + migrationStrategy?: MigrationStrategy | string; + + /** + *The date and time that the migration started.
+ */ + migrationTimestamp?: Date; +} + +export namespace MigrationSummary { + /** + * @internal + */ + export const filterSensitiveLog = (obj: MigrationSummary): any => ({ + ...obj, + }); +} + +export interface GetMigrationsResponse { + /** + *An array of summaries for migrations from Amazon Lex V1 to Amazon Lex V2. To see
+ * details of the migration, use the migrationId from the
+ * summary in a call to the
+ * operation.
If the response is truncated, it includes a pagination token that you + * can specify in your next request to fetch the next page of + * migrations.
+ */ + nextToken?: string; +} + +export namespace GetMigrationsResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetMigrationsResponse): any => ({ + ...obj, + }); +} + export interface GetSlotTypeRequest { /** *The name of the slot type. The name is case sensitive.
@@ -4725,6 +5058,119 @@ export namespace StartImportResponse { }); } +export interface StartMigrationRequest { + /** + *The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.
+ */ + v1BotName: string | undefined; + + /** + *The version of the bot to migrate to Amazon Lex V2. You can migrate the
+ * $LATEST version as well as any numbered version.
The name of the Amazon Lex V2 bot that you are migrating the Amazon Lex V1 bot to.
+ *If the Amazon Lex V2 bot doesn't exist, you must use the
+ * CREATE_NEW migration strategy.
If the Amazon Lex V2 bot exists, you must use the
+ * UPDATE_EXISTING migration strategy to change the
+ * contents of the Amazon Lex V2 bot.
The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
+ */ + v2BotRole: string | undefined; + + /** + *The strategy used to conduct the migration.
+ *
+ * CREATE_NEW - Creates a new Amazon Lex V2 bot and migrates
+ * the Amazon Lex V1 bot to the new bot.
+ * UPDATE_EXISTING - Overwrites the existing Amazon Lex V2 bot
+ * metadata and the locale being migrated. It doesn't change any other
+ * locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale
+ * is created in the Amazon Lex V2 bot.
The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.
+ */ + v1BotName?: string; + + /** + *The version of the bot to migrate to Amazon Lex V2.
+ */ + v1BotVersion?: string; + + /** + *The locale used for the Amazon Lex V1 bot.
+ */ + v1BotLocale?: Locale | string; + + /** + *The unique identifier for the Amazon Lex V2 bot.
+ */ + v2BotId?: string; + + /** + *The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.
+ */ + v2BotRole?: string; + + /** + *The unique identifier that Amazon Lex assigned to the migration.
+ */ + migrationId?: string; + + /** + *The strategy used to conduct the migration.
+ */ + migrationStrategy?: MigrationStrategy | string; + + /** + *The date and time that the migration started.
+ */ + migrationTimestamp?: Date; +} + +export namespace StartMigrationResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: StartMigrationResponse): any => ({ + ...obj, + }); +} + export interface TagResourceRequest { /** *The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel
diff --git a/clients/client-lex-model-building-service/pagination/GetMigrationsPaginator.ts b/clients/client-lex-model-building-service/pagination/GetMigrationsPaginator.ts
new file mode 100644
index 0000000000000..6c94d17e864b4
--- /dev/null
+++ b/clients/client-lex-model-building-service/pagination/GetMigrationsPaginator.ts
@@ -0,0 +1,58 @@
+import { LexModelBuildingService } from "../LexModelBuildingService";
+import { LexModelBuildingServiceClient } from "../LexModelBuildingServiceClient";
+import {
+ GetMigrationsCommand,
+ GetMigrationsCommandInput,
+ GetMigrationsCommandOutput,
+} from "../commands/GetMigrationsCommand";
+import { LexModelBuildingServicePaginationConfiguration } from "./Interfaces";
+import { Paginator } from "@aws-sdk/types";
+
+/**
+ * @private
+ */
+const makePagedClientRequest = async (
+ client: LexModelBuildingServiceClient,
+ input: GetMigrationsCommandInput,
+ ...args: any
+): Promise Amazon Lightsail is the easiest way to get started with Amazon Web Services (AWS) for developers
* who need to build websites or web applications. It includes everything you need to launch your
- * project quickly - instances (virtual private servers), container services, managed databases,
- * SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN)
- * distributions, DNS management of registered domains, and resource snapshots (backups) - for a
- * low, predictable monthly price.
You can manage your Lightsail resources using the Lightsail console, Lightsail API, * AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts - * and tasks, see the Lightsail Dev Guide.
+ * and tasks, see the Amazon Lightsail Developer Guide. * *This API Reference provides detailed information about the actions, data types, * parameters, and errors of the Lightsail service. For more information about the supported @@ -717,7 +768,7 @@ export class Lightsail extends LightsailClient { * to the instance with the specified disk name.
*The attach disk operation supports tag-based access control via resource tags
* applied to the resource identified by disk name. For more information, see the
- * Lightsail Dev Guide.
The attach instances to load balancer operation supports tag-based access
* control via resource tags applied to the resource identified by load balancer
- * name. For more information, see the Lightsail Dev Guide.
The AttachLoadBalancerTlsCertificate operation supports tag-based access
* control via resource tags applied to the resource identified by load balancer
- * name. For more information, see the Lightsail Dev Guide.
Closes ports for a specific Amazon Lightsail instance.
*The CloseInstancePublicPorts action supports tag-based access control via
* resource tags applied to the resource identified by instanceName. For more
- * information, see the Lightsail Dev Guide.
Creates an Amazon Lightsail bucket.
+ * + *A bucket is a cloud storage resource available in the Lightsail object storage service. + * Use buckets to store objects such as data and its descriptive metadata. For more information + * about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer + * Guide.
+ */ + public createBucket( + args: CreateBucketCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreates a new access key for the specified Amazon Lightsail bucket. Access keys consist of + * an access key ID and corresponding secret access key.
+ * + *Access keys grant full programmatic access to the specified bucket and its objects. You + * can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information + * about access keys, see Creating access keys for a bucket in Amazon Lightsail in the + * Amazon Lightsail Developer Guide.
+ * + *The secretAccessKey value is returned only in response to the
+ * CreateBucketAccessKey action. You can get a secret access key only when you
+ * first create an access key; you cannot get the secret access key later. If you lose the
+ * secret access key, you must create a new access key.
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) * distribution and a container service.
@@ -1090,7 +1220,7 @@ export class Lightsail extends LightsailClient { * *You can deploy containers to your container service using container images from a public * registry like Docker Hub, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the - * Lightsail Dev Guide.
+ * Amazon Lightsail Developer Guide. */ public createContainerServiceDeployment( args: CreateContainerServiceDeploymentCommandInput, @@ -1143,7 +1273,7 @@ export class Lightsail extends LightsailClient { *This action is not required if you install and use the Lightsail Control * (lightsailctl) plugin to push container images to your Lightsail container service. For * more information, see Pushing and managing container images on your Amazon Lightsail container services - * in the Lightsail Dev Guide.
+ * in the Amazon Lightsail Developer Guide. *Creates a block storage disk that can be attached to an Amazon Lightsail instance in the
* same Availability Zone (e.g., us-east-2a).
The create disk operation supports tag-based access control via request tags.
- * For more information, see the Lightsail Dev Guide.
us-east-2a).
* The create disk from snapshot operation supports tag-based access control via
* request tags and resource tags applied to the resource identified by disk snapshot
- * name. For more information, see the Lightsail Dev Guide.
The create disk snapshot operation supports tag-based access control via
- * request tags. For more information, see the Lightsail Dev Guide.
Creates a domain resource for the specified domain (e.g., example.com).
*The create domain operation supports tag-based access control via request
- * tags. For more information, see the Lightsail Dev Guide.
The create domain entry operation supports tag-based access control via
* resource tags applied to the resource identified by domain name. For more
- * information, see the Lightsail Dev Guide.
Creates one or more Amazon Lightsail instances.
*The create instances operation supports tag-based access control via request
- * tags. For more information, see the Lightsail Dev Guide.
The create instances from snapshot operation supports tag-based access
* control via request tags and resource tags applied to the resource identified by
- * instance snapshot name. For more information, see the Lightsail Dev Guide.
instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.
*/
public createInstancesFromSnapshot(
args: CreateInstancesFromSnapshotCommandInput,
@@ -1472,7 +1602,7 @@ export class Lightsail extends LightsailClient {
* Creates a snapshot of a specific virtual private server, or instance. * You can use a snapshot to create a new instance that is based on that snapshot.
*The create instance snapshot operation supports tag-based access control via
- * request tags. For more information, see the Lightsail Dev Guide.
Creates an SSH key pair.
*The create key pair operation supports tag-based access control via request
- * tags. For more information, see the Lightsail Dev Guide.
Creates a Lightsail load balancer. To learn more about deciding whether to load balance - * your application, see Configure your Lightsail instances for load balancing. You can create up to 5 + * your application, see Configure your Lightsail instances for load balancing. You can create up to 5 * load balancers per AWS Region in your account.
*When you create a load balancer, you can specify a unique name and port settings. To
* change additional load balancer settings, use the UpdateLoadBalancerAttribute
* operation.
The create load balancer operation supports tag-based access control via
- * request tags. For more information, see the Lightsail Dev Guide.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
*The CreateLoadBalancerTlsCertificate operation supports tag-based access
* control via resource tags applied to the resource identified by load balancer
- * name. For more information, see the Lightsail Dev Guide.
Creates a new database in Amazon Lightsail.
*The create relational database operation supports tag-based access control
- * via request tags. For more information, see the Lightsail Dev Guide.
The create relational database from snapshot operation supports tag-based
* access control via request tags and resource tags applied to the resource identified by
- * relationalDatabaseSnapshotName. For more information, see the Lightsail Dev Guide.
Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, * to make copies of a database, and to save data before deleting a database.
*The create relational database snapshot operation supports tag-based access
- * control via request tags. For more information, see the Lightsail Dev Guide.
Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.
+ *Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
*/ public deleteAutoSnapshot( args: DeleteAutoSnapshotCommandInput, @@ -1781,6 +1911,77 @@ export class Lightsail extends LightsailClient { } } + /** + *Deletes a Amazon Lightsail bucket.
+ * + *When you delete your bucket, the bucket name is released and can be reused for a new + * bucket in your account or another AWS account.
+ *Deletes an access key for the specified Amazon Lightsail bucket.
+ * + *We recommend that you delete an access key if the secret access key is compromised.
+ * + *For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the + * Amazon Lightsail Developer Guide.
+ */ + public deleteBucketAccessKey( + args: DeleteBucketAccessKeyCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) * distribution.
@@ -1926,7 +2127,7 @@ export class Lightsail extends LightsailClient { *The delete disk operation supports tag-based access control via resource tags
* applied to the resource identified by disk name. For more information, see the
- * Lightsail Dev Guide.
The delete disk snapshot operation supports tag-based access control via
* resource tags applied to the resource identified by disk snapshot name. For more
- * information, see the Lightsail Dev Guide.
Deletes the specified domain recordset and all of its domain records.
*The delete domain operation supports tag-based access control via resource
* tags applied to the resource identified by domain name. For more information, see
- * the Lightsail Dev Guide.
Deletes a specific domain entry.
*The delete domain entry operation supports tag-based access control via
* resource tags applied to the resource identified by domain name. For more
- * information, see the Lightsail Dev Guide.
Deletes an Amazon Lightsail instance.
*The delete instance operation supports tag-based access control via resource
* tags applied to the resource identified by instance name. For more information,
- * see the Lightsail Dev Guide.
The delete instance snapshot operation supports tag-based access control via
* resource tags applied to the resource identified by instance snapshot name. For
- * more information, see the Lightsail Dev Guide.
Deletes a specific SSH key pair.
*The delete key pair operation supports tag-based access control via resource
* tags applied to the resource identified by key pair name. For more information,
- * see the Lightsail Dev Guide.
Perform this operation only if you were expecting the host key or certificate mismatch * or if you are familiar with the new host key or certificate on the instance. For more - * information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP + * information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP * client.
*The delete load balancer operation supports tag-based access control via
* resource tags applied to the resource identified by load balancer name. For more
- * information, see the Lightsail Dev Guide.
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
*The DeleteLoadBalancerTlsCertificate operation supports tag-based access
* control via resource tags applied to the resource identified by load balancer
- * name. For more information, see the Lightsail Dev Guide.
Deletes a database in Amazon Lightsail.
*The delete relational database operation supports tag-based access control
* via resource tags applied to the resource identified by relationalDatabaseName. For more
- * information, see the Lightsail Dev Guide.
Deletes a database snapshot in Amazon Lightsail.
*The delete relational database snapshot operation supports tag-based access
* control via resource tags applied to the resource identified by relationalDatabaseName. For
- * more information, see the Lightsail Dev Guide.
The detach disk operation supports tag-based access control via resource tags
* applied to the resource identified by disk name. For more information, see the
- * Lightsail Dev Guide.
The detach instances from load balancer operation supports tag-based access
* control via resource tags applied to the resource identified by load balancer
- * name. For more information, see the Lightsail Dev Guide.
Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
+ *Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
*/ public disableAddOn( args: DisableAddOnCommandInput, @@ -2576,7 +2777,7 @@ export class Lightsail extends LightsailClient { /** *Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see - * the Lightsail Dev Guide.
+ * the Amazon Lightsail Developer Guide. */ public enableAddOn(args: EnableAddOnCommandInput, options?: __HttpHandlerOptions): PromiseThe export snapshot operation supports tag-based access control via resource
* tags applied to the resource identified by source snapshot name. For more
- * information, see the Lightsail Dev Guide.
Use the get instance snapshots or get disk snapshots
* operations to get a list of snapshots that you can export to Amazon EC2.
Returns the available automatic snapshots for an instance or disk. For more information, - * see the Lightsail Dev Guide.
+ * see the Amazon Lightsail Developer Guide. */ public getAutoSnapshots( args: GetAutoSnapshotsCommandInput, @@ -2785,6 +2986,147 @@ export class Lightsail extends LightsailClient { } } + /** + *Returns the existing access key IDs for the specified Amazon Lightsail bucket.
+ * + *This action does not return the secret access key value of an access key. You can get a + * secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must + * create a new access key.
+ *Returns the bundles that you can apply to a Amazon Lightsail bucket.
+ * + *The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a + * bucket.
+ * + *Use the UpdateBucketBundle action to update the bundle for a + * bucket.
+ */ + public getBucketBundles( + args: GetBucketBundlesCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns the data points of a specific metric for an Amazon Lightsail bucket.
+ * + *Metrics report the utilization of a bucket. View and collect metric data regularly to + * monitor the number of objects stored in a bucket (including object versions) and the storage + * space used by those objects.
+ */ + public getBucketMetricData( + args: GetBucketMetricDataCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns information about one or more Amazon Lightsail buckets.
+ * + *For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer + * Guide..
+ */ + public getBuckets(args: GetBucketsCommandInput, options?: __HttpHandlerOptions): PromiseReturns the list of bundles that are available for purchase. A bundle describes the specs * for your virtual private server (or instance).
@@ -3301,8 +3643,8 @@ export class Lightsail extends LightsailClient { } /** - *Returns the list bundles that can be applied to you Amazon Lightsail content delivery - * network (CDN) distributions.
+ *Returns the bundles that can be applied to your Amazon Lightsail content delivery network + * (CDN) distributions.
*A distribution bundle specifies the monthly network transfer quota and monthly cost of * your dsitribution.
*/ @@ -3490,10 +3832,10 @@ export class Lightsail extends LightsailClient { } /** - *Returns the export snapshot record created as a result of the export snapshot
- * operation.
Returns all export snapshot records created as a result of the export
+ * snapshot operation.
An export snapshot record can be used to create a new Amazon EC2 instance and its related
- * resources with the create cloud formation stack operation.
The get instance access details operation supports tag-based access control
* via resource tags applied to the resource identified by instance name. For more
- * information, see the Lightsail Dev Guide.
The OpenInstancePublicPorts action supports tag-based access control via
* resource tags applied to the resource identified by instanceName. For more
- * information, see the Lightsail Dev Guide.
Tries to peer the Lightsail VPC with the user's default VPC.
+ *Peers the Lightsail VPC with the user's default VPC.
*/ public peerVpc(args: PeerVpcCommandInput, options?: __HttpHandlerOptions): PromiseThe PutInstancePublicPorts action supports tag-based access control via
* resource tags applied to the resource identified by instanceName. For more
- * information, see the Lightsail Dev Guide.
Restarts a specific instance.
*The reboot instance operation supports tag-based access control via resource
* tags applied to the resource identified by instance name. For more information,
- * see the Lightsail Dev Guide.
Restarts a specific database in Amazon Lightsail.
*The reboot relational database operation supports tag-based access control
* via resource tags applied to the resource identified by relationalDatabaseName. For more
- * information, see the Lightsail Dev Guide.
This action is not required if you install and use the Lightsail Control * (lightsailctl) plugin to push container images to your Lightsail container service. For * more information, see Pushing and managing container images on your Amazon Lightsail container services - * in the Lightsail Dev Guide.
+ * in the Amazon Lightsail Developer Guide. *Sets the Amazon Lightsail resources that can access the specified Lightsail + * bucket.
+ * + *Lightsail buckets currently support setting access for Lightsail instances in the same + * AWS Region.
+ */ + public setResourceAccessForBucket( + args: SetResourceAccessForBucketCommandInput, + options?: __HttpHandlerOptions + ): PromiseStarts a specific Amazon Lightsail instance from a stopped state. To restart an instance,
* use the reboot instance operation.
When you start a stopped instance, Lightsail assigns a new public IP address to the * instance. To use the same IP address after stopping and starting an instance, create a - * static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.
+ * static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide. *The start instance operation supports tag-based access control via resource
* tags applied to the resource identified by instance name. For more information,
- * see the Lightsail Dev Guide.
reboot relational database operation.
* The start relational database operation supports tag-based access control via
* resource tags applied to the resource identified by relationalDatabaseName. For more
- * information, see the Lightsail Dev Guide.
When you start a stopped instance, Lightsail assigns a new public IP address to the * instance. To use the same IP address after stopping and starting an instance, create a - * static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.
+ * static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide. *The stop instance operation supports tag-based access control via resource
* tags applied to the resource identified by instance name. For more information,
- * see the Lightsail Dev Guide.
Stops a specific database that is currently running in Amazon Lightsail.
*The stop relational database operation supports tag-based access control via
* resource tags applied to the resource identified by relationalDatabaseName. For more
- * information, see the Lightsail Dev Guide.
Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a * maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique - * per resource. For more information about tags, see the Lightsail - * Dev Guide.
+ * per resource. For more information about tags, see the Amazon Lightsail Developer Guide. *The tag resource operation supports tag-based access control via request tags
* and resource tags applied to the resource identified by resource name. For more
- * information, see the Lightsail Dev Guide.
Attempts to unpeer the Lightsail VPC from the user's default VPC.
+ *Unpeers the Lightsail VPC from the user's default VPC.
*/ public unpeerVpc(args: UnpeerVpcCommandInput, options?: __HttpHandlerOptions): PromiseThe untag resource operation supports tag-based access control via request
* tags and resource tags applied to the resource identified by resource name. For
- * more information, see the Lightsail Dev Guide.
Updates an existing Amazon Lightsail bucket.
+ * + *Use this action to update the configuration of an existing bucket, such as versioning, + * public accessibility, and the AWS accounts that can access the bucket.
+ */ + public updateBucket( + args: UpdateBucketCommandInput, + options?: __HttpHandlerOptions + ): PromiseUpdates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
+ * + *A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a
+ * bucket. You can update a bucket's bundle only one time within a monthly AWS billing cycle. To
+ * determine if you can update a bucket's bundle, use the GetBuckets action.
+ * The ableToUpdateBundle parameter in the response will indicate whether you can
+ * currently update a bucket's bundle.
Update a bucket's bundle if it's consistently going over its storage space or data + * transfer quota, or if a bucket's usage is consistently in the lower range of its storage space + * or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might + * experience, we strongly recommend that you update a bucket's bundle only as a long-term + * strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle + * that will provide the bucket with ample storage space and data transfer for a long time to + * come.
+ */ + public updateBucketBundle( + args: UpdateBucketBundleCommandInput, + options?: __HttpHandlerOptions + ): PromiseUpdates the configuration of your Amazon Lightsail container service, such as its power, * scale, and public domain names.
@@ -5315,7 +5770,7 @@ export class Lightsail extends LightsailClient { /** *Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
- *Use this action to update the configuration of your existing distribution
+ *Use this action to update the configuration of your existing distribution.
*/ public updateDistribution( args: UpdateDistributionCommandInput, @@ -5391,7 +5846,7 @@ export class Lightsail extends LightsailClient { *Updates a domain recordset after it is created.
*The update domain entry operation supports tag-based access control via
* resource tags applied to the resource identified by domain name. For more
- * information, see the Lightsail Dev Guide.
The update load balancer attribute operation supports tag-based access
* control via resource tags applied to the resource identified by load balancer
- * name. For more information, see the Lightsail Dev Guide.
The update relational database operation supports tag-based access control
* via resource tags applied to the resource identified by relationalDatabaseName. For more
- * information, see the Lightsail Dev Guide.
reboot relational database operation.
* The update relational database parameters operation supports tag-based access
* control via resource tags applied to the resource identified by relationalDatabaseName. For
- * more information, see the Lightsail Dev Guide.
Amazon Lightsail is the easiest way to get started with Amazon Web Services (AWS) for developers * who need to build websites or web applications. It includes everything you need to launch your - * project quickly - instances (virtual private servers), container services, managed databases, - * SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) - * distributions, DNS management of registered domains, and resource snapshots (backups) - for a - * low, predictable monthly price.
+ * project quickly - instances (virtual private servers), container services, storage buckets, + * managed databases, SSD-based block storage, static IP addresses, load balancers, content + * delivery network (CDN) distributions, DNS management of registered domains, and resource + * snapshots (backups) - for a low, predictable monthly price. * *You can manage your Lightsail resources using the Lightsail console, Lightsail API, * AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts - * and tasks, see the Lightsail Dev Guide.
+ * and tasks, see the Amazon Lightsail Developer Guide. * *This API Reference provides detailed information about the actions, data types, * parameters, and errors of the Lightsail service. For more information about the supported diff --git a/clients/client-lightsail/README.md b/clients/client-lightsail/README.md index 85dfe40eac757..8d01720d97d60 100644 --- a/clients/client-lightsail/README.md +++ b/clients/client-lightsail/README.md @@ -9,14 +9,14 @@ AWS SDK for JavaScript Lightsail Client for Node.js, Browser and React Native.
Amazon Lightsail is the easiest way to get started with Amazon Web Services (AWS) for developers who need to build websites or web applications. It includes everything you need to launch your -project quickly - instances (virtual private servers), container services, managed databases, -SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) -distributions, DNS management of registered domains, and resource snapshots (backups) - for a -low, predictable monthly price.
+project quickly - instances (virtual private servers), container services, storage buckets, +managed databases, SSD-based block storage, static IP addresses, load balancers, content +delivery network (CDN) distributions, DNS management of registered domains, and resource +snapshots (backups) - for a low, predictable monthly price.You can manage your Lightsail resources using the Lightsail console, Lightsail API, AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts -and tasks, see the Lightsail Dev Guide.
+and tasks, see the Amazon Lightsail Developer Guide.This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported diff --git a/clients/client-lightsail/commands/AttachDiskCommand.ts b/clients/client-lightsail/commands/AttachDiskCommand.ts index 4e22fdf02b87b..aa2c87d0afffa 100644 --- a/clients/client-lightsail/commands/AttachDiskCommand.ts +++ b/clients/client-lightsail/commands/AttachDiskCommand.ts @@ -25,7 +25,7 @@ export interface AttachDiskCommandOutput extends AttachDiskResult, __MetadataBea * to the instance with the specified disk name.
*The attach disk operation supports tag-based access control via resource tags
* applied to the resource identified by disk name. For more information, see the
- * Lightsail Dev Guide.
The attach instances to load balancer operation supports tag-based access
* control via resource tags applied to the resource identified by load balancer
- * name. For more information, see the Lightsail Dev Guide.
The AttachLoadBalancerTlsCertificate operation supports tag-based access
* control via resource tags applied to the resource identified by load balancer
- * name. For more information, see the Lightsail Dev Guide.
Closes ports for a specific Amazon Lightsail instance.
*The CloseInstancePublicPorts action supports tag-based access control via
* resource tags applied to the resource identified by instanceName. For more
- * information, see the Lightsail Dev Guide.
Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of + * an access key ID and corresponding secret access key.
+ * + *Access keys grant full programmatic access to the specified bucket and its objects. You + * can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information + * about access keys, see Creating access keys for a bucket in Amazon Lightsail in the + * Amazon Lightsail Developer Guide.
+ * + *The secretAccessKey value is returned only in response to the
+ * CreateBucketAccessKey action. You can get a secret access key only when you
+ * first create an access key; you cannot get the secret access key later. If you lose the
+ * secret access key, you must create a new access key.
Creates an Amazon Lightsail bucket.
+ * + *A bucket is a cloud storage resource available in the Lightsail object storage service. + * Use buckets to store objects such as data and its descriptive metadata. For more information + * about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer + * Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, CreateBucketCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, CreateBucketCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new CreateBucketCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateBucketCommandInput} for command's `input` shape. + * @see {@link CreateBucketCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * + */ +export class CreateBucketCommand extends $Command< + CreateBucketCommandInput, + CreateBucketCommandOutput, + LightsailClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: CreateBucketCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackYou can deploy containers to your container service using container images from a public * registry like Docker Hub, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the - * Lightsail Dev Guide.
+ * Amazon Lightsail Developer Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-lightsail/commands/CreateContainerServiceRegistryLoginCommand.ts b/clients/client-lightsail/commands/CreateContainerServiceRegistryLoginCommand.ts index aa26589c58751..a7b1a79b315e0 100644 --- a/clients/client-lightsail/commands/CreateContainerServiceRegistryLoginCommand.ts +++ b/clients/client-lightsail/commands/CreateContainerServiceRegistryLoginCommand.ts @@ -47,7 +47,7 @@ export interface CreateContainerServiceRegistryLoginCommandOutput *This action is not required if you install and use the Lightsail Control * (lightsailctl) plugin to push container images to your Lightsail container service. For * more information, see Pushing and managing container images on your Amazon Lightsail container services - * in the Lightsail Dev Guide.
+ * in the Amazon Lightsail Developer Guide. * * @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-lightsail/commands/CreateDiskCommand.ts b/clients/client-lightsail/commands/CreateDiskCommand.ts index c9f87cf98106b..a22456d5df958 100644 --- a/clients/client-lightsail/commands/CreateDiskCommand.ts +++ b/clients/client-lightsail/commands/CreateDiskCommand.ts @@ -24,7 +24,7 @@ export interface CreateDiskCommandOutput extends CreateDiskResult, __MetadataBea *Creates a block storage disk that can be attached to an Amazon Lightsail instance in the
* same Availability Zone (e.g., us-east-2a).
The create disk operation supports tag-based access control via request tags.
- * For more information, see the Lightsail Dev Guide.
us-east-2a).
* The create disk from snapshot operation supports tag-based access control via
* request tags and resource tags applied to the resource identified by disk snapshot
- * name. For more information, see the Lightsail Dev Guide.
The create disk snapshot operation supports tag-based access control via
- * request tags. For more information, see the Lightsail Dev Guide.
Creates a domain resource for the specified domain (e.g., example.com).
*The create domain operation supports tag-based access control via request
- * tags. For more information, see the Lightsail Dev Guide.
The create domain entry operation supports tag-based access control via
* resource tags applied to the resource identified by domain name. For more
- * information, see the Lightsail Dev Guide.
Creates a snapshot of a specific virtual private server, or instance. * You can use a snapshot to create a new instance that is based on that snapshot.
*The create instance snapshot operation supports tag-based access control via
- * request tags. For more information, see the Lightsail Dev Guide.
Creates one or more Amazon Lightsail instances.
*The create instances operation supports tag-based access control via request
- * tags. For more information, see the Lightsail Dev Guide.
The create instances from snapshot operation supports tag-based access
* control via request tags and resource tags applied to the resource identified by
- * instance snapshot name. For more information, see the Lightsail Dev Guide.
instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
diff --git a/clients/client-lightsail/commands/CreateKeyPairCommand.ts b/clients/client-lightsail/commands/CreateKeyPairCommand.ts
index 3308fe196a43f..99a9f4d4f45a3 100644
--- a/clients/client-lightsail/commands/CreateKeyPairCommand.ts
+++ b/clients/client-lightsail/commands/CreateKeyPairCommand.ts
@@ -23,7 +23,7 @@ export interface CreateKeyPairCommandOutput extends CreateKeyPairResult, __Metad
/**
* Creates an SSH key pair.
*The create key pair operation supports tag-based access control via request
- * tags. For more information, see the Lightsail Dev Guide.
Creates a Lightsail load balancer. To learn more about deciding whether to load balance - * your application, see Configure your Lightsail instances for load balancing. You can create up to 5 + * your application, see Configure your Lightsail instances for load balancing. You can create up to 5 * load balancers per AWS Region in your account.
*When you create a load balancer, you can specify a unique name and port settings. To
* change additional load balancer settings, use the UpdateLoadBalancerAttribute
* operation.
The create load balancer operation supports tag-based access control via
- * request tags. For more information, see the Lightsail Dev Guide.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
*The CreateLoadBalancerTlsCertificate operation supports tag-based access
* control via resource tags applied to the resource identified by load balancer
- * name. For more information, see the Lightsail Dev Guide.
Creates a new database in Amazon Lightsail.
*The create relational database operation supports tag-based access control
- * via request tags. For more information, see the Lightsail Dev Guide.
The create relational database from snapshot operation supports tag-based
* access control via request tags and resource tags applied to the resource identified by
- * relationalDatabaseSnapshotName. For more information, see the Lightsail Dev Guide.
Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, * to make copies of a database, and to save data before deleting a database.
*The create relational database snapshot operation supports tag-based access
- * control via request tags. For more information, see the Lightsail Dev Guide.
Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.
+ *Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-lightsail/commands/DeleteBucketAccessKeyCommand.ts b/clients/client-lightsail/commands/DeleteBucketAccessKeyCommand.ts new file mode 100644 index 0000000000000..618a7d15f2361 --- /dev/null +++ b/clients/client-lightsail/commands/DeleteBucketAccessKeyCommand.ts @@ -0,0 +1,99 @@ +import { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient"; +import { DeleteBucketAccessKeyRequest, DeleteBucketAccessKeyResult } from "../models/models_0"; +import { + deserializeAws_json1_1DeleteBucketAccessKeyCommand, + serializeAws_json1_1DeleteBucketAccessKeyCommand, +} from "../protocols/Aws_json1_1"; +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + MiddlewareStack, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +export interface DeleteBucketAccessKeyCommandInput extends DeleteBucketAccessKeyRequest {} +export interface DeleteBucketAccessKeyCommandOutput extends DeleteBucketAccessKeyResult, __MetadataBearer {} + +/** + *Deletes an access key for the specified Amazon Lightsail bucket.
+ * + *We recommend that you delete an access key if the secret access key is compromised.
+ * + *For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the + * Amazon Lightsail Developer Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, DeleteBucketAccessKeyCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, DeleteBucketAccessKeyCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new DeleteBucketAccessKeyCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteBucketAccessKeyCommandInput} for command's `input` shape. + * @see {@link DeleteBucketAccessKeyCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DeleteBucketAccessKeyCommand extends $Command< + DeleteBucketAccessKeyCommandInput, + DeleteBucketAccessKeyCommandOutput, + LightsailClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeleteBucketAccessKeyCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes a Amazon Lightsail bucket.
+ * + *When you delete your bucket, the bucket name is released and can be reused for a new + * bucket in your account or another AWS account.
+ *The delete disk operation supports tag-based access control via resource tags
* applied to the resource identified by disk name. For more information, see the
- * Lightsail Dev Guide.
The delete disk snapshot operation supports tag-based access control via
* resource tags applied to the resource identified by disk snapshot name. For more
- * information, see the Lightsail Dev Guide.
Deletes the specified domain recordset and all of its domain records.
*The delete domain operation supports tag-based access control via resource
* tags applied to the resource identified by domain name. For more information, see
- * the Lightsail Dev Guide.
Deletes a specific domain entry.
*The delete domain entry operation supports tag-based access control via
* resource tags applied to the resource identified by domain name. For more
- * information, see the Lightsail Dev Guide.
Deletes an Amazon Lightsail instance.
*The delete instance operation supports tag-based access control via resource
* tags applied to the resource identified by instance name. For more information,
- * see the Lightsail Dev Guide.
The delete instance snapshot operation supports tag-based access control via
* resource tags applied to the resource identified by instance snapshot name. For
- * more information, see the Lightsail Dev Guide.
Deletes a specific SSH key pair.
*The delete key pair operation supports tag-based access control via resource
* tags applied to the resource identified by key pair name. For more information,
- * see the Lightsail Dev Guide.
Perform this operation only if you were expecting the host key or certificate mismatch * or if you are familiar with the new host key or certificate on the instance. For more - * information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP + * information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP * client.
*The delete load balancer operation supports tag-based access control via
* resource tags applied to the resource identified by load balancer name. For more
- * information, see the Lightsail Dev Guide.
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
*The DeleteLoadBalancerTlsCertificate operation supports tag-based access
* control via resource tags applied to the resource identified by load balancer
- * name. For more information, see the Lightsail Dev Guide.
Deletes a database in Amazon Lightsail.
*The delete relational database operation supports tag-based access control
* via resource tags applied to the resource identified by relationalDatabaseName. For more
- * information, see the Lightsail Dev Guide.
Deletes a database snapshot in Amazon Lightsail.
*The delete relational database snapshot operation supports tag-based access
* control via resource tags applied to the resource identified by relationalDatabaseName. For
- * more information, see the Lightsail Dev Guide.
The detach disk operation supports tag-based access control via resource tags
* applied to the resource identified by disk name. For more information, see the
- * Lightsail Dev Guide.
The detach instances from load balancer operation supports tag-based access
* control via resource tags applied to the resource identified by load balancer
- * name. For more information, see the Lightsail Dev Guide.
Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
+ *Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-lightsail/commands/EnableAddOnCommand.ts b/clients/client-lightsail/commands/EnableAddOnCommand.ts index ba4887e6ad0b3..efc0b04fb9168 100644 --- a/clients/client-lightsail/commands/EnableAddOnCommand.ts +++ b/clients/client-lightsail/commands/EnableAddOnCommand.ts @@ -22,7 +22,7 @@ export interface EnableAddOnCommandOutput extends EnableAddOnResult, __MetadataB /** *Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see - * the Lightsail Dev Guide.
+ * the Amazon Lightsail Developer Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-lightsail/commands/ExportSnapshotCommand.ts b/clients/client-lightsail/commands/ExportSnapshotCommand.ts index b324b7de18537..826a3d7a38db8 100644 --- a/clients/client-lightsail/commands/ExportSnapshotCommand.ts +++ b/clients/client-lightsail/commands/ExportSnapshotCommand.ts @@ -31,7 +31,7 @@ export interface ExportSnapshotCommandOutput extends ExportSnapshotResult, __Met * *The export snapshot operation supports tag-based access control via resource
* tags applied to the resource identified by source snapshot name. For more
- * information, see the Lightsail Dev Guide.
Use the get instance snapshots or get disk snapshots
* operations to get a list of snapshots that you can export to Amazon EC2.
Returns the available automatic snapshots for an instance or disk. For more information, - * see the Lightsail Dev Guide.
+ * see the Amazon Lightsail Developer Guide. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-lightsail/commands/GetBucketAccessKeysCommand.ts b/clients/client-lightsail/commands/GetBucketAccessKeysCommand.ts new file mode 100644 index 0000000000000..98309797a301d --- /dev/null +++ b/clients/client-lightsail/commands/GetBucketAccessKeysCommand.ts @@ -0,0 +1,100 @@ +import { LightsailClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LightsailClient"; +import { GetBucketAccessKeysRequest, GetBucketAccessKeysResult } from "../models/models_0"; +import { + deserializeAws_json1_1GetBucketAccessKeysCommand, + serializeAws_json1_1GetBucketAccessKeysCommand, +} from "../protocols/Aws_json1_1"; +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + MiddlewareStack, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +export interface GetBucketAccessKeysCommandInput extends GetBucketAccessKeysRequest {} +export interface GetBucketAccessKeysCommandOutput extends GetBucketAccessKeysResult, __MetadataBearer {} + +/** + *Returns the existing access key IDs for the specified Amazon Lightsail bucket.
+ * + *This action does not return the secret access key value of an access key. You can get a + * secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must + * create a new access key.
+ *Returns the bundles that you can apply to a Amazon Lightsail bucket.
+ * + *The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a + * bucket.
+ * + *Use the UpdateBucketBundle action to update the bundle for a + * bucket.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetBucketBundlesCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetBucketBundlesCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetBucketBundlesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketBundlesCommandInput} for command's `input` shape. + * @see {@link GetBucketBundlesCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * + */ +export class GetBucketBundlesCommand extends $Command< + GetBucketBundlesCommandInput, + GetBucketBundlesCommandOutput, + LightsailClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: GetBucketBundlesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns the data points of a specific metric for an Amazon Lightsail bucket.
+ * + *Metrics report the utilization of a bucket. View and collect metric data regularly to + * monitor the number of objects stored in a bucket (including object versions) and the storage + * space used by those objects.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetBucketMetricDataCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetBucketMetricDataCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetBucketMetricDataCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketMetricDataCommandInput} for command's `input` shape. + * @see {@link GetBucketMetricDataCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * + */ +export class GetBucketMetricDataCommand extends $Command< + GetBucketMetricDataCommandInput, + GetBucketMetricDataCommandOutput, + LightsailClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: GetBucketMetricDataCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns information about one or more Amazon Lightsail buckets.
+ * + *For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer + * Guide..
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, GetBucketsCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, GetBucketsCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new GetBucketsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetBucketsCommandInput} for command's `input` shape. + * @see {@link GetBucketsCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * + */ +export class GetBucketsCommand extends $Command< + GetBucketsCommandInput, + GetBucketsCommandOutput, + LightsailClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: GetBucketsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns the list bundles that can be applied to you Amazon Lightsail content delivery - * network (CDN) distributions.
+ *Returns the bundles that can be applied to your Amazon Lightsail content delivery network + * (CDN) distributions.
*A distribution bundle specifies the monthly network transfer quota and monthly cost of * your dsitribution.
* @example diff --git a/clients/client-lightsail/commands/GetExportSnapshotRecordsCommand.ts b/clients/client-lightsail/commands/GetExportSnapshotRecordsCommand.ts index ed11f3d38390c..a61f4d5e7f62f 100644 --- a/clients/client-lightsail/commands/GetExportSnapshotRecordsCommand.ts +++ b/clients/client-lightsail/commands/GetExportSnapshotRecordsCommand.ts @@ -21,10 +21,10 @@ export interface GetExportSnapshotRecordsCommandInput extends GetExportSnapshotR export interface GetExportSnapshotRecordsCommandOutput extends GetExportSnapshotRecordsResult, __MetadataBearer {} /** - *Returns the export snapshot record created as a result of the export snapshot
- * operation.
Returns all export snapshot records created as a result of the export
+ * snapshot operation.
An export snapshot record can be used to create a new Amazon EC2 instance and its related
- * resources with the create cloud formation stack operation.
The get instance access details operation supports tag-based access control
* via resource tags applied to the resource identified by instance name. For more
- * information, see the Lightsail Dev Guide.
The OpenInstancePublicPorts action supports tag-based access control via
* resource tags applied to the resource identified by instanceName. For more
- * information, see the Lightsail Dev Guide.
Tries to peer the Lightsail VPC with the user's default VPC.
+ *Peers the Lightsail VPC with the user's default VPC.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-lightsail/commands/PutInstancePublicPortsCommand.ts b/clients/client-lightsail/commands/PutInstancePublicPortsCommand.ts index 7b539dc57002c..b158a8f76d0d1 100644 --- a/clients/client-lightsail/commands/PutInstancePublicPortsCommand.ts +++ b/clients/client-lightsail/commands/PutInstancePublicPortsCommand.ts @@ -29,7 +29,7 @@ export interface PutInstancePublicPortsCommandOutput extends PutInstancePublicPo * ports. *The PutInstancePublicPorts action supports tag-based access control via
* resource tags applied to the resource identified by instanceName. For more
- * information, see the Lightsail Dev Guide.
Restarts a specific instance.
*The reboot instance operation supports tag-based access control via resource
* tags applied to the resource identified by instance name. For more information,
- * see the Lightsail Dev Guide.
Restarts a specific database in Amazon Lightsail.
*The reboot relational database operation supports tag-based access control
* via resource tags applied to the resource identified by relationalDatabaseName. For more
- * information, see the Lightsail Dev Guide.
This action is not required if you install and use the Lightsail Control * (lightsailctl) plugin to push container images to your Lightsail container service. For * more information, see Pushing and managing container images on your Amazon Lightsail container services - * in the Lightsail Dev Guide.
+ * in the Amazon Lightsail Developer Guide. *Sets the Amazon Lightsail resources that can access the specified Lightsail + * bucket.
+ * + *Lightsail buckets currently support setting access for Lightsail instances in the same + * AWS Region.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, SetResourceAccessForBucketCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, SetResourceAccessForBucketCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new SetResourceAccessForBucketCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link SetResourceAccessForBucketCommandInput} for command's `input` shape. + * @see {@link SetResourceAccessForBucketCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * + */ +export class SetResourceAccessForBucketCommand extends $Command< + SetResourceAccessForBucketCommandInput, + SetResourceAccessForBucketCommandOutput, + LightsailClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: SetResourceAccessForBucketCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackWhen you start a stopped instance, Lightsail assigns a new public IP address to the * instance. To use the same IP address after stopping and starting an instance, create a - * static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.
+ * static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide. *The start instance operation supports tag-based access control via resource
* tags applied to the resource identified by instance name. For more information,
- * see the Lightsail Dev Guide.
reboot relational database operation.
* The start relational database operation supports tag-based access control via
* resource tags applied to the resource identified by relationalDatabaseName. For more
- * information, see the Lightsail Dev Guide.
When you start a stopped instance, Lightsail assigns a new public IP address to the * instance. To use the same IP address after stopping and starting an instance, create a - * static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.
+ * static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide. *The stop instance operation supports tag-based access control via resource
* tags applied to the resource identified by instance name. For more information,
- * see the Lightsail Dev Guide.
Stops a specific database that is currently running in Amazon Lightsail.
*The stop relational database operation supports tag-based access control via
* resource tags applied to the resource identified by relationalDatabaseName. For more
- * information, see the Lightsail Dev Guide.
Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a * maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique - * per resource. For more information about tags, see the Lightsail - * Dev Guide.
+ * per resource. For more information about tags, see the Amazon Lightsail Developer Guide. *The tag resource operation supports tag-based access control via request tags
* and resource tags applied to the resource identified by resource name. For more
- * information, see the Lightsail Dev Guide.
Attempts to unpeer the Lightsail VPC from the user's default VPC.
+ *Unpeers the Lightsail VPC from the user's default VPC.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-lightsail/commands/UntagResourceCommand.ts b/clients/client-lightsail/commands/UntagResourceCommand.ts index ee8d4e9f0784d..45c478da8e42b 100644 --- a/clients/client-lightsail/commands/UntagResourceCommand.ts +++ b/clients/client-lightsail/commands/UntagResourceCommand.ts @@ -25,7 +25,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResult, __Metad * resource. *The untag resource operation supports tag-based access control via request
* tags and resource tags applied to the resource identified by resource name. For
- * more information, see the Lightsail Dev Guide.
Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
+ * + *A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a
+ * bucket. You can update a bucket's bundle only one time within a monthly AWS billing cycle. To
+ * determine if you can update a bucket's bundle, use the GetBuckets action.
+ * The ableToUpdateBundle parameter in the response will indicate whether you can
+ * currently update a bucket's bundle.
Update a bucket's bundle if it's consistently going over its storage space or data + * transfer quota, or if a bucket's usage is consistently in the lower range of its storage space + * or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might + * experience, we strongly recommend that you update a bucket's bundle only as a long-term + * strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle + * that will provide the bucket with ample storage space and data transfer for a long time to + * come.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, UpdateBucketBundleCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, UpdateBucketBundleCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new UpdateBucketBundleCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBucketBundleCommandInput} for command's `input` shape. + * @see {@link UpdateBucketBundleCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * + */ +export class UpdateBucketBundleCommand extends $Command< + UpdateBucketBundleCommandInput, + UpdateBucketBundleCommandOutput, + LightsailClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: UpdateBucketBundleCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates an existing Amazon Lightsail bucket.
+ * + *Use this action to update the configuration of an existing bucket, such as versioning, + * public accessibility, and the AWS accounts that can access the bucket.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { LightsailClient, UpdateBucketCommand } from "@aws-sdk/client-lightsail"; // ES Modules import + * // const { LightsailClient, UpdateBucketCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import + * const client = new LightsailClient(config); + * const command = new UpdateBucketCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateBucketCommandInput} for command's `input` shape. + * @see {@link UpdateBucketCommandOutput} for command's `response` shape. + * @see {@link LightsailClientResolvedConfig | config} for command's `input` shape. + * + */ +export class UpdateBucketCommand extends $Command< + UpdateBucketCommandInput, + UpdateBucketCommandOutput, + LightsailClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: UpdateBucketCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates an existing Amazon Lightsail content delivery network (CDN) distribution.
- *Use this action to update the configuration of your existing distribution
+ *Use this action to update the configuration of your existing distribution.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-lightsail/commands/UpdateDomainEntryCommand.ts b/clients/client-lightsail/commands/UpdateDomainEntryCommand.ts index e235e085ddecf..fe36ef7e2b97f 100644 --- a/clients/client-lightsail/commands/UpdateDomainEntryCommand.ts +++ b/clients/client-lightsail/commands/UpdateDomainEntryCommand.ts @@ -24,7 +24,7 @@ export interface UpdateDomainEntryCommandOutput extends UpdateDomainEntryResult, *Updates a domain recordset after it is created.
*The update domain entry operation supports tag-based access control via
* resource tags applied to the resource identified by domain name. For more
- * information, see the Lightsail Dev Guide.
The update load balancer attribute operation supports tag-based access
* control via resource tags applied to the resource identified by load balancer
- * name. For more information, see the Lightsail Dev Guide.
The update relational database operation supports tag-based access control
* via resource tags applied to the resource identified by relationalDatabaseName. For more
- * information, see the Lightsail Dev Guide.
reboot relational database operation.
* The update relational database parameters operation supports tag-based access
* control via resource tags applied to the resource identified by relationalDatabaseName. For
- * more information, see the Lightsail Dev Guide.
Describes an access key for an Amazon Lightsail bucket.
+ * + *Access keys grant full programmatic access to the specified bucket and its objects. You + * can have a maximum of two access keys per bucket. Use the CreateBucketAccessKey action to create an access key for a specific bucket. For + * more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the + * Amazon Lightsail Developer Guide.
+ * + *The secretAccessKey value is returned only in response to the
+ * CreateBucketAccessKey action. You can get a secret access key only when you
+ * first create an access key; you cannot get the secret access key later. If you lose the
+ * secret access key, you must create a new access key.
The ID of the access key.
+ */ + accessKeyId?: string; + + /** + *The secret access key used to sign requests.
+ * + *You should store the secret access key in a safe location. We recommend that you delete + * the access key if the secret access key is compromised.
+ */ + secretAccessKey?: string; + + /** + *The status of the access key.
+ * + *A status of Active means that the key is valid, while Inactive
+ * means it is not.
The timestamp when the access key was created.
+ */ + createdAt?: Date; +} + +export namespace AccessKey { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AccessKey): any => ({ + ...obj, + ...(obj.accessKeyId && { accessKeyId: SENSITIVE_STRING }), + }); +} + +/** + *Describes an Amazon Lightsail instance that has access to a Lightsail bucket.
+ */ +export interface ResourceReceivingAccess { + /** + *The name of the Lightsail instance.
+ */ + name?: string; + + /** + *The Lightsail resource type (for example, Instance).
Describes the anonymous access permissions for an Amazon Lightsail bucket and its + * objects.
+ *For more information about bucket access permissions, see Understanding bucket permissions in Amazon Lightsail in the
+ *+ * Amazon Lightsail Developer Guide.
+ */ +export interface AccessRules { + /** + *Specifies the anonymous access to all objects in a bucket.
+ * + *The following options can be specified:
+ * + *
+ * public - Sets all objects in the bucket to public (read-only), making
+ * them readable by anyone in the world.
If the getObject value is set to public, then all objects in
+ * the bucket default to public regardless of the allowPublicOverrides
+ * value.
+ * private - Sets all objects in the bucket to private, making them readable
+ * only by you or anyone you give access to.
If the getObject value is set to private, and the
+ * allowPublicOverrides value is set to true, then all objects in
+ * the bucket default to private unless they are configured with a public-read
+ * ACL. Individual objects with a public-read ACL are readable by anyone in the
+ * world.
A Boolean value that indicates whether the access control list (ACL) permissions that are
+ * applied to individual objects override the getObject option that is currently
+ * specified.
When this is true, you can use the PutObjectAcl Amazon S3 API action to set
+ * individual objects to public (read-only) using the public-read ACL, or to private
+ * using the private ACL.
Lightsail throws this exception when an account is still in the setup in progress * state.
@@ -211,6 +359,7 @@ export enum RegionName { AP_SOUTH_1 = "ap-south-1", CA_CENTRAL_1 = "ca-central-1", EU_CENTRAL_1 = "eu-central-1", + EU_NORTH_1 = "eu-north-1", EU_WEST_1 = "eu-west-1", EU_WEST_2 = "eu-west-2", EU_WEST_3 = "eu-west-3", @@ -274,6 +423,7 @@ export enum MetricName { export enum ResourceType { Alarm = "Alarm", + Bucket = "Bucket", Certificate = "Certificate", CloudFormationStackRecord = "CloudFormationStackRecord", ContactMethod = "ContactMethod", @@ -381,9 +531,8 @@ export enum MetricUnit { /** *Describes an alarm.
- *An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information, - * see Alarms - * in Amazon Lightsail.
+ *An alarm is a way to monitor your Lightsail resource metrics. For more information, see + * Alarms in Amazon Lightsail.
*/ export interface Alarm { /** @@ -594,6 +743,8 @@ export enum OperationType { AttachLoadBalancerTlsCertificate = "AttachLoadBalancerTlsCertificate", AttachStaticIp = "AttachStaticIp", CloseInstancePublicPorts = "CloseInstancePublicPorts", + CreateBucket = "CreateBucket", + CreateBucketAccessKey = "CreateBucketAccessKey", CreateCertificate = "CreateCertificate", CreateContactMethod = "CreateContactMethod", CreateContainerService = "CreateContainerService", @@ -613,6 +764,8 @@ export enum OperationType { CreateRelationalDatabaseFromSnapshot = "CreateRelationalDatabaseFromSnapshot", CreateRelationalDatabaseSnapshot = "CreateRelationalDatabaseSnapshot", DeleteAlarm = "DeleteAlarm", + DeleteBucket = "DeleteBucket", + DeleteBucketAccessKey = "DeleteBucketAccessKey", DeleteCertificate = "DeleteCertificate", DeleteContactMethod = "DeleteContactMethod", DeleteContainerImage = "DeleteContainerImage", @@ -647,11 +800,14 @@ export enum OperationType { ResetDistributionCache = "ResetDistributionCache", SendContactMethodVerification = "SendContactMethodVerification", SetIpAddressType = "SetIpAddressType", + SetResourceAccessForBucket = "SetResourceAccessForBucket", StartInstance = "StartInstance", StartRelationalDatabase = "StartRelationalDatabase", StopInstance = "StopInstance", StopRelationalDatabase = "StopRelationalDatabase", TestAlarm = "TestAlarm", + UpdateBucket = "UpdateBucket", + UpdateBucketBundle = "UpdateBucketBundle", UpdateContainerService = "UpdateContainerService", UpdateDistribution = "UpdateDistribution", UpdateDistributionBundle = "UpdateDistributionBundle", @@ -1305,155 +1461,401 @@ export namespace Blueprint { } /** - *Describes a bundle, which is a set of specs describing your virtual private server (or - * instance).
+ *Describes the state of an Amazon Lightsail bucket.
*/ -export interface Bundle { +export interface BucketState { /** - *The price in US dollars (e.g., 5.0) of the bundle.
The state code of the bucket.
+ * + *The following codes are possible:
+ * + *
+ * OK - The bucket is in a running state.
+ * Unknown - Creation of the bucket might have timed-out. You might want to
+ * delete the bucket and create a new one.
The number of vCPUs included in the bundle (e.g., 2).
A message that describes the state of the bucket.
*/ - cpuCount?: number; + message?: string; +} +export namespace BucketState { /** - *The size of the SSD (e.g., 30).
Describes a tag key and optional value assigned to an Amazon Lightsail resource.
+ *For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
+ */ +export interface Tag { /** - *The bundle ID (e.g., micro_1_0).
The key of the tag.
+ *Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the + * following characters: + - = . _ : / @
*/ - bundleId?: string; + key?: string; /** - *The Amazon EC2 instance type (e.g., t2.micro).
The value of the tag.
+ *Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the + * following characters: + - = . _ : / @
*/ - instanceType?: string; + value?: string; +} +export namespace Tag { /** - *A Boolean value indicating whether the bundle is active.
+ * @internal */ - isActive?: boolean; + export const filterSensitiveLog = (obj: Tag): any => ({ + ...obj, + }); +} +/** + *Describes an Amazon Lightsail bucket.
+ */ +export interface Bucket { /** - *A friendly name for the bundle (e.g., Micro).
The Lightsail resource type of the bucket (for example, Bucket).
A numeric value that represents the power of the bundle (e.g., 500). You can
- * use the bundle's power value in conjunction with a blueprint's minimum power value to
- * determine whether the blueprint will run on the bundle. For example, you need a bundle with a
- * power value of 500 or more to create an instance that uses a blueprint with a minimum power
- * value of 500.
An object that describes the access rules of the bucket.
*/ - power?: number; + accessRules?: AccessRules; /** - *The amount of RAM in GB (e.g., 2.0).
The Amazon Resource Name (ARN) of the bucket.
*/ - ramSizeInGb?: number; + arn?: string; /** - *The data transfer rate per month in GB (e.g., 2000).
The ID of the bundle currently applied to the bucket.
+ * + *A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a + * bucket.
+ * + *Use the UpdateBucketBundle action to change the bundle of a + * bucket.
*/ - transferPerMonthInGb?: number; + bundleId?: string; /** - *The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle
- * supports. You can only launch a WINDOWS bundle on a blueprint that supports the
- * WINDOWS platform. LINUX_UNIX blueprints require a
- * LINUX_UNIX bundle.
The timestamp when the distribution was created.
*/ - supportedPlatforms?: (InstancePlatform | string)[]; -} + createdAt?: Date; -export namespace Bundle { /** - * @internal + *The URL of the bucket.
*/ - export const filterSensitiveLog = (obj: Bundle): any => ({ - ...obj, - }); -} + url?: string; -/** - *Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) - * distribution.
- */ -export interface CacheBehavior { /** - *The cache behavior of the distribution.
- *The following cache behaviors can be specified:
+ *Describes the resource location.
+ */ + location?: ResourceLocation; + + /** + *The name of the bucket.
+ */ + name?: string; + + /** + *The support code for a bucket. Include this code in your email to support when you have + * questions about a Lightsail bucket. This code enables our support team to look up your + * Lightsail information more easily.
+ */ + supportCode?: string; + + /** + *The tag keys and optional values for the bucket. For more information, see Tags in + * Amazon Lightsail in the Amazon Lightsail Developer Guide.
+ */ + tags?: Tag[]; + + /** + *Indicates whether object versioning is enabled for the bucket.
+ * + *The following options can be configured:
*
- *
- * cache
- * - This option is best for static
- * sites. When specified, your distribution caches and serves your entire website as static
- * content. This behavior is ideal for websites with static content that doesn't change
- * depending on who views it, or for websites that don't use cookies, headers, or query
- * strings to personalize content.
Enabled - Object versioning is enabled.
*
- *
- * dont-cache
- * - This option is best for
- * sites that serve a mix of static and dynamic content. When specified, your distribution
- * caches and serve only the content that is specified in the distribution's
- * CacheBehaviorPerPath parameter. This behavior is ideal for websites or web
- * applications that use cookies, headers, and query strings to personalize content for
- * individual users.
Suspended - Object versioning was previously enabled but is currently
+ * suspended. Existing object versions are retained.
+ *
+ * NeverEnabled - Object versioning has never been enabled.
Indicates whether the bundle that is currently applied to a bucket can be changed to + * another bundle.
+ * + *You can update a bucket's bundle only one time within a monthly AWS billing + * cycle.
+ * + *Use the UpdateBucketBundle action to change a bucket's bundle.
+ */ + ableToUpdateBundle?: boolean; + + /** + *An array of strings that specify the AWS account IDs that have read-only access to the + * bucket.
+ */ + readonlyAccessAccounts?: string[]; + + /** + *An array of objects that describe Lightsail instances that have access to the + * bucket.
+ * + *Use the SetResourceAccessForBucket action to update the instances that + * have access to a bucket.
+ */ + resourcesReceivingAccess?: ResourceReceivingAccess[]; + + /** + *An object that describes the state of the bucket.
+ */ + state?: BucketState; } -export namespace CacheBehavior { +export namespace Bucket { /** * @internal */ - export const filterSensitiveLog = (obj: CacheBehavior): any => ({ + export const filterSensitiveLog = (obj: Bucket): any => ({ ...obj, }); } /** - *Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) - * distribution.
- *A per-path cache behavior is used to override, or add an exception to, the default cache
- * behavior of a distribution. For example, if the cacheBehavior is set to
- * cache, then a per-path cache behavior can be used to specify a directory, file,
- * or file type that your distribution will cache. Alternately, if the distribution's
- * cacheBehavior is dont-cache, then a per-path cache behavior can be
- * used to specify a directory, file, or file type that your distribution will not cache.
if the cacheBehavior's behavior is set to 'cache', then
+ *Describes the specifications of a bundle that can be applied to an Amazon Lightsail + * bucket.
+ * + *A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a + * bucket.
*/ -export interface CacheBehaviorPerPath { +export interface BucketBundle { /** - *The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify
- * wildcard directories (path/to/assets/*), and file types (*.html, *jpg,
- * *js). Directories and file paths are case-sensitive.
Examples:
- *Specify the following to cache all files in the document root of an Apache web server - * running on a Lightsail instance.
- *
- * var/www/html/
- *
Specify the following file to cache only the index page in the document root of an - * Apache web server.
- *+ *
The ID of the bundle.
+ */ + bundleId?: string; + + /** + *The name of the bundle.
+ */ + name?: string; + + /** + *The monthly price of the bundle, in US dollars.
+ */ + price?: number; + + /** + *The storage size of the bundle, in GB.
+ */ + storagePerMonthInGb?: number; + + /** + *The monthly network transfer quota of the bundle.
+ */ + transferPerMonthInGb?: number; + + /** + *Indicates whether the bundle is active. Use for a new or existing bucket.
+ */ + isActive?: boolean; +} + +export namespace BucketBundle { + /** + * @internal + */ + export const filterSensitiveLog = (obj: BucketBundle): any => ({ + ...obj, + }); +} + +export enum BucketMetricName { + BucketSizeBytes = "BucketSizeBytes", + NumberOfObjects = "NumberOfObjects", +} + +/** + *Describes a bundle, which is a set of specs describing your virtual private server (or + * instance).
+ */ +export interface Bundle { + /** + *The price in US dollars (e.g., 5.0) of the bundle.
The number of vCPUs included in the bundle (e.g., 2).
The size of the SSD (e.g., 30).
The bundle ID (e.g., micro_1_0).
The Amazon EC2 instance type (e.g., t2.micro).
A Boolean value indicating whether the bundle is active.
+ */ + isActive?: boolean; + + /** + *A friendly name for the bundle (e.g., Micro).
A numeric value that represents the power of the bundle (e.g., 500). You can
+ * use the bundle's power value in conjunction with a blueprint's minimum power value to
+ * determine whether the blueprint will run on the bundle. For example, you need a bundle with a
+ * power value of 500 or more to create an instance that uses a blueprint with a minimum power
+ * value of 500.
The amount of RAM in GB (e.g., 2.0).
The data transfer rate per month in GB (e.g., 2000).
The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle
+ * supports. You can only launch a WINDOWS bundle on a blueprint that supports the
+ * WINDOWS platform. LINUX_UNIX blueprints require a
+ * LINUX_UNIX bundle.
Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) + * distribution.
+ */ +export interface CacheBehavior { + /** + *The cache behavior of the distribution.
+ *The following cache behaviors can be specified:
+ *
+ *
+ * cache
+ * - This option is best for static
+ * sites. When specified, your distribution caches and serves your entire website as static
+ * content. This behavior is ideal for websites with static content that doesn't change
+ * depending on who views it, or for websites that don't use cookies, headers, or query
+ * strings to personalize content.
+ *
+ * dont-cache
+ * - This option is best for
+ * sites that serve a mix of static and dynamic content. When specified, your distribution
+ * caches and serve only the content that is specified in the distribution's
+ * CacheBehaviorPerPath parameter. This behavior is ideal for websites or web
+ * applications that use cookies, headers, and query strings to personalize content for
+ * individual users.
Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) + * distribution.
+ *A per-path cache behavior is used to override, or add an exception to, the default cache
+ * behavior of a distribution. For example, if the cacheBehavior is set to
+ * cache, then a per-path cache behavior can be used to specify a directory, file,
+ * or file type that your distribution will cache. Alternately, if the distribution's
+ * cacheBehavior is dont-cache, then a per-path cache behavior can be
+ * used to specify a directory, file, or file type that your distribution will not cache.
if the cacheBehavior's behavior is set to 'cache', then
+ */ +export interface CacheBehaviorPerPath { + /** + *The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify
+ * wildcard directories (path/to/assets/*), and file types (*.html, *jpg,
+ * *js). Directories and file paths are case-sensitive.
Examples:
+ *Specify the following to cache all files in the document root of an Apache web server + * running on a Lightsail instance.
+ *
+ * var/www/html/
+ *
Specify the following file to cache only the index page in the document root of an + * Apache web server.
+ *
* var/www/html/index.html
*
Describes a tag key and optional value assigned to an Amazon Lightsail resource.
- *For more information about tags in Lightsail, see the Lightsail - * Dev Guide.
- */ -export interface Tag { - /** - *The key of the tag.
- *Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the - * following characters: + - = . _ : / @
- */ - key?: string; - - /** - *The value of the tag.
- *Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the - * following characters: + - = . _ : / @
- */ - value?: string; -} - -export namespace Tag { - /** - * @internal - */ - export const filterSensitiveLog = (obj: Tag): any => ({ - ...obj, - }); -} - /** *Describes the full details of an Amazon Lightsail SSL/TLS certificate.
*The tag keys and optional values for the resource. For more information about tags in - * Lightsail, see the Lightsail - * Dev Guide.
+ * Lightsail, see the Amazon Lightsail Developer Guide. */ tags?: Tag[]; @@ -2169,8 +2540,7 @@ export interface CertificateSummary { /** *The tag keys and optional values for the resource. For more information about tags in - * Lightsail, see the Lightsail - * Dev Guide.
+ * Lightsail, see the Amazon Lightsail Developer Guide. */ tags?: Tag[]; } @@ -2439,7 +2809,7 @@ export enum RecordState { /** *Describes a CloudFormation stack record created as a result of the create cloud
- * formation stack operation.
A CloudFormation stack record provides information about the AWS CloudFormation stack used to * create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.
*/ @@ -2701,7 +3071,9 @@ export interface ContainerServiceHealthCheckConfig { /** *The HTTP codes to use when checking for a successful response from a container. You can - * specify values between 200 and 499.
+ * specify values between200 and 499. You can specify multiple values
+ * (for example, 200,202) or a range of values (for example,
+ * 200-299).
*/
successCodes?: string;
}
@@ -2973,8 +3345,7 @@ export interface ContainerService {
/**
* The tag keys and optional values for the resource. For more information about tags in - * Lightsail, see the Lightsail - * Dev Guide.
+ * Lightsail, see the Amazon Lightsail Developer Guide. */ tags?: Tag[]; @@ -3338,7 +3709,7 @@ export interface CopySnapshotRequest { *Define this parameter only when copying an automatic snapshot as a manual snapshot. - * For more information, see the Lightsail Dev Guide.
+ * For more information, see the Amazon Lightsail Developer Guide. *Define this parameter only when copying an automatic snapshot as a manual snapshot. - * For more information, see the Lightsail Dev Guide.
+ * For more information, see the Amazon Lightsail Developer Guide. *Define this parameter only when copying an automatic snapshot as a manual snapshot. - * For more information, see the Lightsail Dev Guide.
+ * For more information, see the Amazon Lightsail Developer Guide. *The name for the certificate.
+ *The name for the bucket.
+ * + *For more information about bucket names, see Bucket naming rules in Amazon Lightsail in the Amazon Lightsail Developer + * Guide.
*/ - certificateName: string | undefined; + bucketName: string | undefined; /** - *The domain name (e.g., example.com) for the certificate.
The ID of the bundle to use for the bucket.
+ * + *A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a + * bucket.
+ * + *Use the GetBucketBundles action to get a list of bundle IDs that you can + * specify.
+ * + *Use the UpdateBucketBundle action to change the bundle after the bucket + * is created.
*/ - domainName: string | undefined; + bundleId: string | undefined; /** - *An array of strings that specify the alternate domains (e.g., example2.com)
- * and subdomains (e.g., blog.example.com) for the certificate.
You can specify a maximum of nine alternate domains (in addition to the primary domain - * name).
- *Wildcard domain entries (e.g., *.example.com) are not supported.
The tag keys and optional values to add to the bucket during creation.
+ * + *Use the TagResource action to tag the bucket after it's created.
*/ - subjectAlternativeNames?: string[]; + tags?: Tag[]; /** - *The tag keys and optional values to add to the certificate during create.
- *Use the TagResource action to tag a resource after it's created.
A Boolean value that indicates whether to enable versioning of objects in the + * bucket.
+ * + *For more information about versioning, see Enabling and suspending bucket object versioning in Amazon Lightsail in the + * Amazon Lightsail Developer Guide.
*/ - tags?: Tag[]; + enableObjectVersioning?: boolean; } -export namespace CreateCertificateRequest { +export namespace CreateBucketRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateCertificateRequest): any => ({ + export const filterSensitiveLog = (obj: CreateBucketRequest): any => ({ ...obj, }); } -export interface CreateCertificateResult { +export interface CreateBucketResult { /** - *An object that describes the certificate created.
+ *An object that describes the bucket that is created.
*/ - certificate?: CertificateSummary; + bucket?: Bucket; /** *An array of objects that describe the result of the action, such as the status of the @@ -3469,30 +3853,127 @@ export interface CreateCertificateResult { operations?: Operation[]; } -export namespace CreateCertificateResult { +export namespace CreateBucketResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateCertificateResult): any => ({ + export const filterSensitiveLog = (obj: CreateBucketResult): any => ({ ...obj, }); } -export enum PortInfoSourceType { - Closed = "CLOSED", - Default = "DEFAULT", - Instance = "INSTANCE", - None = "NONE", +export interface CreateBucketAccessKeyRequest { + /** + *
The name of the bucket that the new access key will belong to, and grant access to.
+ */ + bucketName: string | undefined; } -/** - *Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the
- * create cloud formation stack operation.
The name of the export snapshot record, which contains the exported Lightsail instance - * snapshot that will be used as the source of the new Amazon EC2 instance.
+ * @internal + */ + export const filterSensitiveLog = (obj: CreateBucketAccessKeyRequest): any => ({ + ...obj, + }); +} + +export interface CreateBucketAccessKeyResult { + /** + *An object that describes the access key that is created.
+ */ + accessKey?: AccessKey; + + /** + *An array of objects that describe the result of the action, such as the status of the + * request, the timestamp of the request, and the resources affected by the request.
+ */ + operations?: Operation[]; +} + +export namespace CreateBucketAccessKeyResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateBucketAccessKeyResult): any => ({ + ...obj, + ...(obj.accessKey && { accessKey: AccessKey.filterSensitiveLog(obj.accessKey) }), + }); +} + +export interface CreateCertificateRequest { + /** + *The name for the certificate.
+ */ + certificateName: string | undefined; + + /** + *The domain name (e.g., example.com) for the certificate.
An array of strings that specify the alternate domains (e.g., example2.com)
+ * and subdomains (e.g., blog.example.com) for the certificate.
You can specify a maximum of nine alternate domains (in addition to the primary domain + * name).
+ *Wildcard domain entries (e.g., *.example.com) are not supported.
The tag keys and optional values to add to the certificate during create.
+ *Use the TagResource action to tag a resource after it's created.
An object that describes the certificate created.
+ */ + certificate?: CertificateSummary; + + /** + *An array of objects that describe the result of the action, such as the status of the + * request, the timestamp of the request, and the resources affected by the request.
+ */ + operations?: Operation[]; +} + +export namespace CreateCertificateResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateCertificateResult): any => ({ + ...obj, + }); +} + +export enum PortInfoSourceType { + Closed = "CLOSED", + Default = "DEFAULT", + Instance = "INSTANCE", + None = "NONE", +} + +/** + *Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the
+ * create cloud formation stack operation.
The name of the export snapshot record, which contains the exported Lightsail instance + * snapshot that will be used as the source of the new Amazon EC2 instance.
*Use the get export snapshot records operation to get a list of export
* snapshot records that you can use to create a CloudFormation stack.
The tag keys and optional values for the container service.
- * - *For more information about tags in Lightsail, see the Lightsail - * Dev Guide.
+ *The tag keys and optional values to add to the certificate during create.
+ *Use the TagResource action to tag a resource after it's created.
For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.
*/ tags?: Tag[]; @@ -3985,7 +4465,7 @@ export interface CreateDiskFromSnapshotRequest { * *Define this parameter only when creating a new disk from an automatic snapshot. For - * more information, see the Lightsail Dev Guide.
+ * more information, see the Amazon Lightsail Developer Guide. *Define this parameter only when creating a new disk from an automatic snapshot. For - * more information, see the Lightsail Dev Guide.
+ * more information, see the Amazon Lightsail Developer Guide. *Define this parameter only when creating a new disk from an automatic snapshot. For - * more information, see the Lightsail Dev Guide.
+ * more information, see the Amazon Lightsail Developer Guide. *The tag keys and optional values for the resource. For more information about tags in - * Lightsail, see the Lightsail - * Dev Guide.
+ * Lightsail, see the Amazon Lightsail Developer Guide. */ tags?: Tag[]; } @@ -4663,7 +5142,7 @@ export interface CreateInstancesRequest { *Depending on the machine image you choose, the command to get software on your instance
* varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use
* apt-get, and FreeBSD uses pkg. For a complete list, see the
- * Dev Guide.
Depending on the machine image you choose, the command to get software on your instance
* varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use
* apt-get, and FreeBSD uses pkg. For a complete list, see the
- * Dev Guide.
Define this parameter only when creating a new instance from an automatic snapshot. - * For more information, see the Lightsail Dev Guide.
+ * For more information, see the Amazon Lightsail Developer Guide. *Define this parameter only when creating a new instance from an automatic snapshot. - * For more information, see the Lightsail Dev Guide.
+ * For more information, see the Amazon Lightsail Developer Guide. *Define this parameter only when creating a new instance from an automatic snapshot. - * For more information, see the Lightsail Dev Guide.
+ * For more information, see the Amazon Lightsail Developer Guide. *Describes the SSH key pair.
+ *Describes an SSH key pair.
*/ export interface KeyPair { /** @@ -4989,8 +5468,7 @@ export interface KeyPair { /** *The tag keys and optional values for the resource. For more information about tags in - * Lightsail, see the Lightsail - * Dev Guide.
+ * Lightsail, see the Amazon Lightsail Developer Guide. */ tags?: Tag[]; @@ -5678,6 +6156,109 @@ export namespace DeleteAutoSnapshotResult { }); } +export interface DeleteBucketRequest { + /** + *The name of the bucket to delete.
+ * + *Use the GetBuckets action to get a list of bucket names that you can + * specify.
+ */ + bucketName: string | undefined; + + /** + *A Boolean value that indicates whether to force delete the bucket.
+ * + *You must force delete the bucket if it has one of the following conditions:
+ *The bucket is the origin of a distribution.
+ *The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.
+ *The bucket has objects.
+ *The bucket has access keys.
+ *Force deleting a bucket might impact other resources that rely on the bucket, such as + * instances, distributions, or software that use the issued access keys.
+ *An array of objects that describe the result of the action, such as the status of the + * request, the timestamp of the request, and the resources affected by the request.
+ */ + operations?: Operation[]; +} + +export namespace DeleteBucketResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteBucketResult): any => ({ + ...obj, + }); +} + +export interface DeleteBucketAccessKeyRequest { + /** + *The name of the bucket that the access key belongs to.
+ */ + bucketName: string | undefined; + + /** + *The ID of the access key to delete.
+ * + *Use the GetBucketAccessKeys action to get a list of access key IDs that + * you can specify.
+ */ + accessKeyId: string | undefined; +} + +export namespace DeleteBucketAccessKeyRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteBucketAccessKeyRequest): any => ({ + ...obj, + }); +} + +export interface DeleteBucketAccessKeyResult { + /** + *An array of objects that describe the result of the action, such as the status of the + * request, the timestamp of the request, and the resources affected by the request.
+ */ + operations?: Operation[]; +} + +export namespace DeleteBucketAccessKeyResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteBucketAccessKeyResult): any => ({ + ...obj, + }); +} + export interface DeleteCertificateRequest { /** *The name of the certificate to delete.
@@ -6500,7 +7081,7 @@ export enum DiskState { } /** - *Describes a system disk or a block storage disk.
+ *Describes a block storage disk.
*/ export interface Disk { /** @@ -6537,8 +7118,7 @@ export interface Disk { /** *The tag keys and optional values for the resource. For more information about tags in - * Lightsail, see the Lightsail - * Dev Guide.
+ * Lightsail, see the Amazon Lightsail Developer Guide. */ tags?: Tag[]; @@ -6696,8 +7276,7 @@ export interface DiskSnapshot { /** *The tag keys and optional values for the resource. For more information about tags in - * Lightsail, see the Lightsail - * Dev Guide.
+ * Lightsail, see the Amazon Lightsail Developer Guide. */ tags?: Tag[]; @@ -6799,7 +7378,7 @@ export interface DistributionBundle { transferPerMonthInGb?: number; /** - *Indicates whether the bundle is active, and can be specified for a new + *
Indicates whether the bundle is active, and can be specified for a new or existing * distribution.
*/ isActive?: boolean; @@ -6824,7 +7403,7 @@ export enum DistributionMetricName { } /** - *Describes a domain where you are storing recordsets in Lightsail.
+ *Describes a domain where you are storing recordsets.
*/ export interface Domain { /** @@ -6862,8 +7441,7 @@ export interface Domain { /** *The tag keys and optional values for the resource. For more information about tags in - * Lightsail, see the Lightsail - * Dev Guide.
+ * Lightsail, see the Amazon Lightsail Developer Guide. */ tags?: Tag[]; @@ -7321,2144 +7899,1555 @@ export namespace GetBlueprintsResult { }); } -export interface GetBundlesRequest { - /** - *A Boolean value that indicates whether to include inactive bundle results in your - * request.
- */ - includeInactive?: boolean; - +export interface GetBucketAccessKeysRequest { /** - *The token to advance to the next page of results from your request.
- *To get a page token, perform an initial GetBundles request. If your results
- * are paginated, the response will return a next page token that you can specify as the page
- * token in a subsequent request.
The name of the bucket for which to return access keys.
*/ - pageToken?: string; + bucketName: string | undefined; } -export namespace GetBundlesRequest { +export namespace GetBucketAccessKeysRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetBundlesRequest): any => ({ + export const filterSensitiveLog = (obj: GetBucketAccessKeysRequest): any => ({ ...obj, }); } -export interface GetBundlesResult { - /** - *An array of key-value pairs that contains information about the available bundles.
- */ - bundles?: Bundle[]; - +export interface GetBucketAccessKeysResult { /** - *The token to advance to the next page of results from your request.
- *A next page token is not returned if there are no more results to display.
- *To get the next page of results, perform another GetBundles request and
- * specify the next page token using the pageToken parameter.
An object that describes the access keys for the specified bucket.
*/ - nextPageToken?: string; + accessKeys?: AccessKey[]; } -export namespace GetBundlesResult { +export namespace GetBucketAccessKeysResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetBundlesResult): any => ({ + export const filterSensitiveLog = (obj: GetBucketAccessKeysResult): any => ({ ...obj, + ...(obj.accessKeys && { accessKeys: obj.accessKeys.map((item) => AccessKey.filterSensitiveLog(item)) }), }); } -export interface GetCertificatesRequest { - /** - *The status of the certificates for which to return information.
- *For example, specify ISSUED to return only certificates with an
- * ISSUED status.
When omitted, the response includes all of your certificates in the AWS Region where the - * request is made, regardless of their current status.
- */ - certificateStatuses?: (CertificateStatus | string)[]; - +export interface GetBucketBundlesRequest { /** - *Indicates whether to include detailed information about the certificates in the + *
A Boolean value that indicates whether to include inactive (unavailable) bundles in the * response.
- *When omitted, the response includes only the certificate names, Amazon Resource Names - * (ARNs), domain names, and tags.
- */ - includeCertificateDetails?: boolean; - - /** - *The name for the certificate for which to return information.
- *When omitted, the response includes all of your certificates in the AWS Region where the - * request is made.
*/ - certificateName?: string; + includeInactive?: boolean; } -export namespace GetCertificatesRequest { +export namespace GetBucketBundlesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetCertificatesRequest): any => ({ + export const filterSensitiveLog = (obj: GetBucketBundlesRequest): any => ({ ...obj, }); } -export interface GetCertificatesResult { +export interface GetBucketBundlesResult { /** - *An object that describes certificates.
+ *An object that describes bucket bundles.
*/ - certificates?: CertificateSummary[]; + bundles?: BucketBundle[]; } -export namespace GetCertificatesResult { +export namespace GetBucketBundlesResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetCertificatesResult): any => ({ + export const filterSensitiveLog = (obj: GetBucketBundlesResult): any => ({ ...obj, }); } -export interface GetCloudFormationStackRecordsRequest { +export interface GetBucketMetricDataRequest { /** - *The token to advance to the next page of results from your request.
- *To get a page token, perform an initial GetClouFormationStackRecords request.
- * If your results are paginated, the response will return a next page token that you can specify
- * as the page token in a subsequent request.
The name of the bucket for which to get metric data.
*/ - pageToken?: string; -} + bucketName: string | undefined; -export namespace GetCloudFormationStackRecordsRequest { /** - * @internal + *The metric for which you want to return information.
+ * + *Valid bucket metric names are listed below, along with the most useful statistics to + * include in your request, and the published unit value.
+ * + *These bucket metrics are reported once per day.
+ *
+ *
+ * BucketSizeBytes
+ * - The amount of data in
+ * bytes stored in a bucket. This value is calculated by summing the size of all objects in
+ * the bucket (including object versions), including the size of all parts for all incomplete
+ * multipart uploads to the bucket.
Statistics: The most useful statistic is Maximum.
Unit: The published unit is Bytes.
+ *
+ * NumberOfObjects
+ * - The total number of
+ * objects stored in a bucket. This value is calculated by counting all objects in the bucket
+ * (including object versions) and the total number of parts for all incomplete multipart
+ * uploads to the bucket.
Statistics: The most useful statistic is Average.
Unit: The published unit is Count.
A list of objects describing the CloudFormation stack records.
- */ - cloudFormationStackRecords?: CloudFormationStackRecord[]; + metricName: BucketMetricName | string | undefined; /** - *The token to advance to the next page of results from your request.
- *A next page token is not returned if there are no more results to display.
- *To get the next page of results, perform another
- * GetCloudFormationStackRecords request and specify the next page token using the
- * pageToken parameter.
The timestamp indicating the earliest data to be returned.
*/ - nextPageToken?: string; -} + startTime: Date | undefined; -export namespace GetCloudFormationStackRecordsResult { /** - * @internal + *The timestamp indicating the latest data to be returned.
*/ - export const filterSensitiveLog = (obj: GetCloudFormationStackRecordsResult): any => ({ - ...obj, - }); -} + endTime: Date | undefined; -export interface GetContactMethodsRequest { /** - *The protocols used to send notifications, such as Email, or SMS
- * (text messaging).
Specify a protocol in your request to return information about a specific contact method - * protocol.
+ *The granularity, in seconds, of the returned data points.
+ *Bucket storage metrics are reported once per day. Therefore, you should specify a period + * of 86400 seconds, which is the number of seconds in a day.
+ *The statistic for the metric.
+ * + *The following statistics are available:
+ * + *
+ * Minimum - The lowest value observed during the specified period. Use this
+ * value to determine low volumes of activity for your application.
+ * Maximum - The highest value observed during the specified period. Use
+ * this value to determine high volumes of activity for your application.
+ * Sum - The sum of all values submitted for the matching metric. You can
+ * use this statistic to determine the total volume of a metric.
+ * Average - The value of Sum / SampleCount during
+ * the specified period. By comparing this statistic with the Minimum and
+ * Maximum values, you can determine the full scope of a metric and how close
+ * the average use is to the Minimum and Maximum values. This
+ * comparison helps you to know when to increase or decrease your resources.
+ * SampleCount - The count, or number, of data points used for the
+ * statistical calculation.
An array of objects that describe the contact methods.
+ *The unit for the metric data request.
+ *Valid units depend on the metric data being requested. For the valid units with each
+ * available metric, see the metricName parameter.
Describes the metric data point.
+ */ +export interface MetricDatapoint { + /** + *The average.
+ */ + average?: number; -export namespace GetContainerAPIMetadataRequest { /** - * @internal + *The maximum.
*/ - export const filterSensitiveLog = (obj: GetContainerAPIMetadataRequest): any => ({ - ...obj, - }); -} + maximum?: number; -export interface GetContainerAPIMetadataResult { /** - *Metadata about Lightsail containers, such as the current version of the Lightsail - * Control (lightsailctl) plugin.
+ *The minimum.
*/ - metadata?: { [key: string]: string }[]; -} + minimum?: number; -export namespace GetContainerAPIMetadataResult { /** - * @internal + *The sample count.
*/ - export const filterSensitiveLog = (obj: GetContainerAPIMetadataResult): any => ({ - ...obj, - }); -} + sampleCount?: number; -export interface GetContainerImagesRequest { /** - *The name of the container service for which to return registered container images.
+ *The sum.
*/ - serviceName: string | undefined; -} + sum?: number; -export namespace GetContainerImagesRequest { /** - * @internal + *The timestamp (e.g., 1479816991.349).
An array of objects that describe container images that are registered to the container - * service.
+ *The unit.
*/ - containerImages?: ContainerImage[]; + unit?: MetricUnit | string; } -export namespace GetContainerImagesResult { +export namespace MetricDatapoint { /** * @internal */ - export const filterSensitiveLog = (obj: GetContainerImagesResult): any => ({ + export const filterSensitiveLog = (obj: MetricDatapoint): any => ({ ...obj, }); } -export interface GetContainerLogRequest { +export interface GetBucketMetricDataResult { /** - *The name of the container service for which to get a container log.
+ *The name of the metric returned.
*/ - serviceName: string | undefined; + metricName?: BucketMetricName | string; /** - *The name of the container that is either running or previously ran on the container - * service for which to return a log.
+ *An array of objects that describe the metric data returned.
*/ - containerName: string | undefined; + metricData?: MetricDatapoint[]; +} +export namespace GetBucketMetricDataResult { /** - *The start of the time interval for which to get log data.
- * - *Constraints:
- * - *Specified in Coordinated Universal Time (UTC).
- *Specified in the Unix time format.
- * - *For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify
- * 1538424000 as the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
+ * @internal */ - startTime?: Date; + export const filterSensitiveLog = (obj: GetBucketMetricDataResult): any => ({ + ...obj, + }); +} +export interface GetBucketsRequest { /** - *The end of the time interval for which to get log data.
- * - *Constraints:
- * - *Specified in Coordinated Universal Time (UTC).
- *Specified in the Unix time format.
- * - *For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify
- * 1538427600 as the end time.
The name of the bucket for which to return information.
* - *You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
+ *When omitted, the response includes all of your buckets in the AWS Region where the + * request is made.
*/ - endTime?: Date; + bucketName?: string; /** - *The pattern to use to filter the returned log events to a specific term.
+ *The token to advance to the next page of results from your request.
* - *The following are a few examples of filter patterns that you can specify:
- *To return all log events, specify a filter pattern of "".
To exclude log events that contain the ERROR term, and return all other
- * log events, specify a filter pattern of "-ERROR".
To return log events that contain the ERROR term, specify a filter
- * pattern of "ERROR".
To return log events that contain both the ERROR and
- * Exception terms, specify a filter pattern of "ERROR
- * Exception".
To return log events that contain the ERROR
- * or the Exception term, specify a filter pattern of
- * "?ERROR ?Exception".
To get a page token, perform an initial GetBuckets request. If your results
+ * are paginated, the response will return a next page token that you can specify as the page
+ * token in a subsequent request.
The token to advance to the next page of results from your request.
- * - *To get a page token, perform an initial GetContainerLog request. If your
- * results are paginated, the response will return a next page token that you can specify as the
- * page token in a subsequent request.
A Boolean value that indicates whether to include Lightsail instances that were given + * access to the bucket using the SetResourceAccessForBucket action.
*/ - pageToken?: string; + includeConnectedResources?: boolean; } -export namespace GetContainerLogRequest { +export namespace GetBucketsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetContainerLogRequest): any => ({ + export const filterSensitiveLog = (obj: GetBucketsRequest): any => ({ ...obj, }); } -export interface GetContainerLogResult { +export interface GetBucketsResult { /** - *An array of objects that describe the log events of a container.
+ *An array of objects that describe buckets.
*/ - logEvents?: ContainerServiceLogEvent[]; + buckets?: Bucket[]; /** *The token to advance to the next page of results from your request.
* *A next page token is not returned if there are no more results to display.
* - *To get the next page of results, perform another GetContainerLog request and
+ *
To get the next page of results, perform another GetBuckets request and
* specify the next page token using the pageToken parameter.
The name of the container service for which to return deployments.
+ *A Boolean value that indicates whether to include inactive bundle results in your + * request.
*/ - serviceName: string | undefined; + includeInactive?: boolean; + + /** + *The token to advance to the next page of results from your request.
+ *To get a page token, perform an initial GetBundles request. If your results
+ * are paginated, the response will return a next page token that you can specify as the page
+ * token in a subsequent request.
An array of objects that describe deployments for a container service.
+ *An array of key-value pairs that contains information about the available bundles.
*/ - deployments?: ContainerServiceDeployment[]; -} + bundles?: Bundle[]; -export namespace GetContainerServiceDeploymentsResult { /** - * @internal + *The token to advance to the next page of results from your request.
+ *A next page token is not returned if there are no more results to display.
+ *To get the next page of results, perform another GetBundles request and
+ * specify the next page token using the pageToken parameter.
The name of the container service for which to get metric data.
+ * @internal */ - serviceName: string | undefined; + export const filterSensitiveLog = (obj: GetBundlesResult): any => ({ + ...obj, + }); +} +export interface GetCertificatesRequest { /** - *The metric for which you want to return information.
- * - *Valid container service metric names are listed below, along with the most useful - * statistics to include in your request, and the published unit value.
- * - *
- * CPUUtilization - The average percentage of compute units that are
- * currently in use across all nodes of the container service. This metric identifies the
- * processing power required to run containers on each node of the container service.
Statistics: The most useful statistics are Maximum and
- * Average.
Unit: The published unit is Percent.
- * MemoryUtilization - The average percentage of available memory that is
- * currently in use across all nodes of the container service. This metric identifies the
- * memory required to run containers on each node of the container service.
Statistics: The most useful statistics are Maximum and
- * Average.
Unit: The published unit is Percent.
The status of the certificates for which to return information.
+ *For example, specify ISSUED to return only certificates with an
+ * ISSUED status.
When omitted, the response includes all of your certificates in the AWS Region where the + * request is made, regardless of their current status.
*/ - metricName: ContainerServiceMetricName | string | undefined; + certificateStatuses?: (CertificateStatus | string)[]; /** - *The start time of the time period.
+ *Indicates whether to include detailed information about the certificates in the + * response.
+ *When omitted, the response includes only the certificate names, Amazon Resource Names + * (ARNs), domain names, and tags.
*/ - startTime: Date | undefined; + includeCertificateDetails?: boolean; /** - *The end time of the time period.
+ *The name for the certificate for which to return information.
+ *When omitted, the response includes all of your certificates in the AWS Region where the + * request is made.
*/ - endTime: Date | undefined; + certificateName?: string; +} +export namespace GetCertificatesRequest { /** - *The granularity, in seconds, of the returned data points.
- * - *All container service metric data is available in 5-minute (300 seconds) - * granularity.
+ * @internal */ - period: number | undefined; + export const filterSensitiveLog = (obj: GetCertificatesRequest): any => ({ + ...obj, + }); +} +export interface GetCertificatesResult { /** - *The statistic for the metric.
- * - *The following statistics are available:
- * - *
- * Minimum - The lowest value observed during the specified period. Use this
- * value to determine low volumes of activity for your application.
- * Maximum - The highest value observed during the specified period. Use
- * this value to determine high volumes of activity for your application.
- * Sum - All values submitted for the matching metric added together. You
- * can use this statistic to determine the total volume of a metric.
- * Average - The value of Sum / SampleCount during
- * the specified period. By comparing this statistic with the Minimum and
- * Maximum values, you can determine the full scope of a metric and how close
- * the average use is to the Minimum and Maximum values. This
- * comparison helps you to know when to increase or decrease your resources.
- * SampleCount - The count, or number, of data points used for the
- * statistical calculation.
An object that describes certificates.
*/ - statistics: (MetricStatistic | string)[] | undefined; + certificates?: CertificateSummary[]; } -export namespace GetContainerServiceMetricDataRequest { +export namespace GetCertificatesResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetContainerServiceMetricDataRequest): any => ({ + export const filterSensitiveLog = (obj: GetCertificatesResult): any => ({ ...obj, }); } -/** - *Describes the metric data point.
- */ -export interface MetricDatapoint { - /** - *The average.
- */ - average?: number; - +export interface GetCloudFormationStackRecordsRequest { /** - *The maximum.
+ *The token to advance to the next page of results from your request.
+ *To get a page token, perform an initial GetClouFormationStackRecords request.
+ * If your results are paginated, the response will return a next page token that you can specify
+ * as the page token in a subsequent request.
The minimum.
+ * @internal */ - minimum?: number; + export const filterSensitiveLog = (obj: GetCloudFormationStackRecordsRequest): any => ({ + ...obj, + }); +} +export interface GetCloudFormationStackRecordsResult { /** - *The sample count.
+ *A list of objects describing the CloudFormation stack records.
*/ - sampleCount?: number; + cloudFormationStackRecords?: CloudFormationStackRecord[]; /** - *The sum.
+ *The token to advance to the next page of results from your request.
+ *A next page token is not returned if there are no more results to display.
+ *To get the next page of results, perform another
+ * GetCloudFormationStackRecords request and specify the next page token using the
+ * pageToken parameter.
The timestamp (e.g., 1479816991.349).
The unit.
+ *The protocols used to send notifications, such as Email, or SMS
+ * (text messaging).
Specify a protocol in your request to return information about a specific contact method + * protocol.
*/ - unit?: MetricUnit | string; + protocols?: (ContactProtocol | string)[]; } -export namespace MetricDatapoint { +export namespace GetContactMethodsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: MetricDatapoint): any => ({ + export const filterSensitiveLog = (obj: GetContactMethodsRequest): any => ({ ...obj, }); } -export interface GetContainerServiceMetricDataResult { - /** - *The name of the metric returned.
- */ - metricName?: ContainerServiceMetricName | string; - +export interface GetContactMethodsResult { /** - *An array of objects that describe the metric data returned.
+ *An array of objects that describe the contact methods.
*/ - metricData?: MetricDatapoint[]; + contactMethods?: ContactMethod[]; } -export namespace GetContainerServiceMetricDataResult { +export namespace GetContactMethodsResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetContainerServiceMetricDataResult): any => ({ + export const filterSensitiveLog = (obj: GetContactMethodsResult): any => ({ ...obj, }); } -export interface GetContainerServicePowersRequest {} +export interface GetContainerAPIMetadataRequest {} -export namespace GetContainerServicePowersRequest { +export namespace GetContainerAPIMetadataRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetContainerServicePowersRequest): any => ({ + export const filterSensitiveLog = (obj: GetContainerAPIMetadataRequest): any => ({ ...obj, }); } -export interface GetContainerServicePowersResult { +export interface GetContainerAPIMetadataResult { /** - *An array of objects that describe the powers that can be specified for a container - * service.
+ *Metadata about Lightsail containers, such as the current version of the Lightsail + * Control (lightsailctl) plugin.
*/ - powers?: ContainerServicePower[]; + metadata?: { [key: string]: string }[]; } -export namespace GetContainerServicePowersResult { +export namespace GetContainerAPIMetadataResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetContainerServicePowersResult): any => ({ + export const filterSensitiveLog = (obj: GetContainerAPIMetadataResult): any => ({ ...obj, }); } -export interface GetContainerServicesRequest { +export interface GetContainerImagesRequest { /** - *The name of the container service for which to return information.
- * - *When omitted, the response includes all of your container services in the AWS Region - * where the request is made.
+ *The name of the container service for which to return registered container images.
*/ - serviceName?: string; + serviceName: string | undefined; } -export namespace GetContainerServicesRequest { +export namespace GetContainerImagesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetContainerServicesRequest): any => ({ + export const filterSensitiveLog = (obj: GetContainerImagesRequest): any => ({ ...obj, }); } -export interface GetDiskRequest { +export interface GetContainerImagesResult { /** - *The name of the disk (e.g., my-disk).
An array of objects that describe container images that are registered to the container + * service.
*/ - diskName: string | undefined; + containerImages?: ContainerImage[]; } -export namespace GetDiskRequest { +export namespace GetContainerImagesResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetDiskRequest): any => ({ + export const filterSensitiveLog = (obj: GetContainerImagesResult): any => ({ ...obj, }); } -export interface GetDiskResult { +export interface GetContainerLogRequest { /** - *An object containing information about the disk.
+ *The name of the container service for which to get a container log.
*/ - disk?: Disk; -} + serviceName: string | undefined; -export namespace GetDiskResult { /** - * @internal + *The name of the container that is either running or previously ran on the container + * service for which to return a log.
*/ - export const filterSensitiveLog = (obj: GetDiskResult): any => ({ - ...obj, - }); -} + containerName: string | undefined; -export interface GetDisksRequest { /** - *The token to advance to the next page of results from your request.
- *To get a page token, perform an initial GetDisks request. If your results are
- * paginated, the response will return a next page token that you can specify as the page token
- * in a subsequent request.
The start of the time interval for which to get log data.
+ * + *Constraints:
+ * + *Specified in Coordinated Universal Time (UTC).
+ *Specified in the Unix time format.
+ * + *For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify
+ * 1538424000 as the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
+ */ + startTime?: Date; + + /** + *The end of the time interval for which to get log data.
+ * + *Constraints:
+ * + *Specified in Coordinated Universal Time (UTC).
+ *Specified in the Unix time format.
+ * + *For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify
+ * 1538427600 as the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
+ */ + endTime?: Date; + + /** + *The pattern to use to filter the returned log events to a specific term.
+ * + *The following are a few examples of filter patterns that you can specify:
+ *To return all log events, specify a filter pattern of "".
To exclude log events that contain the ERROR term, and return all other
+ * log events, specify a filter pattern of "-ERROR".
To return log events that contain the ERROR term, specify a filter
+ * pattern of "ERROR".
To return log events that contain both the ERROR and
+ * Exception terms, specify a filter pattern of "ERROR
+ * Exception".
To return log events that contain the ERROR
+ * or the Exception term, specify a filter pattern of
+ * "?ERROR ?Exception".
The token to advance to the next page of results from your request.
+ * + *To get a page token, perform an initial GetContainerLog request. If your
+ * results are paginated, the response will return a next page token that you can specify as the
+ * page token in a subsequent request.
An array of objects containing information about all block storage disks.
+ *An array of objects that describe the log events of a container.
*/ - disks?: Disk[]; + logEvents?: ContainerServiceLogEvent[]; /** *The token to advance to the next page of results from your request.
+ * *A next page token is not returned if there are no more results to display.
- *To get the next page of results, perform another GetDisks request and specify
- * the next page token using the pageToken parameter.
To get the next page of results, perform another GetContainerLog request and
+ * specify the next page token using the pageToken parameter.
The name of the disk snapshot (e.g., my-disk-snapshot).
The name of the container service for which to return deployments.
*/ - diskSnapshotName: string | undefined; + serviceName: string | undefined; } -export namespace GetDiskSnapshotRequest { +export namespace GetContainerServiceDeploymentsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetDiskSnapshotRequest): any => ({ + export const filterSensitiveLog = (obj: GetContainerServiceDeploymentsRequest): any => ({ ...obj, }); } -export interface GetDiskSnapshotResult { +export interface GetContainerServiceDeploymentsResult { /** - *An object containing information about the disk snapshot.
+ *An array of objects that describe deployments for a container service.
*/ - diskSnapshot?: DiskSnapshot; + deployments?: ContainerServiceDeployment[]; } -export namespace GetDiskSnapshotResult { +export namespace GetContainerServiceDeploymentsResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetDiskSnapshotResult): any => ({ + export const filterSensitiveLog = (obj: GetContainerServiceDeploymentsResult): any => ({ ...obj, }); } -export interface GetDiskSnapshotsRequest { +export interface GetContainerServiceMetricDataRequest { /** - *The token to advance to the next page of results from your request.
- *To get a page token, perform an initial GetDiskSnapshots request. If your
- * results are paginated, the response will return a next page token that you can specify as the
- * page token in a subsequent request.
The name of the container service for which to get metric data.
*/ - pageToken?: string; + serviceName: string | undefined; + + /** + *The metric for which you want to return information.
+ * + *Valid container service metric names are listed below, along with the most useful + * statistics to include in your request, and the published unit value.
+ * + *
+ * CPUUtilization - The average percentage of compute units that are
+ * currently in use across all nodes of the container service. This metric identifies the
+ * processing power required to run containers on each node of the container service.
Statistics: The most useful statistics are Maximum and
+ * Average.
Unit: The published unit is Percent.
+ * MemoryUtilization - The average percentage of available memory that is
+ * currently in use across all nodes of the container service. This metric identifies the
+ * memory required to run containers on each node of the container service.
Statistics: The most useful statistics are Maximum and
+ * Average.
Unit: The published unit is Percent.
The start time of the time period.
+ */ + startTime: Date | undefined; + + /** + *The end time of the time period.
+ */ + endTime: Date | undefined; + + /** + *The granularity, in seconds, of the returned data points.
+ * + *All container service metric data is available in 5-minute (300 seconds) + * granularity.
+ */ + period: number | undefined; + + /** + *The statistic for the metric.
+ * + *The following statistics are available:
+ * + *
+ * Minimum - The lowest value observed during the specified period. Use this
+ * value to determine low volumes of activity for your application.
+ * Maximum - The highest value observed during the specified period. Use
+ * this value to determine high volumes of activity for your application.
+ * Sum - All values submitted for the matching metric added together. You
+ * can use this statistic to determine the total volume of a metric.
+ * Average - The value of Sum / SampleCount during
+ * the specified period. By comparing this statistic with the Minimum and
+ * Maximum values, you can determine the full scope of a metric and how close
+ * the average use is to the Minimum and Maximum values. This
+ * comparison helps you to know when to increase or decrease your resources.
+ * SampleCount - The count, or number, of data points used for the
+ * statistical calculation.
An array of objects containing information about all block storage disk snapshots.
+ *The name of the metric returned.
*/ - diskSnapshots?: DiskSnapshot[]; + metricName?: ContainerServiceMetricName | string; /** - *The token to advance to the next page of results from your request.
- *A next page token is not returned if there are no more results to display.
- *To get the next page of results, perform another GetDiskSnapshots request and
- * specify the next page token using the pageToken parameter.
An array of objects that describe the metric data returned.
*/ - nextPageToken?: string; + metricData?: MetricDatapoint[]; } -export namespace GetDiskSnapshotsResult { +export namespace GetContainerServiceMetricDataResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetDiskSnapshotsResult): any => ({ + export const filterSensitiveLog = (obj: GetContainerServiceMetricDataResult): any => ({ ...obj, }); } -export interface GetDistributionBundlesRequest {} +export interface GetContainerServicePowersRequest {} -export namespace GetDistributionBundlesRequest { +export namespace GetContainerServicePowersRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetDistributionBundlesRequest): any => ({ + export const filterSensitiveLog = (obj: GetContainerServicePowersRequest): any => ({ ...obj, }); } -export interface GetDistributionBundlesResult { +export interface GetContainerServicePowersResult { /** - *An object that describes a distribution bundle.
+ *An array of objects that describe the powers that can be specified for a container + * service.
*/ - bundles?: DistributionBundle[]; + powers?: ContainerServicePower[]; } -export namespace GetDistributionBundlesResult { +export namespace GetContainerServicePowersResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetDistributionBundlesResult): any => ({ + export const filterSensitiveLog = (obj: GetContainerServicePowersResult): any => ({ ...obj, }); } -export interface GetDistributionLatestCacheResetRequest { +export interface GetContainerServicesRequest { /** - *The name of the distribution for which to return the timestamp of the last cache - * reset.
- *Use the GetDistributions action to get a list of distribution names that you
- * can specify.
When omitted, the response includes the latest cache reset timestamp of all your - * distributions.
- */ - distributionName?: string; -} - -export namespace GetDistributionLatestCacheResetRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: GetDistributionLatestCacheResetRequest): any => ({ - ...obj, - }); -} - -export interface GetDistributionLatestCacheResetResult { - /** - *The status of the last cache reset.
- */ - status?: string; - - /** - *The timestamp of the last cache reset (e.g., 1479734909.17) in Unix time
- * format.
The name of the container service for which to return information.
+ * + *When omitted, the response includes all of your container services in the AWS Region + * where the request is made.
*/ - createTime?: Date; + serviceName?: string; } -export namespace GetDistributionLatestCacheResetResult { +export namespace GetContainerServicesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetDistributionLatestCacheResetResult): any => ({ + export const filterSensitiveLog = (obj: GetContainerServicesRequest): any => ({ ...obj, }); } -export interface GetDistributionMetricDataRequest { - /** - *The name of the distribution for which to get metric data.
- *Use the GetDistributions action to get a list of distribution names that you
- * can specify.
The metric for which you want to return information.
- *Valid distribution metric names are listed below, along with the most useful
- * statistics to include in your request, and the published unit
- * value.
- *
- * Requests
- * - The total number of viewer
- * requests received by your Lightsail distribution, for all HTTP methods, and for both
- * HTTP and HTTPS requests.
- * Statistics: The most useful statistic is Sum.
- * Unit: The published unit is None.
- *
- * BytesDownloaded
- * - The number of bytes
- * downloaded by viewers for GET, HEAD, and OPTIONS requests.
- * Statistics: The most useful statistic is Sum.
- * Unit: The published unit is None.
- *
- * BytesUploaded
- * - The number of bytes
- * uploaded to your origin by your Lightsail distribution, using POST and PUT
- * requests.
- * Statistics: The most useful statistic is Sum.
- * Unit: The published unit is None.
- *
- * TotalErrorRate
- * - The percentage of all
- * viewer requests for which the response's HTTP status code was 4xx or 5xx.
- * Statistics: The most useful statistic is Average.
- * Unit: The published unit is Percent.
- *
- * 4xxErrorRate
- * - The percentage of all
- * viewer requests for which the response's HTTP status cod was 4xx. In these cases, the
- * client or client viewer may have made an error. For example, a status code of 404 (Not
- * Found) means that the client requested an object that could not be found.
- * Statistics: The most useful statistic is Average.
- * Unit: The published unit is Percent.
- *
- * 5xxErrorRate
- * - The percentage of all
- * viewer requests for which the response's HTTP status code was 5xx. In these cases, the
- * origin server did not satisfy the requests. For example, a status code of 503 (Service
- * Unavailable) means that the origin server is currently unavailable.
- * Statistics: The most useful statistic is Average.
- * Unit: The published unit is Percent.
The start of the time interval for which to get metric data.
- *Constraints:
- *Specified in Coordinated Universal Time (UTC).
- *Specified in the Unix time format.
- *For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify
- * 1538424000 as the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
- */ - startTime: Date | undefined; - - /** - *The end of the time interval for which to get metric data.
- *Constraints:
- *Specified in Coordinated Universal Time (UTC).
- *Specified in the Unix time format.
- *For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify
- * 1538427600 as the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
- */ - endTime: Date | undefined; - - /** - *The granularity, in seconds, for the metric data points that will be returned.
- */ - period: number | undefined; - - /** - *The unit for the metric data request.
- *Valid units depend on the metric data being requested. For the valid units with each
- * available metric, see the metricName parameter.
The statistic for the metric.
- *The following statistics are available:
- *
- * Minimum - The lowest value observed during the specified period. Use this
- * value to determine low volumes of activity for your application.
- * Maximum - The highest value observed during the specified period. Use
- * this value to determine high volumes of activity for your application.
- * Sum - All values submitted for the matching metric added together. You
- * can use this statistic to determine the total volume of a metric.
- * Average - The value of Sum / SampleCount during the specified period. By
- * comparing this statistic with the Minimum and Maximum values, you can determine the full
- * scope of a metric and how close the average use is to the Minimum and Maximum values. This
- * comparison helps you to know when to increase or decrease your resources.
- * SampleCount - The count, or number, of data points used for the
- * statistical calculation.
The name of the disk (e.g., my-disk).
The name of the metric returned.
- */ - metricName?: DistributionMetricName | string; - +export interface GetDiskResult { /** - *An array of objects that describe the metric data returned.
+ *An object containing information about the disk.
*/ - metricData?: MetricDatapoint[]; + disk?: Disk; } -export namespace GetDistributionMetricDataResult { +export namespace GetDiskResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetDistributionMetricDataResult): any => ({ + export const filterSensitiveLog = (obj: GetDiskResult): any => ({ ...obj, }); } -export interface GetDistributionsRequest { - /** - *The name of the distribution for which to return information.
- *Use the GetDistributions action to get a list of distribution names that you
- * can specify.
When omitted, the response includes all of your distributions in the AWS Region where - * the request is made.
- */ - distributionName?: string; - +export interface GetDisksRequest { /** *The token to advance to the next page of results from your request.
- *To get a page token, perform an initial GetDistributions request. If your
- * results are paginated, the response will return a next page token that you can specify as the
- * page token in a subsequent request.
To get a page token, perform an initial GetDisks request. If your results are
+ * paginated, the response will return a next page token that you can specify as the page token
+ * in a subsequent request.
An array of objects that describe your distributions.
- */ - distributions?: LightsailDistribution[]; - - /** - *The token to advance to the next page of results from your request.
- *A next page token is not returned if there are no more results to display.
- *To get the next page of results, perform another GetDistributions request and
- * specify the next page token using the pageToken parameter.
The domain name for which your want to return information about.
- */ - domainName: string | undefined; -} - -export namespace GetDomainRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: GetDomainRequest): any => ({ - ...obj, - }); -} - -export interface GetDomainResult { - /** - *An array of key-value pairs containing information about your get domain request.
- */ - domain?: Domain; -} - -export namespace GetDomainResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: GetDomainResult): any => ({ - ...obj, - }); -} - -export interface GetDomainsRequest { - /** - *The token to advance to the next page of results from your request.
- *To get a page token, perform an initial GetDomains request. If your results
- * are paginated, the response will return a next page token that you can specify as the page
- * token in a subsequent request.
An array of key-value pairs containing information about each of the domain entries in the - * user's account.
- */ - domains?: Domain[]; - - /** - *The token to advance to the next page of results from your request.
- *A next page token is not returned if there are no more results to display.
- *To get the next page of results, perform another GetDomains request and
- * specify the next page token using the pageToken parameter.
The token to advance to the next page of results from your request.
- *To get a page token, perform an initial GetExportSnapshotRecords request. If
- * your results are paginated, the response will return a next page token that you can specify as
- * the page token in a subsequent request.
A list of objects describing the export snapshot records.
- */ - exportSnapshotRecords?: ExportSnapshotRecord[]; - - /** - *The token to advance to the next page of results from your request.
- *A next page token is not returned if there are no more results to display.
- *To get the next page of results, perform another GetExportSnapshotRecords
- * request and specify the next page token using the pageToken parameter.
The name of the instance.
- */ - instanceName: string | undefined; -} - -export namespace GetInstanceRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: GetInstanceRequest): any => ({ - ...obj, - }); -} - -/** - *Describes the hardware for the instance.
- */ -export interface InstanceHardware { - /** - *The number of vCPUs the instance has.
- */ - cpuCount?: number; - - /** - *The disks attached to the instance.
- */ - disks?: Disk[]; - - /** - *The amount of RAM in GB on the instance (e.g., 1.0).
Describes the monthly data transfer in and out of your virtual private server (or - * instance).
- */ -export interface MonthlyTransfer { - /** - *The amount allocated per month (in GB).
- */ - gbPerMonthAllocated?: number; -} - -export namespace MonthlyTransfer { - /** - * @internal - */ - export const filterSensitiveLog = (obj: MonthlyTransfer): any => ({ - ...obj, - }); -} - -export enum PortAccessType { - Private = "Private", - Public = "Public", -} - -/** - *Describes information about ports for an Amazon Lightsail instance.
- */ -export interface InstancePortInfo { - /** - *The first port in a range of open ports on an instance.
- *Allowed ports:
- *TCP and UDP - 0 to 65535
- *
ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the
- * fromPort (ICMP type), and -1 as the toPort (ICMP
- * code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as
- * the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6
- * code). For more information, see Internet
- * Control Message Protocol for IPv6.
The last port in a range of open ports on an instance.
- *Allowed ports:
- *TCP and UDP - 0 to 65535
- *
ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the
- * fromPort (ICMP type), and -1 as the toPort (ICMP
- * code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as
- * the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6
- * code). For more information, see Internet
- * Control Message Protocol for IPv6.
The IP protocol name.
- *The name can be one of the following:
- *
- * tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and
- * error-checked delivery of streamed data between applications running on hosts
- * communicating by an IP network. If you have an application that doesn't require reliable
- * data stream service, use UDP instead.
- * all - All transport layer protocol types. For more general information,
- * see Transport layer on
- * Wikipedia.
- * udp - With User Datagram Protocol (UDP), computer applications can send
- * messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior
- * communications are not required to set up transmission channels or data paths.
- * Applications that don't require reliable data stream service can use UDP, which provides a
- * connectionless datagram service that emphasizes reduced latency over reliability. If you
- * do require reliable data stream service, use TCP instead.
- * icmp - Internet Control Message Protocol (ICMP) is used to send error
- * messages and operational information indicating success or failure when communicating with
- * an instance. For example, an error is indicated when an instance could not be reached.
- * When you specify icmp as the protocol, you must specify the ICMP
- * type using the fromPort parameter, and ICMP code using the
- * toPort parameter.
The location from which access is allowed. For example, Anywhere (0.0.0.0/0),
- * or Custom if a specific IP address or range of IP addresses is allowed.
The type of access (Public or Private).
The common name of the port information.
- */ - commonName?: string; - - /** - *The access direction (inbound or outbound).
Lightsail currently supports only inbound access direction.
The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to - * connect to an instance through the ports, and the protocol.
- *The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to
- * connect to an instance.
For more information about CIDR block notation, see Classless - * Inter-Domain Routing on Wikipedia.
- */ - cidrs?: string[]; - - /** - *The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to - * connect to an instance through the ports, and the protocol. Only devices with an IPv6 address - * can connect to an instance through IPv6; otherwise, IPv4 should be used.
- *The cidrs parameter lists the IPv4 addresses that are allowed to connect to
- * an instance.
For more information about CIDR block notation, see Classless - * Inter-Domain Routing on Wikipedia.
- */ - ipv6Cidrs?: string[]; - - /** - *An alias that defines access for a preconfigured range of IP addresses.
- *The only alias currently supported is lightsail-connect, which allows IP
- * addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your
- * instance.
Describes monthly data transfer rates and port information for an instance.
- */ -export interface InstanceNetworking { - /** - *The amount of data in GB allocated for monthly data transfers.
- */ - monthlyTransfer?: MonthlyTransfer; - - /** - *An array of key-value pairs containing information about the ports on the instance.
- */ - ports?: InstancePortInfo[]; -} - -export namespace InstanceNetworking { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InstanceNetworking): any => ({ - ...obj, - }); -} - -/** - *Describes the virtual private server (or instance) status.
- */ -export interface InstanceState { - /** - *The status code for the instance.
- */ - code?: number; - - /** - *The state of the instance (e.g., running or pending).
Describes an instance (a virtual private server).
- */ -export interface Instance { - /** - *The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).
The Amazon Resource Name (ARN) of the instance (e.g.,
- * arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
The support code. Include this code in your email to support when you have questions about - * an instance or another resource in Lightsail. This code enables our support team to look up - * your Lightsail information more easily.
- */ - supportCode?: string; - - /** - *The timestamp when the instance was created (e.g., 1479734909.17) in Unix
- * time format.
The region name and Availability Zone where the instance is located.
- */ - location?: ResourceLocation; - - /** - *The type of resource (usually Instance).
The tag keys and optional values for the resource. For more information about tags in - * Lightsail, see the Lightsail - * Dev Guide.
+ * @internal */ - tags?: Tag[]; + export const filterSensitiveLog = (obj: GetDisksRequest): any => ({ + ...obj, + }); +} +export interface GetDisksResult { /** - *The blueprint ID (e.g., os_amlinux_2016_03).
An array of objects containing information about all block storage disks.
*/ - blueprintId?: string; + disks?: Disk[]; /** - *The friendly name of the blueprint (e.g., Amazon Linux).
The token to advance to the next page of results from your request.
+ *A next page token is not returned if there are no more results to display.
+ *To get the next page of results, perform another GetDisks request and specify
+ * the next page token using the pageToken parameter.
The bundle for the instance (e.g., micro_1_0).
An array of objects representing the add-ons enabled on the instance.
+ *The name of the disk snapshot (e.g., my-disk-snapshot).
A Boolean value indicating whether this instance has a static IP assigned to it.
+ * @internal */ - isStaticIp?: boolean; + export const filterSensitiveLog = (obj: GetDiskSnapshotRequest): any => ({ + ...obj, + }); +} +export interface GetDiskSnapshotResult { /** - *The private IP address of the instance.
+ *An object containing information about the disk snapshot.
*/ - privateIpAddress?: string; + diskSnapshot?: DiskSnapshot; +} +export namespace GetDiskSnapshotResult { /** - *The public IP address of the instance.
+ * @internal */ - publicIpAddress?: string; + export const filterSensitiveLog = (obj: GetDiskSnapshotResult): any => ({ + ...obj, + }); +} +export interface GetDiskSnapshotsRequest { /** - *The IPv6 addresses of the instance.
+ *The token to advance to the next page of results from your request.
+ *To get a page token, perform an initial GetDiskSnapshots request. If your
+ * results are paginated, the response will return a next page token that you can specify as the
+ * page token in a subsequent request.
The IP address type of the instance.
- * - *The possible values are ipv4 for IPv4 only, and dualstack for
- * IPv4 and IPv6.
The size of the vCPU and the amount of RAM for the instance.
+ *An array of objects containing information about all block storage disk snapshots.
*/ - hardware?: InstanceHardware; + diskSnapshots?: DiskSnapshot[]; /** - *Information about the public ports and monthly data transfer rates for the - * instance.
+ *The token to advance to the next page of results from your request.
+ *A next page token is not returned if there are no more results to display.
+ *To get the next page of results, perform another GetDiskSnapshots request and
+ * specify the next page token using the pageToken parameter.
The status code and the state (e.g., running) for the instance.
The user name for connecting to the instance (e.g., ec2-user).
The name of the SSH key being used to connect to the instance (e.g.,
- * LightsailDefaultKeyPair).
An object that describes a distribution bundle.
*/ - sshKeyName?: string; + bundles?: DistributionBundle[]; } -export namespace Instance { +export namespace GetDistributionBundlesResult { /** * @internal */ - export const filterSensitiveLog = (obj: Instance): any => ({ + export const filterSensitiveLog = (obj: GetDistributionBundlesResult): any => ({ ...obj, }); } -export interface GetInstanceResult { +export interface GetDistributionLatestCacheResetRequest { /** - *An array of key-value pairs containing information about the specified instance.
+ *The name of the distribution for which to return the timestamp of the last cache + * reset.
+ *Use the GetDistributions action to get a list of distribution names that you
+ * can specify.
When omitted, the response includes the latest cache reset timestamp of all your + * distributions.
*/ - instance?: Instance; + distributionName?: string; } -export namespace GetInstanceResult { +export namespace GetDistributionLatestCacheResetRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetInstanceResult): any => ({ + export const filterSensitiveLog = (obj: GetDistributionLatestCacheResetRequest): any => ({ ...obj, }); } -export enum InstanceAccessProtocol { - rdp = "rdp", - ssh = "ssh", -} - -export interface GetInstanceAccessDetailsRequest { +export interface GetDistributionLatestCacheResetResult { /** - *The name of the instance to access.
+ *The status of the last cache reset.
*/ - instanceName: string | undefined; + status?: string; /** - *The protocol to use to connect to your instance. Defaults to ssh.
The timestamp of the last cache reset (e.g., 1479734909.17) in Unix time
+ * format.
Describes the public SSH host keys or the RDP certificate.
- */ -export interface HostKeyAttributes { +export interface GetDistributionMetricDataRequest { /** - *The SSH host key algorithm or the RDP certificate format.
- *For SSH host keys, the algorithm may be ssh-rsa,
- * ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the
- * algorithm is always x509-cert.
The name of the distribution for which to get metric data.
+ *Use the GetDistributions action to get a list of distribution names that you
+ * can specify.
The public SSH host key or the RDP certificate.
+ *The metric for which you want to return information.
+ *Valid distribution metric names are listed below, along with the most useful
+ * statistics to include in your request, and the published unit
+ * value.
+ *
+ * Requests
+ * - The total number of viewer
+ * requests received by your Lightsail distribution, for all HTTP methods, and for both
+ * HTTP and HTTPS requests.
+ * Statistics: The most useful statistic is Sum.
+ * Unit: The published unit is None.
+ *
+ * BytesDownloaded
+ * - The number of bytes
+ * downloaded by viewers for GET, HEAD, and OPTIONS requests.
+ * Statistics: The most useful statistic is Sum.
+ * Unit: The published unit is None.
+ *
+ * BytesUploaded
+ * - The number of bytes
+ * uploaded to your origin by your Lightsail distribution, using POST and PUT
+ * requests.
+ * Statistics: The most useful statistic is Sum.
+ * Unit: The published unit is None.
+ *
+ * TotalErrorRate
+ * - The percentage of all
+ * viewer requests for which the response's HTTP status code was 4xx or 5xx.
+ * Statistics: The most useful statistic is Average.
+ * Unit: The published unit is Percent.
+ *
+ * 4xxErrorRate
+ * - The percentage of all
+ * viewer requests for which the response's HTTP status cod was 4xx. In these cases, the
+ * client or client viewer may have made an error. For example, a status code of 404 (Not
+ * Found) means that the client requested an object that could not be found.
+ * Statistics: The most useful statistic is Average.
+ * Unit: The published unit is Percent.
+ *
+ * 5xxErrorRate
+ * - The percentage of all
+ * viewer requests for which the response's HTTP status code was 5xx. In these cases, the
+ * origin server did not satisfy the requests. For example, a status code of 503 (Service
+ * Unavailable) means that the origin server is currently unavailable.
+ * Statistics: The most useful statistic is Average.
+ * Unit: The published unit is Percent.
The time that the SSH host key or RDP certificate was recorded by Lightsail.
+ *The start of the time interval for which to get metric data.
+ *Constraints:
+ *Specified in Coordinated Universal Time (UTC).
+ *Specified in the Unix time format.
+ *For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify
+ * 1538424000 as the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*/ - witnessedAt?: Date; + startTime: Date | undefined; /** - *The SHA-1 fingerprint of the returned SSH host key or RDP certificate.
+ *The end of the time interval for which to get metric data.
+ *Constraints:
*Example of an SHA-1 SSH fingerprint:
- *
- * SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0
- *
Specified in Coordinated Universal Time (UTC).
*Example of an SHA-1 RDP fingerprint:
- *
- * af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45
- *
Specified in the Unix time format.
+ *For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify
+ * 1538427600 as the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
*/ - fingerprintSHA1?: string; + endTime: Date | undefined; + + /** + *The granularity, in seconds, for the metric data points that will be returned.
+ */ + period: number | undefined; + + /** + *The unit for the metric data request.
+ *Valid units depend on the metric data being requested. For the valid units with each
+ * available metric, see the metricName parameter.
The SHA-256 fingerprint of the returned SSH host key or RDP certificate.
+ *The statistic for the metric.
+ *The following statistics are available:
*Example of an SHA-256 SSH fingerprint:
*
- * SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o
- *
Minimum - The lowest value observed during the specified period. Use this
+ * value to determine low volumes of activity for your application.
+ *
+ * Maximum - The highest value observed during the specified period. Use
+ * this value to determine high volumes of activity for your application.
+ * Sum - All values submitted for the matching metric added together. You
+ * can use this statistic to determine the total volume of a metric.
+ * Average - The value of Sum / SampleCount during the specified period. By
+ * comparing this statistic with the Minimum and Maximum values, you can determine the full
+ * scope of a metric and how close the average use is to the Minimum and Maximum values. This
+ * comparison helps you to know when to increase or decrease your resources.
Example of an SHA-256 RDP fingerprint:
*
- * 03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68
- *
SampleCount - The count, or number, of data points used for the
+ * statistical calculation.
* The returned RDP certificate is valid after this point in time.
- *This value is listed only for RDP certificates.
- */ - notValidBefore?: Date; - - /** - *The returned RDP certificate is not valid after this point in time.
- *This value is listed only for RDP certificates.
- */ - notValidAfter?: Date; + statistics: (MetricStatistic | string)[] | undefined; } -export namespace HostKeyAttributes { +export namespace GetDistributionMetricDataRequest { /** * @internal */ - export const filterSensitiveLog = (obj: HostKeyAttributes): any => ({ + export const filterSensitiveLog = (obj: GetDistributionMetricDataRequest): any => ({ ...obj, }); } -/** - *The password data for the Windows Server-based instance, including the ciphertext and the - * key pair name.
- */ -export interface PasswordData { +export interface GetDistributionMetricDataResult { /** - *The encrypted password. Ciphertext will be an empty string if access to your new instance - * is not ready yet. When you create an instance, it can take up to 15 minutes for the instance - * to be ready.
- *If you use the default key pair (LightsailDefaultKeyPair), the decrypted
- * password will be available in the password field.
If you are using a custom key pair, you need to use your own means of decryption.
- *If you change the Administrator password on the instance, Lightsail will continue to - * return the original ciphertext value. When accessing the instance using RDP, you need to - * manually enter the Administrator password after changing it from the default.
- *The name of the metric returned.
*/ - ciphertext?: string; + metricName?: DistributionMetricName | string; /** - *The name of the key pair that you used when creating your instance. If no key pair name
- * was specified when creating the instance, Lightsail uses the default key pair
- * (LightsailDefaultKeyPair).
If you are using a custom key pair, you need to use your own means of decrypting your
- * password using the ciphertext. Lightsail creates the ciphertext by encrypting
- * your password with the public key part of this key pair.
An array of objects that describe the metric data returned.
*/ - keyPairName?: string; + metricData?: MetricDatapoint[]; } -export namespace PasswordData { +export namespace GetDistributionMetricDataResult { /** * @internal */ - export const filterSensitiveLog = (obj: PasswordData): any => ({ + export const filterSensitiveLog = (obj: GetDistributionMetricDataResult): any => ({ ...obj, }); } -/** - *The parameters for gaining temporary access to one of your Amazon Lightsail - * instances.
- */ -export interface InstanceAccessDetails { - /** - *For SSH access, the public key to use when accessing your instance For OpenSSH clients
- * (e.g., command line SSH), you should save this value to tempkey-cert.pub.
For SSH access, the date on which the temporary keys expire.
+ *The name of the distribution for which to return information.
+ * + *When omitted, the response includes all of your distributions in the AWS Region where + * the request is made.
*/ - expiresAt?: Date; + distributionName?: string; /** - *The public IP address of the Amazon Lightsail instance.
+ *The token to advance to the next page of results from your request.
+ *To get a page token, perform an initial GetDistributions request. If your
+ * results are paginated, the response will return a next page token that you can specify as the
+ * page token in a subsequent request.
For RDP access, the password for your Amazon Lightsail instance. Password will be an empty - * string if the password for your new instance is not ready yet. When you create an instance, it - * can take up to 15 minutes for the instance to be ready.
- *If you create an instance using any key pair other than the default
- * (LightsailDefaultKeyPair), password will always be an empty
- * string.
If you change the Administrator password on the instance, Lightsail will continue to - * return the original password value. When accessing the instance using RDP, you need to - * manually enter the Administrator password after changing it from the default.
- *For a Windows Server-based instance, an object with the data you can use to retrieve your
- * password. This is only needed if password is empty and the instance is not new
- * (and therefore the password is not ready yet). When you create an instance, it can take up to
- * 15 minutes for the instance to be ready.
An array of objects that describe your distributions.
*/ - passwordData?: PasswordData; + distributions?: LightsailDistribution[]; /** - *For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH),
- * you should save this value to tempkey).
The token to advance to the next page of results from your request.
+ *A next page token is not returned if there are no more results to display.
+ *To get the next page of results, perform another GetDistributions request and
+ * specify the next page token using the pageToken parameter.
The protocol for these Amazon Lightsail instance access details.
+ * @internal */ - protocol?: InstanceAccessProtocol | string; + export const filterSensitiveLog = (obj: GetDistributionsResult): any => ({ + ...obj, + }); +} +export interface GetDomainRequest { /** - *The name of this Amazon Lightsail instance.
+ *The domain name for which your want to return information about.
*/ - instanceName?: string; + domainName: string | undefined; +} +export namespace GetDomainRequest { /** - *The user name to use when logging in to the Amazon Lightsail instance.
+ * @internal */ - username?: string; + export const filterSensitiveLog = (obj: GetDomainRequest): any => ({ + ...obj, + }); +} +export interface GetDomainResult { /** - *Describes the public SSH host keys or the RDP certificate.
+ *An array of key-value pairs containing information about your get domain request.
*/ - hostKeys?: HostKeyAttributes[]; + domain?: Domain; } -export namespace InstanceAccessDetails { +export namespace GetDomainResult { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceAccessDetails): any => ({ + export const filterSensitiveLog = (obj: GetDomainResult): any => ({ ...obj, }); } -export interface GetInstanceAccessDetailsResult { +export interface GetDomainsRequest { /** - *An array of key-value pairs containing information about a get instance access - * request.
+ *The token to advance to the next page of results from your request.
+ *To get a page token, perform an initial GetDomains request. If your results
+ * are paginated, the response will return a next page token that you can specify as the page
+ * token in a subsequent request.
An array of key-value pairs containing information about each of the domain entries in the + * user's account.
+ */ + domains?: Domain[]; + + /** + *The token to advance to the next page of results from your request.
+ *A next page token is not returned if there are no more results to display.
+ *To get the next page of results, perform another GetDomains request and
+ * specify the next page token using the pageToken parameter.
The name of the instance for which you want to get metrics data.
+ * @internal */ - instanceName: string | undefined; + export const filterSensitiveLog = (obj: GetDomainsResult): any => ({ + ...obj, + }); +} +export interface GetExportSnapshotRecordsRequest { /** - *The metric for which you want to return information.
- *Valid instance metric names are listed below, along with the most useful
- * statistics to include in your request, and the published unit
- * value.
- *
- * BurstCapacityPercentage
- * - The percentage
- * of CPU performance available for your instance to burst above its baseline. Your instance
- * continuously accrues and consumes burst capacity. Burst capacity stops accruing when your
- * instance's BurstCapacityPercentage reaches 100%. For more information, see
- * Viewing instance burst capacity in Amazon Lightsail.
- * Statistics: The most useful statistics are Maximum and
- * Average.
- * Unit: The published unit is Percent.
- *
- * BurstCapacityTime
- * - The available amount
- * of time for your instance to burst at 100% CPU utilization. Your instance continuously
- * accrues and consumes burst capacity. Burst capacity time stops accruing when your
- * instance's BurstCapacityPercentage metric reaches 100%.
Burst capacity time is consumed at the full rate only when your instance operates at - * 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the - * burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% - * rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity - * minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
- *
- * Statistics: The most useful statistics are Maximum and
- * Average.
- * Unit: The published unit is Seconds.
- *
- * CPUUtilization
- * - The percentage of
- * allocated compute units that are currently in use on the instance. This metric identifies
- * the processing power to run the applications on the instance. Tools in your operating
- * system can show a lower percentage than Lightsail when the instance is not allocated a
- * full processor core.
- * Statistics: The most useful statistics are Maximum and
- * Average.
- * Unit: The published unit is Percent.
- *
- * NetworkIn
- * - The number of bytes received
- * on all network interfaces by the instance. This metric identifies the volume of incoming
- * network traffic to the instance. The number reported is the number of bytes received
- * during the period. Because this metric is reported in 5-minute intervals, divide the
- * reported number by 300 to find Bytes/second.
- * Statistics: The most useful statistic is Sum.
- * Unit: The published unit is Bytes.
- *
- * NetworkOut
- * - The number of bytes sent
- * out on all network interfaces by the instance. This metric identifies the volume of
- * outgoing network traffic from the instance. The number reported is the number of bytes
- * sent during the period. Because this metric is reported in 5-minute intervals, divide the
- * reported number by 300 to find Bytes/second.
- * Statistics: The most useful statistic is Sum.
- * Unit: The published unit is Bytes.
- *
- * StatusCheckFailed
- * - Reports whether the
- * instance passed or failed both the instance status check and the system status check. This
- * metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute
- * (60 seconds) granularity.
- * Statistics: The most useful statistic is Sum.
- * Unit: The published unit is Count.
- *
- * StatusCheckFailed_Instance
- * - Reports
- * whether the instance passed or failed the instance status check. This metric can be either
- * 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds)
- * granularity.
- * Statistics: The most useful statistic is Sum.
- * Unit: The published unit is Count.
- *
- * StatusCheckFailed_System
- * - Reports
- * whether the instance passed or failed the system status check. This metric can be either 0
- * (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds)
- * granularity.
- * Statistics: The most useful statistic is Sum.
- * Unit: The published unit is Count.
The token to advance to the next page of results from your request.
+ *To get a page token, perform an initial GetExportSnapshotRecords request. If
+ * your results are paginated, the response will return a next page token that you can specify as
+ * the page token in a subsequent request.
The granularity, in seconds, of the returned data points.
- *The StatusCheckFailed, StatusCheckFailed_Instance, and
- * StatusCheckFailed_System instance metric data is available in 1-minute (60
- * seconds) granularity. All other instance metric data is available in 5-minute (300 seconds)
- * granularity.
The start time of the time period.
+ *A list of objects describing the export snapshot records.
*/ - startTime: Date | undefined; + exportSnapshotRecords?: ExportSnapshotRecord[]; /** - *The end time of the time period.
+ *The token to advance to the next page of results from your request.
+ *A next page token is not returned if there are no more results to display.
+ *To get the next page of results, perform another GetExportSnapshotRecords
+ * request and specify the next page token using the pageToken parameter.
The unit for the metric data request. Valid units depend on the metric data being
- * requested. For the valid units to specify with each available metric, see the
- * metricName parameter.
The statistic for the metric.
- *The following statistics are available:
- *
- * Minimum - The lowest value observed during the specified period. Use this
- * value to determine low volumes of activity for your application.
- * Maximum - The highest value observed during the specified period. Use
- * this value to determine high volumes of activity for your application.
- * Sum - All values submitted for the matching metric added together. You
- * can use this statistic to determine the total volume of a metric.
- * Average - The value of Sum / SampleCount during the specified period. By
- * comparing this statistic with the Minimum and Maximum values, you can determine the full
- * scope of a metric and how close the average use is to the Minimum and Maximum values. This
- * comparison helps you to know when to increase or decrease your resources.
- * SampleCount - The count, or number, of data points used for the
- * statistical calculation.
The name of the instance.
*/ - statistics: (MetricStatistic | string)[] | undefined; + instanceName: string | undefined; } -export namespace GetInstanceMetricDataRequest { +export namespace GetInstanceRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetInstanceMetricDataRequest): any => ({ + export const filterSensitiveLog = (obj: GetInstanceRequest): any => ({ ...obj, }); } -export interface GetInstanceMetricDataResult { +/** + *Describes the hardware for the instance.
+ */ +export interface InstanceHardware { /** - *The name of the metric returned.
+ *The number of vCPUs the instance has.
*/ - metricName?: InstanceMetricName | string; + cpuCount?: number; /** - *An array of objects that describe the metric data returned.
+ *The disks attached to the instance.
*/ - metricData?: MetricDatapoint[]; + disks?: Disk[]; + + /** + *The amount of RAM in GB on the instance (e.g., 1.0).
Describes the monthly data transfer in and out of your virtual private server (or + * instance).
+ */ +export interface MonthlyTransfer { /** - *The name of the instance for which to return firewall port states.
+ *The amount allocated per month (in GB).
*/ - instanceName: string | undefined; + gbPerMonthAllocated?: number; } -export namespace GetInstancePortStatesRequest { +export namespace MonthlyTransfer { /** * @internal */ - export const filterSensitiveLog = (obj: GetInstancePortStatesRequest): any => ({ + export const filterSensitiveLog = (obj: MonthlyTransfer): any => ({ ...obj, }); } -export enum PortState { - Closed = "closed", - Open = "open", +export enum PortAccessType { + Private = "Private", + Public = "Public", } /** - *Describes open ports on an instance, the IP addresses allowed to connect to the instance - * through the ports, and the protocol.
+ *Describes information about ports for an Amazon Lightsail instance.
*/ -export interface InstancePortState { +export interface InstancePortInfo { /** *The first port in a range of open ports on an instance.
*Allowed ports:
@@ -9545,12 +9534,28 @@ export interface InstancePortState { protocol?: NetworkProtocol | string; /** - *Specifies whether the instance port is open or closed.
The location from which access is allowed. For example, Anywhere (0.0.0.0/0),
+ * or Custom if a specific IP address or range of IP addresses is allowed.
The type of access (Public or Private).
The common name of the port information.
+ */ + commonName?: string; + + /** + *The access direction (inbound or outbound).
The port state for Lightsail instances is always open.
Lightsail currently supports only inbound access direction.
The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to @@ -9586,293 +9591,59 @@ export interface InstancePortState { cidrListAliases?: string[]; } -export namespace InstancePortState { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InstancePortState): any => ({ - ...obj, - }); -} - -export interface GetInstancePortStatesResult { - /** - *
An array of objects that describe the firewall port states for the specified - * instance.
- */ - portStates?: InstancePortState[]; -} - -export namespace GetInstancePortStatesResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: GetInstancePortStatesResult): any => ({ - ...obj, - }); -} - -export interface GetInstancesRequest { - /** - *The token to advance to the next page of results from your request.
- *To get a page token, perform an initial GetInstances request. If your results
- * are paginated, the response will return a next page token that you can specify as the page
- * token in a subsequent request.
An array of key-value pairs containing information about your instances.
- */ - instances?: Instance[]; - - /** - *The token to advance to the next page of results from your request.
- *A next page token is not returned if there are no more results to display.
- *To get the next page of results, perform another GetInstances request and
- * specify the next page token using the pageToken parameter.
The name of the snapshot for which you are requesting information.
- */ - instanceSnapshotName: string | undefined; -} - -export namespace GetInstanceSnapshotRequest { +export namespace InstancePortInfo { /** * @internal */ - export const filterSensitiveLog = (obj: GetInstanceSnapshotRequest): any => ({ + export const filterSensitiveLog = (obj: InstancePortInfo): any => ({ ...obj, }); } -export enum InstanceSnapshotState { - Available = "available", - Error = "error", - Pending = "pending", -} - /** - *Describes an instance snapshot.
+ *Describes monthly data transfer rates and port information for an instance.
*/ -export interface InstanceSnapshot { - /** - *The name of the snapshot.
- */ - name?: string; - - /** - *The Amazon Resource Name (ARN) of the snapshot (e.g.,
- * arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).
The support code. Include this code in your email to support when you have questions about - * an instance or another resource in Lightsail. This code enables our support team to look up - * your Lightsail information more easily.
- */ - supportCode?: string; - - /** - *The timestamp when the snapshot was created (e.g., 1479907467.024).
The region name and Availability Zone where you created the snapshot.
- */ - location?: ResourceLocation; - - /** - *The type of resource (usually InstanceSnapshot).
The tag keys and optional values for the resource. For more information about tags in - * Lightsail, see the Lightsail - * Dev Guide.
- */ - tags?: Tag[]; - - /** - *The state the snapshot is in.
- */ - state?: InstanceSnapshotState | string; - - /** - *The progress of the snapshot.
- *This is populated only for disk snapshots, and is null for instance
- * snapshots.
An array of disk objects containing information about all block storage disks.
- */ - fromAttachedDisks?: Disk[]; - - /** - *The instance from which the snapshot was created.
- */ - fromInstanceName?: string; - - /** - *The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g.,
- * arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).
The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A
- * blueprint is a virtual private server (or instance) image used to create
- * instances quickly.
The bundle ID from which you created the snapshot (e.g., micro_1_0).
A Boolean value indicating whether the snapshot was created from an automatic - * snapshot.
- */ - isFromAutoSnapshot?: boolean; - - /** - *The size in GB of the SSD.
- */ - sizeInGb?: number; -} - -export namespace InstanceSnapshot { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InstanceSnapshot): any => ({ - ...obj, - }); -} - -export interface GetInstanceSnapshotResult { - /** - *An array of key-value pairs containing information about the results of your get instance - * snapshot request.
- */ - instanceSnapshot?: InstanceSnapshot; -} - -export namespace GetInstanceSnapshotResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: GetInstanceSnapshotResult): any => ({ - ...obj, - }); -} - -export interface GetInstanceSnapshotsRequest { - /** - *The token to advance to the next page of results from your request.
- *To get a page token, perform an initial GetInstanceSnapshots request. If your
- * results are paginated, the response will return a next page token that you can specify as the
- * page token in a subsequent request.
An array of key-value pairs containing information about the results of your get instance - * snapshots request.
+ *The amount of data in GB allocated for monthly data transfers.
*/ - instanceSnapshots?: InstanceSnapshot[]; + monthlyTransfer?: MonthlyTransfer; /** - *The token to advance to the next page of results from your request.
- *A next page token is not returned if there are no more results to display.
- *To get the next page of results, perform another GetInstanceSnapshots request
- * and specify the next page token using the pageToken parameter.
An array of key-value pairs containing information about the ports on the instance.
*/ - nextPageToken?: string; + ports?: InstancePortInfo[]; } -export namespace GetInstanceSnapshotsResult { +export namespace InstanceNetworking { /** * @internal */ - export const filterSensitiveLog = (obj: GetInstanceSnapshotsResult): any => ({ + export const filterSensitiveLog = (obj: InstanceNetworking): any => ({ ...obj, }); } -export interface GetInstanceStateRequest { - /** - *The name of the instance to get state information about.
- */ - instanceName: string | undefined; -} - -export namespace GetInstanceStateRequest { +/** + *Describes the virtual private server (or instance) status.
+ */ +export interface InstanceState { /** - * @internal + *The status code for the instance.
*/ - export const filterSensitiveLog = (obj: GetInstanceStateRequest): any => ({ - ...obj, - }); -} + code?: number; -export interface GetInstanceStateResult { /** - *The state of the instance.
+ *The state of the instance (e.g., running or pending).
Describes an instance (a virtual private server).
+ */ +export interface Instance { + /** + *The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).
The Amazon Resource Name (ARN) of the instance (e.g.,
+ * arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
The support code. Include this code in your email to support when you have questions about + * an instance or another resource in Lightsail. This code enables our support team to look up + * your Lightsail information more easily.
+ */ + supportCode?: string; + + /** + *The timestamp when the instance was created (e.g., 1479734909.17) in Unix
+ * time format.
The region name and Availability Zone where the instance is located.
+ */ + location?: ResourceLocation; + + /** + *The type of resource (usually Instance).
The tag keys and optional values for the resource. For more information about tags in + * Lightsail, see the Amazon Lightsail Developer Guide.
+ */ + tags?: Tag[]; + + /** + *The blueprint ID (e.g., os_amlinux_2016_03).
The friendly name of the blueprint (e.g., Amazon Linux).
The bundle for the instance (e.g., micro_1_0).
An array of objects representing the add-ons enabled on the instance.
+ */ + addOns?: AddOn[]; + + /** + *A Boolean value indicating whether this instance has a static IP assigned to it.
+ */ + isStaticIp?: boolean; + + /** + *The private IP address of the instance.
+ */ + privateIpAddress?: string; + + /** + *The public IP address of the instance.
+ */ + publicIpAddress?: string; + + /** + *The IPv6 addresses of the instance.
+ */ + ipv6Addresses?: string[]; + + /** + *The IP address type of the instance.
+ * + *The possible values are ipv4 for IPv4 only, and dualstack for
+ * IPv4 and IPv6.
The size of the vCPU and the amount of RAM for the instance.
+ */ + hardware?: InstanceHardware; + + /** + *Information about the public ports and monthly data transfer rates for the + * instance.
+ */ + networking?: InstanceNetworking; + + /** + *The status code and the state (e.g., running) for the instance.
The user name for connecting to the instance (e.g., ec2-user).
The name of the SSH key being used to connect to the instance (e.g.,
+ * LightsailDefaultKeyPair).
An array of key-value pairs containing information about the specified instance.
+ */ + instance?: Instance; +} + +export namespace GetInstanceResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetInstanceResult): any => ({ + ...obj, + }); +} + +export enum InstanceAccessProtocol { + rdp = "rdp", + ssh = "ssh", +} + +export interface GetInstanceAccessDetailsRequest { + /** + *The name of the instance to access.
+ */ + instanceName: string | undefined; + + /** + *The protocol to use to connect to your instance. Defaults to ssh.
Describes the public SSH host keys or the RDP certificate.
+ */ +export interface HostKeyAttributes { + /** + *The SSH host key algorithm or the RDP certificate format.
+ *For SSH host keys, the algorithm may be ssh-rsa,
+ * ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the
+ * algorithm is always x509-cert.
The public SSH host key or the RDP certificate.
+ */ + publicKey?: string; + + /** + *The time that the SSH host key or RDP certificate was recorded by Lightsail.
+ */ + witnessedAt?: Date; + + /** + *The SHA-1 fingerprint of the returned SSH host key or RDP certificate.
+ *Example of an SHA-1 SSH fingerprint:
+ *
+ * SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0
+ *
Example of an SHA-1 RDP fingerprint:
+ *
+ * af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45
+ *
The SHA-256 fingerprint of the returned SSH host key or RDP certificate.
+ *Example of an SHA-256 SSH fingerprint:
+ *
+ * SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o
+ *
Example of an SHA-256 RDP fingerprint:
+ *
+ * 03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68
+ *
The returned RDP certificate is valid after this point in time.
+ *This value is listed only for RDP certificates.
+ */ + notValidBefore?: Date; + + /** + *The returned RDP certificate is not valid after this point in time.
+ *This value is listed only for RDP certificates.
+ */ + notValidAfter?: Date; +} + +export namespace HostKeyAttributes { + /** + * @internal + */ + export const filterSensitiveLog = (obj: HostKeyAttributes): any => ({ + ...obj, + }); +} + +/** + *The password data for the Windows Server-based instance, including the ciphertext and the + * key pair name.
+ */ +export interface PasswordData { + /** + *The encrypted password. Ciphertext will be an empty string if access to your new instance + * is not ready yet. When you create an instance, it can take up to 15 minutes for the instance + * to be ready.
+ *If you use the default key pair (LightsailDefaultKeyPair), the decrypted
+ * password will be available in the password field.
If you are using a custom key pair, you need to use your own means of decryption.
+ *If you change the Administrator password on the instance, Lightsail will continue to + * return the original ciphertext value. When accessing the instance using RDP, you need to + * manually enter the Administrator password after changing it from the default.
+ *The name of the key pair that you used when creating your instance. If no key pair name
+ * was specified when creating the instance, Lightsail uses the default key pair
+ * (LightsailDefaultKeyPair).
If you are using a custom key pair, you need to use your own means of decrypting your
+ * password using the ciphertext. Lightsail creates the ciphertext by encrypting
+ * your password with the public key part of this key pair.
The parameters for gaining temporary access to one of your Amazon Lightsail + * instances.
+ */ +export interface InstanceAccessDetails { + /** + *For SSH access, the public key to use when accessing your instance For OpenSSH clients
+ * (e.g., command line SSH), you should save this value to tempkey-cert.pub.
For SSH access, the date on which the temporary keys expire.
+ */ + expiresAt?: Date; + + /** + *The public IP address of the Amazon Lightsail instance.
+ */ + ipAddress?: string; + + /** + *For RDP access, the password for your Amazon Lightsail instance. Password will be an empty + * string if the password for your new instance is not ready yet. When you create an instance, it + * can take up to 15 minutes for the instance to be ready.
+ *If you create an instance using any key pair other than the default
+ * (LightsailDefaultKeyPair), password will always be an empty
+ * string.
If you change the Administrator password on the instance, Lightsail will continue to + * return the original password value. When accessing the instance using RDP, you need to + * manually enter the Administrator password after changing it from the default.
+ *For a Windows Server-based instance, an object with the data you can use to retrieve your
+ * password. This is only needed if password is empty and the instance is not new
+ * (and therefore the password is not ready yet). When you create an instance, it can take up to
+ * 15 minutes for the instance to be ready.
For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH),
+ * you should save this value to tempkey).
The protocol for these Amazon Lightsail instance access details.
+ */ + protocol?: InstanceAccessProtocol | string; + + /** + *The name of this Amazon Lightsail instance.
+ */ + instanceName?: string; + + /** + *The user name to use when logging in to the Amazon Lightsail instance.
+ */ + username?: string; + + /** + *Describes the public SSH host keys or the RDP certificate.
+ */ + hostKeys?: HostKeyAttributes[]; +} + +export namespace InstanceAccessDetails { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InstanceAccessDetails): any => ({ + ...obj, + }); +} + +export interface GetInstanceAccessDetailsResult { + /** + *An array of key-value pairs containing information about a get instance access + * request.
+ */ + accessDetails?: InstanceAccessDetails; +} + +export namespace GetInstanceAccessDetailsResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetInstanceAccessDetailsResult): any => ({ + ...obj, + }); +} + +export enum InstanceMetricName { + BurstCapacityPercentage = "BurstCapacityPercentage", + BurstCapacityTime = "BurstCapacityTime", + CPUUtilization = "CPUUtilization", + NetworkIn = "NetworkIn", + NetworkOut = "NetworkOut", + StatusCheckFailed = "StatusCheckFailed", + StatusCheckFailed_Instance = "StatusCheckFailed_Instance", + StatusCheckFailed_System = "StatusCheckFailed_System", +} + +export interface GetInstanceMetricDataRequest { + /** + *The name of the instance for which you want to get metrics data.
+ */ + instanceName: string | undefined; + + /** + *The metric for which you want to return information.
+ *Valid instance metric names are listed below, along with the most useful
+ * statistics to include in your request, and the published unit
+ * value.
+ *
+ * BurstCapacityPercentage
+ * - The percentage
+ * of CPU performance available for your instance to burst above its baseline. Your instance
+ * continuously accrues and consumes burst capacity. Burst capacity stops accruing when your
+ * instance's BurstCapacityPercentage reaches 100%. For more information, see
+ * Viewing instance burst capacity in Amazon Lightsail.
+ * Statistics: The most useful statistics are Maximum and
+ * Average.
+ * Unit: The published unit is Percent.
+ *
+ * BurstCapacityTime
+ * - The available amount
+ * of time for your instance to burst at 100% CPU utilization. Your instance continuously
+ * accrues and consumes burst capacity. Burst capacity time stops accruing when your
+ * instance's BurstCapacityPercentage metric reaches 100%.
Burst capacity time is consumed at the full rate only when your instance operates at + * 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the + * burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% + * rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity + * minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
+ *
+ * Statistics: The most useful statistics are Maximum and
+ * Average.
+ * Unit: The published unit is Seconds.
+ *
+ * CPUUtilization
+ * - The percentage of
+ * allocated compute units that are currently in use on the instance. This metric identifies
+ * the processing power to run the applications on the instance. Tools in your operating
+ * system can show a lower percentage than Lightsail when the instance is not allocated a
+ * full processor core.
+ * Statistics: The most useful statistics are Maximum and
+ * Average.
+ * Unit: The published unit is Percent.
+ *
+ * NetworkIn
+ * - The number of bytes received
+ * on all network interfaces by the instance. This metric identifies the volume of incoming
+ * network traffic to the instance. The number reported is the number of bytes received
+ * during the period. Because this metric is reported in 5-minute intervals, divide the
+ * reported number by 300 to find Bytes/second.
+ * Statistics: The most useful statistic is Sum.
+ * Unit: The published unit is Bytes.
+ *
+ * NetworkOut
+ * - The number of bytes sent
+ * out on all network interfaces by the instance. This metric identifies the volume of
+ * outgoing network traffic from the instance. The number reported is the number of bytes
+ * sent during the period. Because this metric is reported in 5-minute intervals, divide the
+ * reported number by 300 to find Bytes/second.
+ * Statistics: The most useful statistic is Sum.
+ * Unit: The published unit is Bytes.
+ *
+ * StatusCheckFailed
+ * - Reports whether the
+ * instance passed or failed both the instance status check and the system status check. This
+ * metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute
+ * (60 seconds) granularity.
+ * Statistics: The most useful statistic is Sum.
+ * Unit: The published unit is Count.
+ *
+ * StatusCheckFailed_Instance
+ * - Reports
+ * whether the instance passed or failed the instance status check. This metric can be either
+ * 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds)
+ * granularity.
+ * Statistics: The most useful statistic is Sum.
+ * Unit: The published unit is Count.
+ *
+ * StatusCheckFailed_System
+ * - Reports
+ * whether the instance passed or failed the system status check. This metric can be either 0
+ * (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds)
+ * granularity.
+ * Statistics: The most useful statistic is Sum.
+ * Unit: The published unit is Count.
The granularity, in seconds, of the returned data points.
+ *The StatusCheckFailed, StatusCheckFailed_Instance, and
+ * StatusCheckFailed_System instance metric data is available in 1-minute (60
+ * seconds) granularity. All other instance metric data is available in 5-minute (300 seconds)
+ * granularity.
The start time of the time period.
+ */ + startTime: Date | undefined; + + /** + *The end time of the time period.
+ */ + endTime: Date | undefined; + + /** + *The unit for the metric data request. Valid units depend on the metric data being
+ * requested. For the valid units to specify with each available metric, see the
+ * metricName parameter.
The statistic for the metric.
+ *The following statistics are available:
+ *
+ * Minimum - The lowest value observed during the specified period. Use this
+ * value to determine low volumes of activity for your application.
+ * Maximum - The highest value observed during the specified period. Use
+ * this value to determine high volumes of activity for your application.
+ * Sum - All values submitted for the matching metric added together. You
+ * can use this statistic to determine the total volume of a metric.
+ * Average - The value of Sum / SampleCount during the specified period. By
+ * comparing this statistic with the Minimum and Maximum values, you can determine the full
+ * scope of a metric and how close the average use is to the Minimum and Maximum values. This
+ * comparison helps you to know when to increase or decrease your resources.
+ * SampleCount - The count, or number, of data points used for the
+ * statistical calculation.
The name of the metric returned.
+ */ + metricName?: InstanceMetricName | string; + + /** + *An array of objects that describe the metric data returned.
+ */ + metricData?: MetricDatapoint[]; +} + +export namespace GetInstanceMetricDataResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetInstanceMetricDataResult): any => ({ + ...obj, + }); +} + +export interface GetInstancePortStatesRequest { + /** + *The name of the instance for which to return firewall port states.
+ */ + instanceName: string | undefined; +} + +export namespace GetInstancePortStatesRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetInstancePortStatesRequest): any => ({ + ...obj, + }); +} + +export enum PortState { + Closed = "closed", + Open = "open", +} + +/** + *Describes open ports on an instance, the IP addresses allowed to connect to the instance + * through the ports, and the protocol.
+ */ +export interface InstancePortState { + /** + *The first port in a range of open ports on an instance.
+ *Allowed ports:
+ *TCP and UDP - 0 to 65535
+ *
ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the
+ * fromPort (ICMP type), and -1 as the toPort (ICMP
+ * code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as
+ * the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6
+ * code). For more information, see Internet
+ * Control Message Protocol for IPv6.
The last port in a range of open ports on an instance.
+ *Allowed ports:
+ *TCP and UDP - 0 to 65535
+ *
ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the
+ * fromPort (ICMP type), and -1 as the toPort (ICMP
+ * code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.
ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as
+ * the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6
+ * code). For more information, see Internet
+ * Control Message Protocol for IPv6.
The IP protocol name.
+ *The name can be one of the following:
+ *
+ * tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and
+ * error-checked delivery of streamed data between applications running on hosts
+ * communicating by an IP network. If you have an application that doesn't require reliable
+ * data stream service, use UDP instead.
+ * all - All transport layer protocol types. For more general information,
+ * see Transport layer on
+ * Wikipedia.
+ * udp - With User Datagram Protocol (UDP), computer applications can send
+ * messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior
+ * communications are not required to set up transmission channels or data paths.
+ * Applications that don't require reliable data stream service can use UDP, which provides a
+ * connectionless datagram service that emphasizes reduced latency over reliability. If you
+ * do require reliable data stream service, use TCP instead.
+ * icmp - Internet Control Message Protocol (ICMP) is used to send error
+ * messages and operational information indicating success or failure when communicating with
+ * an instance. For example, an error is indicated when an instance could not be reached.
+ * When you specify icmp as the protocol, you must specify the ICMP
+ * type using the fromPort parameter, and ICMP code using the
+ * toPort parameter.
Specifies whether the instance port is open or closed.
The port state for Lightsail instances is always open.
The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to + * connect to an instance through the ports, and the protocol.
+ *The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to
+ * connect to an instance.
For more information about CIDR block notation, see Classless + * Inter-Domain Routing on Wikipedia.
+ */ + cidrs?: string[]; + + /** + *The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to + * connect to an instance through the ports, and the protocol. Only devices with an IPv6 address + * can connect to an instance through IPv6; otherwise, IPv4 should be used.
+ *The cidrs parameter lists the IPv4 addresses that are allowed to connect to
+ * an instance.
For more information about CIDR block notation, see Classless + * Inter-Domain Routing on Wikipedia.
+ */ + ipv6Cidrs?: string[]; + + /** + *An alias that defines access for a preconfigured range of IP addresses.
+ *The only alias currently supported is lightsail-connect, which allows IP
+ * addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your
+ * instance.
An array of objects that describe the firewall port states for the specified + * instance.
+ */ + portStates?: InstancePortState[]; +} + +export namespace GetInstancePortStatesResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetInstancePortStatesResult): any => ({ + ...obj, + }); +} + +export interface GetInstancesRequest { + /** + *The token to advance to the next page of results from your request.
+ *To get a page token, perform an initial GetInstances request. If your results
+ * are paginated, the response will return a next page token that you can specify as the page
+ * token in a subsequent request.
An array of key-value pairs containing information about your instances.
+ */ + instances?: Instance[]; + + /** + *The token to advance to the next page of results from your request.
+ *A next page token is not returned if there are no more results to display.
+ *To get the next page of results, perform another GetInstances request and
+ * specify the next page token using the pageToken parameter.
The name of the snapshot for which you are requesting information.
+ */ + instanceSnapshotName: string | undefined; +} + +export namespace GetInstanceSnapshotRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetInstanceSnapshotRequest): any => ({ + ...obj, + }); +} + +export enum InstanceSnapshotState { + Available = "available", + Error = "error", + Pending = "pending", +} + +/** + *Describes an instance snapshot.
+ */ +export interface InstanceSnapshot { + /** + *The name of the snapshot.
+ */ + name?: string; + + /** + *The Amazon Resource Name (ARN) of the snapshot (e.g.,
+ * arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).
The support code. Include this code in your email to support when you have questions about + * an instance or another resource in Lightsail. This code enables our support team to look up + * your Lightsail information more easily.
+ */ + supportCode?: string; + + /** + *The timestamp when the snapshot was created (e.g., 1479907467.024).
The region name and Availability Zone where you created the snapshot.
+ */ + location?: ResourceLocation; + + /** + *The type of resource (usually InstanceSnapshot).
The tag keys and optional values for the resource. For more information about tags in + * Lightsail, see the Amazon Lightsail Developer Guide.
+ */ + tags?: Tag[]; + + /** + *The state the snapshot is in.
+ */ + state?: InstanceSnapshotState | string; + + /** + *The progress of the snapshot.
+ *This is populated only for disk snapshots, and is null for instance
+ * snapshots.
An array of disk objects containing information about all block storage disks.
+ */ + fromAttachedDisks?: Disk[]; + + /** + *The instance from which the snapshot was created.
+ */ + fromInstanceName?: string; + + /** + *The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g.,
+ * arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).
The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A
+ * blueprint is a virtual private server (or instance) image used to create
+ * instances quickly.
The bundle ID from which you created the snapshot (e.g., micro_1_0).
A Boolean value indicating whether the snapshot was created from an automatic + * snapshot.
+ */ + isFromAutoSnapshot?: boolean; + + /** + *The size in GB of the SSD.
+ */ + sizeInGb?: number; +} + +export namespace InstanceSnapshot { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InstanceSnapshot): any => ({ + ...obj, + }); +} + +export interface GetInstanceSnapshotResult { + /** + *An array of key-value pairs containing information about the results of your get instance + * snapshot request.
+ */ + instanceSnapshot?: InstanceSnapshot; +} + +export namespace GetInstanceSnapshotResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetInstanceSnapshotResult): any => ({ + ...obj, + }); +} + +export interface GetInstanceSnapshotsRequest { + /** + *The token to advance to the next page of results from your request.
+ *To get a page token, perform an initial GetInstanceSnapshots request. If your
+ * results are paginated, the response will return a next page token that you can specify as the
+ * page token in a subsequent request.
An array of key-value pairs containing information about the results of your get instance + * snapshots request.
+ */ + instanceSnapshots?: InstanceSnapshot[]; + + /** + *The token to advance to the next page of results from your request.
+ *A next page token is not returned if there are no more results to display.
+ *To get the next page of results, perform another GetInstanceSnapshots request
+ * and specify the next page token using the pageToken parameter.
The name of the instance to get state information about.
+ */ + instanceName: string | undefined; +} + +export namespace GetInstanceStateRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetInstanceStateRequest): any => ({ + ...obj, + }); +} + +export interface GetInstanceStateResult { + /** + *The state of the instance.
+ */ + state?: InstanceState; +} + +export namespace GetInstanceStateResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetInstanceStateResult): any => ({ + ...obj, + }); +} + export interface GetKeyPairRequest { /** *The name of the key pair for which you are requesting information.
@@ -337,7 +1413,7 @@ export namespace LoadBalancerTlsCertificateSummary { } /** - *Describes the Lightsail load balancer.
+ *Describes a load balancer.
*/ export interface LoadBalancer { /** @@ -375,8 +1451,7 @@ export interface LoadBalancer { /** *The tag keys and optional values for the resource. For more information about tags in - * Lightsail, see the Lightsail - * Dev Guide.
+ * Lightsail, see the Amazon Lightsail Developer Guide. */ tags?: Tag[]; @@ -1132,8 +2207,7 @@ export interface LoadBalancerTlsCertificate { /** *The tag keys and optional values for the resource. For more information about tags in - * Lightsail, see the Lightsail - * Dev Guide.
+ * Lightsail, see the Amazon Lightsail Developer Guide. */ tags?: Tag[]; @@ -1715,8 +2789,7 @@ export interface RelationalDatabase { /** *The tag keys and optional values for the resource. For more information about tags in - * Lightsail, see the Lightsail - * Dev Guide.
+ * Lightsail, see the Amazon Lightsail Developer Guide. */ tags?: Tag[]; @@ -2767,8 +3840,7 @@ export interface RelationalDatabaseSnapshot { /** *The tag keys and optional values for the resource. For more information about tags in - * Lightsail, see the Lightsail - * Dev Guide.
+ * Lightsail, see the Amazon Lightsail Developer Guide. */ tags?: Tag[]; @@ -2903,7 +3975,7 @@ export namespace GetStaticIpRequest { } /** - *Describes the static IP.
+ *Describes a static IP.
*/ export interface StaticIp { /** @@ -3691,6 +4763,69 @@ export namespace SetIpAddressTypeResult { }); } +export enum ResourceBucketAccess { + Allow = "allow", + Deny = "deny", +} + +export interface SetResourceAccessForBucketRequest { + /** + *The name of the Lightsail instance for which to set bucket access. The instance must be + * in a running or stopped state.
+ */ + resourceName: string | undefined; + + /** + *The name of the bucket for which to set access to another Lightsail resource.
+ */ + bucketName: string | undefined; + + /** + *The access setting.
+ * + *The following access settings are available:
+ * + *
+ * allow - Allows access to the bucket and its objects.
+ * deny - Denies access to the bucket and its objects. Use this setting to
+ * remove access for a resource previously set to allow.
An array of objects that describe the result of the action, such as the status of the + * request, the timestamp of the request, and the resources affected by the request.
+ */ + operations?: Operation[]; +} + +export namespace SetResourceAccessForBucketResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SetResourceAccessForBucketResult): any => ({ + ...obj, + }); +} + export interface StartInstanceRequest { /** *The name of the instance (a virtual private server) to start.
@@ -4008,6 +5143,115 @@ export namespace UntagResourceResult { }); } +export interface UpdateBucketRequest { + /** + *The name of the bucket to update.
+ */ + bucketName: string | undefined; + + /** + *An object that sets the public accessibility of objects in the specified bucket.
+ */ + accessRules?: AccessRules; + + /** + *Specifies whether to enable or suspend versioning of objects in the bucket.
+ * + *The following options can be specified:
+ *
+ * Enabled - Enables versioning of objects in the specified bucket.
+ * Suspended - Suspends versioning of objects in the specified bucket.
+ * Existing object versions are retained.
An array of strings to specify the AWS account IDs that can access the bucket.
+ * + *You can give a maximum of 10 AWS accounts access to a bucket.
+ */ + readonlyAccessAccounts?: string[]; +} + +export namespace UpdateBucketRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateBucketRequest): any => ({ + ...obj, + }); +} + +export interface UpdateBucketResult { + /** + *An object that describes the bucket that is updated.
+ */ + bucket?: Bucket; + + /** + *An array of objects that describe the result of the action, such as the status of the + * request, the timestamp of the request, and the resources affected by the request.
+ */ + operations?: Operation[]; +} + +export namespace UpdateBucketResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateBucketResult): any => ({ + ...obj, + }); +} + +export interface UpdateBucketBundleRequest { + /** + *The name of the bucket for which to update the bundle.
+ */ + bucketName: string | undefined; + + /** + *The ID of the new bundle to apply to the bucket.
+ * + *Use the GetBucketBundles action to get a list of bundle IDs that you can + * specify.
+ */ + bundleId: string | undefined; +} + +export namespace UpdateBucketBundleRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateBucketBundleRequest): any => ({ + ...obj, + }); +} + +export interface UpdateBucketBundleResult { + /** + *An array of objects that describe the result of the action, such as the status of the + * request, the timestamp of the request, and the resources affected by the request.
+ */ + operations?: Operation[]; +} + +export namespace UpdateBucketBundleResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateBucketBundleResult): any => ({ + ...obj, + }); +} + export interface UpdateContainerServiceRequest { /** *The name of the container service to update.
diff --git a/clients/client-lightsail/protocols/Aws_json1_1.ts b/clients/client-lightsail/protocols/Aws_json1_1.ts index 5c44e54246aba..98fd562e6144e 100644 --- a/clients/client-lightsail/protocols/Aws_json1_1.ts +++ b/clients/client-lightsail/protocols/Aws_json1_1.ts @@ -18,6 +18,11 @@ import { CloseInstancePublicPortsCommandOutput, } from "../commands/CloseInstancePublicPortsCommand"; import { CopySnapshotCommandInput, CopySnapshotCommandOutput } from "../commands/CopySnapshotCommand"; +import { + CreateBucketAccessKeyCommandInput, + CreateBucketAccessKeyCommandOutput, +} from "../commands/CreateBucketAccessKeyCommand"; +import { CreateBucketCommandInput, CreateBucketCommandOutput } from "../commands/CreateBucketCommand"; import { CreateCertificateCommandInput, CreateCertificateCommandOutput } from "../commands/CreateCertificateCommand"; import { CreateCloudFormationStackCommandInput, @@ -77,6 +82,11 @@ import { } from "../commands/CreateRelationalDatabaseSnapshotCommand"; import { DeleteAlarmCommandInput, DeleteAlarmCommandOutput } from "../commands/DeleteAlarmCommand"; import { DeleteAutoSnapshotCommandInput, DeleteAutoSnapshotCommandOutput } from "../commands/DeleteAutoSnapshotCommand"; +import { + DeleteBucketAccessKeyCommandInput, + DeleteBucketAccessKeyCommandOutput, +} from "../commands/DeleteBucketAccessKeyCommand"; +import { DeleteBucketCommandInput, DeleteBucketCommandOutput } from "../commands/DeleteBucketCommand"; import { DeleteCertificateCommandInput, DeleteCertificateCommandOutput } from "../commands/DeleteCertificateCommand"; import { DeleteContactMethodCommandInput, @@ -139,6 +149,16 @@ import { GetActiveNamesCommandInput, GetActiveNamesCommandOutput } from "../comm import { GetAlarmsCommandInput, GetAlarmsCommandOutput } from "../commands/GetAlarmsCommand"; import { GetAutoSnapshotsCommandInput, GetAutoSnapshotsCommandOutput } from "../commands/GetAutoSnapshotsCommand"; import { GetBlueprintsCommandInput, GetBlueprintsCommandOutput } from "../commands/GetBlueprintsCommand"; +import { + GetBucketAccessKeysCommandInput, + GetBucketAccessKeysCommandOutput, +} from "../commands/GetBucketAccessKeysCommand"; +import { GetBucketBundlesCommandInput, GetBucketBundlesCommandOutput } from "../commands/GetBucketBundlesCommand"; +import { + GetBucketMetricDataCommandInput, + GetBucketMetricDataCommandOutput, +} from "../commands/GetBucketMetricDataCommand"; +import { GetBucketsCommandInput, GetBucketsCommandOutput } from "../commands/GetBucketsCommand"; import { GetBundlesCommandInput, GetBundlesCommandOutput } from "../commands/GetBundlesCommand"; import { GetCertificatesCommandInput, GetCertificatesCommandOutput } from "../commands/GetCertificatesCommand"; import { @@ -314,6 +334,10 @@ import { SendContactMethodVerificationCommandOutput, } from "../commands/SendContactMethodVerificationCommand"; import { SetIpAddressTypeCommandInput, SetIpAddressTypeCommandOutput } from "../commands/SetIpAddressTypeCommand"; +import { + SetResourceAccessForBucketCommandInput, + SetResourceAccessForBucketCommandOutput, +} from "../commands/SetResourceAccessForBucketCommand"; import { StartInstanceCommandInput, StartInstanceCommandOutput } from "../commands/StartInstanceCommand"; import { StartRelationalDatabaseCommandInput, @@ -328,6 +352,8 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/T import { TestAlarmCommandInput, TestAlarmCommandOutput } from "../commands/TestAlarmCommand"; import { UnpeerVpcCommandInput, UnpeerVpcCommandOutput } from "../commands/UnpeerVpcCommand"; import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand"; +import { UpdateBucketBundleCommandInput, UpdateBucketBundleCommandOutput } from "../commands/UpdateBucketBundleCommand"; +import { UpdateBucketCommandInput, UpdateBucketCommandOutput } from "../commands/UpdateBucketCommand"; import { UpdateContainerServiceCommandInput, UpdateContainerServiceCommandOutput, @@ -352,6 +378,8 @@ import { } from "../commands/UpdateRelationalDatabaseParametersCommand"; import { AccessDeniedException, + AccessKey, + AccessRules, AccountSetupInProgressException, AddOn, AddOnRequest, @@ -374,6 +402,9 @@ import { AutoSnapshotDetails, AvailabilityZone, Blueprint, + Bucket, + BucketBundle, + BucketState, Bundle, CacheBehavior, CacheBehaviorPerPath, @@ -403,6 +434,10 @@ import { CookieObject, CopySnapshotRequest, CopySnapshotResult, + CreateBucketAccessKeyRequest, + CreateBucketAccessKeyResult, + CreateBucketRequest, + CreateBucketResult, CreateCertificateRequest, CreateCertificateResult, CreateCloudFormationStackRequest, @@ -449,6 +484,10 @@ import { DeleteAlarmResult, DeleteAutoSnapshotRequest, DeleteAutoSnapshotResult, + DeleteBucketAccessKeyRequest, + DeleteBucketAccessKeyResult, + DeleteBucketRequest, + DeleteBucketResult, DeleteCertificateRequest, DeleteCertificateResult, DeleteContactMethodRequest, @@ -520,6 +559,14 @@ import { GetAutoSnapshotsResult, GetBlueprintsRequest, GetBlueprintsResult, + GetBucketAccessKeysRequest, + GetBucketAccessKeysResult, + GetBucketBundlesRequest, + GetBucketBundlesResult, + GetBucketMetricDataRequest, + GetBucketMetricDataResult, + GetBucketsRequest, + GetBucketsResult, GetBundlesRequest, GetBundlesResult, GetCertificatesRequest, @@ -563,35 +610,15 @@ import { GetDomainsResult, GetExportSnapshotRecordsRequest, GetExportSnapshotRecordsResult, - GetInstanceAccessDetailsRequest, - GetInstanceAccessDetailsResult, - GetInstanceMetricDataRequest, - GetInstanceMetricDataResult, - GetInstancePortStatesRequest, - GetInstancePortStatesResult, GetInstanceRequest, - GetInstanceResult, - GetInstanceSnapshotRequest, - GetInstanceSnapshotResult, - GetInstanceSnapshotsRequest, - GetInstanceSnapshotsResult, - GetInstanceStateRequest, - GetInstanceStateResult, - GetInstancesRequest, - GetInstancesResult, HeaderEnum, HeaderObject, - HostKeyAttributes, InputOrigin, - Instance, - InstanceAccessDetails, InstanceEntry, InstanceHardware, InstanceNetworking, InstancePlatform, InstancePortInfo, - InstancePortState, - InstanceSnapshot, InstanceSnapshotInfo, InstanceState, InvalidInputException, @@ -605,17 +632,32 @@ import { Operation, OperationFailureException, Origin, - PasswordData, PortInfo, QueryStringObject, RenewalSummary, ResourceLocation, + ResourceReceivingAccess, ResourceRecord, ServiceException, Tag, UnauthenticatedException, } from "../models/models_0"; import { + GetInstanceAccessDetailsRequest, + GetInstanceAccessDetailsResult, + GetInstanceMetricDataRequest, + GetInstanceMetricDataResult, + GetInstancePortStatesRequest, + GetInstancePortStatesResult, + GetInstanceResult, + GetInstanceSnapshotRequest, + GetInstanceSnapshotResult, + GetInstanceSnapshotsRequest, + GetInstanceSnapshotsResult, + GetInstanceStateRequest, + GetInstanceStateResult, + GetInstancesRequest, + GetInstancesResult, GetKeyPairRequest, GetKeyPairResult, GetKeyPairsRequest, @@ -664,9 +706,14 @@ import { GetStaticIpResult, GetStaticIpsRequest, GetStaticIpsResult, + HostKeyAttributes, ImportKeyPairRequest, ImportKeyPairResult, + Instance, + InstanceAccessDetails, InstanceHealthSummary, + InstancePortState, + InstanceSnapshot, IsVpcPeeredRequest, IsVpcPeeredResult, LoadBalancer, @@ -679,6 +726,7 @@ import { LogEvent, OpenInstancePublicPortsRequest, OpenInstancePublicPortsResult, + PasswordData, PeerVpcRequest, PeerVpcResult, PendingMaintenanceAction, @@ -710,6 +758,8 @@ import { SendContactMethodVerificationResult, SetIpAddressTypeRequest, SetIpAddressTypeResult, + SetResourceAccessForBucketRequest, + SetResourceAccessForBucketResult, StartInstanceRequest, StartInstanceResult, StartRelationalDatabaseRequest, @@ -727,6 +777,10 @@ import { UnpeerVpcResult, UntagResourceRequest, UntagResourceResult, + UpdateBucketBundleRequest, + UpdateBucketBundleResult, + UpdateBucketRequest, + UpdateBucketResult, UpdateContainerServiceRequest, UpdateContainerServiceResult, UpdateDistributionBundleRequest, @@ -863,6 +917,32 @@ export const serializeAws_json1_1CopySnapshotCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1CreateBucketCommand = async ( + input: CreateBucketCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "Lightsail_20161128.CreateBucket", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1CreateBucketRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1CreateBucketAccessKeyCommand = async ( + input: CreateBucketAccessKeyCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "Lightsail_20161128.CreateBucketAccessKey", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1CreateBucketAccessKeyRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1CreateCertificateCommand = async ( input: CreateCertificateCommandInput, context: __SerdeContext @@ -1162,6 +1242,32 @@ export const serializeAws_json1_1DeleteAutoSnapshotCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1DeleteBucketCommand = async ( + input: DeleteBucketCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "Lightsail_20161128.DeleteBucket", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DeleteBucketRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DeleteBucketAccessKeyCommand = async ( + input: DeleteBucketAccessKeyCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "Lightsail_20161128.DeleteBucketAccessKey", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DeleteBucketAccessKeyRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1DeleteCertificateCommand = async ( input: DeleteCertificateCommandInput, context: __SerdeContext @@ -1539,6 +1645,58 @@ export const serializeAws_json1_1GetBlueprintsCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1GetBucketAccessKeysCommand = async ( + input: GetBucketAccessKeysCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "Lightsail_20161128.GetBucketAccessKeys", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1GetBucketAccessKeysRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1GetBucketBundlesCommand = async ( + input: GetBucketBundlesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "Lightsail_20161128.GetBucketBundles", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1GetBucketBundlesRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1GetBucketMetricDataCommand = async ( + input: GetBucketMetricDataCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "Lightsail_20161128.GetBucketMetricData", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1GetBucketMetricDataRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1GetBucketsCommand = async ( + input: GetBucketsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "Lightsail_20161128.GetBuckets", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1GetBucketsRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1GetBundlesCommand = async ( input: GetBundlesCommandInput, context: __SerdeContext @@ -2410,6 +2568,19 @@ export const serializeAws_json1_1SetIpAddressTypeCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1SetResourceAccessForBucketCommand = async ( + input: SetResourceAccessForBucketCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "Lightsail_20161128.SetResourceAccessForBucket", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1SetResourceAccessForBucketRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1StartInstanceCommand = async ( input: StartInstanceCommandInput, context: __SerdeContext @@ -2514,6 +2685,32 @@ export const serializeAws_json1_1UntagResourceCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1UpdateBucketCommand = async ( + input: UpdateBucketCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "Lightsail_20161128.UpdateBucket", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1UpdateBucketRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1UpdateBucketBundleCommand = async ( + input: UpdateBucketBundleCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "Lightsail_20161128.UpdateBucketBundle", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1UpdateBucketBundleRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1UpdateContainerServiceCommand = async ( input: UpdateContainerServiceCommandInput, context: __SerdeContext @@ -3413,27 +3610,27 @@ const deserializeAws_json1_1CopySnapshotCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; -export const deserializeAws_json1_1CreateCertificateCommand = async ( +export const deserializeAws_json1_1CreateBucketCommand = async ( output: __HttpResponse, context: __SerdeContext -): Promise