Amazon AppFlow is a fully managed integration service that enables you to securely * transfer data between software as a service (SaaS) applications like Salesforce, Marketo, - * Slack, and ServiceNow, and AWS services like Amazon S3 and Amazon Redshift.
+ * Slack, and ServiceNow, and Amazon Web Services like Amazon S3 and Amazon Redshift. * * * @@ -108,8 +108,8 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; */ export class Appflow extends AppflowClient { /** - *Creates a new connector profile associated with your AWS account. There is a soft quota - * of 100 connector profiles per AWS account. If you need more connector profiles than this quota + *
Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota + * of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota * allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support * channel.
*/ diff --git a/clients/client-appflow/AppflowClient.ts b/clients/client-appflow/AppflowClient.ts index ec8688b3b127..8787b215211b 100644 --- a/clients/client-appflow/AppflowClient.ts +++ b/clients/client-appflow/AppflowClient.ts @@ -277,7 +277,7 @@ export interface AppflowClientResolvedConfig extends AppflowClientResolvedConfig * *Amazon AppFlow is a fully managed integration service that enables you to securely * transfer data between software as a service (SaaS) applications like Salesforce, Marketo, - * Slack, and ServiceNow, and AWS services like Amazon S3 and Amazon Redshift.
+ * Slack, and ServiceNow, and Amazon Web Services like Amazon S3 and Amazon Redshift. * * * diff --git a/clients/client-appflow/README.md b/clients/client-appflow/README.md index d4411ca365cc..c1fe334f4142 100644 --- a/clients/client-appflow/README.md +++ b/clients/client-appflow/README.md @@ -12,7 +12,7 @@ detailed information about the Amazon AppFlow API operations, data types, and erAmazon AppFlow is a fully managed integration service that enables you to securely transfer data between software as a service (SaaS) applications like Salesforce, Marketo, -Slack, and ServiceNow, and AWS services like Amazon S3 and Amazon Redshift.
+Slack, and ServiceNow, and Amazon Web Services like Amazon S3 and Amazon Redshift.Use the following links to get started on the Amazon AppFlow API:
diff --git a/clients/client-appflow/commands/CreateConnectorProfileCommand.ts b/clients/client-appflow/commands/CreateConnectorProfileCommand.ts index 783aad88de86..ba8d2c80ce9c 100644 --- a/clients/client-appflow/commands/CreateConnectorProfileCommand.ts +++ b/clients/client-appflow/commands/CreateConnectorProfileCommand.ts @@ -21,8 +21,8 @@ export interface CreateConnectorProfileCommandInput extends CreateConnectorProfi export interface CreateConnectorProfileCommandOutput extends CreateConnectorProfileResponse, __MetadataBearer {} /** - *Creates a new connector profile associated with your AWS account. There is a soft quota - * of 100 connector profiles per AWS account. If you need more connector profiles than this quota + *
Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota + * of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota * allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support * channel.
* @example diff --git a/clients/client-appflow/models/models_0.ts b/clients/client-appflow/models/models_0.ts index 808fd32e3646..d933a929ec65 100644 --- a/clients/client-appflow/models/models_0.ts +++ b/clients/client-appflow/models/models_0.ts @@ -104,6 +104,31 @@ export namespace AmplitudeSourceProperties { }); } +/** + *The basic auth credentials required for basic authentication.
+ */ +export interface BasicAuthCredentials { + /** + *The username to use to connect to a resource.
+ */ + username: string | undefined; + + /** + *The password to use to connect to a resource.
+ */ + password: string | undefined; +} + +export namespace BasicAuthCredentials { + /** + * @internal + */ + export const filterSensitiveLog = (obj: BasicAuthCredentials): any => ({ + ...obj, + ...(obj.password && { password: SENSITIVE_STRING }), + }); +} + /** *There was a conflict when processing the request (for example, a flow with the given name * already exists within the account. Check for conflicting resource names and try again.
@@ -315,6 +340,20 @@ export namespace SalesforceMetadata { }); } +/** + *The connector metadata specific to SAPOData.
+ */ +export interface SAPODataMetadata {} + +export namespace SAPODataMetadata { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SAPODataMetadata): any => ({ + ...obj, + }); +} + /** *The connector metadata specific to ServiceNow.
*/ @@ -367,7 +406,7 @@ export namespace SlackMetadata { */ export interface SnowflakeMetadata { /** - *Specifies the supported AWS Regions when using Snowflake.
+ *Specifies the supported Amazon Web Services Regions when using Snowflake.
*/ supportedRegions?: string[]; } @@ -546,6 +585,11 @@ export interface ConnectorMetadata { *The connector metadata specific to Amazon Honeycode.
*/ Honeycode?: HoneycodeMetadata; + + /** + *The connector metadata specific to SAPOData.
+ */ + SAPOData?: SAPODataMetadata; } export namespace ConnectorMetadata { @@ -571,6 +615,7 @@ export enum ConnectorType { REDSHIFT = "Redshift", S3 = "S3", SALESFORCE = "Salesforce", + SAPODATA = "SAPOData", SERVICENOW = "Servicenow", SINGULAR = "Singular", SLACK = "Slack", @@ -1038,6 +1083,30 @@ export enum SalesforceConnectorOperator { VALIDATE_NUMERIC = "VALIDATE_NUMERIC", } +export enum SAPODataConnectorOperator { + ADDITION = "ADDITION", + BETWEEN = "BETWEEN", + CONTAINS = "CONTAINS", + DIVISION = "DIVISION", + EQUAL_TO = "EQUAL_TO", + GREATER_THAN = "GREATER_THAN", + GREATER_THAN_OR_EQUAL_TO = "GREATER_THAN_OR_EQUAL_TO", + LESS_THAN = "LESS_THAN", + LESS_THAN_OR_EQUAL_TO = "LESS_THAN_OR_EQUAL_TO", + MASK_ALL = "MASK_ALL", + MASK_FIRST_N = "MASK_FIRST_N", + MASK_LAST_N = "MASK_LAST_N", + MULTIPLICATION = "MULTIPLICATION", + NOT_EQUAL_TO = "NOT_EQUAL_TO", + NO_OP = "NO_OP", + PROJECTION = "PROJECTION", + SUBTRACTION = "SUBTRACTION", + VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE", + VALIDATE_NON_NULL = "VALIDATE_NON_NULL", + VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO", + VALIDATE_NUMERIC = "VALIDATE_NUMERIC", +} + export enum ServiceNowConnectorOperator { ADDITION = "ADDITION", BETWEEN = "BETWEEN", @@ -1232,6 +1301,11 @@ export interface ConnectorOperator { *The operation to be performed on the provided Zendesk source fields.
*/ Zendesk?: ZendeskConnectorOperator | string; + + /** + *The operation to be performed on the provided SAPOData source fields.
+ */ + SAPOData?: SAPODataConnectorOperator | string; } export namespace ConnectorOperator { @@ -1407,6 +1481,86 @@ export namespace SalesforceConnectorProfileProperties { }); } +/** + *The OAuth properties required for OAuth type authentication.
+ */ +export interface OAuthProperties { + /** + *The token url required to fetch access/refresh tokens using authorization code and also to refresh expired + * access token using refresh token.
+ */ + tokenUrl: string | undefined; + + /** + *The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type + * authentication.
+ */ + authCodeUrl: string | undefined; + + /** + *The OAuth scopes required for OAuth type authentication.
+ */ + oAuthScopes: string[] | undefined; +} + +export namespace OAuthProperties { + /** + * @internal + */ + export const filterSensitiveLog = (obj: OAuthProperties): any => ({ + ...obj, + }); +} + +/** + *The connector-specific profile properties required when using SAPOData.
+ */ +export interface SAPODataConnectorProfileProperties { + /** + *The location of the SAPOData resource.
+ */ + applicationHostUrl: string | undefined; + + /** + *The application path to catalog service.
+ */ + applicationServicePath: string | undefined; + + /** + *The port number of the SAPOData instance.
+ */ + portNumber: number | undefined; + + /** + *The client number for the client creating the connection.
+ */ + clientNumber: string | undefined; + + /** + *The logon language of SAPOData instance.
+ */ + logonLanguage?: string; + + /** + *The SAPOData Private Link service name to be used for private data transfers.
+ */ + privateLinkServiceName?: string; + + /** + *The SAPOData OAuth properties required for OAuth type authentication.
+ */ + oAuthProperties?: OAuthProperties; +} + +export namespace SAPODataConnectorProfileProperties { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SAPODataConnectorProfileProperties): any => ({ + ...obj, + }); +} + /** *The connector-specific profile properties required when using ServiceNow.
*/ @@ -1496,7 +1650,7 @@ export interface SnowflakeConnectorProfileProperties { accountName?: string; /** - *The AWS Region of the Snowflake account.
+ *The Amazon Web Services Region of the Snowflake account.
*/ region?: string; } @@ -1645,6 +1799,11 @@ export interface ConnectorProfileProperties { *The connector-specific properties required by Zendesk.
*/ Zendesk?: ZendeskConnectorProfileProperties; + + /** + *The connector-specific profile properties required when using SAPOData.
+ */ + SAPOData?: SAPODataConnectorProfileProperties; } export namespace ConnectorProfileProperties { @@ -1656,6 +1815,49 @@ export namespace ConnectorProfileProperties { }); } +export enum PrivateConnectionProvisioningFailureCause { + ACCESS_DENIED = "ACCESS_DENIED", + CONNECTOR_AUTHENTICATION = "CONNECTOR_AUTHENTICATION", + CONNECTOR_SERVER = "CONNECTOR_SERVER", + INTERNAL_SERVER = "INTERNAL_SERVER", + VALIDATION = "VALIDATION", +} + +export enum PrivateConnectionProvisioningStatus { + CREATED = "CREATED", + FAILED = "FAILED", + PENDING = "PENDING", +} + +/** + *Specifies the private connection provisioning state.
+ */ +export interface PrivateConnectionProvisioningState { + /** + *Specifies the private connection provisioning status.
+ */ + status?: PrivateConnectionProvisioningStatus | string; + + /** + *Specifies the private connection provisioning failure reason.
+ */ + failureMessage?: string; + + /** + *Specifies the private connection provisioning failure cause.
+ */ + failureCause?: PrivateConnectionProvisioningFailureCause | string; +} + +export namespace PrivateConnectionProvisioningState { + /** + * @internal + */ + export const filterSensitiveLog = (obj: PrivateConnectionProvisioningState): any => ({ + ...obj, + }); +} + /** *Describes an instance of a connector. This includes the provided name, credentials ARN, * connection-mode, and so on. To keep the API intuitive and extensible, the fields that are @@ -1671,7 +1873,7 @@ export interface ConnectorProfile { /** *
The name of the connector profile. The name is unique for each
- * ConnectorProfile in the AWS account.
ConnectorProfile in the Amazon Web Services account.
*/
connectorProfileName?: string;
@@ -1704,6 +1906,11 @@ export interface ConnectorProfile {
* Specifies when the connector profile was last updated.
*/ lastUpdatedAt?: Date; + + /** + *Specifies the private connection provisioning state.
+ */ + privateConnectionProvisioningState?: PrivateConnectionProvisioningState; } export namespace ConnectorProfile { @@ -1972,6 +2179,77 @@ export namespace SalesforceConnectorProfileCredentials { }); } +/** + *The OAuth credentials required for OAuth type authentication.
+ */ +export interface OAuthCredentials { + /** + *The identifier for the desired client.
+ */ + clientId: string | undefined; + + /** + *The client secret used by the OAuth client to authenticate to the authorization server. + *
+ */ + clientSecret: string | undefined; + + /** + *The access token used to access protected SAPOData resources.
+ */ + accessToken?: string; + + /** + *The refresh token used to refresh expired access token.
+ */ + refreshToken?: string; + + /** + *The OAuth requirement needed to request security tokens from the connector endpoint. + *
+ */ + oAuthRequest?: ConnectorOAuthRequest; +} + +export namespace OAuthCredentials { + /** + * @internal + */ + export const filterSensitiveLog = (obj: OAuthCredentials): any => ({ + ...obj, + ...(obj.clientSecret && { clientSecret: SENSITIVE_STRING }), + ...(obj.accessToken && { accessToken: SENSITIVE_STRING }), + }); +} + +/** + *The connector-specific profile credentials required when using SAPOData.
+ */ +export interface SAPODataConnectorProfileCredentials { + /** + *The SAPOData basic authentication credentials.
+ */ + basicAuthCredentials?: BasicAuthCredentials; + + /** + *The SAPOData OAuth type authentication credentials.
+ */ + oAuthCredentials?: OAuthCredentials; +} + +export namespace SAPODataConnectorProfileCredentials { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SAPODataConnectorProfileCredentials): any => ({ + ...obj, + ...(obj.basicAuthCredentials && { + basicAuthCredentials: BasicAuthCredentials.filterSensitiveLog(obj.basicAuthCredentials), + }), + ...(obj.oAuthCredentials && { oAuthCredentials: OAuthCredentials.filterSensitiveLog(obj.oAuthCredentials) }), + }); +} + /** *The connector-specific profile credentials required when using ServiceNow.
*/ @@ -2246,6 +2524,11 @@ export interface ConnectorProfileCredentials { *The connector-specific credentials required when using Zendesk.
*/ Zendesk?: ZendeskConnectorProfileCredentials; + + /** + *The connector-specific profile credentials required when using SAPOData.
+ */ + SAPOData?: SAPODataConnectorProfileCredentials; } export namespace ConnectorProfileCredentials { @@ -2269,6 +2552,7 @@ export namespace ConnectorProfileCredentials { ...(obj.Trendmicro && { Trendmicro: TrendmicroConnectorProfileCredentials.filterSensitiveLog(obj.Trendmicro) }), ...(obj.Veeva && { Veeva: VeevaConnectorProfileCredentials.filterSensitiveLog(obj.Veeva) }), ...(obj.Zendesk && { Zendesk: ZendeskConnectorProfileCredentials.filterSensitiveLog(obj.Zendesk) }), + ...(obj.SAPOData && { SAPOData: SAPODataConnectorProfileCredentials.filterSensitiveLog(obj.SAPOData) }), }); } @@ -2321,7 +2605,7 @@ export namespace ConnectorServerException { export interface CreateConnectorProfileRequest { /** * The name of the connector profile. The name is unique for each
- * ConnectorProfile in your AWS account.
ConnectorProfile in your Amazon Web Services account.
*/
connectorProfileName: string | undefined;
@@ -2340,7 +2624,7 @@ export interface CreateConnectorProfileRequest {
/**
* Indicates the connection mode and specifies whether it is public or private. Private - * flows use AWS PrivateLink to route data over AWS infrastructure without exposing it to the + * flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the * public internet.
*/ connectionMode: ConnectionMode | string | undefined; @@ -2973,7 +3257,7 @@ export interface DestinationFlowConfig { /** *The name of the connector profile. This name must be unique for each connector profile in - * the AWS account.
+ * the Amazon Web Services account. */ connectorProfileName?: string; @@ -3162,6 +3446,25 @@ export namespace SalesforceSourceProperties { }); } +/** + *The properties that are applied when using SAPOData as a flow source.
+ */ +export interface SAPODataSourceProperties { + /** + *The object path specified in the SAPOData flow source.
+ */ + objectPath?: string; +} + +export namespace SAPODataSourceProperties { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SAPODataSourceProperties): any => ({ + ...obj, + }); +} + /** *The properties that are applied when ServiceNow is being used as a source.
*/ @@ -3246,6 +3549,26 @@ export interface VeevaSourceProperties { *The object specified in the Veeva flow source.
*/ object: string | undefined; + + /** + *The document type specified in the Veeva document extract flow.
+ */ + documentType?: string; + + /** + *Boolean value to include source files in Veeva document extract flow.
+ */ + includeSourceFiles?: boolean; + + /** + *Boolean value to include file renditions in Veeva document extract flow.
+ */ + includeRenditions?: boolean; + + /** + *Boolean value to include All Versions of files in Veeva document extract flow.
+ */ + includeAllVersions?: boolean; } export namespace VeevaSourceProperties { @@ -3349,6 +3672,11 @@ export interface SourceConnectorProperties { *Specifies the information that is required for querying Zendesk.
*/ Zendesk?: ZendeskSourceProperties; + + /** + *The properties that are applied when using SAPOData as a flow source.
+ */ + SAPOData?: SAPODataSourceProperties; } export namespace SourceConnectorProperties { @@ -3372,7 +3700,7 @@ export interface SourceFlowConfig { /** *The name of the connector profile. This name must be unique for each connector profile in - * the AWS account.
+ * the Amazon Web Services account. */ connectorProfileName?: string; @@ -3766,7 +4094,7 @@ export interface DescribeConnectorEntityRequest { /** * The name of the connector profile. The name is unique for each
- * ConnectorProfile in the AWS account.
ConnectorProfile in the Amazon Web Services account.
*/
connectorProfileName?: string;
}
@@ -3801,7 +4129,7 @@ export namespace DescribeConnectorEntityResponse {
export interface DescribeConnectorProfilesRequest {
/**
* The name of the connector profile. The name is unique for each
- * ConnectorProfile in the AWS account.
ConnectorProfile in the Amazon Web Services account.
*/
connectorProfileNames?: string[];
@@ -4294,7 +4622,7 @@ export namespace FlowDefinition {
export interface ListConnectorEntitiesRequest {
/**
* The name of the connector profile. The name is unique for each
- * ConnectorProfile in the AWS account, and is used to query the downstream
+ * ConnectorProfile in the Amazon Web Services account, and is used to query the downstream
* connector.
The name of the connector profile and is unique for each ConnectorProfile in
- * the AWS Account.
Contains information about the configuration of the source connector used in the flow. *
*/ - sourceFlowConfig?: SourceFlowConfig; + sourceFlowConfig: SourceFlowConfig | undefined; /** *The configuration that controls how Amazon AppFlow transfers data to the destination diff --git a/clients/client-appflow/protocols/Aws_restJson1.ts b/clients/client-appflow/protocols/Aws_restJson1.ts index d117716fc787..0862ecfdab22 100644 --- a/clients/client-appflow/protocols/Aws_restJson1.ts +++ b/clients/client-appflow/protocols/Aws_restJson1.ts @@ -46,6 +46,7 @@ import { AmplitudeConnectorProfileProperties, AmplitudeMetadata, AmplitudeSourceProperties, + BasicAuthCredentials, ConflictException, ConnectorAuthenticationException, ConnectorConfiguration, @@ -101,9 +102,12 @@ import { MarketoConnectorProfileProperties, MarketoMetadata, MarketoSourceProperties, + OAuthCredentials, + OAuthProperties, Operator, OperatorPropertiesKeys, PrefixConfig, + PrivateConnectionProvisioningState, RedshiftConnectorProfileCredentials, RedshiftConnectorProfileProperties, RedshiftDestinationProperties, @@ -113,6 +117,10 @@ import { S3Metadata, S3OutputFormatConfig, S3SourceProperties, + SAPODataConnectorProfileCredentials, + SAPODataConnectorProfileProperties, + SAPODataMetadata, + SAPODataSourceProperties, SalesforceConnectorProfileCredentials, SalesforceConnectorProfileProperties, SalesforceDestinationProperties, @@ -2363,6 +2371,13 @@ const serializeAws_restJson1AmplitudeSourceProperties = ( }; }; +const serializeAws_restJson1BasicAuthCredentials = (input: BasicAuthCredentials, context: __SerdeContext): any => { + return { + ...(input.password !== undefined && input.password !== null && { password: input.password }), + ...(input.username !== undefined && input.username !== null && { username: input.username }), + }; +}; + const serializeAws_restJson1ConnectorOAuthRequest = (input: ConnectorOAuthRequest, context: __SerdeContext): any => { return { ...(input.authCode !== undefined && input.authCode !== null && { authCode: input.authCode }), @@ -2380,6 +2395,7 @@ const serializeAws_restJson1ConnectorOperator = (input: ConnectorOperator, conte ...(input.InforNexus !== undefined && input.InforNexus !== null && { InforNexus: input.InforNexus }), ...(input.Marketo !== undefined && input.Marketo !== null && { Marketo: input.Marketo }), ...(input.S3 !== undefined && input.S3 !== null && { S3: input.S3 }), + ...(input.SAPOData !== undefined && input.SAPOData !== null && { SAPOData: input.SAPOData }), ...(input.Salesforce !== undefined && input.Salesforce !== null && { Salesforce: input.Salesforce }), ...(input.ServiceNow !== undefined && input.ServiceNow !== null && { ServiceNow: input.ServiceNow }), ...(input.Singular !== undefined && input.Singular !== null && { Singular: input.Singular }), @@ -2449,6 +2465,10 @@ const serializeAws_restJson1ConnectorProfileCredentials = ( input.Redshift !== null && { Redshift: serializeAws_restJson1RedshiftConnectorProfileCredentials(input.Redshift, context), }), + ...(input.SAPOData !== undefined && + input.SAPOData !== null && { + SAPOData: serializeAws_restJson1SAPODataConnectorProfileCredentials(input.SAPOData, context), + }), ...(input.Salesforce !== undefined && input.Salesforce !== null && { Salesforce: serializeAws_restJson1SalesforceConnectorProfileCredentials(input.Salesforce, context), @@ -2531,6 +2551,10 @@ const serializeAws_restJson1ConnectorProfileProperties = ( input.Redshift !== null && { Redshift: serializeAws_restJson1RedshiftConnectorProfileProperties(input.Redshift, context), }), + ...(input.SAPOData !== undefined && + input.SAPOData !== null && { + SAPOData: serializeAws_restJson1SAPODataConnectorProfileProperties(input.SAPOData, context), + }), ...(input.Salesforce !== undefined && input.Salesforce !== null && { Salesforce: serializeAws_restJson1SalesforceConnectorProfileProperties(input.Salesforce, context), @@ -2892,6 +2916,39 @@ const serializeAws_restJson1MarketoSourceProperties = ( }; }; +const serializeAws_restJson1OAuthCredentials = (input: OAuthCredentials, context: __SerdeContext): any => { + return { + ...(input.accessToken !== undefined && input.accessToken !== null && { accessToken: input.accessToken }), + ...(input.clientId !== undefined && input.clientId !== null && { clientId: input.clientId }), + ...(input.clientSecret !== undefined && input.clientSecret !== null && { clientSecret: input.clientSecret }), + ...(input.oAuthRequest !== undefined && + input.oAuthRequest !== null && { + oAuthRequest: serializeAws_restJson1ConnectorOAuthRequest(input.oAuthRequest, context), + }), + ...(input.refreshToken !== undefined && input.refreshToken !== null && { refreshToken: input.refreshToken }), + }; +}; + +const serializeAws_restJson1OAuthProperties = (input: OAuthProperties, context: __SerdeContext): any => { + return { + ...(input.authCodeUrl !== undefined && input.authCodeUrl !== null && { authCodeUrl: input.authCodeUrl }), + ...(input.oAuthScopes !== undefined && + input.oAuthScopes !== null && { oAuthScopes: serializeAws_restJson1OAuthScopeList(input.oAuthScopes, context) }), + ...(input.tokenUrl !== undefined && input.tokenUrl !== null && { tokenUrl: input.tokenUrl }), + }; +}; + +const serializeAws_restJson1OAuthScopeList = (input: string[], context: __SerdeContext): any => { + return input + .filter((e: any) => e != null) + .map((entry) => { + if (entry === null) { + return null as any; + } + return entry; + }); +}; + const serializeAws_restJson1PrefixConfig = (input: PrefixConfig, context: __SerdeContext): any => { return { ...(input.prefixFormat !== undefined && input.prefixFormat !== null && { prefixFormat: input.prefixFormat }), @@ -3029,6 +3086,52 @@ const serializeAws_restJson1SalesforceSourceProperties = ( }; }; +const serializeAws_restJson1SAPODataConnectorProfileCredentials = ( + input: SAPODataConnectorProfileCredentials, + context: __SerdeContext +): any => { + return { + ...(input.basicAuthCredentials !== undefined && + input.basicAuthCredentials !== null && { + basicAuthCredentials: serializeAws_restJson1BasicAuthCredentials(input.basicAuthCredentials, context), + }), + ...(input.oAuthCredentials !== undefined && + input.oAuthCredentials !== null && { + oAuthCredentials: serializeAws_restJson1OAuthCredentials(input.oAuthCredentials, context), + }), + }; +}; + +const serializeAws_restJson1SAPODataConnectorProfileProperties = ( + input: SAPODataConnectorProfileProperties, + context: __SerdeContext +): any => { + return { + ...(input.applicationHostUrl !== undefined && + input.applicationHostUrl !== null && { applicationHostUrl: input.applicationHostUrl }), + ...(input.applicationServicePath !== undefined && + input.applicationServicePath !== null && { applicationServicePath: input.applicationServicePath }), + ...(input.clientNumber !== undefined && input.clientNumber !== null && { clientNumber: input.clientNumber }), + ...(input.logonLanguage !== undefined && input.logonLanguage !== null && { logonLanguage: input.logonLanguage }), + ...(input.oAuthProperties !== undefined && + input.oAuthProperties !== null && { + oAuthProperties: serializeAws_restJson1OAuthProperties(input.oAuthProperties, context), + }), + ...(input.portNumber !== undefined && input.portNumber !== null && { portNumber: input.portNumber }), + ...(input.privateLinkServiceName !== undefined && + input.privateLinkServiceName !== null && { privateLinkServiceName: input.privateLinkServiceName }), + }; +}; + +const serializeAws_restJson1SAPODataSourceProperties = ( + input: SAPODataSourceProperties, + context: __SerdeContext +): any => { + return { + ...(input.objectPath !== undefined && input.objectPath !== null && { objectPath: input.objectPath }), + }; +}; + const serializeAws_restJson1ScheduledTriggerProperties = ( input: ScheduledTriggerProperties, context: __SerdeContext @@ -3203,6 +3306,8 @@ const serializeAws_restJson1SourceConnectorProperties = ( input.Marketo !== null && { Marketo: serializeAws_restJson1MarketoSourceProperties(input.Marketo, context) }), ...(input.S3 !== undefined && input.S3 !== null && { S3: serializeAws_restJson1S3SourceProperties(input.S3, context) }), + ...(input.SAPOData !== undefined && + input.SAPOData !== null && { SAPOData: serializeAws_restJson1SAPODataSourceProperties(input.SAPOData, context) }), ...(input.Salesforce !== undefined && input.Salesforce !== null && { Salesforce: serializeAws_restJson1SalesforceSourceProperties(input.Salesforce, context), @@ -3406,6 +3511,13 @@ const serializeAws_restJson1VeevaConnectorProfileProperties = ( const serializeAws_restJson1VeevaSourceProperties = (input: VeevaSourceProperties, context: __SerdeContext): any => { return { + ...(input.documentType !== undefined && input.documentType !== null && { documentType: input.documentType }), + ...(input.includeAllVersions !== undefined && + input.includeAllVersions !== null && { includeAllVersions: input.includeAllVersions }), + ...(input.includeRenditions !== undefined && + input.includeRenditions !== null && { includeRenditions: input.includeRenditions }), + ...(input.includeSourceFiles !== undefined && + input.includeSourceFiles !== null && { includeSourceFiles: input.includeSourceFiles }), ...(input.object !== undefined && input.object !== null && { object: input.object }), }; }; @@ -3648,6 +3760,10 @@ const deserializeAws_restJson1ConnectorMetadata = (output: any, context: __Serde output.S3 !== undefined && output.S3 !== null ? deserializeAws_restJson1S3Metadata(output.S3, context) : undefined, + SAPOData: + output.SAPOData !== undefined && output.SAPOData !== null + ? deserializeAws_restJson1SAPODataMetadata(output.SAPOData, context) + : undefined, Salesforce: output.Salesforce !== undefined && output.Salesforce !== null ? deserializeAws_restJson1SalesforceMetadata(output.Salesforce, context) @@ -3696,6 +3812,7 @@ const deserializeAws_restJson1ConnectorOperator = (output: any, context: __Serde InforNexus: __expectString(output.InforNexus), Marketo: __expectString(output.Marketo), S3: __expectString(output.S3), + SAPOData: __expectString(output.SAPOData), Salesforce: __expectString(output.Salesforce), ServiceNow: __expectString(output.ServiceNow), Singular: __expectString(output.Singular), @@ -3725,6 +3842,10 @@ const deserializeAws_restJson1ConnectorProfile = (output: any, context: __SerdeC output.lastUpdatedAt !== undefined && output.lastUpdatedAt !== null ? new Date(Math.round(output.lastUpdatedAt * 1000)) : undefined, + privateConnectionProvisioningState: + output.privateConnectionProvisioningState !== undefined && output.privateConnectionProvisioningState !== null + ? deserializeAws_restJson1PrivateConnectionProvisioningState(output.privateConnectionProvisioningState, context) + : undefined, } as any; }; @@ -3779,6 +3900,10 @@ const deserializeAws_restJson1ConnectorProfileProperties = ( output.Redshift !== undefined && output.Redshift !== null ? deserializeAws_restJson1RedshiftConnectorProfileProperties(output.Redshift, context) : undefined, + SAPOData: + output.SAPOData !== undefined && output.SAPOData !== null + ? deserializeAws_restJson1SAPODataConnectorProfileProperties(output.SAPOData, context) + : undefined, Salesforce: output.Salesforce !== undefined && output.Salesforce !== null ? deserializeAws_restJson1SalesforceConnectorProfileProperties(output.Salesforce, context) @@ -4262,6 +4387,17 @@ const deserializeAws_restJson1MarketoSourceProperties = ( } as any; }; +const deserializeAws_restJson1OAuthProperties = (output: any, context: __SerdeContext): OAuthProperties => { + return { + authCodeUrl: __expectString(output.authCodeUrl), + oAuthScopes: + output.oAuthScopes !== undefined && output.oAuthScopes !== null + ? deserializeAws_restJson1OAuthScopeList(output.oAuthScopes, context) + : undefined, + tokenUrl: __expectString(output.tokenUrl), + } as any; +}; + const deserializeAws_restJson1OAuthScopeList = (output: any, context: __SerdeContext): string[] => { return (output || []) .filter((e: any) => e != null) @@ -4280,6 +4416,17 @@ const deserializeAws_restJson1PrefixConfig = (output: any, context: __SerdeConte } as any; }; +const deserializeAws_restJson1PrivateConnectionProvisioningState = ( + output: any, + context: __SerdeContext +): PrivateConnectionProvisioningState => { + return { + failureCause: __expectString(output.failureCause), + failureMessage: __expectString(output.failureMessage), + status: __expectString(output.status), + } as any; +}; + const deserializeAws_restJson1RedshiftConnectorProfileProperties = ( output: any, context: __SerdeContext @@ -4409,6 +4556,37 @@ const deserializeAws_restJson1SalesforceSourceProperties = ( } as any; }; +const deserializeAws_restJson1SAPODataConnectorProfileProperties = ( + output: any, + context: __SerdeContext +): SAPODataConnectorProfileProperties => { + return { + applicationHostUrl: __expectString(output.applicationHostUrl), + applicationServicePath: __expectString(output.applicationServicePath), + clientNumber: __expectString(output.clientNumber), + logonLanguage: __expectString(output.logonLanguage), + oAuthProperties: + output.oAuthProperties !== undefined && output.oAuthProperties !== null + ? deserializeAws_restJson1OAuthProperties(output.oAuthProperties, context) + : undefined, + portNumber: __expectInt(output.portNumber), + privateLinkServiceName: __expectString(output.privateLinkServiceName), + } as any; +}; + +const deserializeAws_restJson1SAPODataMetadata = (output: any, context: __SerdeContext): SAPODataMetadata => { + return {} as any; +}; + +const deserializeAws_restJson1SAPODataSourceProperties = ( + output: any, + context: __SerdeContext +): SAPODataSourceProperties => { + return { + objectPath: __expectString(output.objectPath), + } as any; +}; + const deserializeAws_restJson1ScheduledTriggerProperties = ( output: any, context: __SerdeContext @@ -4585,6 +4763,10 @@ const deserializeAws_restJson1SourceConnectorProperties = ( output.S3 !== undefined && output.S3 !== null ? deserializeAws_restJson1S3SourceProperties(output.S3, context) : undefined, + SAPOData: + output.SAPOData !== undefined && output.SAPOData !== null + ? deserializeAws_restJson1SAPODataSourceProperties(output.SAPOData, context) + : undefined, Salesforce: output.Salesforce !== undefined && output.Salesforce !== null ? deserializeAws_restJson1SalesforceSourceProperties(output.Salesforce, context) @@ -4843,6 +5025,10 @@ const deserializeAws_restJson1VeevaMetadata = (output: any, context: __SerdeCont const deserializeAws_restJson1VeevaSourceProperties = (output: any, context: __SerdeContext): VeevaSourceProperties => { return { + documentType: __expectString(output.documentType), + includeAllVersions: __expectBoolean(output.includeAllVersions), + includeRenditions: __expectBoolean(output.includeRenditions), + includeSourceFiles: __expectBoolean(output.includeSourceFiles), object: __expectString(output.object), } as any; }; diff --git a/clients/client-application-auto-scaling/ApplicationAutoScaling.ts b/clients/client-application-auto-scaling/ApplicationAutoScaling.ts index 8aadb34274a0..b946a2f69c3d 100644 --- a/clients/client-application-auto-scaling/ApplicationAutoScaling.ts +++ b/clients/client-application-auto-scaling/ApplicationAutoScaling.ts @@ -56,40 +56,43 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; * resources:
*Amazon ECS services
+ *Amazon AppStream 2.0 fleets
*Amazon EC2 Spot Fleet requests
+ *Amazon Aurora Replicas
*Amazon EMR clusters
+ *Amazon Comprehend document classification and entity recognizer endpoints
*Amazon AppStream 2.0 fleets
+ *Amazon DynamoDB tables and global secondary indexes throughput capacity
*Amazon DynamoDB tables and global secondary indexes throughput capacity
+ *Amazon ECS services
*Amazon Aurora Replicas
+ *Amazon ElastiCache for Redis clusters (replication groups)
*Amazon SageMaker endpoint variants
+ *Amazon EMR clusters
*Custom resources provided by your own applications or services
+ *Amazon Keyspaces (for Apache Cassandra) tables
*Amazon Comprehend document classification and entity recognizer endpoints
+ *Lambda function provisioned concurrency
*AWS Lambda function provisioned concurrency
+ *Amazon Managed Streaming for Apache Kafka broker storage
*Amazon Keyspaces (for Apache Cassandra) tables
+ *Amazon SageMaker endpoint variants
*Amazon Managed Streaming for Apache Kafka broker storage
+ *Spot Fleet (Amazon EC2) requests
+ *Custom resources provided by your own applications or services
*@@ -98,7 +101,7 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; *
The Application Auto Scaling service API includes three key sets of actions:
*Register and manage scalable targets - Register AWS or custom resources as scalable + *
Register and manage scalable targets - Register Amazon Web Services or custom resources as scalable * targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and * retrieve information on existing scalable targets.
*Amazon ECS services
+ *Amazon AppStream 2.0 fleets
*Amazon EC2 Spot Fleet requests
+ *Amazon Aurora Replicas
*Amazon EMR clusters
+ *Amazon Comprehend document classification and entity recognizer endpoints
*Amazon AppStream 2.0 fleets
+ *Amazon DynamoDB tables and global secondary indexes throughput capacity
*Amazon DynamoDB tables and global secondary indexes throughput capacity
+ *Amazon ECS services
*Amazon Aurora Replicas
+ *Amazon ElastiCache for Redis clusters (replication groups)
*Amazon SageMaker endpoint variants
+ *Amazon EMR clusters
*Custom resources provided by your own applications or services
+ *Amazon Keyspaces (for Apache Cassandra) tables
*Amazon Comprehend document classification and entity recognizer endpoints
+ *Lambda function provisioned concurrency
*AWS Lambda function provisioned concurrency
+ *Amazon Managed Streaming for Apache Kafka broker storage
*Amazon Keyspaces (for Apache Cassandra) tables
+ *Amazon SageMaker endpoint variants
*Amazon Managed Streaming for Apache Kafka broker storage
+ *Spot Fleet (Amazon EC2) requests
+ *Custom resources provided by your own applications or services
*@@ -294,7 +297,7 @@ export interface ApplicationAutoScalingClientResolvedConfig extends ApplicationA *
The Application Auto Scaling service API includes three key sets of actions:
*Register and manage scalable targets - Register AWS or custom resources as scalable + *
Register and manage scalable targets - Register Amazon Web Services or custom resources as scalable * targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and * retrieve information on existing scalable targets.
*Amazon ECS services
+Amazon AppStream 2.0 fleets
Amazon EC2 Spot Fleet requests
+Amazon Aurora Replicas
Amazon EMR clusters
+Amazon Comprehend document classification and entity recognizer endpoints
Amazon AppStream 2.0 fleets
+Amazon DynamoDB tables and global secondary indexes throughput capacity
Amazon DynamoDB tables and global secondary indexes throughput capacity
+Amazon ECS services
Amazon Aurora Replicas
+Amazon ElastiCache for Redis clusters (replication groups)
Amazon SageMaker endpoint variants
+Amazon EMR clusters
Custom resources provided by your own applications or services
+Amazon Keyspaces (for Apache Cassandra) tables
Amazon Comprehend document classification and entity recognizer endpoints
+Lambda function provisioned concurrency
AWS Lambda function provisioned concurrency
+Amazon Managed Streaming for Apache Kafka broker storage
Amazon Keyspaces (for Apache Cassandra) tables
+Amazon SageMaker endpoint variants
Amazon Managed Streaming for Apache Kafka broker storage
+Spot Fleet (Amazon EC2) requests
+Custom resources provided by your own applications or services
@@ -53,7 +56,7 @@ resources:
The Application Auto Scaling service API includes three key sets of actions:
Register and manage scalable targets - Register AWS or custom resources as scalable +
Register and manage scalable targets - Register Amazon Web Services or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.
The namespace of the AWS service that provides the resource. For a resource provided + *
The namespace of the Amazon Web Services service that provides the resource. For a resource provided
* by your own application or service, use custom-resource instead.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
* Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
+ * Example: replication-group/mycluster.
- * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
*
- * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
* @@ -224,12 +231,20 @@ export interface DeleteScalingPolicyRequest { *
- * cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
*
* kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ * elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ * elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
The namespace of the AWS service that provides the resource. For a resource provided + *
The namespace of the Amazon Web Services service that provides the resource. For a resource provided
* by your own application or service, use custom-resource instead.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
* Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
+ * Example: replication-group/mycluster.
- * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
*
- * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
* @@ -454,12 +473,20 @@ export interface DeleteScheduledActionRequest { *
- * cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
*
* kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ * elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ * elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
The namespace of the AWS service that provides the resource. For a resource provided + *
The namespace of the Amazon Web Services service that provides the resource. For a resource provided
* by your own application or service, use custom-resource instead.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
* Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
+ * Example: replication-group/mycluster.
- * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
*
- * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
* @@ -621,12 +652,20 @@ export interface DeregisterScalableTargetRequest { *
- * cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
*
* kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ * elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ * elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
The namespace of the AWS service that provides the resource. For a resource provided + *
The namespace of the Amazon Web Services service that provides the resource. For a resource provided
* by your own application or service, use custom-resource instead.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
* Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
+ * Example: replication-group/mycluster.
- * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
*
- * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
* @@ -788,12 +831,20 @@ export interface DescribeScalableTargetsRequest { *
- * cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
*
* kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ * elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ * elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
The namespace of the AWS service that provides the resource, or a + *
The namespace of the Amazon Web Services service that provides the resource, or a
* custom-resource.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
* Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
+ * Example: replication-group/mycluster.
- * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
*
- * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
* @@ -999,12 +1054,20 @@ export interface ScalableTarget { *
- * cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
*
* kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ * elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ * elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
The namespace of the AWS service that provides the resource. For a resource provided + *
The namespace of the Amazon Web Services service that provides the resource. For a resource provided
* by your own application or service, use custom-resource instead.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
* Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
+ * Example: replication-group/mycluster.
- * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
*
- * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
* @@ -1222,12 +1289,20 @@ export interface DescribeScalingActivitiesRequest { *
- * cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
*
* kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ * elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ * elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
The namespace of the AWS service that provides the resource, or a + *
The namespace of the Amazon Web Services service that provides the resource, or a
* custom-resource.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
* Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
+ * Example: replication-group/mycluster.
- * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
*
- * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
* @@ -1410,12 +1489,20 @@ export interface ScalingActivity { *
- * cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
*
* kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ * elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ * elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
The namespace of the AWS service that provides the resource. For a resource provided + *
The namespace of the Amazon Web Services service that provides the resource. For a resource provided
* by your own application or service, use custom-resource instead.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
* Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
+ * Example: replication-group/mycluster.
- * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
*
- * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
* @@ -1628,12 +1719,20 @@ export interface DescribeScalingPoliciesRequest { *
- * cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
*
* kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ * elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ * elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
Application Auto Scaling provides a default value of 300 for the following scalable targets:
+ *Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups + * and a default value of 300 for the following scalable targets:
*ECS services
@@ -1898,7 +1998,7 @@ export enum MetricStatistic { /** *Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use * with Application Auto Scaling.
- *For information about the available metrics for a service, see AWS
+ * For information about the available metrics for a service, see Amazon Web Services
* Services That Publish CloudWatch Metrics in the Amazon CloudWatch User
* Guide. To create your customized metric specification: Represents a predefined metric for a target tracking scaling policy to use with
* Application Auto Scaling. Only the AWS services that you're using send metrics to Amazon CloudWatch. To determine whether a
+ * Only the Amazon Web Services that you're using send metrics to Amazon CloudWatch. To determine whether a
* desired metric already exists by looking up its namespace and dimension using the CloudWatch
* metrics dashboard in the console, follow the procedure in Building dashboards
* with CloudWatch in the Application Auto Scaling User Guide.ALBRequestCountPerTarget and there is a target
* group attached to the Spot Fleet request or ECS service.
You create the resource label by appending the final portion of the load balancer ARN
- * and the final portion of the target group ARN into a single value, separated by a forward
- * slash (/). The format is
- * app/
app/
+ * app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
Where:
+ *app/
targetgroup/
targetgroup/
This is an example: - * app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.
- *To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use - * the DescribeTargetGroups API operation.
+ *To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use + * the DescribeTargetGroups API operation.
*/ ResourceLabel?: string; } @@ -2063,7 +2165,8 @@ export interface TargetTrackingScalingPolicyConfiguration { * cooldown period ends. While the cooldown period is in effect, the capacity added by the * initiating scale-out activity is calculated as part of the desired capacity for the next * scale-out activity. - *Application Auto Scaling provides a default value of 300 for the following scalable targets:
+ *Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups + * and a default value of 300 for the following scalable targets:
*ECS services
@@ -2119,7 +2222,8 @@ export interface TargetTrackingScalingPolicyConfiguration { * until the cooldown period has expired. However, if another alarm triggers a scale-out activity * during the scale-in cooldown period, Application Auto Scaling scales out the target immediately. In this case, * the scale-in cooldown period stops and doesn't complete. - *Application Auto Scaling provides a default value of 300 for the following scalable targets:
+ *Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups + * and a default value of 300 for the following scalable targets:
*ECS services
@@ -2204,7 +2308,7 @@ export interface ScalingPolicy { PolicyName: string | undefined; /** - *The namespace of the AWS service that provides the resource, or a + *
The namespace of the Amazon Web Services service that provides the resource, or a
* custom-resource.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
* Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
+ * Example: replication-group/mycluster.
- * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
*
- * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
* @@ -2337,12 +2445,20 @@ export interface ScalingPolicy { *
- * cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
*
* kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ * elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ * elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
The namespace of the AWS service that provides the resource. For a resource provided + *
The namespace of the Amazon Web Services service that provides the resource. For a resource provided
* by your own application or service, use custom-resource instead.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
* Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
+ * Example: replication-group/mycluster.
- * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
*
- * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
* @@ -2566,12 +2686,20 @@ export interface DescribeScheduledActionsRequest { *
- * cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
*
* kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ * elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ * elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
The namespace of the AWS service that provides the resource, or a + *
The namespace of the Amazon Web Services service that provides the resource, or a
* custom-resource.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
* Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
+ * Example: replication-group/mycluster.
- * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
*
- * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
* @@ -2815,12 +2947,20 @@ export interface ScheduledAction { *
- * cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
*
* kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ * elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ * elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
The namespace of the AWS service that provides the resource. For a resource provided + *
The namespace of the Amazon Web Services service that provides the resource. For a resource provided
* by your own application or service, use custom-resource instead.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
* Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
+ * Example: replication-group/mycluster.
- * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
*
- * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
* @@ -3038,12 +3182,20 @@ export interface PutScalingPolicyRequest { *
- * cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
*
* kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ * elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ * elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
* TargetTrackingScaling—Not supported for Amazon EMR
- * StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces (for
- * Apache Cassandra), or Amazon MSK.
StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces (for Apache
+ * Cassandra), Amazon MSK, or Amazon ElastiCache for Redis.
* For more information, see Target * tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
*/ @@ -3109,7 +3261,7 @@ export namespace PutScalingPolicyResponse { export interface PutScheduledActionRequest { /** - *The namespace of the AWS service that provides the resource. For a resource provided + *
The namespace of the Amazon Web Services service that provides the resource. For a resource provided
* by your own application or service, use custom-resource instead.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
* Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
+ * Example: replication-group/mycluster.
- * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
*
- * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
* @@ -3282,12 +3438,20 @@ export interface PutScheduledActionRequest { *
- * cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
*
* kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ * elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ * elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
The namespace of the AWS service that provides the resource. For a resource provided + *
The namespace of the Amazon Web Services service that provides the resource. For a resource provided
* by your own application or service, use custom-resource instead.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
* Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name.
+ * Example: replication-group/mycluster.
- * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
*
- * elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
* @@ -3467,12 +3635,20 @@ export interface RegisterScalableTargetRequest { *
- * cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
*
* kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
+ * elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
+ * elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication 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 ID of the environment to change settings.
@@ -1076,6 +1086,28 @@ export interface UpdateEnvironmentRequest { *Any new or replacement description for the environment.
*/ description?: string; + + /** + *Allows the environment owner to turn on or turn off the Amazon Web Services managed temporary + * credentials for an Cloud9 environment by using one of the following values:
+ *
+ * ENABLE
+ *
+ * DISABLE
+ *
Only the environment owner can change the status of managed temporary credentials. An AccessDeniedException is thrown if an attempt to turn on or turn off managed temporary credentials is made by an account that's not the environment
+ * owner.
Access denied. Check your permissions.
+ *Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.
*/ export interface AccessDeniedException extends __SmithyException, $MetadataBearer { name: "AccessDeniedException"; @@ -196,7 +196,7 @@ export interface ObjectReference { *- * $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier
+ * $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. *@@ -225,12 +225,13 @@ export namespace ObjectReference { */ export interface SchemaFacet { /** - *
The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions.
+ *The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions. + * If this value is set, FacetName must also be set.
*/ SchemaArn?: string; /** - *The name of the facet.
+ *The name of the facet. If this value is set, SchemaArn must also be set.
*/ FacetName?: string; } @@ -1255,13 +1256,25 @@ export namespace BatchListObjectParentPaths { }); } +/** + *Lists parent objects that are associated with a given object in pagination + * fashion.
+ */ export interface BatchListObjectParents { /** *The reference that identifies an object.
*/ ObjectReference: ObjectReference | undefined; + /** + *The pagination token.
+ */ NextToken?: string; + + /** + *The maximum number of items to be retrieved in a single call. This is an approximate + * number.
+ */ MaxResults?: number; } @@ -1442,7 +1455,12 @@ export interface BatchReadOperation { */ GetObjectAttributes?: BatchGetObjectAttributes; + /** + *Lists parent objects that are associated with a given object in pagination + * fashion.
+ */ ListObjectParents?: BatchListObjectParents; + /** *Returns policies attached to an object in pagination fashion.
*/ @@ -1865,8 +1883,18 @@ export namespace ObjectIdentifierAndLinkNameTuple { }); } +/** + *Represents the output of a ListObjectParents response operation.
+ */ export interface BatchListObjectParentsResponse { + /** + *Returns a list of parent reference and LinkName Tuples.
+ */ ParentLinks?: ObjectIdentifierAndLinkNameTuple[]; + + /** + *The pagination token.
+ */ NextToken?: string; } @@ -2116,6 +2144,9 @@ export interface BatchReadSuccessfulResponse { */ GetLinkAttributes?: BatchGetLinkAttributesResponse; + /** + *The list of parent objects to retrieve.
+ */ ListObjectParents?: BatchListObjectParentsResponse; } diff --git a/clients/client-cloudwatch-logs/CloudWatchLogs.ts b/clients/client-cloudwatch-logs/CloudWatchLogs.ts index ec0eb086d493..20a9025005e3 100644 --- a/clients/client-cloudwatch-logs/CloudWatchLogs.ts +++ b/clients/client-cloudwatch-logs/CloudWatchLogs.ts @@ -201,9 +201,9 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; /** *You can use Amazon CloudWatch Logs to monitor, store, and access your log files from - * EC2 instances, AWS CloudTrail, and other sources. You can then retrieve the associated + * EC2 instances, CloudTrail, and other sources. You can then retrieve the associated * log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the - * AWS CLI, CloudWatch Logs API, or CloudWatch Logs SDK.
+ * Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK. *You can use CloudWatch Logs to:
*- * Monitor AWS CloudTrail logged events: You can + * Monitor CloudTrail logged events: You can * create alarms in CloudWatch and receive notifications of particular API activity as * captured by CloudTrail. You can use the notification to perform troubleshooting.
*Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.
- *Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. + *
Associates the specified Key Management Service customer master key (CMK) with the specified log group.
+ *Associating an KMS CMK with a log group overrides any existing associations between the log group and a CMK. * After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. - * This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. - * This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.
+ * This association is stored as long as the data encrypted with the CMK is still within CloudWatch Logs. + * This enables CloudWatch Logs to decrypt this data whenever it is requested. *CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK
* with your log group. For more information, see Using Symmetric and Asymmetric
@@ -363,7 +363,7 @@ export class CloudWatchLogs extends CloudWatchLogsClient {
* You must use the following guidelines when naming a log group: Log group names must be unique within a region for an AWS account. Log group names must be unique within a region for an Amazon Web Services account. Log group names can be between 1 and 512 characters long. When you create a log group, by default the log events in the log group never expire. To set
* a retention policy so that events expire and are deleted after a specified time, use
* PutRetentionPolicy. If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK.
- * This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs.
- * This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested. If you associate a Key Management Service customer master key (CMK) with the log group, ingested data is encrypted using the CMK.
+ * This association is stored as long as the data encrypted with the CMK is still within CloudWatch Logs.
+ * This enables CloudWatch Logs to decrypt this data whenever it is requested. If you attempt to associate a CMK with the log group but the CMK does not exist or the
* CMK is disabled, you receive an CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with
+ * CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with
* your log group. For more information, see Using Symmetric and Asymmetric
* Keys. Lists the specified log groups. You can list all your log groups or filter the results by prefix.
* The results are ASCII-sorted by log group name. CloudWatch Logs doesn’t support IAM policies that control access to the Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group. After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group.
- * All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested. Disassociates the associated Key Management Service customer master key (CMK) from the specified log group. After the KMS CMK is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group.
+ * All previously ingested data remains encrypted, and CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested. Note that it can take up to 5 minutes for this operation to take effect. Creates or updates an access policy associated with an existing
* destination. An access policy is an IAM policy document that is used
* to authorize claims to register a subscription filter against a given destination. If multiple AWS accounts are sending logs to this destination, each sender account must be
+ * If multiple Amazon Web Services accounts are sending logs to this destination, each sender account must be
* listed separately in the policy. The policy does not support specifying The log events in the batch must be in chronological order by their timestamp. The
* timestamp is the time the event occurred, expressed as the number of milliseconds after
- * Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the
+ * Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the
* timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example,
* 2017-09-15T13:45:30.) There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be changed.
*
InvalidParameterException error. DescribeLogGroups action by using the
+ * aws:ResourceTag/key-name
+ * condition key. Other CloudWatch Logs actions
+ * do support the use of the aws:ResourceTag/key-name
+ * condition key to control access.
+ * For more information about using tags to control access, see
+ * Controlling access to Amazon Web Services resources using tags.*
* as the Principal or the use of the aws:PrincipalOrgId global key.
If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key.
If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid Amazon Web Services access key ID or secret key.
You can also set up a billing alarm to alert you if your charges are higher than * expected. For more information, * see - * Creating a Billing Alarm to Monitor Your Estimated AWS Charges. + * Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges. *
* */ @@ -1526,8 +1533,8 @@ export class CloudWatchLogs extends CloudWatchLogsClient { } /** - *Creates or updates a resource policy allowing other AWS services to put log events to - * this account, such as Amazon Route 53. An account can have up to 10 resource policies per AWS + *
Creates or updates a resource policy allowing other Amazon Web Services services to put log events to + * this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services * Region.
*/ public putResourcePolicy( @@ -1614,7 +1621,7 @@ export class CloudWatchLogs extends CloudWatchLogsClient { * subscription filter, for same-account delivery. * *An AWS Lambda function that belongs to the same account as the subscription filter, + *
An Lambda function that belongs to the same account as the subscription filter, * for same-account delivery.
*For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs * in the Amazon CloudWatch Logs User Guide.
+ *CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to
+ * log groups using the aws:Resource/key-name
+ * or aws:TagKeys condition keys.
+ * For more information about using tags to control access, see
+ * Controlling access to Amazon Web Services resources using tags.
Removes the specified tags from the specified log group.
*To list the tags for a log group, use ListTagsLogGroup. * To add tags, use TagLogGroup.
+ *CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to
+ * log groups using the aws:Resource/key-name
+ * or aws:TagKeys condition keys.
+ *
You can use Amazon CloudWatch Logs to monitor, store, and access your log files from - * EC2 instances, AWS CloudTrail, and other sources. You can then retrieve the associated + * EC2 instances, CloudTrail, and other sources. You can then retrieve the associated * log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the - * AWS CLI, CloudWatch Logs API, or CloudWatch Logs SDK.
+ * Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK. *You can use CloudWatch Logs to:
*- * Monitor AWS CloudTrail logged events: You can + * Monitor CloudTrail logged events: You can * create alarms in CloudWatch and receive notifications of particular API activity as * captured by CloudTrail. You can use the notification to perform troubleshooting.
*You can use Amazon CloudWatch Logs to monitor, store, and access your log files from -EC2 instances, AWS CloudTrail, and other sources. You can then retrieve the associated +EC2 instances, CloudTrail, and other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the -AWS CLI, CloudWatch Logs API, or CloudWatch Logs SDK.
+Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch Logs SDK.You can use CloudWatch Logs to:
-Monitor AWS CloudTrail logged events: You can +Monitor CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail. You can use the notification to perform troubleshooting.
Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.
- *Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. + *
Associates the specified Key Management Service customer master key (CMK) with the specified log group.
+ *Associating an KMS CMK with a log group overrides any existing associations between the log group and a CMK. * After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. - * This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. - * This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.
+ * This association is stored as long as the data encrypted with the CMK is still within CloudWatch Logs. + * This enables CloudWatch Logs to decrypt this data whenever it is requested. *CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK
* with your log group. For more information, see Using Symmetric and Asymmetric
diff --git a/clients/client-cloudwatch-logs/commands/CreateLogGroupCommand.ts b/clients/client-cloudwatch-logs/commands/CreateLogGroupCommand.ts
index c249ebe36787..a73e96033e02 100644
--- a/clients/client-cloudwatch-logs/commands/CreateLogGroupCommand.ts
+++ b/clients/client-cloudwatch-logs/commands/CreateLogGroupCommand.ts
@@ -25,7 +25,7 @@ export interface CreateLogGroupCommandOutput extends __MetadataBearer {}
* You must use the following guidelines when naming a log group: Log group names must be unique within a region for an AWS account. Log group names must be unique within a region for an Amazon Web Services account. Log group names can be between 1 and 512 characters long. When you create a log group, by default the log events in the log group never expire. To set
* a retention policy so that events expire and are deleted after a specified time, use
* PutRetentionPolicy. If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK.
- * This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs.
- * This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested. If you associate a Key Management Service customer master key (CMK) with the log group, ingested data is encrypted using the CMK.
+ * This association is stored as long as the data encrypted with the CMK is still within CloudWatch Logs.
+ * This enables CloudWatch Logs to decrypt this data whenever it is requested. If you attempt to associate a CMK with the log group but the CMK does not exist or the
* CMK is disabled, you receive an CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with
+ * CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with
* your log group. For more information, see Using Symmetric and Asymmetric
* Keys. Lists the specified log groups. You can list all your log groups or filter the results by prefix.
* The results are ASCII-sorted by log group name. CloudWatch Logs doesn’t support IAM policies that control access to the Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group. After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group.
- * All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested. Disassociates the associated Key Management Service customer master key (CMK) from the specified log group. After the KMS CMK is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group.
+ * All previously ingested data remains encrypted, and CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested. Note that it can take up to 5 minutes for this operation to take effect. Creates or updates an access policy associated with an existing
* destination. An access policy is an IAM policy document that is used
* to authorize claims to register a subscription filter against a given destination. If multiple AWS accounts are sending logs to this destination, each sender account must be
+ * If multiple Amazon Web Services accounts are sending logs to this destination, each sender account must be
* listed separately in the policy. The policy does not support specifying The log events in the batch must be in chronological order by their timestamp. The
* timestamp is the time the event occurred, expressed as the number of milliseconds after
- * Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the
+ * Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell and the Amazon Web Services SDK for .NET, the
* timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example,
* 2017-09-15T13:45:30.) There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be changed. If a call to If a call to You can also set up a billing alarm to alert you if your charges are higher than
* expected. For more information,
* see
- * Creating a Billing Alarm to Monitor Your Estimated AWS Charges.
+ * Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges
*
- * InvalidParameterException error. DescribeLogGroups action by using the
+ * aws:ResourceTag/key-name
+ * condition key. Other CloudWatch Logs actions
+ * do support the use of the aws:ResourceTag/key-name
+ * condition key to control access.
+ * For more information about using tags to control access, see
+ * Controlling access to Amazon Web Services resources using tags.*
* as the Principal or the use of the aws:PrincipalOrgId global key.PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key. PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid Amazon Web Services access key ID or secret key.
Creates or updates a resource policy allowing other AWS services to put log events to - * this account, such as Amazon Route 53. An account can have up to 10 resource policies per AWS + *
Creates or updates a resource policy allowing other Amazon Web Services services to put log events to + * this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services * Region.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-cloudwatch-logs/commands/PutSubscriptionFilterCommand.ts b/clients/client-cloudwatch-logs/commands/PutSubscriptionFilterCommand.ts index b693de6fcd0c..bcfe0c47332f 100644 --- a/clients/client-cloudwatch-logs/commands/PutSubscriptionFilterCommand.ts +++ b/clients/client-cloudwatch-logs/commands/PutSubscriptionFilterCommand.ts @@ -41,7 +41,7 @@ export interface PutSubscriptionFilterCommandOutput extends __MetadataBearer {} * subscription filter, for same-account delivery. * *An AWS Lambda function that belongs to the same account as the subscription filter, + *
An Lambda function that belongs to the same account as the subscription filter, * for same-account delivery.
*For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs * in the Amazon CloudWatch Logs User Guide.
+ *CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to
+ * log groups using the aws:Resource/key-name
+ * or aws:TagKeys condition keys.
+ * For more information about using tags to control access, see
+ * Controlling access to Amazon Web Services resources using tags.
Removes the specified tags from the specified log group.
*To list the tags for a log group, use ListTagsLogGroup. * To add tags, use TagLogGroup.
+ *CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to
+ * log groups using the aws:Resource/key-name
+ * or aws:TagKeys condition keys.
+ *
The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. This must be a symmetric CMK. - * For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS) and Using Symmetric and Asymmetric Keys.
+ * For more information, see Amazon Resource Names - Key Management Service and Using Symmetric and Asymmetric Keys. */ kmsKeyId: string | undefined; } @@ -160,7 +160,7 @@ export interface CreateExportTaskRequest { to: number | undefined; /** - *The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.
+ *The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services region.
*/ destination: string | undefined; @@ -240,12 +240,17 @@ export interface CreateLogGroupRequest { /** *The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. - * For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS).
+ * For more information, see Amazon Resource Names - Key Management Service. */ kmsKeyId?: string; /** *The key-value pairs to use for the tags.
+ *CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to
+ * log groups using the aws:Resource/key-name
+ * or aws:TagKeys condition keys.
+ * For more information about using tags to control access, see
+ * Controlling access to Amazon Web Services resources using tags.
An IAM policy document that governs which AWS accounts can create subscription filters + *
An IAM policy document that governs which Amazon Web Services accounts can create subscription filters * against this destination.
*/ accessPolicy?: string; @@ -770,8 +775,9 @@ export interface LogGroup { /** *The number of days to retain the log events in the specified log group. * Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.
- *If you omit retentionInDays in a PutRetentionPolicy operation,
- * the events in the log group are always retained and never expire.
To set a log group to never have log events expire, use + * DeleteRetentionPolicy. + *
*/ retentionInDays?: number; @@ -1093,7 +1099,7 @@ export interface MetricTransformation { *You can also set up a billing alarm to alert you if your charges are higher than * expected. For more information, * see - * Creating a Billing Alarm to Monitor Your Estimated AWS Charges. + * Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges. *
* */ @@ -1761,7 +1767,6 @@ export interface GetLogEventsRequest { /** *The token for the next set of items to return. (You received this token from a previous call.)
- *Using this token works only when you specify true for startFromHead.
If the value is true, the earliest log events are returned first. * If the value is false, the latest log events are returned first. * The default value is false.
- *If you are using nextToken in this operation, you must specify true for startFromHead.
If you are using a previous nextForwardToken value as the nextToken in this operation,
+ * you must specify true for startFromHead.
The most likely cause is an invalid AWS access key ID or secret key.
+ *The most likely cause is an invalid Amazon Web Services access key ID or secret key.
*/ export interface UnrecognizedClientException extends __SmithyException, $MetadataBearer { name: "UnrecognizedClientException"; @@ -2405,24 +2411,40 @@ export interface PutResourcePolicyRequest { *Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. * This parameter is required.
*The following example creates a resource policy enabling the Route 53 service to put
- * DNS query logs in to the specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.
"logArn" with the ARN of
+ * your CloudWatch Logs resource, such as a log group or log stream.
+ * CloudWatch Logs also supports aws:SourceArn + * and aws:SourceAccount + * condition context keys.
+ *In the example resource policy, you would replace the value of SourceArn with the resource making the
+ * call from Route 53 to CloudWatch Logs and replace the value of SourceAccount with
+ * the Amazon Web Services account ID making that call.
* {
- * "Version": "2012-10-17",
- * "Statement": [
- * {
- * "Sid": "Route53LogsToCloudWatchLogs",
- * "Effect": "Allow",
- * "Principal": {
- * "Service": [
- * "route53.amazonaws.com"
- * ]
+ * "Version": "2012-10-17",
+ * "Statement": [
+ * {
+ * "Sid": "Route53LogsToCloudWatchLogs",
+ * "Effect": "Allow",
+ * "Principal": {
+ * "Service": [
+ * "route53.amazonaws.com"
+ * ]
* },
- * "Action":"logs:PutLogEvents",
- * "Resource": "logArn"
- * }
- * ]
- * }
+ * "Action": "logs:PutLogEvents",
+ * "Resource": "logArn",
+ * "Condition": {
+ * "ArnLike": {
+ * "aws:SourceArn": "myRoute53ResourceArn"
+ * },
+ * "StringEquals": {
+ * "aws:SourceAccount": "myAwsAccountId"
+ * }
+ * }
+ * }
+ * ]
+ * }
*
*
The number of days to retain the log events in the specified log group. * Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.
- *If you omit retentionInDays in a PutRetentionPolicy operation,
- * the events in the log group are always retained and never expire.
To set a log group to never have log events expire, use + * DeleteRetentionPolicy. + *
*/ retentionInDays: number | undefined; } @@ -2516,7 +2539,7 @@ export interface PutSubscriptionFilterRequest { * subscription filter, for same-account delivery. * *An AWS Lambda function belonging to the same account as the subscription filter, + *
A Lambda function belonging to the same account as the subscription filter, * for same-account delivery.
*invalidInputException is thrown.
* To be able to report the build status to the source provider, the user associated with the source provider must * have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.
- *The status of a build triggered by a webhook is always reported to your source + *
The status of a build triggered by a webhook is always reported to your source * provider.
- *If your project's builds are triggered by a webhook, you must push a + * new commit to the repo for a change to this property to take + * effect.
*/ reportBuildStatus?: boolean; diff --git a/clients/client-config-service/models/models_0.ts b/clients/client-config-service/models/models_0.ts index 504fae34744f..5f0eb68f91c8 100644 --- a/clients/client-config-service/models/models_0.ts +++ b/clients/client-config-service/models/models_0.ts @@ -609,6 +609,10 @@ export enum ResourceType { ApplicationVersion = "AWS::ElasticBeanstalk::ApplicationVersion", AssociationCompliance = "AWS::SSM::AssociationCompliance", AutoScalingGroup = "AWS::AutoScaling::AutoScalingGroup", + BackupPlan = "AWS::Backup::BackupPlan", + BackupRecoveryPoint = "AWS::Backup::RecoveryPoint", + BackupSelection = "AWS::Backup::BackupSelection", + BackupVault = "AWS::Backup::BackupVault", Bucket = "AWS::S3::Bucket", Certificate = "AWS::ACM::Certificate", CloudFormationProduct = "AWS::ServiceCatalog::CloudFormationProduct", @@ -628,7 +632,14 @@ export enum ResourceType { DBSubnetGroup = "AWS::RDS::DBSubnetGroup", Distribution = "AWS::CloudFront::Distribution", Domain = "AWS::Elasticsearch::Domain", + ECRRepository = "AWS::ECR::Repository", + ECSCluster = "AWS::ECS::Cluster", + ECSService = "AWS::ECS::Service", + ECSTaskDefinition = "AWS::ECS::TaskDefinition", + EFSAccessPoint = "AWS::EFS::AccessPoint", + EFSFileSystem = "AWS::EFS::FileSystem", EIP = "AWS::EC2::EIP", + EKSCluster = "AWS::EKS::Cluster", EgressOnlyInternetGateway = "AWS::EC2::EgressOnlyInternetGateway", EncryptionConfig = "AWS::XRay::EncryptionConfig", Environment = "AWS::ElasticBeanstalk::Environment", diff --git a/clients/client-cost-explorer/CostExplorer.ts b/clients/client-cost-explorer/CostExplorer.ts index 3b21955cbe68..ffb98162a1c8 100644 --- a/clients/client-cost-explorer/CostExplorer.ts +++ b/clients/client-cost-explorer/CostExplorer.ts @@ -148,9 +148,10 @@ import { import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; /** - *The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data - * such as total monthly costs or total daily usage. You can also query for granular data, such as the number of - * daily write operations for Amazon DynamoDB database tables in your production environment.
+ *You can use the Cost Explorer API to programmatically query your cost and usage data. You + * can query for aggregated data such as total monthly costs or total daily usage. You can also + * query for granular data. This might include the number of daily write operations for Amazon + * DynamoDB database tables in your production environment.
*Service Endpoint
*The Cost Explorer API provides the following endpoint:
*For information about costs associated with the Cost Explorer API, see - * AWS Cost Management Pricing.
+ *For information about the costs that are associated with the Cost Explorer API, see + * Amazon Web Services Cost + * Management Pricing.
*/ export class CostExplorer extends CostExplorerClient { /** @@ -393,7 +395,7 @@ export class CostExplorer extends CostExplorerClient { } /** - *Retrieves all of the cost anomalies detected on your account, during the time period + *
Retrieves all of the cost anomalies detected on your account during the time period that's
* specified by the DateInterval object.
Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as
- * BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group
- * your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list
- * of valid dimensions, see the
- * GetDimensionValues
- * operation. Management account in an organization in AWS Organizations have access to all member accounts.
Retrieves cost and usage metrics for your account. You can specify which cost and
+ * usage-related metric that you want the request to return. For example, you can specify
+ * BlendedCosts or UsageQuantity. You can also filter and group your
+ * data by various dimensions, such as SERVICE or AZ, in a specific
+ * time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts.
For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.
*/ public getCostAndUsage( @@ -531,10 +532,9 @@ export class CostExplorer extends CostExplorerClient { * usage-related metric, such asBlendedCosts or UsageQuantity, that
* you want the request to return. You can also filter and group your data by various dimensions,
* such as SERVICE or AZ, in a specific time range. For a complete list
- * of valid dimensions, see the GetDimensionValues operation. Management account in an organization in AWS
- * Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.
+ * of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.
* This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the AWS Billing and Cost Management User Guide.
+ *This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the Billing and Cost Management User Guide.
*Retrieves an array of Cost Category names and values incurred cost.
- *If some Cost Category names and values are not associated with any cost, they will not be returned by this API.
*Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. * Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.
- *AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage - * into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations + *
Amazon Web Services generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage + * into categories that are eligible for a reservation. After Amazon Web Services has these categories, it simulates every combination of reservations * in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.
- *For example, AWS automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region - * and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance - * in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units + *
For example, Amazon Web Services automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region
+ * and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. Amazon Web Services recommends the smallest size instance
+ * in an instance family. This makes it easier to purchase a size-flexible RI. Amazon Web Services also shows the equal number of normalized units
* so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large
* because that is the smallest size instance in the c4 instance family.
Updates an existing cost anomaly monitor. The changes made are applied going forward, and - * does not change anomalies detected in the past.
+ * doesn'tt change anomalies detected in the past. */ public updateAnomalyMonitor( args: UpdateAnomalyMonitorCommandInput, @@ -1170,7 +1170,7 @@ export class CostExplorer extends CostExplorerClient { } /** - *Updates an existing cost anomaly monitor subscription.
+ *Updates an existing cost anomaly monitor subscription.
*/ public updateAnomalySubscription( args: UpdateAnomalySubscriptionCommandInput, diff --git a/clients/client-cost-explorer/CostExplorerClient.ts b/clients/client-cost-explorer/CostExplorerClient.ts index 9ee518d00f3b..bdcf0ab0b729 100644 --- a/clients/client-cost-explorer/CostExplorerClient.ts +++ b/clients/client-cost-explorer/CostExplorerClient.ts @@ -350,9 +350,10 @@ type CostExplorerClientResolvedConfigType = __SmithyResolvedConfiguration<__Http export interface CostExplorerClientResolvedConfig extends CostExplorerClientResolvedConfigType {} /** - *The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data - * such as total monthly costs or total daily usage. You can also query for granular data, such as the number of - * daily write operations for Amazon DynamoDB database tables in your production environment.
+ *You can use the Cost Explorer API to programmatically query your cost and usage data. You + * can query for aggregated data such as total monthly costs or total daily usage. You can also + * query for granular data. This might include the number of daily write operations for Amazon + * DynamoDB database tables in your production environment.
*Service Endpoint
*The Cost Explorer API provides the following endpoint:
*For information about costs associated with the Cost Explorer API, see - * AWS Cost Management Pricing.
+ *For information about the costs that are associated with the Cost Explorer API, see + * Amazon Web Services Cost + * Management Pricing.
*/ export class CostExplorerClient extends __Client< __HttpHandlerOptions, diff --git a/clients/client-cost-explorer/README.md b/clients/client-cost-explorer/README.md index f0ae742f10df..f3f70ec6cc1b 100644 --- a/clients/client-cost-explorer/README.md +++ b/clients/client-cost-explorer/README.md @@ -7,9 +7,10 @@ AWS SDK for JavaScript CostExplorer Client for Node.js, Browser and React Native. -The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data -such as total monthly costs or total daily usage. You can also query for granular data, such as the number of -daily write operations for Amazon DynamoDB database tables in your production environment.
+You can use the Cost Explorer API to programmatically query your cost and usage data. You +can query for aggregated data such as total monthly costs or total daily usage. You can also +query for granular data. This might include the number of daily write operations for Amazon +DynamoDB database tables in your production environment.
Service Endpoint
The Cost Explorer API provides the following endpoint:
For information about costs associated with the Cost Explorer API, see -AWS Cost Management Pricing.
+For information about the costs that are associated with the Cost Explorer API, see +Amazon Web Services Cost +Management Pricing.
## Installing diff --git a/clients/client-cost-explorer/commands/GetAnomaliesCommand.ts b/clients/client-cost-explorer/commands/GetAnomaliesCommand.ts index fb75d82e5a96..9712b5976e77 100644 --- a/clients/client-cost-explorer/commands/GetAnomaliesCommand.ts +++ b/clients/client-cost-explorer/commands/GetAnomaliesCommand.ts @@ -21,7 +21,7 @@ export interface GetAnomaliesCommandInput extends GetAnomaliesRequest {} export interface GetAnomaliesCommandOutput extends GetAnomaliesResponse, __MetadataBearer {} /** - *Retrieves all of the cost anomalies detected on your account, during the time period + *
Retrieves all of the cost anomalies detected on your account during the time period that's
* specified by the DateInterval object.
Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as
- * BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group
- * your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list
- * of valid dimensions, see the
- * GetDimensionValues
- * operation. Management account in an organization in AWS Organizations have access to all member accounts.
Retrieves cost and usage metrics for your account. You can specify which cost and
+ * usage-related metric that you want the request to return. For example, you can specify
+ * BlendedCosts or UsageQuantity. You can also filter and group your
+ * data by various dimensions, such as SERVICE or AZ, in a specific
+ * time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts.
For information about filter limitations, see Quotas and restrictions in the Billing and Cost Management User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-cost-explorer/commands/GetCostAndUsageWithResourcesCommand.ts b/clients/client-cost-explorer/commands/GetCostAndUsageWithResourcesCommand.ts index 1cc0369516ee..e75a2c670729 100644 --- a/clients/client-cost-explorer/commands/GetCostAndUsageWithResourcesCommand.ts +++ b/clients/client-cost-explorer/commands/GetCostAndUsageWithResourcesCommand.ts @@ -27,10 +27,9 @@ export interface GetCostAndUsageWithResourcesCommandOutput * usage-related metric, such asBlendedCosts or UsageQuantity, that
* you want the request to return. You can also filter and group your data by various dimensions,
* such as SERVICE or AZ, in a specific time range. For a complete list
- * of valid dimensions, see the GetDimensionValues operation. Management account in an organization in AWS
- * Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.
+ * of valid dimensions, see the GetDimensionValues operation. Management account in an organization in Organizations have access to all member accounts. This API is currently available for the Amazon Elastic Compute Cloud – Compute service only.
* This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the AWS Billing and Cost Management User Guide.
+ *This is an opt-in only feature. You can enable this feature from the Cost Explorer Settings page. For information on how to access the Settings page, see Controlling Access for Cost Explorer in the Billing and Cost Management User Guide.
*Retrieves an array of Cost Category names and values incurred cost.
- *If some Cost Category names and values are not associated with any cost, they will not be returned by this API.
*Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. * Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.
- *AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage - * into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations + *
Amazon Web Services generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage + * into categories that are eligible for a reservation. After Amazon Web Services has these categories, it simulates every combination of reservations * in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.
- *For example, AWS automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region - * and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance - * in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units + *
For example, Amazon Web Services automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region
+ * and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. Amazon Web Services recommends the smallest size instance
+ * in an instance family. This makes it easier to purchase a size-flexible RI. Amazon Web Services also shows the equal number of normalized units
* so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large
* because that is the smallest size instance in the c4 instance family.
Updates an existing cost anomaly monitor. The changes made are applied going forward, and - * does not change anomalies detected in the past.
+ * doesn'tt change anomalies detected in the past. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cost-explorer/commands/UpdateAnomalySubscriptionCommand.ts b/clients/client-cost-explorer/commands/UpdateAnomalySubscriptionCommand.ts index de8c8d1894e2..0f17177ebd61 100644 --- a/clients/client-cost-explorer/commands/UpdateAnomalySubscriptionCommand.ts +++ b/clients/client-cost-explorer/commands/UpdateAnomalySubscriptionCommand.ts @@ -21,7 +21,7 @@ export interface UpdateAnomalySubscriptionCommandInput extends UpdateAnomalySubs export interface UpdateAnomalySubscriptionCommandOutput extends UpdateAnomalySubscriptionResponse, __MetadataBearer {} /** - *Updates an existing cost anomaly monitor subscription.
+ *Updates an existing cost anomaly monitor subscription.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-cost-explorer/models/models_0.ts b/clients/client-cost-explorer/models/models_0.ts index 6384b1d8f52d..2408a48649fa 100644 --- a/clients/client-cost-explorer/models/models_0.ts +++ b/clients/client-cost-explorer/models/models_0.ts @@ -6,20 +6,16 @@ export enum AccountScope { } /** - *Quantifies the anomaly. The higher score means that it is more anomalous.
+ *Quantifies the anomaly. The higher score means that it's more anomalous.
*/ export interface AnomalyScore { /** - *
- * The maximum score observed during the AnomalyDateInterval.
- *
The maximum score that's observed during the AnomalyDateInterval.
- * The last observed score. - *
+ *The last observed score.
*/ CurrentScore: number | undefined; } @@ -40,22 +36,16 @@ export enum AnomalyFeedbackType { } /** - *- * The anomaly's dollar value. - *
+ *The dollar value of the anomaly.
*/ export interface Impact { /** - *- * The maximum dollar value observed for an anomaly. - *
+ *The maximum dollar value that's observed for an anomaly.
*/ MaxImpact: number | undefined; /** - *- * The cumulative dollar value observed for an anomaly. - *
+ *The cumulative dollar value that's observed for an anomaly.
*/ TotalImpact?: number; } @@ -70,36 +60,27 @@ export namespace Impact { } /** - *- * The combination of AWS service, linked account, Region, and usage type where a cost anomaly is observed. - *
+ *The combination of Amazon Web Services service, linked account, Region, and usage type + * where a cost anomaly is observed.
*/ export interface RootCause { /** - *- * The AWS service name associated with the cost anomaly. - *
+ *The Amazon Web Services service name that's associated with the cost anomaly.
*/ Service?: string; /** - *- * The AWS Region associated with the cost anomaly. - *
+ *The Amazon Web Services Region that's associated with the cost anomaly.
*/ Region?: string; /** - *- * The linked account value associated with the cost anomaly. - *
+ *The member account value that's associated with the cost anomaly.
*/ LinkedAccount?: string; /** - *
- * The UsageType value associated with the cost anomaly.
- *
The UsageType value that's associated with the cost anomaly.
- * An unusual cost pattern. This consists of the detailed metadata and the current status of the anomaly object. - *
+ *An unusual cost pattern. This consists of the detailed metadata and the current status + * of the anomaly object.
*/ export interface Anomaly { /** - *- * The unique identifier for the anomaly. - *
+ *The unique identifier for the anomaly.
*/ AnomalyId: string | undefined; /** - *- * The first day the anomaly is detected. - *
+ *The first day the anomaly is detected.
*/ AnomalyStartDate?: string; /** - *- * The last day the anomaly is detected. - *
+ *The last day the anomaly is detected.
*/ AnomalyEndDate?: string; /** - *- * The dimension for the anomaly. For example, an AWS service in a service monitor. - *
+ *The dimension for the anomaly (for example, an Amazon Web Services service in a service + * monitor).
*/ DimensionValue?: string; /** - *- * The list of identified root causes for the anomaly. - *
+ *The list of identified root causes for the anomaly.
*/ RootCauses?: RootCause[]; /** - *- * The latest and maximum score for the anomaly. - *
+ *The latest and maximum score for the anomaly.
*/ AnomalyScore: AnomalyScore | undefined; /** - *- * The dollar impact for the anomaly. - *
+ *The dollar impact for the anomaly.
*/ Impact: Impact | undefined; /** - *The Amazon Resource Name (ARN) for the cost monitor that generated this anomaly.
+ *The Amazon Resource Name (ARN) for the cost monitor that generated this anomaly. + *
*/ MonitorArn: string | undefined; /** - *- * The feedback value. - *
+ *The feedback value.
*/ Feedback?: AnomalyFeedbackType | string; } @@ -191,22 +157,16 @@ export namespace Anomaly { } /** - *- * The time period for an anomaly. - *
+ *The time period for an anomaly.
*/ export interface AnomalyDateInterval { /** - *- * The first date an anomaly was observed. - *
+ *The first date an anomaly was observed.
*/ StartDate: string | undefined; /** - *- * The last date an anomaly was observed. - *
+ *The last date an anomaly was observed.
*/ EndDate?: string; } @@ -236,10 +196,13 @@ export enum MatchOption { /** *The Cost Categories values used for filtering the costs.
- *If Values and Key are not specified, the ABSENT
- * MatchOption is applied to all Cost Categories. That is, filtering on resources that are not mapped to any Cost Categories.
If Values is provided and Key is not specified, the ABSENT
- * MatchOption is applied to the Cost Categories Key only. That is, filtering on resources without the given Cost Categories key.
If Values and Key are not specified, the ABSENT
+ * MatchOption is applied to all Cost Categories. That is, it filters on
+ * resources that aren't mapped to any Cost Categories.
If Values is provided and Key isn't specified, the
+ * ABSENT
+ * MatchOption is applied to the Cost Categories Key only. That
+ * is, it filters on resources without the given Cost Categories key.
- * The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.
+ *
The match options that you can use to filter your results. MatchOptions is only
+ * applicable for actions related to cost category. The default values for
+ * MatchOptions is EQUALS and CASE_SENSITIVE.
*
The names of the metadata types that you can use to filter and group your results.
- * For example, AZ returns a list of Availability Zones.
The names of the metadata types that you can use to filter and group your results. For
+ * example, AZ returns a list of Availability Zones.
The match options that you can use to filter your results.
- * MatchOptions is only applicable for actions related to Cost Category.
- * The default values for MatchOptions are EQUALS and
- * CASE_SENSITIVE.
The match options that you can use to filter your results. MatchOptions
+ * is only applicable for actions related to Cost Category. The default values for
+ * MatchOptions are EQUALS and
+ * CASE_SENSITIVE.
The values that are available for a tag.
- *If Values and Key are not specified, the ABSENT
- * MatchOption is applied to all tags. That is, filtering on resources with no tags.
If Values is provided and Key is not specified, the ABSENT
- * MatchOption is applied to the tag Key only. That is, filtering on resources without the given tag key.
If Values and Key aren't specified, the ABSENT
+ * MatchOption is applied to all tags. That is, it's filtered on resources
+ * with no tags.
If Values is provided and Key isn't specified, the
+ * ABSENT
+ * MatchOption is applied to the tag Key only. That is, it's
+ * filtered on resources without the given tag key.
The match options that you can use to filter your results.
- * MatchOptions is only applicable for actions related to Cost Category.
- * The default values for MatchOptions are EQUALS and
- * CASE_SENSITIVE.
The match options that you can use to filter your results. MatchOptions
+ * is only applicable for actions related to Cost Category. The default values for
+ * MatchOptions are EQUALS and
+ * CASE_SENSITIVE.
- * The recipient of AnomalySubscription notifications.
- *
The recipient of AnomalySubscription notifications.
The email address or SNS Amazon Resource Name (ARN), depending on the Type.
The email address or SNS Amazon Resource Name (ARN). This depends on the
+ * Type.
- * The notification delivery channel. - *
+ *The notification delivery channel.
*/ Type?: SubscriberType | string; /** - *Indicates if the subscriber accepts the notifications.
+ *Indicates if the subscriber accepts the notifications.
*/ Status?: SubscriberStatus | string; } @@ -429,55 +393,44 @@ export namespace Subscriber { } /** - *
- * The association between a monitor, threshold, and list of subscribers used to deliver notifications about anomalies detected by a monitor that exceeds a threshold. The content consists of the detailed metadata and the current status of the AnomalySubscription object.
- *
The association between a monitor, threshold, and list of subscribers used to deliver
+ * notifications about anomalies detected by a monitor that exceeds a threshold. The
+ * content consists of the detailed metadata and the current status of the
+ * AnomalySubscription object.
The AnomalySubscription Amazon Resource Name (ARN).
The AnomalySubscription Amazon Resource Name (ARN).
- * Your unique account identifier. - *
+ *Your unique account identifier.
*/ AccountId?: string; /** - *- * A list of cost anomaly monitors. - *
+ *A list of cost anomaly monitors.
*/ MonitorArnList: string[] | undefined; /** - *- * A list of subscribers to notify. - *
+ *A list of subscribers to notify.
*/ Subscribers: Subscriber[] | undefined; /** - *- * The dollar value that triggers a notification if the threshold is exceeded. - *
+ *The dollar value that triggers a notification if the threshold is exceeded.
*/ Threshold: number | undefined; /** - *- * The frequency at which anomaly reports are sent over email. - *
+ *The frequency that anomaly reports are sent over email.
*/ Frequency: AnomalySubscriptionFrequency | string | undefined; /** - *- * The name for the subscription. - *
+ *The name for the subscription.
*/ SubscriptionName: string | undefined; } @@ -493,7 +446,7 @@ export namespace AnomalySubscription { export interface CreateAnomalyMonitorResponse { /** - *The unique identifier of your newly created cost anomaly detection monitor.
+ *The unique identifier of your newly created cost anomaly detection monitor.
*/ MonitorArn: string | undefined; } @@ -527,9 +480,7 @@ export namespace LimitExceededException { export interface CreateAnomalySubscriptionRequest { /** - *- * The cost anomaly subscription object that you want to create. - *
+ *The cost anomaly subscription object that you want to create.
*/ AnomalySubscription: AnomalySubscription | undefined; } @@ -545,9 +496,7 @@ export namespace CreateAnomalySubscriptionRequest { export interface CreateAnomalySubscriptionResponse { /** - *- * The unique identifier of your newly created cost anomaly subscription. - *
+ *The unique identifier of your newly created cost anomaly subscription.
*/ SubscriptionArn: string | undefined; } @@ -586,12 +535,21 @@ export enum CostCategoryInheritedValueDimensionName { } /** - *When creating or updating a cost category, you can define the CostCategoryRule rule type as INHERITED_VALUE. This rule type adds the flexibility of defining a rule that dynamically inherits the cost category value from the dimension value defined by CostCategoryInheritedValueDimension. For example, if you wanted to dynamically group costs based on the value of a specific tag key, you would first choose an inherited value rule type, then choose the tag dimension and specify the tag key to use.
When creating or updating a cost category, you can define the
+ * CostCategoryRule rule type as INHERITED_VALUE. This rule
+ * type adds the flexibility of defining a rule that dynamically inherits the cost category
+ * value from the dimension value defined by
+ * CostCategoryInheritedValueDimension. For example, if you want to
+ * dynamically group costs that are based on the value of a specific tag key, first choose
+ * an inherited value rule type, then choose the tag dimension and specify the tag key to
+ * use.
The name of dimension for which to group costs.
- *If you specify LINKED_ACCOUNT_NAME, the cost category value will be based on account name. If you specify TAG, the cost category value will be based on the value of the specified tag key.
The name of the dimension that's used to group costs.
+ *If you specify LINKED_ACCOUNT_NAME, the cost category value is based on
+ * account name. If you specify TAG, the cost category value will be based on
+ * the value of the specified tag key.
The parameters for a split charge method.
+ */ +export interface CostCategorySplitChargeRuleParameter { + /** + *The parameter type.
+ */ + Type: CostCategorySplitChargeRuleParameterType | string | undefined; + + /** + *The parameter values.
+ */ + Values: string[] | undefined; +} + +export namespace CostCategorySplitChargeRuleParameter { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CostCategorySplitChargeRuleParameter): any => ({ + ...obj, + }); +} + +/** + *Use the split charge rule to split the cost of one Cost Category value across several + * other target values.
+ */ +export interface CostCategorySplitChargeRule { + /** + *The Cost Category value that you want to split. That value can't be used as a source + * or a target in other split charge rules. To indicate uncategorized costs, you can use an empty string as the source.
+ */ + Source: string | undefined; + + /** + *The Cost Category values that you want to split costs across. These values can't be + * used as a source in other split charge rules.
+ */ + Targets: string[] | undefined; + + /** + *The method that's used to define how to split your source costs across your targets.
+ *
+ * Proportional - Allocates charges across your targets based on the
+ * proportional weighted cost of each target.
+ * Fixed - Allocates charges across your targets based on your defined
+ * allocation percentage.
>Even - Allocates costs evenly across all targets.
The parameters for a split charge method. This is only required for the
+ * FIXED method.
@@ -665,7 +702,7 @@ export namespace ServiceQuotaExceededException { export interface DeleteAnomalyMonitorRequest { /** - *
The unique identifier of the cost anomaly monitor that you want to delete.
+ *The unique identifier of the cost anomaly monitor that you want to delete.
*/ MonitorArn: string | undefined; } @@ -692,7 +729,7 @@ export namespace DeleteAnomalyMonitorResponse { export interface DeleteAnomalySubscriptionRequest { /** - *The unique identifier of the cost anomaly subscription that you want to delete.
+ *The unique identifier of the cost anomaly subscription that you want to delete.
*/ SubscriptionArn: string | undefined; } @@ -834,22 +871,17 @@ export enum CostCategoryStatus { } /** - *- * The list of processing statuses for Cost Management products for a specific cost category. - *
+ *The list of processing statuses for Cost Management products for a specific cost + * category.
*/ export interface CostCategoryProcessingStatus { /** - *- * The Cost Management product name of the applied status. - *
+ *The Cost Management product name of the applied status.
*/ Component?: CostCategoryStatusComponent | string; /** - *- * The process status for a specific cost category. - *
+ *The process status for a specific cost category.
*/ Status?: CostCategoryStatus | string; } @@ -873,25 +905,21 @@ export enum NumericOperator { } /** - *Filters cost anomalies based on the total impact.
+ *Filters cost anomalies based on the total impact.
*/ export interface TotalImpactFilter { /** - *- * The comparing value used in the filter. - *
+ *The comparing value that's used in the filter.
*/ NumericOperator: NumericOperator | string | undefined; /** - *- * The lower bound dollar value used in the filter. - *
+ *The lower bound dollar value that's used in the filter.
*/ StartValue: number | undefined; /** - *The upper bound dollar value used in the filter.
+ *The upper bound dollar value that's used in the filter.
*/ EndValue?: number; } @@ -931,16 +959,13 @@ export interface GetAnomaliesRequest { TotalImpact?: TotalImpactFilter; /** - *- * The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size. - *
+ *The token to retrieve the next set of results. Amazon Web Services provides the token when + * the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; /** - *- * The number of entries a paginated response contains. - *
+ *The number of entries a paginated response contains.
*/ MaxResults?: number; } @@ -956,16 +981,13 @@ export namespace GetAnomaliesRequest { export interface GetAnomaliesResponse { /** - *- * A list of cost anomalies. - *
+ *A list of cost anomalies.
*/ Anomalies: Anomaly[] | undefined; /** - *- * The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size. - *
+ *The token to retrieve the next set of results. Amazon Web Services provides the token when + * the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; } @@ -999,23 +1021,18 @@ export namespace InvalidNextTokenException { export interface GetAnomalyMonitorsRequest { /** - *- * A list of cost anomaly monitor ARNs. - *
+ *A list of cost anomaly monitor ARNs.
*/ MonitorArnList?: string[]; /** - *- * The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size. - *
+ *The token to retrieve the next set of results. Amazon Web Services provides the token when + * the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; /** - *- * The number of entries a paginated response contains. - *
+ *The number of entries that a paginated response contains.
*/ MaxResults?: number; } @@ -1031,30 +1048,23 @@ export namespace GetAnomalyMonitorsRequest { export interface GetAnomalySubscriptionsRequest { /** - *- * A list of cost anomaly subscription ARNs. - *
+ *A list of cost anomaly subscription ARNs.
*/ SubscriptionArnList?: string[]; /** - *- * Cost anomaly monitor ARNs. - *
+ *Cost anomaly monitor ARNs.
*/ MonitorArn?: string; /** - *- * The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size. - *
+ *The token to retrieve the next set of results. Amazon Web Services provides the token when + * the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; /** - *- * The number of entries a paginated response contains. - *
+ *The number of entries a paginated response contains.
*/ MaxResults?: number; } @@ -1070,16 +1080,13 @@ export namespace GetAnomalySubscriptionsRequest { export interface GetAnomalySubscriptionsResponse { /** - *- * A list of cost anomaly subscriptions that includes the detailed metadata for each one. - *
+ *A list of cost anomaly subscriptions that includes the detailed metadata for each one.
*/ AnomalySubscriptions: AnomalySubscription[] | undefined; /** - *- * The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size. - *
+ *The token to retrieve the next set of results. Amazon Web Services provides the token when + * the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; } @@ -1142,8 +1149,8 @@ export enum GroupDefinitionType { } /** - *Represents a group when you specify a group by criteria or in the response to a - * query with a specific grouping.
+ *Represents a group when you specify a group by criteria or in the response to a query + * with a specific grouping.
*/ export interface GroupDefinition { /** @@ -1167,23 +1174,21 @@ export namespace GroupDefinition { } /** - *The time period of the request. - *
+ *The time period of the request.
*/ export interface DateInterval { /** - *The beginning of the time period. The start
- * date is inclusive. For example, if start is 2017-01-01, AWS
- * retrieves cost and usage data starting at 2017-01-01 up to the end
- * date. The start date must be equal to or no later than the current date to avoid a validation error.
The beginning of the time period. The start date is inclusive. For example, if
+ * start is 2017-01-01, Amazon Web Services retrieves cost and
+ * usage data starting at 2017-01-01 up to the end date. The start date must
+ * be equal to or no later than the current date to avoid a validation error.
The end of the time period. The end date is
- * exclusive. For example, if end is 2017-05-01, AWS retrieves
- * cost and usage data from the start date up to, but not including,
- * 2017-05-01.
The end of the time period. The end date is exclusive. For example, if
+ * end is 2017-05-01, Amazon Web Services retrieves cost and
+ * usage data from the start date up to, but not including, 2017-05-01.
The metadata of a specific type that you can use to filter and group your results.
- * You can use GetDimensionValues to find specific values.
The metadata of a specific type that you can use to filter and group your results. You
+ * can use GetDimensionValues to find specific values.
The result that is associated with a time period.
+ *The result that's associated with a time period.
*/ export interface ResultByTime { /** @@ -1290,8 +1295,7 @@ export interface ResultByTime { Groups?: Group[]; /** - *Whether - * the result is estimated.
+ *Determines whether the result is estimated.
*/ Estimated?: boolean; } @@ -1307,7 +1311,7 @@ export namespace ResultByTime { export interface GetCostAndUsageResponse { /** - *The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
+ *The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; @@ -1317,7 +1321,7 @@ export interface GetCostAndUsageResponse { GroupDefinitions?: GroupDefinition[]; /** - *The time period that is covered by the results in the response.
+ *The time period that's covered by the results in the response.
*/ ResultsByTime?: ResultByTime[]; @@ -1357,7 +1361,7 @@ export namespace RequestChangedException { export interface GetCostAndUsageWithResourcesResponse { /** - *The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
+ *The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; @@ -1397,12 +1401,12 @@ export enum SortOrder { */ export interface SortDefinition { /** - *The key by which to sort the data.
+ *The key that's used to sort the data.
*/ Key: string | undefined; /** - *The order in which to sort the data.
+ *The order that's used to sort the data.
*/ SortOrder?: SortOrder | string; } @@ -1418,7 +1422,7 @@ export namespace SortDefinition { export interface GetCostCategoriesResponse { /** - *If the number of objects that are still available for retrieval exceeds the limit, AWS returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
+ *If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
*/ NextPageToken?: string; @@ -1429,7 +1433,7 @@ export interface GetCostCategoriesResponse { /** *The Cost Category values.
- *+ *
* CostCategoryValues are not returned if CostCategoryName is not specified in the request.
The forecast created for your query.
+ *The forecast that's created for your query.
*/ export interface ForecastResult { /** @@ -1542,11 +1546,11 @@ export interface GetDimensionValuesResponse { *INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
+ *LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.
*LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value - * field contains the AWS ID of the member account.
+ * field contains the Amazon Web Services ID of the member account. *OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
@@ -1562,7 +1566,7 @@ export interface GetDimensionValuesResponse { * Instances and Standard Reserved Instances. *SERVICE - The AWS service such as Amazon DynamoDB.
+ *SERVICE - The Amazon Web Services service such as Amazon DynamoDB.
*USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation
@@ -1596,13 +1600,13 @@ export interface GetDimensionValuesResponse {
*
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value - * field contains the AWS ID of the member account.
+ * field contains the Amazon Web Services ID of the member account. *PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*REGION - The AWS Region.
+ *REGION - The Amazon Web Services Region.
*SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
@@ -1623,14 +1627,14 @@ export interface GetDimensionValuesResponse { *PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
*REGION - The AWS Region.
+ *REGION - The Amazon Web Services Region.
*INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value - * field contains the AWS ID of the member account.
+ * field contains the Amazon Web Services ID of the member account. *SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
@@ -1640,7 +1644,7 @@ export interface GetDimensionValuesResponse { DimensionValues: DimensionValuesWithAttributes[] | undefined; /** - *The number of results that AWS returned at one time.
+ *The number of results that Amazon Web Services returned at one time.
*/ ReturnSize: number | undefined; @@ -1650,7 +1654,7 @@ export interface GetDimensionValuesResponse { TotalSize: number | undefined; /** - *The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
+ *The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; } @@ -1718,15 +1722,16 @@ export namespace CoverageHours { } /** - *The amount of instance usage, in normalized units. Normalized units enable you to - * see your EC2 usage for multiple sizes of instances in a uniform way. For example, - * suppose you run an xlarge instance and a 2xlarge instance. If you run both instances for + *
The amount of instance usage, in normalized units. You can use normalized units to see + * your EC2 usage for multiple sizes of instances in a uniform way. For example, suppose + * that you run an xlarge instance and a 2xlarge instance. If you run both instances for * the same amount of time, the 2xlarge instance uses twice as much of your reservation as - * the xlarge instance, even though both instances show only one instance-hour. Using - * normalized units instead of instance-hours, the xlarge instance used 8 normalized units, - * and the 2xlarge instance used 16 normalized units.
- *For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide for - * Linux Instances.
+ * the xlarge instance, even though both instances show only one instance-hour. When you + * use normalized units instead of instance-hours, the xlarge instance used 8 normalized + * units, and the 2xlarge instance used 16 normalized units. + *For more information, see Modifying Reserved Instances + * in the Amazon Elastic Compute Cloud User Guide for Linux + * Instances.
*/ export interface CoverageNormalizedUnits { /** @@ -1771,8 +1776,7 @@ export interface Coverage { CoverageHours?: CoverageHours; /** - *The amount of instance usage that the reservation covered, in normalized - * units.
+ *The amount of instance usage that the reservation covered, in normalized units.
*/ CoverageNormalizedUnits?: CoverageNormalizedUnits; @@ -1792,8 +1796,7 @@ export namespace Coverage { } /** - *A - * group of reservations that share a set of attributes.
+ *A group of reservations that share a set of attributes.
*/ export interface ReservationCoverageGroup { /** @@ -1817,9 +1820,7 @@ export namespace ReservationCoverageGroup { } /** - *Reservation - * coverage for a specified period, in - * hours.
+ *Reservation coverage for a specified period, in hours.
*/ export interface CoverageByTime { /** @@ -1859,7 +1860,7 @@ export interface GetReservationCoverageResponse { Total?: Coverage; /** - *The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
+ *The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; } @@ -1894,12 +1895,12 @@ export enum OfferingClass { } /** - *The Amazon EC2 hardware specifications that you want AWS to provide recommendations - * for.
+ *The Amazon EC2 hardware specifications that you want Amazon Web Services to provide + * recommendations for.
*/ export interface EC2Specification { /** - *Whether you want a recommendation for standard or convertible + *
Indicates whether you want a recommendation for standard or convertible * reservations.
*/ OfferingClass?: OfferingClass | string; @@ -1915,13 +1916,12 @@ export namespace EC2Specification { } /** - *Hardware specifications for the service that you want recommendations - * for.
+ *Hardware specifications for the service that you want recommendations for.
*/ export interface ServiceSpecification { /** - *The Amazon EC2 hardware specifications that you want AWS to provide recommendations - * for.
+ *The Amazon EC2 hardware specifications that you want Amazon Web Services to provide + * recommendations for.
*/ EC2Specification?: EC2Specification; } @@ -1941,8 +1941,7 @@ export enum TermInYears { } /** - *Information about this specific recommendation, such as the timestamp for when AWS - * made a specific recommendation.
+ *Information about this specific recommendation, such as the timestamp for when Amazon Web Services made a specific recommendation.
*/ export interface ReservationPurchaseRecommendationMetadata { /** @@ -1951,7 +1950,7 @@ export interface ReservationPurchaseRecommendationMetadata { RecommendationId?: string; /** - *The timestamp for when AWS made this recommendation.
+ *The timestamp for when Amazon Web Services made this recommendation.
*/ GenerationTimestamp?: string; } @@ -1966,7 +1965,8 @@ export namespace ReservationPurchaseRecommendationMetadata { } /** - *Details about the Amazon EC2 instances that AWS recommends that you purchase.
+ *Details about the Amazon EC2 instances that Amazon Web Services recommends that you + * purchase.
*/ export interface EC2InstanceDetails { /** @@ -1975,12 +1975,12 @@ export interface EC2InstanceDetails { Family?: string; /** - *The type of instance that AWS recommends.
+ *The type of instance that Amazon Web Services recommends.
*/ InstanceType?: string; /** - *The AWS Region of the recommended reservation.
+ *The Amazon Web Services Region of the recommended reservation.
*/ Region?: string; @@ -1990,23 +1990,23 @@ export interface EC2InstanceDetails { AvailabilityZone?: string; /** - *The platform of the recommended reservation. The platform is the specific - * combination of operating system, license model, and software on an instance.
+ *The platform of the recommended reservation. The platform is the specific combination + * of operating system, license model, and software on an instance.
*/ Platform?: string; /** - *Whether the recommended reservation is dedicated or shared.
+ *Determines whether the recommended reservation is dedicated or shared.
*/ Tenancy?: string; /** - *Whether the recommendation is for a current-generation instance.
+ *Determines whether the recommendation is for a current-generation instance.
*/ CurrentGeneration?: boolean; /** - *Whether the recommended reservation is size flexible.
+ *Determines whether the recommended reservation is size flexible.
*/ SizeFlexEligible?: boolean; } @@ -2021,8 +2021,8 @@ export namespace EC2InstanceDetails { } /** - *Details about the Amazon ElastiCache instances that AWS recommends that you - * purchase.
+ *Details about the Amazon ElastiCache instances that Amazon Web Services recommends that + * you purchase.
*/ export interface ElastiCacheInstanceDetails { /** @@ -2031,12 +2031,12 @@ export interface ElastiCacheInstanceDetails { Family?: string; /** - *The type of node that AWS recommends.
+ *The type of node that Amazon Web Services recommends.
*/ NodeType?: string; /** - *The AWS Region of the recommended reservation.
+ *The Amazon Web Services Region of the recommended reservation.
*/ Region?: string; @@ -2046,12 +2046,12 @@ export interface ElastiCacheInstanceDetails { ProductDescription?: string; /** - *Whether the recommendation is for a current generation instance.
+ *Determines whether the recommendation is for a current generation instance.
*/ CurrentGeneration?: boolean; /** - *Whether the recommended reservation is size flexible.
+ *Determines whether the recommended reservation is size flexible.
*/ SizeFlexEligible?: boolean; } @@ -2066,32 +2066,32 @@ export namespace ElastiCacheInstanceDetails { } /** - *Details about the Amazon ES instances that AWS recommends that you + *
Details about the Amazon ES instances that Amazon Web Services recommends that you * purchase.
*/ export interface ESInstanceDetails { /** - *The class of instance that AWS recommends.
+ *The class of instance that Amazon Web Services recommends.
*/ InstanceClass?: string; /** - *The size of instance that AWS recommends.
+ *The size of instance that Amazon Web Services recommends.
*/ InstanceSize?: string; /** - *The AWS Region of the recommended reservation.
+ *The Amazon Web Services Region of the recommended reservation.
*/ Region?: string; /** - *Whether the recommendation is for a current-generation instance.
+ *Determines whether the recommendation is for a current-generation instance.
*/ CurrentGeneration?: boolean; /** - *Whether the recommended reservation is size flexible.
+ *Determines whether the recommended reservation is size flexible.
*/ SizeFlexEligible?: boolean; } @@ -2106,7 +2106,7 @@ export namespace ESInstanceDetails { } /** - *Details about the Amazon RDS instances that AWS recommends that you + *
Details about the Amazon RDS instances that Amazon Web Services recommends that you * purchase.
*/ export interface RDSInstanceDetails { @@ -2116,12 +2116,12 @@ export interface RDSInstanceDetails { Family?: string; /** - *The type of instance that AWS recommends.
+ *The type of instance that Amazon Web Services recommends.
*/ InstanceType?: string; /** - *The AWS Region of the recommended reservation.
+ *The Amazon Web Services Region of the recommended reservation.
*/ Region?: string; @@ -2136,8 +2136,8 @@ export interface RDSInstanceDetails { DatabaseEdition?: string; /** - *Whether the recommendation is for a reservation in a single Availability Zone or a - * reservation with a backup in a second Availability Zone.
+ *Determines whether the recommendation is for a reservation in a single Availability + * Zone or a reservation with a backup in a second Availability Zone.
*/ DeploymentOption?: string; @@ -2147,12 +2147,12 @@ export interface RDSInstanceDetails { LicenseModel?: string; /** - *Whether the recommendation is for a current-generation instance.
+ *Determines whether the recommendation is for a current-generation instance.
*/ CurrentGeneration?: boolean; /** - *Whether the recommended reservation is size flexible.
+ *Determines whether the recommended reservation is size flexible.
*/ SizeFlexEligible?: boolean; } @@ -2167,8 +2167,8 @@ export namespace RDSInstanceDetails { } /** - *Details about the Amazon Redshift instances that AWS recommends that you - * purchase.
+ *Details about the Amazon Redshift instances that Amazon Web Services recommends that + * you purchase.
*/ export interface RedshiftInstanceDetails { /** @@ -2177,22 +2177,22 @@ export interface RedshiftInstanceDetails { Family?: string; /** - *The type of node that AWS recommends.
+ *The type of node that Amazon Web Services recommends.
*/ NodeType?: string; /** - *The AWS Region of the recommended reservation.
+ *The Amazon Web Services Region of the recommended reservation.
*/ Region?: string; /** - *Whether the recommendation is for a current-generation instance.
+ *Determines whether the recommendation is for a current-generation instance.
*/ CurrentGeneration?: boolean; /** - *Whether the recommended reservation is size flexible.
+ *Determines whether the recommended reservation is size flexible.
*/ SizeFlexEligible?: boolean; } @@ -2207,31 +2207,33 @@ export namespace RedshiftInstanceDetails { } /** - *Details about the instances that AWS recommends that you purchase.
+ *Details about the instances that Amazon Web Services recommends that you + * purchase.
*/ export interface InstanceDetails { /** - *The Amazon EC2 instances that AWS recommends that you purchase.
+ *The Amazon EC2 instances that Amazon Web Services recommends that you purchase.
*/ EC2InstanceDetails?: EC2InstanceDetails; /** - *The Amazon RDS instances that AWS recommends that you purchase.
+ *The Amazon RDS instances that Amazon Web Services recommends that you purchase.
*/ RDSInstanceDetails?: RDSInstanceDetails; /** - *The Amazon Redshift instances that AWS recommends that you purchase.
+ *The Amazon Redshift instances that Amazon Web Services recommends that you + * purchase.
*/ RedshiftInstanceDetails?: RedshiftInstanceDetails; /** - *The ElastiCache instances that AWS recommends that you purchase.
+ *The ElastiCache instances that Amazon Web Services recommends that you purchase.
*/ ElastiCacheInstanceDetails?: ElastiCacheInstanceDetails; /** - *The Amazon ES instances that AWS recommends that you purchase.
+ *The Amazon ES instances that Amazon Web Services recommends that you purchase.
*/ ESInstanceDetails?: ESInstanceDetails; } @@ -2255,98 +2257,103 @@ export interface ReservationPurchaseRecommendationDetail { AccountId?: string; /** - *Details about the instances that AWS recommends that you purchase.
+ *Details about the instances that Amazon Web Services recommends that you + * purchase.
*/ InstanceDetails?: InstanceDetails; /** - *The number of instances that AWS recommends that you purchase.
+ *The number of instances that Amazon Web Services recommends that you purchase.
*/ RecommendedNumberOfInstancesToPurchase?: string; /** - *The number of normalized units that AWS recommends that you purchase.
+ *The number of normalized units that Amazon Web Services recommends that you + * purchase.
*/ RecommendedNormalizedUnitsToPurchase?: string; /** - *The minimum number of instances that you used in an hour during the historical - * period. AWS uses this to calculate your recommended reservation purchases.
+ *The minimum number of instances that you used in an hour during the historical period. + * Amazon Web Services uses this to calculate your recommended reservation + * purchases.
*/ MinimumNumberOfInstancesUsedPerHour?: string; /** - *The minimum number of normalized units that you used in an hour during the - * historical period. AWS uses this to calculate your recommended reservation + *
The minimum number of normalized units that you used in an hour during the historical + * period. Amazon Web Services uses this to calculate your recommended reservation * purchases.
*/ MinimumNormalizedUnitsUsedPerHour?: string; /** - *The maximum number of instances that you used in an hour during the historical - * period. AWS uses this to calculate your recommended reservation purchases.
+ *The maximum number of instances that you used in an hour during the historical period. + * Amazon Web Services uses this to calculate your recommended reservation + * purchases.
*/ MaximumNumberOfInstancesUsedPerHour?: string; /** - *The maximum number of normalized units that you used in an hour during the - * historical period. AWS uses this to calculate your recommended reservation + *
The maximum number of normalized units that you used in an hour during the historical + * period. Amazon Web Services uses this to calculate your recommended reservation * purchases.
*/ MaximumNormalizedUnitsUsedPerHour?: string; /** - *The average number of instances that you used in an hour during the historical - * period. AWS uses this to calculate your recommended reservation purchases.
+ *The average number of instances that you used in an hour during the historical period. + * Amazon Web Services uses this to calculate your recommended reservation + * purchases.
*/ AverageNumberOfInstancesUsedPerHour?: string; /** - *The average number of normalized units that you used in an hour during the - * historical period. AWS uses this to calculate your recommended reservation + *
The average number of normalized units that you used in an hour during the historical + * period. Amazon Web Services uses this to calculate your recommended reservation * purchases.
*/ AverageNormalizedUnitsUsedPerHour?: string; /** - *The average utilization of your instances. AWS uses this to calculate your - * recommended reservation purchases.
+ *The average utilization of your instances. Amazon Web Services uses this to calculate + * your recommended reservation purchases.
*/ AverageUtilization?: string; /** - *How long AWS estimates that it takes for this instance to start saving you money, - * in months.
+ *How long Amazon Web Services estimates that it takes for this instance to start saving + * you money, in months.
*/ EstimatedBreakEvenInMonths?: string; /** - *The currency code that AWS used to calculate the costs for this instance.
+ *The currency code that Amazon Web Services used to calculate the costs for this + * instance.
*/ CurrencyCode?: string; /** - *How much AWS estimates that this specific recommendation could save you in a - * month.
+ *How much Amazon Web Services estimates that this specific recommendation could save you + * in a month.
*/ EstimatedMonthlySavingsAmount?: string; /** - *How much AWS estimates that this specific recommendation could save you in a month, - * as a percentage of your overall costs.
+ *How much Amazon Web Services estimates that this specific recommendation could save you + * in a month, as a percentage of your overall costs.
*/ EstimatedMonthlySavingsPercentage?: string; /** - *How much AWS estimates that you spend on On-Demand Instances in a month.
+ *How much Amazon Web Services estimates that you spend on On-Demand Instances in a + * month.
*/ EstimatedMonthlyOnDemandCost?: string; /** - *How much AWS estimates that you would have spent for all usage during the specified - * historical period if you had - * a - * reservation.
+ *How much Amazon Web Services estimates that you would have spent for all usage during + * the specified historical period if you had a reservation.
*/ EstimatedReservationCostForLookbackPeriod?: string; @@ -2371,20 +2378,20 @@ export namespace ReservationPurchaseRecommendationDetail { } /** - *A summary about this recommendation, such as the currency code, the amount that AWS - * estimates that you could save, and the total amount of reservation to - * purchase.
+ *A summary about this recommendation, such as the currency code, the amount that + * Amazon Web Services estimates that you could save, and the total amount of + * reservation to purchase.
*/ export interface ReservationPurchaseRecommendationSummary { /** - *The total amount that AWS estimates that this recommendation could save you in a - * month.
+ *The total amount that Amazon Web Services estimates that this recommendation could save + * you in a month.
*/ TotalEstimatedMonthlySavingsAmount?: string; /** - *The total amount that AWS estimates that this recommendation could save you in a - * month, as a percentage of your costs.
+ *The total amount that Amazon Web Services estimates that this recommendation could save + * you in a month, as a percentage of your costs.
*/ TotalEstimatedMonthlySavingsPercentage?: string; @@ -2404,18 +2411,18 @@ export namespace ReservationPurchaseRecommendationSummary { } /** - *A specific reservation that AWS recommends for purchase.
+ *A specific reservation that Amazon Web Services recommends for purchase.
*/ export interface ReservationPurchaseRecommendation { /** - *The account scope that AWS recommends that you purchase this instance for. For - * example, you can purchase this reservation for an entire organization in AWS - * Organizations.
+ *The account scope that Amazon Web Services recommends that you purchase this instance + * for. For example, you can purchase this reservation for an entire organization in + * Amazon Web Services Organizations.
*/ AccountScope?: AccountScope | string; /** - *How many days of previous usage that AWS considers when making this + *
How many days of previous usage that Amazon Web Services considers when making this * recommendation.
*/ LookbackPeriodInDays?: LookbackPeriodInDays | string; @@ -2426,14 +2433,13 @@ export interface ReservationPurchaseRecommendation { TermInYears?: TermInYears | string; /** - *The payment option for the reservation. For example, AllUpfront or
- * NoUpfront.
The payment option for the reservation (for example, AllUpfront or
+ * NoUpfront).
Hardware specifications for the service that you want recommendations - * for.
+ *Hardware specifications for the service that you want recommendations for.
*/ ServiceSpecification?: ServiceSpecification; @@ -2493,9 +2499,9 @@ export interface ReservationAggregates { UtilizationPercentage?: string; /** - *The percentage of Amazon EC2 reservation time that you used, converted to normalized - * units. Normalized units are available only for Amazon EC2 usage after November 11, - * 2017.
+ *The percentage of Amazon EC2 reservation time that you used. It's converted to + * normalized units. Normalized units are available only for Amazon EC2 usage after + * November 11, 2017.
*/ UtilizationPercentageInUnits?: string; @@ -2505,8 +2511,9 @@ export interface ReservationAggregates { PurchasedHours?: string; /** - *How many Amazon EC2 reservation hours that you purchased, converted to normalized units. - * Normalized units are available only for Amazon EC2 usage after November 11, 2017.
+ *The number of Amazon EC2 reservation hours that you purchased. It's converted to + * normalized units. Normalized units are available only for Amazon EC2 usage after + * November 11, 2017.
*/ PurchasedUnits?: string; @@ -2516,9 +2523,9 @@ export interface ReservationAggregates { TotalActualHours?: string; /** - *The total number of Amazon EC2 reservation hours that you used, converted to normalized - * units. Normalized units are available only for Amazon EC2 usage after November 11, - * 2017.
+ *The total number of Amazon EC2 reservation hours that you used. It's converted to + * normalized units. Normalized units are available only for Amazon EC2 usage after + * November 11, 2017.
*/ TotalActualUnits?: string; @@ -2528,44 +2535,43 @@ export interface ReservationAggregates { UnusedHours?: string; /** - *The number of Amazon EC2 reservation hours that you didn't use, converted to normalized - * units. Normalized units are available only for Amazon EC2 usage after November 11, - * 2017.
+ *The number of Amazon EC2 reservation hours that you didn't use. It's converted to + * normalized units. Normalized units are available only for Amazon EC2 usage after + * November 11, 2017.
*/ UnusedUnits?: string; /** - *How much your reservation would cost if charged On-Demand rates.
+ *How much your reservation costs if charged On-Demand rates.
*/ OnDemandCostOfRIHoursUsed?: string; /** - *How much you saved due to purchasing and utilizing reservation. AWS calculates this
- * by subtracting TotalAmortizedFee from
+ *
How much you saved due to purchasing and utilizing reservation. Amazon Web Services
+ * calculates this by subtracting TotalAmortizedFee from
* OnDemandCostOfRIHoursUsed.
How much you could save if you use your entire reservation.
+ *How much you might save if you use your entire reservation.
*/ TotalPotentialRISavings?: string; /** - *The upfront cost of your reservation, amortized over the reservation + *
The upfront cost of your reservation. It's amortized over the reservation * period.
*/ AmortizedUpfrontFee?: string; /** - *The monthly cost of your reservation, amortized over the reservation + *
The monthly cost of your reservation. It's amortized over the reservation * period.
*/ AmortizedRecurringFee?: string; /** - *The total cost of your reservation, amortized over the reservation - * period.
+ *The total cost of your reservation. It's amortized over the reservation period.
*/ TotalAmortizedFee?: string; @@ -2575,12 +2581,12 @@ export interface ReservationAggregates { RICostForUnusedHours?: string; /** - *The realized savings due to purchasing and using a reservation.
+ *The realized savings because of purchasing and using a reservation.
*/ RealizedSavings?: string; /** - *The unrealized savings due to purchasing and using a reservation.
+ *The unrealized savings because of purchasing and using a reservation.
*/ UnrealizedSavings?: string; } @@ -2669,7 +2675,7 @@ export interface GetReservationUtilizationResponse { Total?: ReservationAggregates; /** - *The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
+ *The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; } @@ -2689,24 +2695,23 @@ export enum RecommendationTarget { } /** - *Enables you to customize recommendations across two attributes. You can choose to view - * recommendations for instances within the same instance families or across different instance - * families. You can also choose to view your estimated savings associated with recommendations - * with consideration of existing Savings Plans or RI benefits, or - * neither.
+ *You can use RightsizingRecommendationConfiguration to customize
+ * recommendations across two attributes. You can choose to view recommendations for
+ * instances within the same instance families or across different instance families. You
+ * can also choose to view your estimated savings that are associated with recommendations
+ * with consideration of existing Savings Plans or RI benefits, or neither.
- * The option to see recommendations within the same instance family, or recommendations for instances across other families. The default value is SAME_INSTANCE_FAMILY.
- *
The option to see recommendations within the same instance family or recommendations
+ * for instances across other families. The default value is
+ * SAME_INSTANCE_FAMILY.
- * The option to consider RI or Savings Plans discount benefits in your savings calculation. The default value is TRUE.
- *
The option to consider RI or Savings Plans discount benefits in your savings
+ * calculation. The default value is TRUE.
The ID for this specific recommendation.
+ *The ID for this specific recommendation.
*/ RecommendationId?: string; /** - *The timestamp for when AWS made this recommendation.
+ *The timestamp for when Amazon Web Services made this recommendation.
*/ GenerationTimestamp?: string; /** - *How many days of previous usage that AWS considers when making this - * recommendation.
+ *The number of days of previous usage that Amazon Web Services considers when making + * this recommendation.
*/ LookbackPeriodInDays?: LookbackPeriodInDays | string; /** - *Additional metadata that may be applicable to the recommendation.
+ *Additional metadata that might be applicable to the recommendation.
*/ AdditionalMetadata?: string; } @@ -2756,52 +2761,53 @@ export namespace RightsizingRecommendationMetadata { } /** - *Details on the Amazon EC2 Resource.
+ *Details on the Amazon EC2 Resource.
*/ export interface EC2ResourceDetails { /** - *Hourly public On-Demand rate for the instance type.
+ *The hourly public On-Demand rate for the instance type.
*/ HourlyOnDemandRate?: string; /** - *The type of AWS instance.
+ *The type of Amazon Web Services instance.
*/ InstanceType?: string; /** - *The platform of the AWS instance. The platform is the specific combination of - * operating system, license model, and software on an instance.
+ *The platform of the Amazon Web Services instance. The platform is the specific + * combination of operating system, license model, and software on an instance.
*/ Platform?: string; /** - *The AWS Region of the instance.
+ *The Amazon Web Services Region of the instance.
*/ Region?: string; /** - *The SKU of the product.
+ *The SKU of the product.
*/ Sku?: string; /** - *Memory capacity of the AWS instance.
+ *The memory capacity of the Amazon Web Services instance.
*/ Memory?: string; /** - *Network performance capacity of the AWS instance.
+ *The network performance capacity of the Amazon Web Services instance.
*/ NetworkPerformance?: string; /** - *The disk storage of the AWS instance (not EBS storage).
+ *The disk storage of the Amazon Web Services instance. This doesn't include EBS + * storage.
*/ Storage?: string; /** - *Number of VCPU cores in the AWS instance type.
+ *The number of VCPU cores in the Amazon Web Services instance type.
*/ Vcpu?: string; } @@ -2835,36 +2841,27 @@ export namespace ResourceDetails { } /** - *- * The field that contains a list of disk (local storage) metrics associated with the current instance. - *
+ *The field that contains a list of disk (local storage) metrics that are associated + * with the current instance.
*/ export interface DiskResourceUtilization { /** - *- * The maximum number of read operations per second. - *
+ *The maximum number of read operations per second.
*/ DiskReadOpsPerSecond?: string; /** - *- * The maximum number of write operations per second. - *
+ *The maximum number of write operations per second.
*/ DiskWriteOpsPerSecond?: string; /** - *- * The maximum read throughput operations per second. - *
+ *The maximum read throughput operations per second.
*/ DiskReadBytesPerSecond?: string; /** - *- * The maximum write throughput operations per second. - *
+ *The maximum write throughput operations per second.
*/ DiskWriteBytesPerSecond?: string; } @@ -2879,36 +2876,27 @@ export namespace DiskResourceUtilization { } /** - *- * The EBS field that contains a list of EBS metrics associated with the current instance. - *
+ *The EBS field that contains a list of EBS metrics that are associated with the current + * instance.
*/ export interface EBSResourceUtilization { /** - *- * The maximum number of read operations per second. - *
+ *The maximum number of read operations per second.
*/ EbsReadOpsPerSecond?: string; /** - *- * The maximum number of write operations per second. - *
+ *The maximum number of write operations per second.
*/ EbsWriteOpsPerSecond?: string; /** - *- * The maximum size of read operations per second - *
+ *The maximum size of read operations per second
*/ EbsReadBytesPerSecond?: string; /** - *- * The maximum size of write operations per second. - *
+ *The maximum size of write operations per second.
*/ EbsWriteBytesPerSecond?: string; } @@ -2923,36 +2911,27 @@ export namespace EBSResourceUtilization { } /** - *- * The network field that contains a list of network metrics associated with the current instance. - *
+ *The network field that contains a list of network metrics that are associated with + * the current instance.
*/ export interface NetworkResourceUtilization { /** - *- * The network ingress throughput utilization measured in Bytes per second. - *
+ *The network inbound throughput utilization measured in Bytes per second.
*/ NetworkInBytesPerSecond?: string; /** - *- * The network outgress throughput utilization measured in Bytes per second. - *
+ *The network outbound throughput utilization measured in Bytes per second.
*/ NetworkOutBytesPerSecond?: string; /** - *- * The network ingress packets measured in packets per second. - *
+ *The network ingress packets that are measured in packets per second.
*/ NetworkPacketsInPerSecond?: string; /** - *- * The network outgress packets measured in packets per second. - *
+ *The network outgress packets that are measured in packets per second.
*/ NetworkPacketsOutPerSecond?: string; } @@ -2967,42 +2946,40 @@ export namespace NetworkResourceUtilization { } /** - *Utilization metrics of the instance.
+ *Utilization metrics of the instance.
*/ export interface EC2ResourceUtilization { /** - *Maximum observed or expected CPU utilization of the instance.
+ *The maximum observed or expected CPU utilization of the instance.
*/ MaxCpuUtilizationPercentage?: string; /** - *Maximum observed or expected memory utilization of the instance.
+ *The maximum observed or expected memory utilization of the instance.
*/ MaxMemoryUtilizationPercentage?: string; /** - *Maximum observed or expected storage utilization of the instance (does not measure EBS storage).
+ *The maximum observed or expected storage utilization of the instance. This doesn't + * include EBS storage.
*/ MaxStorageUtilizationPercentage?: string; /** - *- * The EBS field that contains a list of EBS metrics associated with the current instance. - *
+ *The EBS field that contains a list of EBS metrics that are associated with the current + * instance.
*/ EBSResourceUtilization?: EBSResourceUtilization; /** - *- * The field that contains a list of disk (local storage) metrics associated with the current instance. - *
+ *The field that contains a list of disk (local storage) metrics that are associated + * with the current instance.
*/ DiskResourceUtilization?: DiskResourceUtilization; /** - *- * The network field that contains a list of network metrics associated with the current instance. - *
+ *The network field that contains a list of network metrics that are associated with + * the current instance.
*/ NetworkResourceUtilization?: NetworkResourceUtilization; } @@ -3017,11 +2994,11 @@ export namespace EC2ResourceUtilization { } /** - *Resource utilization of current resource.
+ *Resource utilization of current resource.
*/ export interface ResourceUtilization { /** - *Utilization of current Amazon EC2 instance.
+ *The utilization of current Amazon EC2 instance.
*/ EC2ResourceUtilization?: EC2ResourceUtilization; } @@ -3045,52 +3022,55 @@ export interface CurrentInstance { ResourceId?: string; /** - *The name you've given an instance. This field will show as blank if you haven't given the instance a name.
+ *The name that you given an instance. This field shows as blank if you haven't given + * the instance a name.
*/ InstanceName?: string; /** - *Cost allocation resource tags applied to the instance.
+ *Cost allocation resource tags that are applied to the instance.
*/ Tags?: TagValues[]; /** - *Details about the resource and utilization.
+ *Details about the resource and utilization.
*/ ResourceDetails?: ResourceDetails; /** - *Utilization information of the current instance during the lookback period.
+ *Utilization information of the current instance during the lookback period.
*/ ResourceUtilization?: ResourceUtilization; /** - *Number of hours during the lookback period covered by reservations.
+ *The number of hours during the lookback period that's covered by reservations.
*/ ReservationCoveredHoursInLookbackPeriod?: string; /** - *Number of hours during the lookback period covered by Savings Plans.
+ *The number of hours during the lookback period that's covered by Savings Plans.
*/ SavingsPlansCoveredHoursInLookbackPeriod?: string; /** - *Number of hours during the lookback period billed at On-Demand rates.
+ *The number of hours during the lookback period that's billed at On-Demand + * rates.
*/ OnDemandHoursInLookbackPeriod?: string; /** - *The total number of hours the instance ran during the lookback period.
+ *The total number of hours that the instance ran during the lookback period.
*/ TotalRunningHoursInLookbackPeriod?: string; /** - *Current On-Demand cost of operating this instance on a monthly basis.
+ *The current On-Demand cost of operating this instance on a monthly basis.
*/ MonthlyCost?: string; /** - *The currency code that AWS used to calculate the costs for this instance.
+ *The currency code that Amazon Web Services used to calculate the costs for this + * instance.
*/ CurrencyCode?: string; } @@ -3132,43 +3112,44 @@ export enum PlatformDifference { } /** - *Details on recommended instance.
+ *Details on recommended instance.
*/ export interface TargetInstance { /** - *Expected cost to operate this instance type on a monthly basis.
+ *The expected cost to operate this instance type on a monthly basis.
*/ EstimatedMonthlyCost?: string; /** - *Estimated savings resulting from modification, on a monthly basis.
+ *The estimated savings that result from modification, on a monthly basis.
*/ EstimatedMonthlySavings?: string; /** - *The currency code that AWS used to calculate the costs for this instance.
+ *The currency code that Amazon Web Services used to calculate the costs for this + * instance.
*/ CurrencyCode?: string; /** - *Indicates whether this recommendation is the defaulted AWS recommendation.
+ *Determines whether this recommendation is the defaulted Amazon Web Services + * recommendation.
*/ DefaultTargetInstance?: boolean; /** - *Details on the target instance type.
+ *Details on the target instance type.
*/ ResourceDetails?: ResourceDetails; /** - *Expected utilization metrics for target instance type.
+ *The expected utilization metrics for target instance type.
*/ ExpectedResourceUtilization?: ResourceUtilization; /** - *- * Explains the actions you might need to take in order to successfully migrate your workloads from the current instance type to the recommended instance type. - *
+ *Explains the actions you might need to take in order to successfully migrate your + * workloads from the current instance type to the recommended instance type.
*/ PlatformDifferences?: (PlatformDifference | string)[]; } @@ -3187,7 +3168,8 @@ export namespace TargetInstance { */ export interface ModifyRecommendationDetail { /** - *Identifies whether this instance type is the AWS default recommendation.
+ *Determines whether this instance type is the Amazon Web Services default + * recommendation.
*/ TargetInstances?: TargetInstance[]; } @@ -3207,16 +3189,17 @@ export enum RightsizingType { } /** - *Details on termination recommendation.
+ *Details on termination recommendation.
*/ export interface TerminateRecommendationDetail { /** - *Estimated savings resulting from modification, on a monthly basis.
+ *The estimated savings that result from modification, on a monthly basis.
*/ EstimatedMonthlySavings?: string; /** - *The currency code that AWS used to calculate the costs for this instance.
+ *The currency code that Amazon Web Services used to calculate the costs for this + * instance.
*/ CurrencyCode?: string; } @@ -3240,29 +3223,28 @@ export interface RightsizingRecommendation { AccountId?: string; /** - *Context regarding the current instance.
+ *Context regarding the current instance.
*/ CurrentInstance?: CurrentInstance; /** - *Recommendation to either terminate or modify the resource.
+ *A recommendation to either terminate or modify the resource.
*/ RightsizingType?: RightsizingType | string; /** - *Details for modification recommendations.
+ *The details for the modification recommendations.
*/ ModifyRecommendationDetail?: ModifyRecommendationDetail; /** - *Details for termination recommendations.
+ *The details for termination recommendations.
*/ TerminateRecommendationDetail?: TerminateRecommendationDetail; /** - *- * The list of possible reasons why the recommendation is generated such as under or over utilization of specific metrics (for example, CPU, Memory, Network). - *
+ *The list of possible reasons why the recommendation is generated such as under or + * over utilization of specific metrics (for example, CPU, Memory, Network).
*/ FindingReasonCodes?: (FindingReasonCode | string)[]; } @@ -3277,28 +3259,27 @@ export namespace RightsizingRecommendation { } /** - *Summary of rightsizing recommendations
+ *The summary of rightsizing recommendations
*/ export interface RightsizingRecommendationSummary { /** - *Total number of instance recommendations.
+ *The total number of instance recommendations.
*/ TotalRecommendationCount?: string; /** - *Estimated total savings resulting from modifications, on a monthly basis.
+ *The estimated total savings resulting from modifications, on a monthly basis.
*/ EstimatedTotalMonthlySavingsAmount?: string; /** - *The currency code that AWS used to calculate the savings.
+ *The currency code that Amazon Web Services used to calculate the savings.
*/ SavingsCurrencyCode?: string; /** - *Savings percentage based on the recommended modifications, relative to the total - * On-Demand - * costs associated with these instances.
+ *The savings percentage based on the recommended modifications. It's relative to the + * total On-Demand costs that are associated with these instances.
*/ SavingsPercentage?: string; } @@ -3353,27 +3334,29 @@ export namespace GetRightsizingRecommendationResponse { } /** - *Specific coverage percentage, On-Demand costs, and spend covered by Savings Plans, and total Savings Plans costs for an account.
+ *Specific coverage percentage, On-Demand costs, and spend covered by Savings Plans, and + * total Savings Plans costs for an account.
*/ export interface SavingsPlansCoverageData { /** - *The amount of your AWS usage that is covered by a Savings Plans.
+ *The amount of your Amazon Web Services usage that is covered by a Savings Plans.
*/ SpendCoveredBySavingsPlans?: string; /** - *The cost of your AWS usage at the public On-Demand rate.
+ *The cost of your Amazon Web Services usage at the public On-Demand rate.
*/ OnDemandCost?: string; /** - *The total cost of your AWS usage, regardless of your purchase option.
+ *The total cost of your Amazon Web Services usage, regardless of your purchase + * option.
*/ TotalCost?: string; /** *The percentage of your existing Savings Plans covered usage, divided by all of your - * eligible Savings Plans usage in an account(or set of accounts).
+ * eligible Savings Plans usage in an account (or set of accounts). */ CoveragePercentage?: string; } @@ -3388,7 +3371,8 @@ export namespace SavingsPlansCoverageData { } /** - *The amount of Savings Plans eligible usage that is covered by Savings Plans. All calculations consider the On-Demand equivalent of your Savings Plans usage.
+ *The amount of Savings Plans eligible usage that is covered by Savings Plans. All + * calculations consider the On-Demand equivalent of your Savings Plans usage.
*/ export interface SavingsPlansCoverage { /** @@ -3402,8 +3386,7 @@ export interface SavingsPlansCoverage { Coverage?: SavingsPlansCoverageData; /** - *The time period of the request. - *
+ *The time period of the request.
*/ TimePeriod?: DateInterval; } @@ -3459,7 +3442,7 @@ export interface SavingsPlansPurchaseRecommendationMetadata { GenerationTimestamp?: string; /** - *Additional metadata that may be applicable to the recommendation.
+ *Additional metadata that might be applicable to the recommendation.
*/ AdditionalMetadata?: string; } @@ -3474,11 +3457,11 @@ export namespace SavingsPlansPurchaseRecommendationMetadata { } /** - *Attribute details on a specific Savings Plan.
+ *The attribute details on a specific Savings Plan.
*/ export interface SavingsPlansDetails { /** - *A collection of AWS resources in a geographic area. Each AWS Region is isolated and independent of the other Regions.
+ *A collection of Amazon Web Services resources in a geographic area. Each Amazon Web Services Region is isolated and independent of the other Regions.
*/ Region?: string; @@ -3488,7 +3471,7 @@ export interface SavingsPlansDetails { InstanceFamily?: string; /** - *The unique ID used to distinguish Savings Plans from one another.
+ *The unique ID that's used to distinguish Savings Plans from one another.
*/ OfferingId?: string; } @@ -3517,50 +3500,57 @@ export interface SavingsPlansPurchaseRecommendationDetail { AccountId?: string; /** - *The upfront cost of the recommended Savings Plans, based on the selected payment option.
+ *The upfront cost of the recommended Savings Plans, based on the selected payment + * option.
*/ UpfrontCost?: string; /** - *The estimated return on investment based on the recommended Savings Plans purchased. This is calculated as estimatedSavingsAmount/ estimatedSPCost*100.
The estimated return on investment that's based on the recommended Savings Plans that
+ * you purchased. This is calculated as estimatedSavingsAmount/
+ * estimatedSPCost*100.
The currency code AWS used to generate the recommendations and present potential - * savings.
+ *The currency code that Amazon Web Services used to generate the recommendations and + * present potential savings.
*/ CurrencyCode?: string; /** - *The cost of the recommended Savings Plans over the length of the lookback period.
+ *The cost of the recommended Savings Plans over the length of the lookback + * period.
*/ EstimatedSPCost?: string; /** - *The remaining On-Demand cost estimated to not be covered by the recommended Savings Plans, over the length of the lookback period.
+ *The remaining On-Demand cost estimated to not be covered by the recommended Savings + * Plans, over the length of the lookback period.
*/ EstimatedOnDemandCost?: string; /** - *- * The estimated On-Demand costs you would expect with no additional commitment, based on your usage of the selected time period and the Savings Plans you own. - *
+ *The estimated On-Demand costs you would expect with no additional commitment, based + * on your usage of the selected time period and the Savings Plans you own.
*/ EstimatedOnDemandCostWithCurrentCommitment?: string; /** - *The estimated savings amount based on the recommended Savings Plans over the length of the lookback period.
+ *The estimated savings amount that's based on the recommended Savings Plans over the + * length of the lookback period.
*/ EstimatedSavingsAmount?: string; /** - *The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.
+ *The estimated savings percentage relative to the total cost of applicable On-Demand + * usage over the lookback period.
*/ EstimatedSavingsPercentage?: string; /** - *The recommended hourly commitment level for the Savings Plans type, and configuration based on the usage during the lookback period.
+ *The recommended hourly commitment level for the Savings Plans type and the + * configuration that's based on the usage during the lookback period.
*/ HourlyCommitmentToPurchase?: string; @@ -3570,22 +3560,25 @@ export interface SavingsPlansPurchaseRecommendationDetail { EstimatedAverageUtilization?: string; /** - *The estimated monthly savings amount, based on the recommended Savings Plans.
+ *The estimated monthly savings amount based on the recommended Savings Plans.
*/ EstimatedMonthlySavingsAmount?: string; /** - *The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.
+ *The lowest value of hourly On-Demand spend over the lookback period of the applicable + * usage type.
*/ CurrentMinimumHourlyOnDemandSpend?: string; /** - *The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.
+ *The highest value of hourly On-Demand spend over the lookback period of the applicable + * usage type.
*/ CurrentMaximumHourlyOnDemandSpend?: string; /** - *The average value of hourly On-Demand spend over the lookback period of the applicable usage type.
+ *The average value of hourly On-Demand spend over the lookback period of the applicable + * usage type.
*/ CurrentAverageHourlyOnDemandSpend?: string; } @@ -3604,33 +3597,39 @@ export namespace SavingsPlansPurchaseRecommendationDetail { */ export interface SavingsPlansPurchaseRecommendationSummary { /** - *The estimated return on investment based on the recommended Savings Plans and estimated savings.
+ *The estimated return on investment that's based on the recommended Savings Plans and + * estimated savings.
*/ EstimatedROI?: string; /** - *The currency code AWS used to generate the recommendations and present potential - * savings.
+ *The currency code that Amazon Web Services used to generate the recommendations and + * present potential savings.
*/ CurrencyCode?: string; /** - *The estimated total cost of the usage after purchasing the recommended Savings Plans. This is a sum of the cost of Savings Plans during this term, and the remaining On-Demand usage.
+ *The estimated total cost of the usage after purchasing the recommended Savings Plans. + * This is a sum of the cost of Savings Plans during this term, and the remaining On-Demand + * usage.
*/ EstimatedTotalCost?: string; /** - *The current total on demand spend of the applicable usage types over the lookback period.
+ *The current total on demand spend of the applicable usage types over the lookback + * period.
*/ CurrentOnDemandSpend?: string; /** - *The estimated total savings over the lookback period, based on the purchase of the recommended Savings Plans.
+ *The estimated total savings over the lookback period, based on the purchase of the + * recommended Savings Plans.
*/ EstimatedSavingsAmount?: string; /** - *The aggregate number of Savings Plans recommendations that exist for your account.
+ *The aggregate number of Savings Plans recommendations that exist for your + * account.
*/ TotalRecommendationCount?: string; @@ -3640,24 +3639,27 @@ export interface SavingsPlansPurchaseRecommendationSummary { DailyCommitmentToPurchase?: string; /** - *The recommended hourly commitment based on the recommendation parameters.
+ *The recommended hourly commitment that's based on the recommendation + * parameters.
*/ HourlyCommitmentToPurchase?: string; /** - *The estimated savings relative to the total cost of On-Demand usage, over the lookback period. This is calculated as estimatedSavingsAmount/ CurrentOnDemandSpend*100.
The estimated savings relative to the total cost of On-Demand usage, over the lookback
+ * period. This is calculated as estimatedSavingsAmount/
+ * CurrentOnDemandSpend*100.
The estimated monthly savings amount, based on the recommended Savings Plans purchase.
+ *The estimated monthly savings amount that's based on the recommended Savings Plans + * purchase.
*/ EstimatedMonthlySavingsAmount?: string; /** - *- * The estimated On-Demand costs you would expect with no additional commitment, based on your usage of the selected time period and the Savings Plans you own. - *
+ *The estimated On-Demand costs you would expect with no additional commitment. It's + * based on your usage of the selected time period and the Savings Plans you own.
*/ EstimatedOnDemandCostWithCurrentCommitment?: string; } @@ -3672,11 +3674,15 @@ export namespace SavingsPlansPurchaseRecommendationSummary { } /** - *Contains your request parameters, Savings Plan Recommendations Summary, and Details.
+ *Contains your request parameters, Savings Plan Recommendations Summary, and + * Details.
*/ export interface SavingsPlansPurchaseRecommendation { /** - *The account scope that you want your recommendations for. Amazon Web Services calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.
The account scope that you want your recommendations for. Amazon Web Services
+ * calculates recommendations that include the management account and member accounts if
+ * the value is set to PAYER. If the value is LINKED,
+ * recommendations are calculated for individual member accounts only.
The Savings Plans recommendation term in years, used to generate the recommendation.
+ *The Savings Plans recommendation term in years. It's used to generate the + * recommendation.
*/ TermInYears?: TermInYears | string; @@ -3733,7 +3740,7 @@ export interface GetSavingsPlansPurchaseRecommendationResponse { SavingsPlansPurchaseRecommendation?: SavingsPlansPurchaseRecommendation; /** - *The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
+ *The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; } @@ -3748,21 +3755,25 @@ export namespace GetSavingsPlansPurchaseRecommendationResponse { } /** - *The amortized amount of Savings Plans purchased in a specific account during a specific time interval.
+ *The amortized amount of Savings Plans purchased in a specific account during a + * specific time interval.
*/ export interface SavingsPlansAmortizedCommitment { /** - *The amortized amount of your Savings Plans commitment that was purchased with either a Partial or a NoUpfront.
The amortized amount of your Savings Plans commitment that was purchased with either a
+ * Partial or a NoUpfront.
The amortized amount of your Savings Plans commitment that was purchased with an Upfront or PartialUpfront Savings Plans.
The amortized amount of your Savings Plans commitment that was purchased with an
+ * Upfront or PartialUpfront Savings Plans.
The total amortized amount of your Savings Plans commitment, regardless of your Savings Plans purchase method.
+ *The total amortized amount of your Savings Plans commitment, regardless of your + * Savings Plans purchase method.
*/ TotalAmortizedCommitment?: string; } @@ -3777,18 +3788,19 @@ export namespace SavingsPlansAmortizedCommitment { } /** - *The amount of savings you're accumulating, against the public On-Demand rate of the usage accrued in an account.
+ *The amount of savings that you're accumulating, against the public On-Demand rate of + * the usage accrued in an account.
*/ export interface SavingsPlansSavings { /** - *The savings amount that you are accumulating for the usage that is covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.
+ *The savings amount that you're accumulating for the usage that's covered by a Savings + * Plans, when compared to the On-Demand equivalent of the same usage.
*/ NetSavings?: string; /** - *How much the amount that the usage would have cost if it was - * accrued - * at the On-Demand rate.
+ *How much the amount that the usage would have cost if it was accrued at the On-Demand + * rate.
*/ OnDemandCostEquivalent?: string; } @@ -3803,26 +3815,30 @@ export namespace SavingsPlansSavings { } /** - *The measurement of how well you are using your existing Savings Plans.
+ *The measurement of how well you're using your existing Savings Plans.
*/ export interface SavingsPlansUtilization { /** - *The total amount of Savings Plans commitment that's been purchased in an account (or set of accounts).
+ *The total amount of Savings Plans commitment that's been purchased in an account (or + * set of accounts).
*/ TotalCommitment?: string; /** - *The amount of your Savings Plans commitment that was consumed from Savings Plans eligible usage in a specific period.
+ *The amount of your Savings Plans commitment that was consumed from Savings Plans + * eligible usage in a specific period.
*/ UsedCommitment?: string; /** - *The amount of your Savings Plans commitment that was not consumed from Savings Plans eligible usage in a specific period.
+ *The amount of your Savings Plans commitment that wasn't consumed from Savings Plans + * eligible usage in a specific period.
*/ UnusedCommitment?: string; /** - *The amount of UsedCommitment divided by the TotalCommitment for your Savings Plans.
The amount of UsedCommitment divided by the TotalCommitment
+ * for your Savings Plans.
The time period of the request. - *
+ *The time period of the request.
*/ TimePeriod: DateInterval | undefined; /** - *A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.
+ *A ratio of your effectiveness of using existing Savings Plans to apply to workloads + * that are Savings Plans eligible.
*/ Utilization: SavingsPlansUtilization | undefined; /** - *The amount saved by using existing Savings Plans. Savings returns both net savings from Savings Plans as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.
The amount saved by using existing Savings Plans. Savings returns both net savings
+ * from Savings Plans as well as the onDemandCostEquivalent of the Savings
+ * Plans when considering the utilization rate.
The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.
+ *The total amortized commitment for a Savings Plans. This includes the sum of the + * upfront and recurring Savings Plans fees.
*/ AmortizedCommitment?: SavingsPlansAmortizedCommitment; } @@ -3876,17 +3895,21 @@ export namespace SavingsPlansUtilizationByTime { */ export interface SavingsPlansUtilizationAggregates { /** - *A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.
+ *A ratio of your effectiveness of using existing Savings Plans to apply to workloads + * that are Savings Plans eligible.
*/ Utilization: SavingsPlansUtilization | undefined; /** - *The amount saved by using existing Savings Plans. Savings returns both net savings from Savings Plans, as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.
The amount saved by using existing Savings Plans. Savings returns both net savings
+ * from Savings Plans, as well as the onDemandCostEquivalent of the Savings
+ * Plans when considering the utilization rate.
The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.
+ *The total amortized commitment for a Savings Plans. This includes the sum of the + * upfront and recurring Savings Plans fees.
*/ AmortizedCommitment?: SavingsPlansAmortizedCommitment; } @@ -3929,7 +3952,9 @@ export enum SavingsPlansDataType { } /** - *A single daily or monthly Savings Plans utilization rate, and details for your account. A management account in an organization have access to member accounts. You can use GetDimensionValues to determine the possible dimension values.
A single daily or monthly Savings Plans utilization rate, and details for your
+ * account. A management account in an organization have access to member accounts. You can
+ * use GetDimensionValues to determine the possible dimension values.
A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.
+ *A ratio of your effectiveness of using existing Savings Plans to apply to workloads + * that are Savings Plans eligible.
*/ Utilization?: SavingsPlansUtilization; /** - *The amount saved by using existing Savings Plans. Savings returns both net savings from savings plans as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.
The amount saved by using existing Savings Plans. Savings returns both net savings
+ * from savings plans as well as the onDemandCostEquivalent of the Savings
+ * Plans when considering the utilization rate.
The total amortized commitment for a Savings Plans. Includes the sum of the upfront and recurring Savings Plans fees.
+ *The total amortized commitment for a Savings Plans. Includes the sum of the upfront + * and recurring Savings Plans fees.
*/ AmortizedCommitment?: SavingsPlansAmortizedCommitment; } @@ -3979,8 +4008,7 @@ export interface GetSavingsPlansUtilizationDetailsResponse { Total?: SavingsPlansUtilizationAggregates; /** - *The time period of the request. - *
+ *The time period of the request.
*/ TimePeriod: DateInterval | undefined; @@ -4001,7 +4029,7 @@ export namespace GetSavingsPlansUtilizationDetailsResponse { export interface GetTagsResponse { /** - *The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
+ *The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; @@ -4011,7 +4039,7 @@ export interface GetTagsResponse { Tags: string[] | undefined; /** - *The number of query results that AWS returns at a time.
+ *The number of query results that Amazon Web Services returns at a time.
*/ ReturnSize: number | undefined; @@ -4101,14 +4129,14 @@ export namespace ListCostCategoryDefinitionsRequest { } /** - *A reference to a Cost Category containing only enough information to identify the Cost Category.
- *You can use this information to retrieve the full Cost Category information using DescribeCostCategory.
A reference to a Cost Category containing only enough information to identify the Cost + * Category.
+ *You can use this information to retrieve the full Cost Category information using
+ * DescribeCostCategory.
- * The unique identifier for your Cost Category. - *
+ *The unique identifier for your Cost Category.
*/ CostCategoryArn?: string; @@ -4118,40 +4146,34 @@ export interface CostCategoryReference { Name?: string; /** - *- * The Cost Category's effective start date.
+ *The Cost Category's effective start date.
*/ EffectiveStart?: string; /** - *- * The Cost Category's effective end date.
+ *The Cost Category's effective end date.
*/ EffectiveEnd?: string; /** - *- * The number of rules associated with a specific Cost Category. - *
+ *The number of rules that are associated with a specific Cost Category.
*/ NumberOfRules?: number; /** - *- * The list of processing statuses for Cost Management products for a specific cost category. - *
+ *The list of processing statuses for Cost Management products for a specific cost + * category.
*/ ProcessingStatus?: CostCategoryProcessingStatus[]; /** - *- * A list of unique cost category values in a specific cost category. - *
+ *A list of unique cost category values in a specific cost category.
*/ Values?: string[]; /** - *The default value for the cost category.
+ *The + * default value for the cost category.
*/ DefaultValue?: string; } @@ -4192,9 +4214,7 @@ export namespace ListCostCategoryDefinitionsResponse { export interface ProvideAnomalyFeedbackRequest { /** - *- * A cost anomaly ID. - *
+ *A cost anomaly ID.
*/ AnomalyId: string | undefined; @@ -4215,9 +4235,7 @@ export namespace ProvideAnomalyFeedbackRequest { export interface ProvideAnomalyFeedbackResponse { /** - *- * The ID of the modified cost anomaly. - *
+ *The ID of the modified cost anomaly.
*/ AnomalyId: string | undefined; } @@ -4233,14 +4251,12 @@ export namespace ProvideAnomalyFeedbackResponse { export interface UpdateAnomalyMonitorRequest { /** - *Cost anomaly monitor Amazon Resource Names (ARNs).
+ *Cost anomaly monitor Amazon Resource Names (ARNs).
*/ MonitorArn: string | undefined; /** - *- * The new name for the cost anomaly monitor. - *
+ *The new name for the cost anomaly monitor.
*/ MonitorName?: string; } @@ -4256,9 +4272,7 @@ export namespace UpdateAnomalyMonitorRequest { export interface UpdateAnomalyMonitorResponse { /** - *- * A cost anomaly monitor ARN. - *
+ *A cost anomaly monitor ARN.
*/ MonitorArn: string | undefined; } @@ -4274,42 +4288,32 @@ export namespace UpdateAnomalyMonitorResponse { export interface UpdateAnomalySubscriptionRequest { /** - *A cost anomaly subscription Amazon Resource Name (ARN).
+ *A cost anomaly subscription Amazon Resource Name (ARN).
*/ SubscriptionArn: string | undefined; /** - *- * The update to the threshold value for receiving notifications. - *
+ *The update to the threshold value for receiving notifications.
*/ Threshold?: number; /** - *- * The update to the frequency value at which subscribers will receive notifications. - *
+ *The update to the frequency value that subscribers receive notifications.
*/ Frequency?: AnomalySubscriptionFrequency | string; /** - *- * A list of cost anomaly monitor ARNs. - *
+ *A list of cost anomaly monitor ARNs.
*/ MonitorArnList?: string[]; /** - *- * The update to the subscriber list. - *
+ *The update to the subscriber list.
*/ Subscribers?: Subscriber[]; /** - *- * The subscription's new name. - *
+ *The new name of the subscription.
*/ SubscriptionName?: string; } @@ -4325,9 +4329,7 @@ export namespace UpdateAnomalySubscriptionRequest { export interface UpdateAnomalySubscriptionResponse { /** - *- * A cost anomaly subscription ARN. - *
+ *A cost anomaly subscription ARN.
*/ SubscriptionArn: string | undefined; } @@ -4372,32 +4374,34 @@ export namespace UpdateCostCategoryDefinitionResponse { *Simple dimension values - You can set the dimension name and values for the
* filters that you plan to use. For example, you can filter for
- * REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia). The
- * Expression example looks like:
REGION==us-east-1 OR REGION==us-west-1. For
+ * GetRightsizingRecommendation, the Region is a full name (for
+ * example, REGION==US East (N. Virginia). The Expression
+ * example is as follows:
*
- * { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1",
- * “us-west-1” ] } }
+ * { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ]
+ * } }
*
The list of dimension values are OR'd together to retrieve cost or usage
- * data. You can create Expression and DimensionValues
- * objects using either with* methods or set* methods in
- * multiple lines.
The list of dimension values are OR'd together to retrieve cost or usage data.
+ * You can create Expression and DimensionValues objects
+ * using either with* methods or set* methods in multiple
+ * lines.
Compound dimension values with logical operations - You can use multiple
* Expression types and the logical operators
* AND/OR/NOT to create a list of one or more
- * Expression objects. This allows you to filter on more advanced
- * options. For example, you can filter on ((REGION == us-east-1 OR
+ * Expression objects. By doing this, you can filter on more
+ * advanced options. For example, you can filter on ((REGION == us-east-1 OR
* REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE !=
- * DataTransfer). The Expression for that looks like
- * this:
Expression for that is as
+ * follows:
*
- * { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION",
- * "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName",
- * "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE",
- * "Values": ["DataTransfer"] }}} ] }
- *
{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [
+ * "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values":
+ * ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values":
+ * ["DataTransfer"] }}} ] }
+ *
* Because each Expression can have only one operator, the
* service returns an error if more than one is specified. The following
@@ -4407,22 +4411,19 @@ export namespace UpdateCostCategoryDefinitionResponse {
*
* { "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE",
* "Values": [ "DataTransfer" ] } }
- *
For the GetRightsizingRecommendation action, a combination of OR and NOT is not
- * supported. OR is not supported between different dimensions, or dimensions and tags.
- * NOT operators aren't supported.
- * Dimensions
- * are also limited to LINKED_ACCOUNT, REGION, or
+ *
For the GetRightsizingRecommendation action, a combination of OR and
+ * NOT isn't supported. OR isn't supported between different dimensions, or dimensions
+ * and tags. NOT operators aren't supported. Dimensions are also limited to
+ * LINKED_ACCOUNT, REGION, or
* RIGHTSIZING_TYPE.
For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR are not supported. Dimensions are limited to LINKED_ACCOUNT.
For the GetReservationPurchaseRecommendation action, only NOT is
+ * supported. AND and OR aren't supported. Dimensions are limited to
+ * LINKED_ACCOUNT.
The filter based on CostCategory values.
The filter that's based on CostCategory values.
This object continuously inspects your account's cost data for anomalies, based on
- * MonitorType and MonitorSpecification. The content consists
+ *
This object continuously inspects your account's cost data for anomalies. It's based
+ * on MonitorType and MonitorSpecification. The content consists
* of detailed metadata and the current status of the monitor object.
The Amazon Resource Name (ARN) value.
+ *The Amazon Resource Name (ARN) value.
*/ MonitorArn?: string; /** - *- * The name of the monitor. - *
+ *The name of the monitor.
*/ MonitorName: string | undefined; /** - *- * The date when the monitor was created. - *
+ *The date when the monitor was created.
*/ CreationDate?: string; /** - *- * The date when the monitor was last updated. - *
+ *The date when the monitor was last updated.
*/ LastUpdatedDate?: string; /** - *- * The date when the monitor last evaluated for anomalies. - *
+ *The date when the monitor last evaluated for anomalies.
*/ LastEvaluatedDate?: string; /** - *- * The possible type values. - *
+ *The possible type values.
*/ MonitorType: MonitorType | string | undefined; /** - *- * The dimensions to evaluate. - *
+ *The dimensions to evaluate.
*/ MonitorDimension?: MonitorDimension | string; @@ -4524,32 +4513,34 @@ export interface AnomalyMonitor { *Simple dimension values - You can set the dimension name and values for the
* filters that you plan to use. For example, you can filter for
- * REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia). The
- * Expression example looks like:
REGION==us-east-1 OR REGION==us-west-1. For
+ * GetRightsizingRecommendation, the Region is a full name (for
+ * example, REGION==US East (N. Virginia). The Expression
+ * example is as follows:
*
- * { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1",
- * “us-west-1” ] } }
+ * { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ]
+ * } }
*
The list of dimension values are OR'd together to retrieve cost or usage
- * data. You can create Expression and DimensionValues
- * objects using either with* methods or set* methods in
- * multiple lines.
The list of dimension values are OR'd together to retrieve cost or usage data.
+ * You can create Expression and DimensionValues objects
+ * using either with* methods or set* methods in multiple
+ * lines.
Compound dimension values with logical operations - You can use multiple
* Expression types and the logical operators
* AND/OR/NOT to create a list of one or more
- * Expression objects. This allows you to filter on more advanced
- * options. For example, you can filter on ((REGION == us-east-1 OR
+ * Expression objects. By doing this, you can filter on more
+ * advanced options. For example, you can filter on ((REGION == us-east-1 OR
* REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE !=
- * DataTransfer). The Expression for that looks like
- * this:
Expression for that is as
+ * follows:
*
- * { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION",
- * "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName",
- * "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE",
- * "Values": ["DataTransfer"] }}} ] }
- *
{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [
+ * "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values":
+ * ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values":
+ * ["DataTransfer"] }}} ] }
+ *
* Because each Expression can have only one operator, the
* service returns an error if more than one is specified. The following
@@ -4559,29 +4550,24 @@ export interface AnomalyMonitor {
*
* { "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE",
* "Values": [ "DataTransfer" ] } }
- *
For the GetRightsizingRecommendation action, a combination of OR and NOT is not
- * supported. OR is not supported between different dimensions, or dimensions and tags.
- * NOT operators aren't supported.
- * Dimensions
- * are also limited to LINKED_ACCOUNT, REGION, or
+ *
For the GetRightsizingRecommendation action, a combination of OR and
+ * NOT isn't supported. OR isn't supported between different dimensions, or dimensions
+ * and tags. NOT operators aren't supported. Dimensions are also limited to
+ * LINKED_ACCOUNT, REGION, or
* RIGHTSIZING_TYPE.
For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR are not supported. Dimensions are limited to LINKED_ACCOUNT.
For the GetReservationPurchaseRecommendation action, only NOT is
+ * supported. AND and OR aren't supported. Dimensions are limited to
+ * LINKED_ACCOUNT.
- * The value for evaluated dimensions. - *
+ *The value for evaluated dimensions.
*/ DimensionalValueCount?: number; } @@ -4596,11 +4582,13 @@ export namespace AnomalyMonitor { } /** - *Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.
+ *Rules are processed in order. If there are multiple rules that match the line item, + * then the first rule to match is used to determine that Cost Category value.
*/ export interface CostCategoryRule { /** - *The default value for the cost category.
+ *The + * default value for the cost category.
*/ Value?: string; @@ -4610,25 +4598,32 @@ export interface CostCategoryRule { * Currently the only dimensions supported areLINKED_ACCOUNT,
* SERVICE_CODE, RECORD_TYPE, and
* LINKED_ACCOUNT_NAME.
- * Root level OR is not supported. We recommend that you create a separate
+ *
Root level OR isn't supported. We recommend that you create a separate
* rule instead.
* RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also
* supported for Cost Category expressions. This dimension uses different terms, depending
* on whether you're using the console or API/JSON editor. For a detailed comparison, see
- * Term Comparisons in the AWS Billing and Cost Management User
+ * Term Comparisons in the Billing and Cost Management User
* Guide.
The value the line item will be categorized as, if the line item contains the matched dimension.
+ *The value the line item is categorized as if the line item contains the matched + * dimension.
*/ InheritedValue?: CostCategoryInheritedValueDimension; /** - *You can define the CostCategoryRule rule type as either REGULAR or INHERITED_VALUE. The INHERITED_VALUE rule type adds the flexibility of defining a rule that dynamically inherits the cost category value from the dimension value defined by CostCategoryInheritedValueDimension. For example, if you wanted to dynamically group costs based on the value of a specific tag key, you would first choose an inherited value rule type, then choose the tag dimension and specify the tag key to use.
You can define the CostCategoryRule rule type as either
+ * REGULAR or INHERITED_VALUE. The
+ * INHERITED_VALUE rule type adds the flexibility of defining a rule that
+ * dynamically inherits the cost category value from the dimension value defined by
+ * CostCategoryInheritedValueDimension. For example, if you want to
+ * dynamically group costs based on the value of a specific tag key, first choose an
+ * inherited value rule type, then choose the tag dimension and specify the tag key to
+ * use.
Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is
- * retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
Sets the start date and end date for retrieving Amazon Web Services costs. The start date
+ * is inclusive, but the end date is exclusive. For example, if start is
+ * 2017-01-01 and end is 2017-05-01, then the cost and
+ * usage data is retrieved from 2017-01-01 up to and including
+ * 2017-04-30 but not including 2017-05-01.
Sets the AWS cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set,
+ *
Sets the Amazon Web Services cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set,
* the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.
Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT
+ *
Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT
* and get the costs that are associated with that account's usage of that service. You can nest Expression objects
* to define any combination of dimension filters. For more information, see
* Expression.
Valid values are AmortizedCost, BlendedCost, NetAmortizedCost,
* NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.
If you return the UsageQuantity metric, the service aggregates all usage numbers without
- * taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2,
- * the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units
- * (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or
- * UsageTypeGroups.
If you return the UsageQuantity metric, the service aggregates all usage
+ * numbers without taking into account the units. For example, if you aggregate
+ * usageQuantity across all of Amazon EC2, the results aren't meaningful because
+ * Amazon EC2 compute hours and data transfer are measured in different units (for example,
+ * hours and GB). To get more meaningful UsageQuantity metrics, filter by
+ * UsageType or UsageTypeGroups.
* Metrics is required for GetCostAndUsage requests.
You can group AWS costs using up to two different groups, either dimensions, tag keys, + *
You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, * cost categories, or any two group by types.
- *When you group by tag key, you get all tag values, including empty strings.
- *Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT,
- * OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS,
+ *
Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT,
+ * OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE,
* TENANCY, RECORD_TYPE, and USAGE_TYPE.
When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
+ *The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; } @@ -4714,7 +4713,7 @@ export interface GetCostAndUsageWithResourcesRequest { TimePeriod: DateInterval | undefined; /** - *Sets the AWS cost granularity to MONTHLY, DAILY, or HOURLY. If
+ *
Sets the Amazon Web Services cost granularity to MONTHLY, DAILY, or HOURLY. If
* Granularity isn't set, the response object doesn't include the
* Granularity, MONTHLY, DAILY, or HOURLY.
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
+ *The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; } @@ -4775,13 +4774,12 @@ export namespace GetCostAndUsageWithResourcesRequest { export interface GetCostCategoriesRequest { /** *The value that you want to search the filter values for.
- *If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.
If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.
The time period of the request. - *
+ *The time period of the request.
*/ TimePeriod: DateInterval | undefined; @@ -4796,32 +4794,34 @@ export interface GetCostCategoriesRequest { *Simple dimension values - You can set the dimension name and values for the
* filters that you plan to use. For example, you can filter for
- * REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia). The
- * Expression example looks like:
REGION==us-east-1 OR REGION==us-west-1. For
+ * GetRightsizingRecommendation, the Region is a full name (for
+ * example, REGION==US East (N. Virginia). The Expression
+ * example is as follows:
*
- * { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1",
- * “us-west-1” ] } }
+ * { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ]
+ * } }
*
The list of dimension values are OR'd together to retrieve cost or usage
- * data. You can create Expression and DimensionValues
- * objects using either with* methods or set* methods in
- * multiple lines.
The list of dimension values are OR'd together to retrieve cost or usage data.
+ * You can create Expression and DimensionValues objects
+ * using either with* methods or set* methods in multiple
+ * lines.
Compound dimension values with logical operations - You can use multiple
* Expression types and the logical operators
* AND/OR/NOT to create a list of one or more
- * Expression objects. This allows you to filter on more advanced
- * options. For example, you can filter on ((REGION == us-east-1 OR
+ * Expression objects. By doing this, you can filter on more
+ * advanced options. For example, you can filter on ((REGION == us-east-1 OR
* REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE !=
- * DataTransfer). The Expression for that looks like
- * this:
Expression for that is as
+ * follows:
*
- * { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION",
- * "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName",
- * "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE",
- * "Values": ["DataTransfer"] }}} ] }
- *
{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [
+ * "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values":
+ * ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values":
+ * ["DataTransfer"] }}} ] }
+ *
* Because each Expression can have only one operator, the
* service returns an error if more than one is specified. The following
@@ -4831,28 +4831,25 @@ export interface GetCostCategoriesRequest {
*
* { "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE",
* "Values": [ "DataTransfer" ] } }
- *
For the GetRightsizingRecommendation action, a combination of OR and NOT is not
- * supported. OR is not supported between different dimensions, or dimensions and tags.
- * NOT operators aren't supported.
- * Dimensions
- * are also limited to LINKED_ACCOUNT, REGION, or
+ *
For the GetRightsizingRecommendation action, a combination of OR and
+ * NOT isn't supported. OR isn't supported between different dimensions, or dimensions
+ * and tags. NOT operators aren't supported. Dimensions are also limited to
+ * LINKED_ACCOUNT, REGION, or
* RIGHTSIZING_TYPE.
For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR are not supported. Dimensions are limited to LINKED_ACCOUNT.
For the GetReservationPurchaseRecommendation action, only NOT is
+ * supported. AND and OR aren't supported. Dimensions are limited to
+ * LINKED_ACCOUNT.
The value by which you want to sort the data.
- *The key represents cost and usage metrics. The following values are supported:
+ *The key represents cost and usage metrics. The following values are supported:
*@@ -4897,13 +4894,13 @@ export interface GetCostCategoriesRequest { /** *
This field is only used when SortBy is provided in the request.
The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.
For GetCostCategories, MaxResults has an upper limit of 1000.
The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.
For GetCostCategories, MaxResults has an upper limit of 1000.
If the number of objects that are still available for retrieval exceeds the limit, AWS returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.
+ *If the number of objects that are still available for retrieval exceeds the limit, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.
*/ NextPageToken?: string; } @@ -5101,8 +5098,11 @@ export interface GetDimensionValuesRequest { SearchString?: string; /** - *The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is
- * retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.
The start date and end date for retrieving the dimension values. The start date is
+ * inclusive, but the end date is exclusive. For example, if start is
+ * 2017-01-01 and end is 2017-05-01, then the cost and
+ * usage data is retrieved from 2017-01-01 up to and including
+ * 2017-04-30 but not including 2017-05-01.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
+ *LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.
*LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value - * field contains the AWS ID of the member account.
+ * field contains the Amazon Web Services ID of the member account. *OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
@@ -5152,7 +5152,7 @@ export interface GetDimensionValuesRequest { * Instances and Standard Reserved Instances. *SERVICE - The AWS service such as Amazon DynamoDB.
+ *SERVICE - The Amazon Web Services service such as Amazon DynamoDB.
*USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation
@@ -5163,7 +5163,7 @@ export interface GetDimensionValuesRequest {
* operation includes a unit attribute.
REGION - The AWS Region.
+ *REGION - The Amazon Web Services Region.
*RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
@@ -5189,13 +5189,13 @@ export interface GetDimensionValuesRequest { *LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value - * field contains the AWS ID of the member account.
+ * field contains the Amazon Web Services ID of the member account. *PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
*REGION - The AWS Region.
+ *REGION - The Amazon Web Services Region.
*SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
@@ -5216,14 +5216,14 @@ export interface GetDimensionValuesRequest { *PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
*REGION - The AWS Region.
+ *REGION - The Amazon Web Services Region.
*INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value - * field contains the AWS ID of the member account.
+ * field contains the Amazon Web Services ID of the member account. *SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
@@ -5238,32 +5238,34 @@ export interface GetDimensionValuesRequest { *Simple dimension values - You can set the dimension name and values for the
* filters that you plan to use. For example, you can filter for
- * REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia). The
- * Expression example looks like:
REGION==us-east-1 OR REGION==us-west-1. For
+ * GetRightsizingRecommendation, the Region is a full name (for
+ * example, REGION==US East (N. Virginia). The Expression
+ * example is as follows:
*
- * { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1",
- * “us-west-1” ] } }
+ * { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ]
+ * } }
*
The list of dimension values are OR'd together to retrieve cost or usage
- * data. You can create Expression and DimensionValues
- * objects using either with* methods or set* methods in
- * multiple lines.
The list of dimension values are OR'd together to retrieve cost or usage data.
+ * You can create Expression and DimensionValues objects
+ * using either with* methods or set* methods in multiple
+ * lines.
Compound dimension values with logical operations - You can use multiple
* Expression types and the logical operators
* AND/OR/NOT to create a list of one or more
- * Expression objects. This allows you to filter on more advanced
- * options. For example, you can filter on ((REGION == us-east-1 OR
+ * Expression objects. By doing this, you can filter on more
+ * advanced options. For example, you can filter on ((REGION == us-east-1 OR
* REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE !=
- * DataTransfer). The Expression for that looks like
- * this:
Expression for that is as
+ * follows:
*
- * { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION",
- * "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName",
- * "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE",
- * "Values": ["DataTransfer"] }}} ] }
- *
{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [
+ * "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values":
+ * ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values":
+ * ["DataTransfer"] }}} ] }
+ *
* Because each Expression can have only one operator, the
* service returns an error if more than one is specified. The following
@@ -5273,28 +5275,25 @@ export interface GetDimensionValuesRequest {
*
* { "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE",
* "Values": [ "DataTransfer" ] } }
- *
For the GetRightsizingRecommendation action, a combination of OR and NOT is not
- * supported. OR is not supported between different dimensions, or dimensions and tags.
- * NOT operators aren't supported.
- * Dimensions
- * are also limited to LINKED_ACCOUNT, REGION, or
+ *
For the GetRightsizingRecommendation action, a combination of OR and
+ * NOT isn't supported. OR isn't supported between different dimensions, or dimensions
+ * and tags. NOT operators aren't supported. Dimensions are also limited to
+ * LINKED_ACCOUNT, REGION, or
* RIGHTSIZING_TYPE.
For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR are not supported. Dimensions are limited to LINKED_ACCOUNT.
For the GetReservationPurchaseRecommendation action, only NOT is
+ * supported. AND and OR aren't supported. Dimensions are limited to
+ * LINKED_ACCOUNT.
The value by which you want to sort the data.
- *The key represents cost and usage metrics. The following values are supported:
+ *The key represents cost and usage metrics. The following values are supported:
*@@ -5339,12 +5338,12 @@ export interface GetDimensionValuesRequest { /** *
This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.
- *For GetDimensionValues, MaxResults has an upper limit of 1000.
For GetDimensionValues, MaxResults has an upper limit of 1000.
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
+ *The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; } @@ -5407,7 +5406,7 @@ export interface GetReservationCoverageRequest { GroupBy?: GroupDefinition[]; /** - *The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.
The granularity of the Amazon Web Services cost data for the reservation. Valid values are MONTHLY and DAILY.
If GroupBy is set, Granularity can't be set. If Granularity isn't set,
* the response object doesn't include Granularity, either MONTHLY or DAILY.
The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
+ *The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; /** *The value by which you want to sort the data.
- *The following values are supported for Key:
The following values are supported for Key:
@@ -5536,7 +5535,7 @@ export interface GetReservationCoverageRequest { SortBy?: SortDefinition; /** - *
The maximum number of objects that you returned for this request. If more objects are available, in the response, AWS provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.
+ *The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.
*/ MaxResults?: number; } @@ -5567,32 +5566,34 @@ export interface GetReservationPurchaseRecommendationRequest { *Simple dimension values - You can set the dimension name and values for the
* filters that you plan to use. For example, you can filter for
- * REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia). The
- * Expression example looks like:
REGION==us-east-1 OR REGION==us-west-1. For
+ * GetRightsizingRecommendation, the Region is a full name (for
+ * example, REGION==US East (N. Virginia). The Expression
+ * example is as follows:
*
- * { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1",
- * “us-west-1” ] } }
+ * { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ]
+ * } }
*
The list of dimension values are OR'd together to retrieve cost or usage
- * data. You can create Expression and DimensionValues
- * objects using either with* methods or set* methods in
- * multiple lines.
The list of dimension values are OR'd together to retrieve cost or usage data.
+ * You can create Expression and DimensionValues objects
+ * using either with* methods or set* methods in multiple
+ * lines.
Compound dimension values with logical operations - You can use multiple
* Expression types and the logical operators
* AND/OR/NOT to create a list of one or more
- * Expression objects. This allows you to filter on more advanced
- * options. For example, you can filter on ((REGION == us-east-1 OR
+ * Expression objects. By doing this, you can filter on more
+ * advanced options. For example, you can filter on ((REGION == us-east-1 OR
* REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE !=
- * DataTransfer). The Expression for that looks like
- * this:
Expression for that is as
+ * follows:
*
- * { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION",
- * "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName",
- * "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE",
- * "Values": ["DataTransfer"] }}} ] }
- *
{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [
+ * "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values":
+ * ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values":
+ * ["DataTransfer"] }}} ] }
+ *
* Because each Expression can have only one operator, the
* service returns an error if more than one is specified. The following
@@ -5602,22 +5603,19 @@ export interface GetReservationPurchaseRecommendationRequest {
*
* { "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE",
* "Values": [ "DataTransfer" ] } }
- *
For the GetRightsizingRecommendation action, a combination of OR and NOT is not
- * supported. OR is not supported between different dimensions, or dimensions and tags.
- * NOT operators aren't supported.
- * Dimensions
- * are also limited to LINKED_ACCOUNT, REGION, or
+ *
For the GetRightsizingRecommendation action, a combination of OR and
+ * NOT isn't supported. OR isn't supported between different dimensions, or dimensions
+ * and tags. NOT operators aren't supported. Dimensions are also limited to
+ * LINKED_ACCOUNT, REGION, or
* RIGHTSIZING_TYPE.
For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR are not supported. Dimensions are limited to LINKED_ACCOUNT.
For the GetReservationPurchaseRecommendation action, only NOT is
+ * supported. AND and OR aren't supported. Dimensions are limited to
+ * LINKED_ACCOUNT.
The number of previous days that you want AWS to consider when it calculates your recommendations.
+ *The number of previous days that you want Amazon Web Services to consider when it calculates your recommendations.
*/ LookbackPeriodInDays?: LookbackPeriodInDays | string; @@ -5734,7 +5732,7 @@ export interface GetReservationUtilizationRequest { /** *The value by which you want to sort the data.
* - *The following values are supported for Key:
The following values are supported for Key:
@@ -5828,12 +5826,12 @@ export interface GetReservationUtilizationRequest { SortBy?: SortDefinition; /** - *
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
+ *The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; /** - *The maximum number of objects that you returned for this request. If more objects are available, in the response, AWS provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.
+ *The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.
*/ MaxResults?: number; } @@ -5854,32 +5852,34 @@ export interface GetRightsizingRecommendationRequest { *Simple dimension values - You can set the dimension name and values for the
* filters that you plan to use. For example, you can filter for
- * REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia). The
- * Expression example looks like:
REGION==us-east-1 OR REGION==us-west-1. For
+ * GetRightsizingRecommendation, the Region is a full name (for
+ * example, REGION==US East (N. Virginia). The Expression
+ * example is as follows:
*
- * { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1",
- * “us-west-1” ] } }
+ * { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ]
+ * } }
*
The list of dimension values are OR'd together to retrieve cost or usage
- * data. You can create Expression and DimensionValues
- * objects using either with* methods or set* methods in
- * multiple lines.
The list of dimension values are OR'd together to retrieve cost or usage data.
+ * You can create Expression and DimensionValues objects
+ * using either with* methods or set* methods in multiple
+ * lines.
Compound dimension values with logical operations - You can use multiple
* Expression types and the logical operators
* AND/OR/NOT to create a list of one or more
- * Expression objects. This allows you to filter on more advanced
- * options. For example, you can filter on ((REGION == us-east-1 OR
+ * Expression objects. By doing this, you can filter on more
+ * advanced options. For example, you can filter on ((REGION == us-east-1 OR
* REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE !=
- * DataTransfer). The Expression for that looks like
- * this:
Expression for that is as
+ * follows:
*
- * { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION",
- * "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName",
- * "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE",
- * "Values": ["DataTransfer"] }}} ] }
- *
{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [
+ * "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values":
+ * ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values":
+ * ["DataTransfer"] }}} ] }
+ *
* Because each Expression can have only one operator, the
* service returns an error if more than one is specified. The following
@@ -5889,22 +5889,19 @@ export interface GetRightsizingRecommendationRequest {
*
* { "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE",
* "Values": [ "DataTransfer" ] } }
- *
For the GetRightsizingRecommendation action, a combination of OR and NOT is not
- * supported. OR is not supported between different dimensions, or dimensions and tags.
- * NOT operators aren't supported.
- * Dimensions
- * are also limited to LINKED_ACCOUNT, REGION, or
+ *
For the GetRightsizingRecommendation action, a combination of OR and
+ * NOT isn't supported. OR isn't supported between different dimensions, or dimensions
+ * and tags. NOT operators aren't supported. Dimensions are also limited to
+ * LINKED_ACCOUNT, REGION, or
* RIGHTSIZING_TYPE.
For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR are not supported. Dimensions are limited to LINKED_ACCOUNT.
For the GetReservationPurchaseRecommendation action, only NOT is
+ * supported. AND and OR aren't supported. Dimensions are limited to
+ * LINKED_ACCOUNT.
The value by which you want to sort the data.
- *The following values are supported for Key:
The following values are supported for Key:
@@ -6184,7 +6181,7 @@ export interface GetSavingsPlansUtilizationDetailsRequest { /** *
The value by which you want to sort the data.
* - *The following values are supported for Key:
The following values are supported for Key:
@@ -6292,7 +6289,7 @@ export interface GetSavingsPlansUtilizationRequest { /** *
The value by which you want to sort the data.
- *The following values are supported for Key:
The following values are supported for Key:
@@ -6358,32 +6355,34 @@ export interface GetTagsRequest { *
Simple dimension values - You can set the dimension name and values for the
* filters that you plan to use. For example, you can filter for
- * REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia). The
- * Expression example looks like:
REGION==us-east-1 OR REGION==us-west-1. For
+ * GetRightsizingRecommendation, the Region is a full name (for
+ * example, REGION==US East (N. Virginia). The Expression
+ * example is as follows:
*
- * { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1",
- * “us-west-1” ] } }
+ * { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ]
+ * } }
*
The list of dimension values are OR'd together to retrieve cost or usage
- * data. You can create Expression and DimensionValues
- * objects using either with* methods or set* methods in
- * multiple lines.
The list of dimension values are OR'd together to retrieve cost or usage data.
+ * You can create Expression and DimensionValues objects
+ * using either with* methods or set* methods in multiple
+ * lines.
Compound dimension values with logical operations - You can use multiple
* Expression types and the logical operators
* AND/OR/NOT to create a list of one or more
- * Expression objects. This allows you to filter on more advanced
- * options. For example, you can filter on ((REGION == us-east-1 OR
+ * Expression objects. By doing this, you can filter on more
+ * advanced options. For example, you can filter on ((REGION == us-east-1 OR
* REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE !=
- * DataTransfer). The Expression for that looks like
- * this:
Expression for that is as
+ * follows:
*
- * { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION",
- * "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName",
- * "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE",
- * "Values": ["DataTransfer"] }}} ] }
- *
{ "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [
+ * "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values":
+ * ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values":
+ * ["DataTransfer"] }}} ] }
+ *
* Because each Expression can have only one operator, the
* service returns an error if more than one is specified. The following
@@ -6393,28 +6392,25 @@ export interface GetTagsRequest {
*
* { "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE",
* "Values": [ "DataTransfer" ] } }
- *
For the GetRightsizingRecommendation action, a combination of OR and NOT is not
- * supported. OR is not supported between different dimensions, or dimensions and tags.
- * NOT operators aren't supported.
- * Dimensions
- * are also limited to LINKED_ACCOUNT, REGION, or
+ *
For the GetRightsizingRecommendation action, a combination of OR and
+ * NOT isn't supported. OR isn't supported between different dimensions, or dimensions
+ * and tags. NOT operators aren't supported. Dimensions are also limited to
+ * LINKED_ACCOUNT, REGION, or
* RIGHTSIZING_TYPE.
For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR are not supported. Dimensions are limited to LINKED_ACCOUNT.
For the GetReservationPurchaseRecommendation action, only NOT is
+ * supported. AND and OR aren't supported. Dimensions are limited to
+ * LINKED_ACCOUNT.
The value by which you want to sort the data.
- *The key represents cost and usage metrics. The following values are supported:
+ *The key represents cost and usage metrics. The following values are supported:
*@@ -6459,12 +6455,12 @@ export interface GetTagsRequest { /** *
This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.
- *For GetTags, MaxResults has an upper limit of 1000.
For GetTags, MaxResults has an upper limit of 1000.
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
+ *The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; } @@ -6647,7 +6643,7 @@ export namespace GetUsageForecastRequest { export interface CreateAnomalyMonitorRequest { /** - *The cost anomaly detection monitor object that you want to create.
+ *The cost anomaly detection monitor object that you want to create.
*/ AnomalyMonitor: AnomalyMonitor | undefined; } @@ -6662,25 +6658,22 @@ export namespace CreateAnomalyMonitorRequest { } /** - *The structure of Cost Categories. This includes detailed metadata and the set of rules for the CostCategory object.
The structure of Cost Categories. This includes detailed metadata and the set of rules
+ * for the CostCategory object.
- * The unique identifier for your Cost Category. - *
+ *The unique identifier for your Cost Category.
*/ CostCategoryArn: string | undefined; /** - *- * The Cost Category's effective start date.
+ *The effective state data of your Cost Category.
*/ EffectiveStart: string | undefined; /** - *- * The Cost Category's effective end date.
+ *The effective end data of your Cost Category.
*/ EffectiveEnd?: string; @@ -6695,21 +6688,27 @@ export interface CostCategory { RuleVersion: CostCategoryRuleVersion | string | undefined; /** - *- * Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value. + *
The rules are processed in order. If there are multiple rules that match the line + * item, then the first rule to match is used to determine that Cost Category value. *
*/ Rules: CostCategoryRule[] | undefined; /** - *- * The list of processing statuses for Cost Management products for a specific cost category. - *
+ *The split charge rules that are used to allocate your charges between your Cost + * Category values.
+ */ + SplitChargeRules?: CostCategorySplitChargeRule[]; + + /** + *The list of processing statuses for Cost Management products for a specific cost + * category.
*/ ProcessingStatus?: CostCategoryProcessingStatus[]; /** - *The default value for the cost category.
+ *The + * default value for the cost category.
*/ DefaultValue?: string; } @@ -6741,9 +6740,17 @@ export interface CreateCostCategoryDefinitionRequest { Rules: CostCategoryRule[] | undefined; /** - *The default value for the cost category.
+ *The + * default value for the cost category.
*/ DefaultValue?: string; + + /** + *+ * The split charge rules used to allocate your charges between your Cost Category values. + *
+ */ + SplitChargeRules?: CostCategorySplitChargeRule[]; } export namespace CreateCostCategoryDefinitionRequest { @@ -6757,16 +6764,13 @@ export namespace CreateCostCategoryDefinitionRequest { export interface GetAnomalyMonitorsResponse { /** - *- * A list of cost anomaly monitors that includes the detailed metadata for each monitor. - *
+ *A list of cost anomaly monitors that includes the detailed metadata for each monitor.
*/ AnomalyMonitors: AnomalyMonitor[] | undefined; /** - *- * The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size. - *
+ *The token to retrieve the next set of results. Amazon Web Services provides the token when + * the response from a previous call has more results than the maximum page size.
*/ NextPageToken?: string; } @@ -6798,9 +6802,17 @@ export interface UpdateCostCategoryDefinitionRequest { Rules: CostCategoryRule[] | undefined; /** - *The default value for the cost category.
+ *The + * default value for the cost category.
*/ DefaultValue?: string; + + /** + *+ * The split charge rules used to allocate your charges between your Cost Category values. + *
+ */ + SplitChargeRules?: CostCategorySplitChargeRule[]; } export namespace UpdateCostCategoryDefinitionRequest { @@ -6814,7 +6826,8 @@ export namespace UpdateCostCategoryDefinitionRequest { export interface DescribeCostCategoryDefinitionResponse { /** - *The structure of Cost Categories. This includes detailed metadata and the set of rules for the CostCategory object.
The structure of Cost Categories. This includes detailed metadata and the set of rules
+ * for the CostCategory object.
AWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.
+ *Directory Service is a web service that makes it easy for you to setup and run directories in the + * Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active + * Directory. This guide provides detailed information about Directory Service operations, data types, + * parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service + * Administration Guide.
*AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web - * Services.
+ *Amazon Web Services provides SDKs that consist of libraries and sample code for various + * programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs + * provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services + * services. For more information about the Amazon Web Services SDKs, including how to download and + * install them, see Tools for Amazon Web + * Services.
*If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC.
- *Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
+ *If the DNS server for your self-managed domain uses a publicly addressable IP address, + * you must add a CIDR address block to correctly route traffic to and from your Microsoft AD + * on Amazon Web Services. AddIpRoutes adds this address block. You can + * also use AddIpRoutes to facilitate routing traffic that uses public IP + * ranges from your Microsoft AD on Amazon Web Services to a peer VPC.
+ *Before you call AddIpRoutes, ensure that all of the required + * permissions have been explicitly granted through a policy. For details about what + * permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
*/ public addIpRoutes(args: AddIpRoutesCommandInput, options?: __HttpHandlerOptions): PromiseAdds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.
+ *Adds or overwrites one or more tags for the specified directory. Each directory can + * have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be + * unique to each resource.
*/ public addTagsToResource( args: AddTagsToResourceCommandInput, @@ -398,7 +419,11 @@ export class DirectoryService extends DirectoryServiceClient { } /** - *Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema.
Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema
+ * extension has started replicating to all domain controllers, the task can no longer be
+ * canceled. A schema extension can be canceled during any of the following states;
+ * Initializing, CreatingSnapshot, and
+ * UpdatingSchema.
Creates an AD Connector to connect to an on-premises directory.
+ *Creates an AD Connector to connect to a self-managed directory.
*Before you call ConnectDirectory, ensure that all of the required permissions
* have been explicitly granted through a policy. For details about what permissions are required
- * to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions
+ * to run the ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions
* Reference.
Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
+ *Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional + * forwarders are required in order to set up a trust relationship with another domain. The + * conditional forwarder points to the trusted domain.
*/ public createConditionalForwarder( args: CreateConditionalForwarderCommandInput, @@ -561,11 +588,11 @@ export class DirectoryService extends DirectoryServiceClient { } /** - *Creates a Simple AD directory. For more information, see Simple Active Directory in the AWS Directory Service Admin + *
Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin * Guide.
*Before you call CreateDirectory, ensure that all of the required permissions
* have been explicitly granted through a policy. For details about what permissions are required
- * to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions
+ * to run the CreateDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions
* Reference.
Creates a subscription to forward real-time Directory Service domain controller security - * logs to the specified Amazon CloudWatch log group in your AWS account.
+ * logs to the specified Amazon CloudWatch log group in your Amazon Web Services account. */ public createLogSubscription( args: CreateLogSubscriptionCommandInput, @@ -631,8 +658,10 @@ export class DirectoryService extends DirectoryServiceClient { } /** - *Creates a Microsoft AD directory in the AWS Cloud. For more information, see AWS Managed Microsoft AD in the AWS Directory Service Admin Guide.
- *Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
+ *Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.
+ *Before you call CreateMicrosoftAD, ensure that all of the required + * permissions have been explicitly granted through a policy. For details about what permissions + * are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
*/ public createMicrosoftAD( args: CreateMicrosoftADCommandInput, @@ -664,7 +693,7 @@ export class DirectoryService extends DirectoryServiceClient { } /** - *Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
+ *Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
*You cannot take snapshots of AD Connector directories.
*AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
- *This action initiates the creation of the AWS side of a trust relationship between an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.
+ *Directory Service for Microsoft Active Directory allows you to configure trust relationships. For + * example, you can establish a trust between your Managed Microsoft AD directory, and your existing + * self-managed Microsoft Active Directory. This would allow you to provide users and groups + * access to resources in either domain, with a single set of credentials.
+ *This action initiates the creation of the Amazon Web Services side of a trust relationship between an + * Managed Microsoft AD directory and an external domain. You can create either a forest trust or an + * external trust.
*/ public createTrust(args: CreateTrustCommandInput, options?: __HttpHandlerOptions): PromiseDeletes a conditional forwarder that has been set up for your AWS directory.
+ *Deletes a conditional forwarder that has been set up for your Amazon Web Services + * directory.
*/ public deleteConditionalForwarder( args: DeleteConditionalForwarderCommandInput, @@ -758,10 +793,10 @@ export class DirectoryService extends DirectoryServiceClient { } /** - *Deletes an AWS Directory Service directory.
+ *Deletes an Directory Service directory.
*Before you call DeleteDirectory, ensure that all of the required permissions
* have been explicitly granted through a policy. For details about what permissions are required
- * to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions
+ * to run the DeleteDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions
* Reference.
Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.
+ *Deletes an existing trust relationship between your Managed Microsoft AD directory and an external + * domain.
*/ public deleteTrust(args: DeleteTrustCommandInput, options?: __HttpHandlerOptions): PromiseRemoves the specified directory as a publisher to the specified SNS topic.
+ *Removes the specified directory as a publisher to the specified Amazon SNS topic.
*/ public deregisterEventTopic( args: DeregisterEventTopicCommandInput, @@ -979,9 +1015,43 @@ export class DirectoryService extends DirectoryServiceClient { } } + /** + *Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported.
+ *
Obtains information about the conditional forwarders for this account.
- *If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
+ *If no input parameters are provided for RemoteDomainNames, this request describes all + * conditional forwarders for the specified directory ID.
*/ public describeConditionalForwarders( args: DescribeConditionalForwardersCommandInput, @@ -1087,8 +1157,10 @@ export class DirectoryService extends DirectoryServiceClient { } /** - *Obtains information about which SNS topics receive status messages from the specified directory.
- *If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
+ *Obtains information about which Amazon SNS topics receive status messages from the specified + * directory.
+ *If no input parameters are provided, such as DirectoryId or TopicName, this request + * describes all of the associations in the account.
*/ public describeEventTopics( args: DescribeEventTopicsCommandInput, @@ -1256,7 +1328,8 @@ export class DirectoryService extends DirectoryServiceClient { /** *Obtains information about the trust relationships for this account.
- *If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
+ *If no input parameters are provided, such as DirectoryId or TrustIds, this request + * describes all the trust relationships belonging to the account.
*/ public describeTrusts( args: DescribeTrustsCommandInput, @@ -1349,7 +1422,8 @@ export class DirectoryService extends DirectoryServiceClient { } /** - *Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
+ *Disables multi-factor authentication (MFA) with the Remote Authentication Dial In + * User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
*/ public disableRadius( args: DisableRadiusCommandInput, @@ -1465,7 +1539,8 @@ export class DirectoryService extends DirectoryServiceClient { } /** - *Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
+ *Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User + * Service (RADIUS) server for an AD Connector or Microsoft AD directory.
*/ public enableRadius( args: EnableRadiusCommandInput, @@ -1494,7 +1569,9 @@ export class DirectoryService extends DirectoryServiceClient { } /** - *Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately.
+ *Enables single sign-on for a directory. Single sign-on allows users in your directory to + * access certain Amazon Web Services services from a computer joined to the directory without having to enter + * their credentials separately.
*/ public enableSso(args: EnableSsoCommandInput, options?: __HttpHandlerOptions): PromiseLists the active log subscriptions for the AWS account.
+ *Lists the active log subscriptions for the Amazon Web Services account.
*/ public listLogSubscriptions( args: ListLogSubscriptionsCommandInput, @@ -1773,7 +1850,11 @@ export class DirectoryService extends DirectoryServiceClient { } /** - *Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
+ *Associates a directory with an Amazon SNS topic. This establishes the directory as a + * publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when + * the status of your directory changes. You get notified if your directory goes from an Active + * status to an Impaired or Inoperable status. You also receive a notification when the directory + * returns to an Active status.
*/ public registerEventTopic( args: RegisterEventTopicCommandInput, @@ -1932,7 +2013,7 @@ export class DirectoryService extends DirectoryServiceClient { } /** - *Resets the password for any user in your AWS Managed Microsoft AD or Simple AD + *
Resets the password for any user in your Managed Microsoft AD or Simple AD * directory.
*You can reset the password for any user in your directory with the following * exceptions:
@@ -1943,11 +2024,10 @@ export class DirectoryService extends DirectoryServiceClient { * Admins group except for the administrator user. *For AWS Managed Microsoft AD, you can only reset the password for a user that is in an + *
For Managed Microsoft AD, you can only reset the password for a user that is in an * OU based off of the NetBIOS name that you typed when you created your directory. For - * example, you cannot reset the password for a user in the AWS - * Reserved OU. For more information about the OU structure for an AWS Managed - * Microsoft AD directory, see What Gets Created in the AWS Directory Service Administration + * example, you cannot reset the password for a user in the Amazon Web Services + * Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration * Guide.
*Shares a specified directory (DirectoryId) in your AWS account (directory
- * owner) with another AWS account (directory consumer). With this operation you can use your
- * directory from any AWS account and from any Amazon VPC within an AWS Region.
When you share your AWS Managed Microsoft AD directory, AWS Directory Service creates a + *
Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory
+ * owner) with another Amazon Web Services account (directory consumer). With this operation you can use your
+ * directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.
When you share your Managed Microsoft AD directory, Directory Service creates a * shared directory in the directory consumer account. This shared directory contains the * metadata to provide access to the directory within the directory owner account. The shared * directory is visible in all VPCs in the directory consumer account.
*The ShareMethod parameter determines whether the specified directory can be
- * shared between AWS accounts inside the same AWS organization (ORGANIZATIONS). It
- * also determines whether you can share the directory with any other AWS account either inside
+ * shared between Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It
+ * also determines whether you can share the directory with any other Amazon Web Services account either inside
* or outside of the organization (HANDSHAKE).
The ShareNotes parameter is only used when HANDSHAKE is called,
* which sends a directory sharing request to the directory consumer.
Updates a conditional forwarder that has been set up for your AWS directory.
+ *Updates a conditional forwarder that has been set up for your Amazon Web Services + * directory.
*/ public updateConditionalForwarder( args: UpdateConditionalForwarderCommandInput, @@ -2159,7 +2240,11 @@ export class DirectoryService extends DirectoryServiceClient { } /** - *Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.
+ *Adds or removes domain controllers to or from the directory. Based on the difference + * between current value and new value (provided through this API call), domain controllers will + * be added or removed. It may take up to 45 minutes for any new domain controllers to become + * fully active once the requested number of domain controllers is updated. During this time, you + * cannot make another update request.
*/ public updateNumberOfDomainControllers( args: UpdateNumberOfDomainControllersCommandInput, @@ -2191,7 +2276,8 @@ export class DirectoryService extends DirectoryServiceClient { } /** - *Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
+ *Updates the Remote Authentication Dial In User Service (RADIUS) server information + * for an AD Connector or Microsoft AD directory.
*/ public updateRadius( args: UpdateRadiusCommandInput, @@ -2220,7 +2306,8 @@ export class DirectoryService extends DirectoryServiceClient { } /** - *Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.
+ *Updates the trust that has been set up between your Managed Microsoft AD directory and an + * self-managed Active Directory.
*/ public updateTrust(args: UpdateTrustCommandInput, options?: __HttpHandlerOptions): PromiseAWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
- *This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain.
+ *Directory Service for Microsoft Active Directory allows you to configure and verify trust + * relationships.
+ *This action verifies a trust relationship between your Managed Microsoft AD directory and an + * external domain.
*/ public verifyTrust(args: VerifyTrustCommandInput, options?: __HttpHandlerOptions): PromiseAWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.
+ *Directory Service is a web service that makes it easy for you to setup and run directories in the + * Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active + * Directory. This guide provides detailed information about Directory Service operations, data types, + * parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service + * Administration Guide.
*AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web - * Services.
+ *Amazon Web Services provides SDKs that consist of libraries and sample code for various + * programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs + * provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services + * services. For more information about the Amazon Web Services SDKs, including how to download and + * install them, see Tools for Amazon Web + * Services.
*AWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.
+Directory Service is a web service that makes it easy for you to setup and run directories in the +Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active +Directory. This guide provides detailed information about Directory Service operations, data types, +parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service +Administration Guide.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web
+ Amazon Web Services provides SDKs that consist of libraries and sample code for various
+programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs
+provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services
+services. For more information about the Amazon Web Services SDKs, including how to download and
+install them, see Tools for Amazon Web
Services.
If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC.
- *Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
+ *If the DNS server for your self-managed domain uses a publicly addressable IP address, + * you must add a CIDR address block to correctly route traffic to and from your Microsoft AD + * on Amazon Web Services. AddIpRoutes adds this address block. You can + * also use AddIpRoutes to facilitate routing traffic that uses public IP + * ranges from your Microsoft AD on Amazon Web Services to a peer VPC.
+ *Before you call AddIpRoutes, ensure that all of the required + * permissions have been explicitly granted through a policy. For details about what + * permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/AddTagsToResourceCommand.ts b/clients/client-directory-service/commands/AddTagsToResourceCommand.ts index 877b2341182b..02a8afe51a78 100644 --- a/clients/client-directory-service/commands/AddTagsToResourceCommand.ts +++ b/clients/client-directory-service/commands/AddTagsToResourceCommand.ts @@ -21,7 +21,9 @@ export interface AddTagsToResourceCommandInput extends AddTagsToResourceRequest export interface AddTagsToResourceCommandOutput extends AddTagsToResourceResult, __MetadataBearer {} /** - *Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.
+ *Adds or overwrites one or more tags for the specified directory. Each directory can + * have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be + * unique to each resource.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/CancelSchemaExtensionCommand.ts b/clients/client-directory-service/commands/CancelSchemaExtensionCommand.ts index f2b7a1f61420..d36094debfcc 100644 --- a/clients/client-directory-service/commands/CancelSchemaExtensionCommand.ts +++ b/clients/client-directory-service/commands/CancelSchemaExtensionCommand.ts @@ -21,7 +21,11 @@ export interface CancelSchemaExtensionCommandInput extends CancelSchemaExtension export interface CancelSchemaExtensionCommandOutput extends CancelSchemaExtensionResult, __MetadataBearer {} /** - *Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema.
Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema
+ * extension has started replicating to all domain controllers, the task can no longer be
+ * canceled. A schema extension can be canceled during any of the following states;
+ * Initializing, CreatingSnapshot, and
+ * UpdatingSchema.
Creates an AD Connector to connect to an on-premises directory.
+ *Creates an AD Connector to connect to a self-managed directory.
*Before you call ConnectDirectory, ensure that all of the required permissions
* have been explicitly granted through a policy. For details about what permissions are required
- * to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions
+ * to run the ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions
* Reference.
Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
+ *Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional + * forwarders are required in order to set up a trust relationship with another domain. The + * conditional forwarder points to the trusted domain.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/CreateDirectoryCommand.ts b/clients/client-directory-service/commands/CreateDirectoryCommand.ts index 2d4648e9f2c1..00d0a87632b2 100644 --- a/clients/client-directory-service/commands/CreateDirectoryCommand.ts +++ b/clients/client-directory-service/commands/CreateDirectoryCommand.ts @@ -21,11 +21,11 @@ export interface CreateDirectoryCommandInput extends CreateDirectoryRequest {} export interface CreateDirectoryCommandOutput extends CreateDirectoryResult, __MetadataBearer {} /** - *Creates a Simple AD directory. For more information, see Simple Active Directory in the AWS Directory Service Admin + *
Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin * Guide.
*Before you call CreateDirectory, ensure that all of the required permissions
* have been explicitly granted through a policy. For details about what permissions are required
- * to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions
+ * to run the CreateDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions
* Reference.
Creates a subscription to forward real-time Directory Service domain controller security - * logs to the specified Amazon CloudWatch log group in your AWS account.
+ * logs to the specified Amazon CloudWatch log group in your 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-directory-service/commands/CreateMicrosoftADCommand.ts b/clients/client-directory-service/commands/CreateMicrosoftADCommand.ts index b085bf69ec4c..ad51673d7ebc 100644 --- a/clients/client-directory-service/commands/CreateMicrosoftADCommand.ts +++ b/clients/client-directory-service/commands/CreateMicrosoftADCommand.ts @@ -21,8 +21,10 @@ export interface CreateMicrosoftADCommandInput extends CreateMicrosoftADRequest export interface CreateMicrosoftADCommandOutput extends CreateMicrosoftADResult, __MetadataBearer {} /** - *Creates a Microsoft AD directory in the AWS Cloud. For more information, see AWS Managed Microsoft AD in the AWS Directory Service Admin Guide.
- *Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
+ *Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.
+ *Before you call CreateMicrosoftAD, ensure that all of the required + * permissions have been explicitly granted through a policy. For details about what permissions + * are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/CreateSnapshotCommand.ts b/clients/client-directory-service/commands/CreateSnapshotCommand.ts index 5c19f755dfad..0f2575440e57 100644 --- a/clients/client-directory-service/commands/CreateSnapshotCommand.ts +++ b/clients/client-directory-service/commands/CreateSnapshotCommand.ts @@ -21,7 +21,7 @@ export interface CreateSnapshotCommandInput extends CreateSnapshotRequest {} export interface CreateSnapshotCommandOutput extends CreateSnapshotResult, __MetadataBearer {} /** - *Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
+ *Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
*You cannot take snapshots of AD Connector directories.
*AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
- *This action initiates the creation of the AWS side of a trust relationship between an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.
+ *Directory Service for Microsoft Active Directory allows you to configure trust relationships. For + * example, you can establish a trust between your Managed Microsoft AD directory, and your existing + * self-managed Microsoft Active Directory. This would allow you to provide users and groups + * access to resources in either domain, with a single set of credentials.
+ *This action initiates the creation of the Amazon Web Services side of a trust relationship between an + * Managed Microsoft AD directory and an external domain. You can create either a forest trust or an + * external trust.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/DeleteConditionalForwarderCommand.ts b/clients/client-directory-service/commands/DeleteConditionalForwarderCommand.ts index c2994820b893..4877d65b3c89 100644 --- a/clients/client-directory-service/commands/DeleteConditionalForwarderCommand.ts +++ b/clients/client-directory-service/commands/DeleteConditionalForwarderCommand.ts @@ -21,7 +21,8 @@ export interface DeleteConditionalForwarderCommandInput extends DeleteConditiona export interface DeleteConditionalForwarderCommandOutput extends DeleteConditionalForwarderResult, __MetadataBearer {} /** - *Deletes a conditional forwarder that has been set up for your AWS directory.
+ *Deletes a conditional forwarder that has been set up for your Amazon Web Services + * directory.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/DeleteDirectoryCommand.ts b/clients/client-directory-service/commands/DeleteDirectoryCommand.ts index 86ba184d2eea..b9d938d73afc 100644 --- a/clients/client-directory-service/commands/DeleteDirectoryCommand.ts +++ b/clients/client-directory-service/commands/DeleteDirectoryCommand.ts @@ -21,10 +21,10 @@ export interface DeleteDirectoryCommandInput extends DeleteDirectoryRequest {} export interface DeleteDirectoryCommandOutput extends DeleteDirectoryResult, __MetadataBearer {} /** - *Deletes an AWS Directory Service directory.
+ *Deletes an Directory Service directory.
*Before you call DeleteDirectory, ensure that all of the required permissions
* have been explicitly granted through a policy. For details about what permissions are required
- * to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions
+ * to run the DeleteDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions
* Reference.
Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.
+ *Deletes an existing trust relationship between your Managed Microsoft AD directory and an external + * domain.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/DeregisterEventTopicCommand.ts b/clients/client-directory-service/commands/DeregisterEventTopicCommand.ts index 4d3770efc239..313b16691cca 100644 --- a/clients/client-directory-service/commands/DeregisterEventTopicCommand.ts +++ b/clients/client-directory-service/commands/DeregisterEventTopicCommand.ts @@ -21,7 +21,7 @@ export interface DeregisterEventTopicCommandInput extends DeregisterEventTopicRe export interface DeregisterEventTopicCommandOutput extends DeregisterEventTopicResult, __MetadataBearer {} /** - *Removes the specified directory as a publisher to the specified SNS topic.
+ *Removes the specified directory as a publisher to the specified Amazon SNS topic.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/DescribeClientAuthenticationSettingsCommand.ts b/clients/client-directory-service/commands/DescribeClientAuthenticationSettingsCommand.ts new file mode 100644 index 000000000000..bf25ecf0d144 --- /dev/null +++ b/clients/client-directory-service/commands/DescribeClientAuthenticationSettingsCommand.ts @@ -0,0 +1,106 @@ +import { DirectoryServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DirectoryServiceClient"; +import { + DescribeClientAuthenticationSettingsRequest, + DescribeClientAuthenticationSettingsResult, +} from "../models/models_0"; +import { + deserializeAws_json1_1DescribeClientAuthenticationSettingsCommand, + serializeAws_json1_1DescribeClientAuthenticationSettingsCommand, +} 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 DescribeClientAuthenticationSettingsCommandInput extends DescribeClientAuthenticationSettingsRequest {} +export interface DescribeClientAuthenticationSettingsCommandOutput + extends DescribeClientAuthenticationSettingsResult, + __MetadataBearer {} + +/** + *Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported.
+ *
Obtains information about the conditional forwarders for this account.
- *If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
+ *If no input parameters are provided for RemoteDomainNames, this request describes all + * conditional forwarders for the specified directory ID.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/DescribeEventTopicsCommand.ts b/clients/client-directory-service/commands/DescribeEventTopicsCommand.ts index 529c07763092..6958ccb6549b 100644 --- a/clients/client-directory-service/commands/DescribeEventTopicsCommand.ts +++ b/clients/client-directory-service/commands/DescribeEventTopicsCommand.ts @@ -21,8 +21,10 @@ export interface DescribeEventTopicsCommandInput extends DescribeEventTopicsRequ export interface DescribeEventTopicsCommandOutput extends DescribeEventTopicsResult, __MetadataBearer {} /** - *Obtains information about which SNS topics receive status messages from the specified directory.
- *If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
+ *Obtains information about which Amazon SNS topics receive status messages from the specified + * directory.
+ *If no input parameters are provided, such as DirectoryId or TopicName, this request + * describes all of the 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-directory-service/commands/DescribeTrustsCommand.ts b/clients/client-directory-service/commands/DescribeTrustsCommand.ts index 491b8303814c..ee471b5bc699 100644 --- a/clients/client-directory-service/commands/DescribeTrustsCommand.ts +++ b/clients/client-directory-service/commands/DescribeTrustsCommand.ts @@ -22,7 +22,8 @@ export interface DescribeTrustsCommandOutput extends DescribeTrustsResult, __Met /** *Obtains information about the trust relationships for this account.
- *If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
+ *If no input parameters are provided, such as DirectoryId or TrustIds, this request + * describes all the trust relationships belonging to the account.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/DisableRadiusCommand.ts b/clients/client-directory-service/commands/DisableRadiusCommand.ts index dac43b099b83..8a1f062d58ad 100644 --- a/clients/client-directory-service/commands/DisableRadiusCommand.ts +++ b/clients/client-directory-service/commands/DisableRadiusCommand.ts @@ -21,7 +21,8 @@ export interface DisableRadiusCommandInput extends DisableRadiusRequest {} export interface DisableRadiusCommandOutput extends DisableRadiusResult, __MetadataBearer {} /** - *Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
+ *Disables multi-factor authentication (MFA) with the Remote Authentication Dial In + * User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/EnableRadiusCommand.ts b/clients/client-directory-service/commands/EnableRadiusCommand.ts index 538279bf336f..494bb3578dd9 100644 --- a/clients/client-directory-service/commands/EnableRadiusCommand.ts +++ b/clients/client-directory-service/commands/EnableRadiusCommand.ts @@ -21,7 +21,8 @@ export interface EnableRadiusCommandInput extends EnableRadiusRequest {} export interface EnableRadiusCommandOutput extends EnableRadiusResult, __MetadataBearer {} /** - *Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
+ *Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User + * Service (RADIUS) server for an AD Connector or Microsoft AD directory.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/EnableSsoCommand.ts b/clients/client-directory-service/commands/EnableSsoCommand.ts index 6c2a7793ca25..2cbd282a240c 100644 --- a/clients/client-directory-service/commands/EnableSsoCommand.ts +++ b/clients/client-directory-service/commands/EnableSsoCommand.ts @@ -18,7 +18,9 @@ export interface EnableSsoCommandInput extends EnableSsoRequest {} export interface EnableSsoCommandOutput extends EnableSsoResult, __MetadataBearer {} /** - *Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately.
+ *Enables single sign-on for a directory. Single sign-on allows users in your directory to + * access certain Amazon Web Services services from a computer joined to the directory without having to enter + * their credentials separately.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/ListLogSubscriptionsCommand.ts b/clients/client-directory-service/commands/ListLogSubscriptionsCommand.ts index 7ee54374c4ee..d7be17e99a63 100644 --- a/clients/client-directory-service/commands/ListLogSubscriptionsCommand.ts +++ b/clients/client-directory-service/commands/ListLogSubscriptionsCommand.ts @@ -21,7 +21,7 @@ export interface ListLogSubscriptionsCommandInput extends ListLogSubscriptionsRe export interface ListLogSubscriptionsCommandOutput extends ListLogSubscriptionsResult, __MetadataBearer {} /** - *Lists the active log subscriptions for the AWS account.
+ *Lists the active log subscriptions for the 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-directory-service/commands/RegisterEventTopicCommand.ts b/clients/client-directory-service/commands/RegisterEventTopicCommand.ts index f8954f497593..1a66d3052656 100644 --- a/clients/client-directory-service/commands/RegisterEventTopicCommand.ts +++ b/clients/client-directory-service/commands/RegisterEventTopicCommand.ts @@ -21,7 +21,11 @@ export interface RegisterEventTopicCommandInput extends RegisterEventTopicReques export interface RegisterEventTopicCommandOutput extends RegisterEventTopicResult, __MetadataBearer {} /** - *Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
+ *Associates a directory with an Amazon SNS topic. This establishes the directory as a + * publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when + * the status of your directory changes. You get notified if your directory goes from an Active + * status to an Impaired or Inoperable status. You also receive a notification when the directory + * returns to an Active status.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/ResetUserPasswordCommand.ts b/clients/client-directory-service/commands/ResetUserPasswordCommand.ts index 74ebe14bacea..82358ca2ad19 100644 --- a/clients/client-directory-service/commands/ResetUserPasswordCommand.ts +++ b/clients/client-directory-service/commands/ResetUserPasswordCommand.ts @@ -21,7 +21,7 @@ export interface ResetUserPasswordCommandInput extends ResetUserPasswordRequest export interface ResetUserPasswordCommandOutput extends ResetUserPasswordResult, __MetadataBearer {} /** - *Resets the password for any user in your AWS Managed Microsoft AD or Simple AD + *
Resets the password for any user in your Managed Microsoft AD or Simple AD * directory.
*You can reset the password for any user in your directory with the following * exceptions:
@@ -32,11 +32,10 @@ export interface ResetUserPasswordCommandOutput extends ResetUserPasswordResult, * Admins group except for the administrator user. *For AWS Managed Microsoft AD, you can only reset the password for a user that is in an + *
For Managed Microsoft AD, you can only reset the password for a user that is in an * OU based off of the NetBIOS name that you typed when you created your directory. For - * example, you cannot reset the password for a user in the AWS - * Reserved OU. For more information about the OU structure for an AWS Managed - * Microsoft AD directory, see What Gets Created in the AWS Directory Service Administration + * example, you cannot reset the password for a user in the Amazon Web Services + * Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration * Guide.
*Shares a specified directory (DirectoryId) in your AWS account (directory
- * owner) with another AWS account (directory consumer). With this operation you can use your
- * directory from any AWS account and from any Amazon VPC within an AWS Region.
When you share your AWS Managed Microsoft AD directory, AWS Directory Service creates a + *
Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory
+ * owner) with another Amazon Web Services account (directory consumer). With this operation you can use your
+ * directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.
When you share your Managed Microsoft AD directory, Directory Service creates a * shared directory in the directory consumer account. This shared directory contains the * metadata to provide access to the directory within the directory owner account. The shared * directory is visible in all VPCs in the directory consumer account.
*The ShareMethod parameter determines whether the specified directory can be
- * shared between AWS accounts inside the same AWS organization (ORGANIZATIONS). It
- * also determines whether you can share the directory with any other AWS account either inside
+ * shared between Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It
+ * also determines whether you can share the directory with any other Amazon Web Services account either inside
* or outside of the organization (HANDSHAKE).
The ShareNotes parameter is only used when HANDSHAKE is called,
* which sends a directory sharing request to the directory consumer.
Updates a conditional forwarder that has been set up for your AWS directory.
+ *Updates a conditional forwarder that has been set up for your Amazon Web Services + * directory.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/UpdateNumberOfDomainControllersCommand.ts b/clients/client-directory-service/commands/UpdateNumberOfDomainControllersCommand.ts index 8b72c11040e2..d8804bc00708 100644 --- a/clients/client-directory-service/commands/UpdateNumberOfDomainControllersCommand.ts +++ b/clients/client-directory-service/commands/UpdateNumberOfDomainControllersCommand.ts @@ -23,7 +23,11 @@ export interface UpdateNumberOfDomainControllersCommandOutput __MetadataBearer {} /** - *Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.
+ *Adds or removes domain controllers to or from the directory. Based on the difference + * between current value and new value (provided through this API call), domain controllers will + * be added or removed. It may take up to 45 minutes for any new domain controllers to become + * fully active once the requested number of domain controllers is updated. During this time, you + * cannot make another update request.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/UpdateRadiusCommand.ts b/clients/client-directory-service/commands/UpdateRadiusCommand.ts index 5266d6ab420e..520ebf7a4efd 100644 --- a/clients/client-directory-service/commands/UpdateRadiusCommand.ts +++ b/clients/client-directory-service/commands/UpdateRadiusCommand.ts @@ -21,7 +21,8 @@ export interface UpdateRadiusCommandInput extends UpdateRadiusRequest {} export interface UpdateRadiusCommandOutput extends UpdateRadiusResult, __MetadataBearer {} /** - *Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
+ *Updates the Remote Authentication Dial In User Service (RADIUS) server information + * for an AD Connector or Microsoft AD directory.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/UpdateTrustCommand.ts b/clients/client-directory-service/commands/UpdateTrustCommand.ts index 411de96a2726..0bd12e4016a4 100644 --- a/clients/client-directory-service/commands/UpdateTrustCommand.ts +++ b/clients/client-directory-service/commands/UpdateTrustCommand.ts @@ -21,7 +21,8 @@ export interface UpdateTrustCommandInput extends UpdateTrustRequest {} export interface UpdateTrustCommandOutput extends UpdateTrustResult, __MetadataBearer {} /** - *Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.
+ *Updates the trust that has been set up between your Managed Microsoft AD directory and an + * self-managed Active Directory.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/commands/VerifyTrustCommand.ts b/clients/client-directory-service/commands/VerifyTrustCommand.ts index 1ddc37e372ff..7564cb378871 100644 --- a/clients/client-directory-service/commands/VerifyTrustCommand.ts +++ b/clients/client-directory-service/commands/VerifyTrustCommand.ts @@ -21,8 +21,10 @@ export interface VerifyTrustCommandInput extends VerifyTrustRequest {} export interface VerifyTrustCommandOutput extends VerifyTrustResult, __MetadataBearer {} /** - *AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
- *This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain.
+ *Directory Service for Microsoft Active Directory allows you to configure and verify trust + * relationships.
+ *This action verifies a trust relationship between your Managed Microsoft AD directory and an + * external domain.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-directory-service/index.ts b/clients/client-directory-service/index.ts index d66783064c7c..7b52175c7228 100644 --- a/clients/client-directory-service/index.ts +++ b/clients/client-directory-service/index.ts @@ -22,6 +22,7 @@ export * from "./commands/DeleteTrustCommand"; export * from "./commands/DeregisterCertificateCommand"; export * from "./commands/DeregisterEventTopicCommand"; export * from "./commands/DescribeCertificateCommand"; +export * from "./commands/DescribeClientAuthenticationSettingsCommand"; export * from "./commands/DescribeConditionalForwardersCommand"; export * from "./commands/DescribeDirectoriesCommand"; export * from "./commands/DescribeDomainControllersCommand"; diff --git a/clients/client-directory-service/models/models_0.ts b/clients/client-directory-service/models/models_0.ts index 49c315496fd7..a7ee947c80cc 100644 --- a/clients/client-directory-service/models/models_0.ts +++ b/clients/client-directory-service/models/models_0.ts @@ -53,7 +53,7 @@ export interface SharedDirectory { /** *The method used when sharing a directory to determine whether the directory should be
- * shared within your AWS organization (ORGANIZATIONS) or with any AWS account by
+ * shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by
* sending a shared directory request (HANDSHAKE).
Current directory status of the shared AWS Managed Microsoft AD directory.
+ *Current directory status of the shared Managed Microsoft AD directory.
*/ ShareStatus?: ShareStatus | string; @@ -132,7 +132,7 @@ export interface ClientException extends __SmithyException, $MetadataBearer { Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -147,7 +147,7 @@ export namespace ClientException { } /** - *The specified directory has already been shared with this AWS account.
+ *The specified directory has already been shared with this Amazon Web Services account.
*/ export interface DirectoryAlreadySharedException extends __SmithyException, $MetadataBearer { name: "DirectoryAlreadySharedException"; @@ -158,7 +158,7 @@ export interface DirectoryAlreadySharedException extends __SmithyException, $Met Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -184,7 +184,7 @@ export interface EntityDoesNotExistException extends __SmithyException, $Metadat Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -210,7 +210,7 @@ export interface InvalidParameterException extends __SmithyException, $MetadataB Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -225,7 +225,7 @@ export namespace InvalidParameterException { } /** - *An exception has occurred in AWS Directory Service.
+ *An exception has occurred in Directory Service.
*/ export interface ServiceException extends __SmithyException, $MetadataBearer { name: "ServiceException"; @@ -236,7 +236,7 @@ export interface ServiceException extends __SmithyException, $MetadataBearer { Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -262,7 +262,7 @@ export interface AccessDeniedException extends __SmithyException, $MetadataBeare Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -277,11 +277,14 @@ export namespace AccessDeniedException { } /** - *IP address block. This is often the address block of the DNS server used for your on-premises domain.
+ *IP address block. This is often the address block of the DNS server used for your + * self-managed domain.
*/ export interface IpRoute { /** - *IP address block using CIDR format, for example 10.0.0.0/24. This is often the address block of the DNS server used for your on-premises domain. For a single IP address use a CIDR address block with /32. For example 10.0.0.0/32.
+ *IP address block using CIDR format, for example 10.0.0.0/24. This is often the + * address block of the DNS server used for your self-managed domain. For a single IP address + * use a CIDR address block with /32. For example 10.0.0.0/32.
*/ CidrIp?: string; @@ -307,14 +310,15 @@ export interface AddIpRoutesRequest { DirectoryId: string | undefined; /** - *IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your on-premises domain.
+ *IP address blocks, using CIDR format, of the traffic to route. This is often the IP + * address block of the DNS server used for your self-managed domain.
*/ IpRoutes: IpRoute[] | undefined; /** - *If set to true, updates the inbound and outbound rules of the security group that has the description: "AWS created security group for directory ID directory controllers." - * Following are the new rules: - *
+ *If set to true, updates the inbound and outbound rules of the security group that has + * the description: "Amazon Web Services created security group for directory ID + * directory controllers." Following are the new rules:
*Inbound:
*Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0
*Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0
+ *Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: + * 0.0.0.0/0
*Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0
+ *Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: + * 0.0.0.0/0
*Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0
@@ -377,7 +383,8 @@ export interface AddIpRoutesRequest { *Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0
*These security rules impact an internal network interface that is not exposed publicly.
+ *These security rules impact an internal network interface that is not exposed + * publicly.
*/ UpdateSecurityGroupForDirectoryControllers?: boolean; } @@ -414,7 +421,7 @@ export interface DirectoryUnavailableException extends __SmithyException, $Metad Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -440,7 +447,7 @@ export interface EntityAlreadyExistsException extends __SmithyException, $Metada Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -455,7 +462,8 @@ export namespace EntityAlreadyExistsException { } /** - *The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.
+ *The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP + * address blocks.
*/ export interface IpRouteLimitExceededException extends __SmithyException, $MetadataBearer { name: "IpRouteLimitExceededException"; @@ -466,7 +474,7 @@ export interface IpRouteLimitExceededException extends __SmithyException, $Metad Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -491,7 +499,7 @@ export interface DirectoryVpcSettings { /** *The identifiers of the subnets for the directory servers. The two subnets must be in - * different Availability Zones. AWS Directory Service creates a directory server and a DNS + * different Availability Zones. Directory Service creates a directory server and a DNS * server in each of these subnets.
*/ SubnetIds: string[] | undefined; @@ -545,7 +553,7 @@ export namespace AddRegionResult { } /** - *The Region you specified is the same Region where the AWS Managed Microsoft AD directory + *
The Region you specified is the same Region where the Managed Microsoft AD directory * was created. Specify a different Region and try again.
*/ export interface DirectoryAlreadyInRegionException extends __SmithyException, $MetadataBearer { @@ -557,7 +565,7 @@ export interface DirectoryAlreadyInRegionException extends __SmithyException, $M Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -583,7 +591,7 @@ export interface DirectoryDoesNotExistException extends __SmithyException, $Meta Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -610,7 +618,7 @@ export interface RegionLimitExceededException extends __SmithyException, $Metada Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -636,7 +644,7 @@ export interface UnsupportedOperationException extends __SmithyException, $Metad Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -655,12 +663,17 @@ export namespace UnsupportedOperationException { */ export interface Tag { /** - *Required name of the tag. The string value can be Unicode characters and cannot be prefixed with "aws:". The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
+ *Required name of the tag. The string value can be Unicode characters and cannot be + * prefixed with "aws:". The string can contain only the set of Unicode letters, digits, + * white-space, '_', '.', '/', '=', '+', '-' (Java regex: + * "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
*/ Key: string | undefined; /** - *The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
+ *The optional value of the tag. The string value can be Unicode characters. The string + * can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' + * (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
*/ Value: string | undefined; } @@ -718,7 +731,7 @@ export interface TagLimitExceededException extends __SmithyException, $MetadataB Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -913,7 +926,7 @@ export interface CertificateAlreadyExistsException extends __SmithyException, $M Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -939,7 +952,7 @@ export interface CertificateDoesNotExistException extends __SmithyException, $Me Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -1005,7 +1018,7 @@ export interface CertificateInUseException extends __SmithyException, $MetadataB Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -1031,7 +1044,7 @@ export interface CertificateLimitExceededException extends __SmithyException, $M Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -1045,10 +1058,44 @@ export namespace CertificateLimitExceededException { }); } +export enum ClientAuthenticationStatus { + DISABLED = "Disabled", + ENABLED = "Enabled", +} + export enum ClientAuthenticationType { SMART_CARD = "SmartCard", } +/** + *Contains information about a client authentication method for a directory.
+ */ +export interface ClientAuthenticationSettingInfo { + /** + *The type of client authentication for the specified directory. If no type is specified, a list of all client authentication types that are supported for the directory is retrieved.
+ */ + Type?: ClientAuthenticationType | string; + + /** + *Whether the client authentication type is enabled or disabled for the specified directory.
+ */ + Status?: ClientAuthenticationStatus | string; + + /** + *The date and time when the status of the client authentication type was last updated.
+ */ + LastUpdatedDateTime?: Date; +} + +export namespace ClientAuthenticationSettingInfo { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ClientAuthenticationSettingInfo): any => ({ + ...obj, + }); +} + /** *Contains information about a computer account in a directory.
*/ @@ -1084,23 +1131,27 @@ export enum ReplicationScope { } /** - *Points to a remote domain with which you are setting up a trust relationship. Conditional forwarders are required in order to set up a trust relationship with another domain.
+ *Points to a remote domain with which you are setting up a trust relationship. + * Conditional forwarders are required in order to set up a trust relationship with another + * domain.
*/ export interface ConditionalForwarder { /** - *The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.
+ *The fully qualified domain name (FQDN) of the remote domains pointed to by the + * conditional forwarder.
*/ RemoteDomainName?: string; /** - *The IP addresses of the remote DNS server associated with RemoteDomainName. This is the IP address of the DNS server that your conditional forwarder points to.
+ *The IP addresses of the remote DNS server associated with RemoteDomainName. This is the + * IP address of the DNS server that your conditional forwarder points to.
*/ DnsIpAddrs?: string[]; /** *The replication scope of the conditional forwarder. The only allowed value is
- * Domain, which will replicate the conditional forwarder to all of the
- * domain controllers for your AWS directory.
Domain, which will replicate the conditional forwarder to all of the domain
+ * controllers for your Amazon Web Services directory.
*/
ReplicationScope?: ReplicationScope | string;
}
@@ -1130,13 +1181,13 @@ export interface DirectoryConnectSettings {
SubnetIds: string[] | undefined;
/**
- * A list of one or more IP addresses of DNS servers or domain controllers in the on-premises + *
A list of one or more IP addresses of DNS servers or domain controllers in your self-managed * directory.
*/ CustomerDnsIps: string[] | undefined; /** - *The user name of an account in the on-premises directory that is used to connect to the + *
The user name of an account in your self-managed directory that is used to connect to the * directory. This account must have the following permissions:
*The fully qualified name of the on-premises directory, such as + *
The fully qualified name of your self-managed directory, such as
* corp.example.com.
The NetBIOS name of the on-premises directory, such as CORP.
The NetBIOS name of your self-managed directory, such as CORP.
The password for the on-premises user account.
+ *The password for your self-managed user account.
*/ Password: string | undefined; @@ -1240,8 +1291,8 @@ export namespace ConnectDirectoryResult { /** *The maximum number of directories in the region has been reached. You can use the - * GetDirectoryLimits operation to determine your directory limits in the - * region.
+ * GetDirectoryLimits operation to determine your directory limits in + * the region. */ export interface DirectoryLimitExceededException extends __SmithyException, $MetadataBearer { name: "DirectoryLimitExceededException"; @@ -1252,7 +1303,7 @@ export interface DirectoryLimitExceededException extends __SmithyException, $Met Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -1277,7 +1328,7 @@ export interface CreateAliasRequest { /** *The requested alias.
- *The alias must be unique amongst all aliases in AWS. This operation throws an + *
The alias must be unique amongst all aliases in Amazon Web Services. This operation throws an
* EntityAlreadyExistsException error if the alias already exists.
Initiates the creation of a conditional forwarder for your AWS Directory Service for Microsoft Active Directory. Conditional forwarders are required in order to set up a trust relationship with another domain.
+ *Initiates the creation of a conditional forwarder for your Directory Service for Microsoft Active + * Directory. Conditional forwarders are required in order to set up a trust relationship with + * another domain.
*/ export interface CreateConditionalForwarderRequest { /** - *The directory ID of the AWS directory for which you are creating the conditional forwarder.
+ *The directory ID of the Amazon Web Services directory for which you are creating the conditional + * forwarder.
*/ DirectoryId: string | undefined; /** - *The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
+ *The fully qualified domain name (FQDN) of the remote domain with which you will set up + * a trust relationship.
*/ RemoteDomainName: string | undefined; @@ -1563,7 +1618,7 @@ export interface InsufficientPermissionsException extends __SmithyException, $Me Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -1583,18 +1638,20 @@ export enum DirectoryEdition { } /** - *Creates an AWS Managed Microsoft AD directory.
+ *Creates an Managed Microsoft AD directory.
*/ export interface CreateMicrosoftADRequest { /** - *The fully qualified domain name for the AWS Managed Microsoft AD directory, such as
- * corp.example.com. This name will resolve inside your VPC only. It does not need
- * to be publicly resolvable.
The fully qualified domain name for the Managed Microsoft AD directory, such as
+ * corp.example.com. This name will resolve inside your VPC only. It does not need
+ * to be publicly resolvable.
The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.
The NetBIOS name for your domain, such as CORP. If you don't specify a
+ * NetBIOS name, it will default to the first part of your directory DNS. For example,
+ * CORP for the directory DNS corp.example.com.
A description for the directory. This label will appear on the AWS console Directory Details page after the directory is created.
A description for the directory. This label will appear on the Amazon Web Services console
+ * Directory Details page after the directory is created.
AWS Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.
Managed Microsoft AD is available in two editions: Standard and
+ * Enterprise. Enterprise is the default.
The tags to be assigned to the AWS Managed Microsoft AD directory.
+ *The tags to be assigned to the Managed Microsoft AD directory.
*/ Tags?: Tag[]; } @@ -1699,8 +1758,8 @@ export namespace CreateSnapshotResult { /** *The maximum number of manual snapshots for the directory has been reached. You can - * use the GetSnapshotLimits operation to determine the snapshot limits for a - * directory.
+ * use the GetSnapshotLimits operation to determine the snapshot limits + * for a directory. */ export interface SnapshotLimitExceededException extends __SmithyException, $MetadataBearer { name: "SnapshotLimitExceededException"; @@ -1711,7 +1770,7 @@ export interface SnapshotLimitExceededException extends __SmithyException, $Meta Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -1742,22 +1801,29 @@ export enum TrustType { } /** - *AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
- *This action initiates the creation of the AWS side of a trust relationship between an AWS Managed Microsoft AD directory and an external domain.
+ *Directory Service for Microsoft Active Directory allows you to configure trust relationships. For + * example, you can establish a trust between your Managed Microsoft AD directory, and your existing + * self-managed Microsoft Active Directory. This would allow you to provide users and groups + * access to resources in either domain, with a single set of credentials.
+ *This action initiates the creation of the Amazon Web Services side of a trust relationship between an + * Managed Microsoft AD directory and an external domain.
*/ export interface CreateTrustRequest { /** - *The Directory ID of the AWS Managed Microsoft AD directory for which to establish the trust relationship.
+ *The Directory ID of the Managed Microsoft AD directory for which to establish the trust + * relationship.
*/ DirectoryId: string | undefined; /** - *The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.
+ *The Fully Qualified Domain Name (FQDN) of the external domain for which to create the + * trust relationship.
*/ RemoteDomainName: string | undefined; /** - *The trust password. The must be the same password that was used when creating the trust relationship on the external domain.
+ *The trust password. The must be the same password that was used when creating the trust + * relationship on the external domain.
*/ TrustPassword: string | undefined; @@ -1821,7 +1887,8 @@ export interface DeleteConditionalForwarderRequest { DirectoryId: string | undefined; /** - *The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.
+ *The fully qualified domain name (FQDN) of the remote domain with which you are deleting + * the conditional forwarder.
*/ RemoteDomainName: string | undefined; } @@ -1953,7 +2020,8 @@ export namespace DeleteSnapshotResult { } /** - *Deletes the local side of an existing trust relationship between the AWS Managed Microsoft AD directory and the external domain.
+ *Deletes the local side of an existing trust relationship between the Managed Microsoft AD + * directory and the external domain.
*/ export interface DeleteTrustRequest { /** @@ -2028,16 +2096,18 @@ export namespace DeregisterCertificateResult { } /** - *Removes the specified directory as a publisher to the specified SNS topic.
+ *Removes the specified directory as a publisher to the specified Amazon SNS topic.
*/ export interface DeregisterEventTopicRequest { /** - *The Directory ID to remove as a publisher. This directory will no longer send messages to the specified SNS topic.
+ *The Directory ID to remove as a publisher. This directory will no longer send messages + * to the specified Amazon SNS topic.
*/ DirectoryId: string | undefined; /** - *The name of the SNS topic from which to remove the directory as a publisher.
+ *The name of the Amazon SNS topic from which to remove the directory as a + * publisher.
*/ TopicName: string | undefined; } @@ -2103,17 +2173,73 @@ export namespace DescribeCertificateResult { }); } +export interface DescribeClientAuthenticationSettingsRequest { + /** + *The identifier of the directory for which to retrieve information.
+ */ + DirectoryId: string | undefined; + + /** + *The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.
+ */ + Type?: ClientAuthenticationType | string; + + /** + *The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call.
+ */ + NextToken?: string; + + /** + *The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
+ */ + Limit?: number; +} + +export namespace DescribeClientAuthenticationSettingsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeClientAuthenticationSettingsRequest): any => ({ + ...obj, + }); +} + +export interface DescribeClientAuthenticationSettingsResult { + /** + *Information about the type of client authentication for the specified directory. The following information is retrieved: The date and time when the status of the client authentication type was last updated, whether the client authentication type is enabled or disabled, and the type of client authentication.
+ */ + ClientAuthenticationSettingsInfo?: ClientAuthenticationSettingInfo[]; + + /** + *The next token used to retrieve the client authentication settings if the number of setting types exceeds + * page limit and there is another page.
+ */ + NextToken?: string; +} + +export namespace DescribeClientAuthenticationSettingsResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeClientAuthenticationSettingsResult): any => ({ + ...obj, + }); +} + /** *Describes a conditional forwarder.
*/ export interface DescribeConditionalForwardersRequest { /** - *The directory ID for which to get the list of associated conditional forwarders.
+ *The directory ID for which to get the list of associated conditional + * forwarders.
*/ DirectoryId: string | undefined; /** - *The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned.
+ *The fully qualified domain names (FQDN) of the remote domains for which to get the list + * of associated conditional forwarders. If this member is null, all conditional forwarders are + * returned.
*/ RemoteDomainNames?: string[]; } @@ -2193,7 +2319,7 @@ export interface DirectoryConnectSettingsDescription { SubnetIds?: string[]; /** - *The user name of the service account in the on-premises directory.
+ *The user name of the service account in your self-managed directory.
*/ CustomerUserName?: string; @@ -2230,16 +2356,20 @@ export enum RadiusAuthenticationProtocol { } /** - *Contains information about a Remote Authentication Dial In User Service (RADIUS) server.
+ *Contains information about a Remote Authentication Dial In User Service (RADIUS) + * server.
*/ export interface RadiusSettings { /** - *An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.
+ *An array of strings that contains the fully qualified domain name (FQDN) or IP + * addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server + * load balancer.
*/ RadiusServers?: string[]; /** - *The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers.
+ *The port that your RADIUS server is using for communications. Your self-managed + * network must allow inbound traffic over this port from the Directory Service servers.
*/ RadiusPort?: number; @@ -2249,7 +2379,8 @@ export interface RadiusSettings { RadiusTimeout?: number; /** - *The maximum number of times that communication with the RADIUS server is attempted.
+ *The maximum number of times that communication with the RADIUS server is + * attempted.
*/ RadiusRetries?: number; @@ -2330,7 +2461,7 @@ export namespace DirectoryVpcSettingsDescription { */ export interface OwnerDirectoryDescription { /** - *Identifier of the AWS Managed Microsoft AD directory in the directory owner + *
Identifier of the Managed Microsoft AD directory in the directory owner * account.
*/ DirectoryId?: string; @@ -2378,7 +2509,7 @@ export namespace OwnerDirectoryDescription { */ export interface RegionsInfo { /** - *The Region where the AWS Managed Microsoft AD directory was originally created.
+ *The Region where the Managed Microsoft AD directory was originally created.
*/ PrimaryRegion?: string; @@ -2420,7 +2551,7 @@ export enum DirectoryType { } /** - *Contains information about an AWS Directory Service directory.
+ *Contains information about an Directory Service directory.
*/ export interface DirectoryDescription { /** @@ -2471,7 +2602,7 @@ export interface DirectoryDescription { *The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD * directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For * an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers - * in the on-premises directory to which the AD Connector is connected.
+ * in your self-managed directory to which the AD Connector is connected. */ DnsIpAddrs?: string[]; @@ -2481,13 +2612,13 @@ export interface DirectoryDescription { Stage?: DirectoryStage | string; /** - *Current directory status of the shared AWS Managed Microsoft AD directory.
+ *Current directory status of the shared Managed Microsoft AD directory.
*/ ShareStatus?: ShareStatus | string; /** *The method used when sharing a directory to determine whether the directory should be
- * shared within your AWS organization (ORGANIZATIONS) or with any AWS account by
+ * shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by
* sending a shared directory request (HANDSHAKE).
A DirectoryVpcSettingsDescription object that contains additional * information about a directory. This member is only present if the directory is a Simple AD or - * Managed AD directory.
+ * Managed Microsoft AD directory. */ VpcSettings?: DirectoryVpcSettingsDescription; @@ -2550,12 +2681,13 @@ export interface DirectoryDescription { SsoEnabled?: boolean; /** - *The desired number of domain controllers in the directory if the directory is Microsoft AD.
+ *The desired number of domain controllers in the directory if the directory is Microsoft + * AD.
*/ DesiredNumberOfDomainControllers?: number; /** - *Describes the AWS Managed Microsoft AD directory in the directory owner account.
+ *Describes the Managed Microsoft AD directory in the directory owner account.
*/ OwnerDirectoryDescription?: OwnerDirectoryDescription; @@ -2624,7 +2756,7 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -2640,17 +2772,21 @@ export namespace InvalidNextTokenException { export interface DescribeDomainControllersRequest { /** - *Identifier of the directory for which to retrieve the domain controller information.
+ *Identifier of the directory for which to retrieve the domain controller + * information.
*/ DirectoryId: string | undefined; /** - *A list of identifiers for the domain controllers whose information will be provided.
+ *A list of identifiers for the domain controllers whose information will be + * provided.
*/ DomainControllerIds?: string[]; /** - *The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.
+ *The DescribeDomainControllers.NextToken value from a previous call + * to DescribeDomainControllers. Pass null if this is the first call. + *
*/ NextToken?: string; @@ -2750,7 +2886,9 @@ export interface DescribeDomainControllersResult { DomainControllers?: DomainController[]; /** - *If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDomainControllers retrieve the next set of items.
If not null, more results are available. Pass this value for the NextToken
+ * parameter in a subsequent call to DescribeDomainControllers retrieve the
+ * next set of items.
The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned.
+ *The Directory ID for which to get the list of associated Amazon SNS topics. If this member + * is null, associations for all Directory IDs are returned.
*/ DirectoryId?: string; /** - *A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.
- *An empty list results in an InvalidParameterException being thrown.
A list of Amazon SNS topic names for which to obtain the information. If this member is + * null, all associations for the specified Directory ID are returned.
+ *An empty list results in an InvalidParameterException being
+ * thrown.
Information about SNS topic and AWS Directory Service directory associations.
+ *Information about Amazon SNS topic and Directory Service directory associations.
*/ export interface EventTopic { /** - *The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic.
+ *The Directory ID of an Directory Service directory that will publish status messages to an Amazon SNS + * topic.
*/ DirectoryId?: string; /** - *The name of an AWS SNS topic the receives status messages from the directory.
+ *The name of an Amazon SNS topic the receives status messages from the directory.
*/ TopicName?: string; /** - *The SNS topic ARN (Amazon Resource Name).
+ *The Amazon SNS topic ARN (Amazon Resource Name).
*/ TopicArn?: string; /** - *The date and time of when you associated your directory with the SNS topic.
+ *The date and time of when you associated your directory with the Amazon SNS topic.
*/ CreatedDateTime?: Date; @@ -2840,7 +2982,8 @@ export namespace EventTopic { */ export interface DescribeEventTopicsResult { /** - *A list of SNS topic names that receive status messages from the specified Directory ID.
+ *A list of Amazon SNS topic names that receive status messages from the specified Directory + * ID.
*/ EventTopics?: EventTopic[]; } @@ -3242,23 +3385,28 @@ export namespace DescribeSnapshotsResult { } /** - *Describes the trust relationships for a particular AWS Managed Microsoft AD directory. If no input parameters are are provided, such as directory ID or trust ID, this request describes all the trust relationships.
+ *Describes the trust relationships for a particular Managed Microsoft AD directory. If no input + * parameters are provided, such as directory ID or trust ID, this request describes all the + * trust relationships.
*/ export interface DescribeTrustsRequest { /** - *The Directory ID of the AWS directory that is a part of the requested trust relationship.
+ *The Directory ID of the Amazon Web Services directory that is a part of the requested trust + * relationship.
*/ DirectoryId?: string; /** - *A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned.
+ *A list of identifiers of the trust relationships for which to obtain the information. If + * this member is null, all trust relationships that belong to the current account are + * returned.
*An empty list results in an InvalidParameterException being thrown.
The DescribeTrustsResult.NextToken value from a previous call to - * DescribeTrusts. Pass null if this is the first call.
+ * DescribeTrusts. Pass null if this is the first call. */ NextToken?: string; @@ -3292,11 +3440,12 @@ export enum TrustState { } /** - *Describes a trust relationship between an AWS Managed Microsoft AD directory and an external domain.
+ *Describes a trust relationship between an Managed Microsoft AD directory and an external + * domain.
*/ export interface Trust { /** - *The Directory ID of the AWS directory involved in the trust relationship.
+ *The Directory ID of the Amazon Web Services directory involved in the trust relationship.
*/ DirectoryId?: string; @@ -3306,7 +3455,8 @@ export interface Trust { TrustId?: string; /** - *The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.
+ *The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust + * relationship.
*/ RemoteDomainName?: string; @@ -3367,15 +3517,15 @@ export interface DescribeTrustsResult { /** *The list of Trust objects that were retrieved.
*It is possible that this list contains less than the number of items specified in the - * Limit member of the request. This occurs if there are less than the requested - * number of items left to retrieve, or if the limitations of the operation have been - * exceeded.
+ * Limit member of the request. This occurs if there are less than the + * requested number of items left to retrieve, or if the limitations of the operation have been + * exceeded. */ Trusts?: Trust[]; /** - *If not null, more results are available. Pass this value for the NextToken parameter - * in a subsequent call to DescribeTrusts to retrieve the next set of items.
+ *If not null, more results are available. Pass this value for the + * NextToken parameter in a subsequent call to DescribeTrusts to retrieve the next set of items.
*/ NextToken?: string; } @@ -3409,17 +3559,17 @@ export interface DirectoryLimits { CloudOnlyDirectoriesLimitReached?: boolean; /** - *The maximum number of AWS Managed Microsoft AD directories allowed in the region.
+ *The maximum number of Managed Microsoft AD directories allowed in the region.
*/ CloudOnlyMicrosoftADLimit?: number; /** - *The current number of AWS Managed Microsoft AD directories in the region.
+ *The current number of Managed Microsoft AD directories in the region.
*/ CloudOnlyMicrosoftADCurrentCount?: number; /** - *Indicates if the AWS Managed Microsoft AD directory limit has been reached.
+ *Indicates if the Managed Microsoft AD directory limit has been reached.
*/ CloudOnlyMicrosoftADLimitReached?: boolean; @@ -3449,7 +3599,7 @@ export namespace DirectoryLimits { } /** - *The specified directory has not been shared with this AWS account.
+ *The specified directory has not been shared with this Amazon Web Services account.
*/ export interface DirectoryNotSharedException extends __SmithyException, $MetadataBearer { name: "DirectoryNotSharedException"; @@ -3460,7 +3610,7 @@ export interface DirectoryNotSharedException extends __SmithyException, $Metadat Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -3518,7 +3668,7 @@ export interface InvalidClientAuthStatusException extends __SmithyException, $Me Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -3578,7 +3728,7 @@ export interface InvalidLDAPSStatusException extends __SmithyException, $Metadat Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -3635,17 +3785,21 @@ export interface DisableSsoRequest { DirectoryId: string | undefined; /** - *The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name.
- *If the AD Connector service account does not have privileges to remove a service principal - * name, you can specify an alternate account with the UserName and Password - * parameters. These credentials are only used to disable single sign-on and are not stored by - * the service. The AD Connector service account is not changed.
+ *The username of an alternate account to use to disable single-sign on. This is only used + * for AD Connector directories. This account must have privileges to remove a service + * principal name.
+ *If the AD Connector service account does not have privileges to remove a service + * principal name, you can specify an alternate account with the UserName + * and Password parameters. These credentials are only used to disable + * single sign-on and are not stored by the service. The AD Connector service account is not + * changed.
*/ UserName?: string; /** *The password of an alternate account to use to disable single-sign on. This is only used - * for AD Connector directories. For more information, see the UserName parameter.
+ * for AD Connector directories. For more information, see the UserName + * parameter. */ Password?: string; } @@ -3683,7 +3837,7 @@ export interface EnableClientAuthenticationRequest { /** *The type of client authentication to enable. Currently only the value SmartCard is
* supported. Smart card authentication in AD Connector requires that you enable Kerberos
- * Constrained Delegation for the Service User to the LDAP service in the on-premises AD.
+ * Constrained Delegation for the Service User to the LDAP service in your self-managed AD.
*
The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -3779,7 +3933,8 @@ export interface EnableRadiusRequest { DirectoryId: string | undefined; /** - *A RadiusSettings object that contains information about the RADIUS server.
+ *A RadiusSettings object that contains information about the RADIUS + * server.
*/ RadiusSettings: RadiusSettings | undefined; } @@ -3818,17 +3973,21 @@ export interface EnableSsoRequest { DirectoryId: string | undefined; /** - *The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.
+ *The username of an alternate account to use to enable single-sign on. This is only used + * for AD Connector directories. This account must have privileges to add a service principal + * name.
*If the AD Connector service account does not have privileges to add a service principal - * name, you can specify an alternate account with the UserName and Password - * parameters. These credentials are only used to enable single sign-on and are not stored by - * the service. The AD Connector service account is not changed.
+ * name, you can specify an alternate account with the UserName and + * Password parameters. These credentials are only used to enable single + * sign-on and are not stored by the service. The AD Connector service account is not + * changed. */ UserName?: string; /** - *The password of an alternate account to use to enable single-sign on. This is only used for - * AD Connector directories. For more information, see the UserName parameter.
+ *The password of an alternate account to use to enable single-sign on. This is only used + * for AD Connector directories. For more information, see the UserName + * parameter.
*/ Password?: string; } @@ -3877,7 +4036,7 @@ export namespace GetDirectoryLimitsRequest { export interface GetDirectoryLimitsResult { /** *A DirectoryLimits object that contains the directory limits for the - * current rRegion.
+ * current Region. */ DirectoryLimits?: DirectoryLimits; } @@ -4013,18 +4172,19 @@ export namespace ListCertificatesResult { export interface ListIpRoutesRequest { /** - *Identifier (ID) of the directory for which you want to retrieve the IP addresses.
+ *Identifier (ID) of the directory for which you want to retrieve the IP + * addresses.
*/ DirectoryId: string | undefined; /** - *The ListIpRoutes.NextToken value from a previous call to - * ListIpRoutes. Pass null if this is the first call.
+ *The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.
*/ NextToken?: string; /** - *Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
+ *Maximum number of items to return. If this value is zero, the maximum number of items + * is specified by the limitations of the operation.
*/ Limit?: number; } @@ -4098,8 +4258,8 @@ export interface ListIpRoutesResult { IpRoutesInfo?: IpRouteInfo[]; /** - *If not null, more results are available. Pass this value for the NextToken parameter - * in a subsequent call to ListIpRoutes to retrieve the next set of items.
+ *If not null, more results are available. Pass this value for the + * NextToken parameter in a subsequent call to ListIpRoutes to retrieve the next set of items.
*/ NextToken?: string; } @@ -4117,8 +4277,8 @@ export interface ListLogSubscriptionsRequest { /** *If a DirectoryID is provided, lists only the log subscription * associated with that directory. If no DirectoryId is provided, lists all - * log subscriptions associated with your AWS account. If there are no log subscriptions for the - * AWS account or the directory, an empty list will be returned.
+ * log subscriptions associated with your Amazon Web Services account. If there are no log subscriptions for the + * Amazon Web Services account or the directory, an empty list will be returned. */ DirectoryId?: string; @@ -4175,8 +4335,7 @@ export namespace LogSubscription { export interface ListLogSubscriptionsResult { /** - *A list of active LogSubscription objects for calling the AWS - * account.
+ *A list of active LogSubscription objects for calling the Amazon Web Services account.
*/ LogSubscriptions?: LogSubscription[]; @@ -4197,12 +4356,14 @@ export namespace ListLogSubscriptionsResult { export interface ListSchemaExtensionsRequest { /** - *The identifier of the directory from which to retrieve the schema extension information.
+ *The identifier of the directory from which to retrieve the schema extension + * information.
*/ DirectoryId: string | undefined; /** - *The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call.
The ListSchemaExtensions.NextToken value from a previous call to
+ * ListSchemaExtensions. Pass null if this is the first call.
The date and time that the schema extension started being applied to the directory.
+ *The date and time that the schema extension started being applied to the + * directory.
*/ StartDateTime?: Date; @@ -4289,7 +4451,9 @@ export interface ListSchemaExtensionsResult { SchemaExtensionsInfo?: SchemaExtensionInfo[]; /** - *If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListSchemaExtensions to retrieve the next set of items.
If not null, more results are available. Pass this value for the NextToken
+ * parameter in a subsequent call to ListSchemaExtensions to retrieve the next set
+ * of items.
The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -4428,12 +4592,13 @@ export namespace RegisterCertificateResult { */ export interface RegisterEventTopicRequest { /** - *The Directory ID that will publish status messages to the SNS topic.
+ *The Directory ID that will publish status messages to the Amazon SNS topic.
*/ DirectoryId: string | undefined; /** - *The SNS topic name to which the directory will publish status messages. This SNS topic must be in the same region as the specified Directory ID.
+ *The Amazon SNS topic name to which the directory will publish status messages. This Amazon SNS + * topic must be in the same region as the specified Directory ID.
*/ TopicName: string | undefined; } @@ -4496,7 +4661,8 @@ export namespace RejectSharedDirectoryResult { export interface RemoveIpRoutesRequest { /** - *Identifier (ID) of the directory from which you want to remove the IP addresses.
+ *Identifier (ID) of the directory from which you want to remove the IP + * addresses.
*/ DirectoryId: string | undefined; @@ -4586,7 +4752,8 @@ export namespace RemoveTagsFromResourceResult { } /** - *The new password provided by the user does not meet the password complexity requirements defined in your directory.
+ *The new password provided by the user does not meet the password complexity + * requirements defined in your directory.
*/ export interface InvalidPasswordException extends __SmithyException, $MetadataBearer { name: "InvalidPasswordException"; @@ -4597,7 +4764,7 @@ export interface InvalidPasswordException extends __SmithyException, $MetadataBe Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -4613,7 +4780,7 @@ export namespace InvalidPasswordException { export interface ResetUserPasswordRequest { /** - *Identifier of the AWS Managed Microsoft AD or Simple AD directory in which the user + *
Identifier of the Managed Microsoft AD or Simple AD directory in which the user * resides.
*/ DirectoryId: string | undefined; @@ -4662,7 +4829,7 @@ export interface UserDoesNotExistException extends __SmithyException, $MetadataB Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -4721,7 +4888,7 @@ export interface InvalidTargetException extends __SmithyException, $MetadataBear Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -4736,7 +4903,7 @@ export namespace InvalidTargetException { } /** - *Exception encountered while trying to access your AWS organization.
+ *Exception encountered while trying to access your Amazon Web Services organization.
*/ export interface OrganizationsException extends __SmithyException, $MetadataBearer { name: "OrganizationsException"; @@ -4747,7 +4914,7 @@ export interface OrganizationsException extends __SmithyException, $MetadataBear Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -4791,8 +4958,7 @@ export namespace ShareTarget { export interface ShareDirectoryRequest { /** - *Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS - * accounts.
+ *Identifier of the Managed Microsoft AD directory that you want to share with other Amazon Web Services accounts.
*/ DirectoryId: string | undefined; @@ -4811,7 +4977,7 @@ export interface ShareDirectoryRequest { /** *The method used when sharing a directory to determine whether the directory should be
- * shared within your AWS organization (ORGANIZATIONS) or with any AWS account by
+ * shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by
* sending a directory sharing request (HANDSHAKE).
The maximum number of AWS accounts that you can share with this directory has been reached.
+ *The maximum number of Amazon Web Services accounts that you can share with this directory has been + * reached.
*/ export interface ShareLimitExceededException extends __SmithyException, $MetadataBearer { name: "ShareLimitExceededException"; @@ -4856,7 +5023,7 @@ export interface ShareLimitExceededException extends __SmithyException, $Metadat Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -4872,17 +5039,21 @@ export namespace ShareLimitExceededException { export interface StartSchemaExtensionRequest { /** - *The identifier of the directory for which the schema extension will be applied to.
+ *The identifier of the directory for which the schema extension will be applied + * to.
*/ DirectoryId: string | undefined; /** - *If true, creates a snapshot of the directory before applying the schema extension.
+ *If true, creates a snapshot of the directory before applying the schema + * extension.
*/ CreateSnapshotBeforeSchemaExtension: boolean | undefined; /** - *The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \n. See the example request below for more details. The file size can be no larger than 1MB.
+ *The LDIF file represented as a string. To construct the LdifContent string, precede + * each line as it would be formatted in an ldif file with \n. See the example request below for + * more details. The file size can be no larger than 1MB.
*/ LdifContent: string | undefined; @@ -4944,7 +5115,7 @@ export namespace UnshareTarget { export interface UnshareDirectoryRequest { /** - *The identifier of the AWS Managed Microsoft AD directory that you want to stop + *
The identifier of the Managed Microsoft AD directory that you want to stop * sharing.
*/ DirectoryId: string | undefined; @@ -4987,17 +5158,20 @@ export namespace UnshareDirectoryResult { */ export interface UpdateConditionalForwarderRequest { /** - *The directory ID of the AWS directory for which to update the conditional forwarder.
+ *The directory ID of the Amazon Web Services directory for which to update the conditional + * forwarder.
*/ DirectoryId: string | undefined; /** - *The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
+ *The fully qualified domain name (FQDN) of the remote domain with which you will set up + * a trust relationship.
*/ RemoteDomainName: string | undefined; /** - *The updated IP addresses of the remote DNS server associated with the conditional forwarder.
+ *The updated IP addresses of the remote DNS server associated with the conditional + * forwarder.
*/ DnsIpAddrs: string[] | undefined; } @@ -5026,7 +5200,8 @@ export namespace UpdateConditionalForwarderResult { } /** - *The maximum allowed number of domain controllers per directory was exceeded. The default limit per directory is 20 domain controllers.
+ *The maximum allowed number of domain controllers per directory was exceeded. The + * default limit per directory is 20 domain controllers.
*/ export interface DomainControllerLimitExceededException extends __SmithyException, $MetadataBearer { name: "DomainControllerLimitExceededException"; @@ -5037,7 +5212,7 @@ export interface DomainControllerLimitExceededException extends __SmithyExceptio Message?: string; /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; } @@ -5053,7 +5228,8 @@ export namespace DomainControllerLimitExceededException { export interface UpdateNumberOfDomainControllersRequest { /** - *Identifier of the directory to which the domain controllers will be added or removed.
+ *Identifier of the directory to which the domain controllers will be added or + * removed.
*/ DirectoryId: string | undefined; @@ -5088,12 +5264,14 @@ export namespace UpdateNumberOfDomainControllersResult { */ export interface UpdateRadiusRequest { /** - *The identifier of the directory for which to update the RADIUS server information.
+ *The identifier of the directory for which to update the RADIUS server + * information.
*/ DirectoryId: string | undefined; /** - *A RadiusSettings object that contains information about the RADIUS server.
+ *A RadiusSettings object that contains information about the RADIUS + * server.
*/ RadiusSettings: RadiusSettings | undefined; } @@ -5145,7 +5323,7 @@ export namespace UpdateTrustRequest { export interface UpdateTrustResult { /** - *The AWS request identifier.
+ *The Amazon Web Services request identifier.
*/ RequestId?: string; @@ -5165,7 +5343,8 @@ export namespace UpdateTrustResult { } /** - *Initiates the verification of an existing trust relationship between an AWS Managed Microsoft AD directory and an external domain.
+ *Initiates the verification of an existing trust relationship between an Managed Microsoft AD + * directory and an external domain.
*/ export interface VerifyTrustRequest { /** diff --git a/clients/client-directory-service/protocols/Aws_json1_1.ts b/clients/client-directory-service/protocols/Aws_json1_1.ts index b5c177ce7b14..84156dc90a14 100644 --- a/clients/client-directory-service/protocols/Aws_json1_1.ts +++ b/clients/client-directory-service/protocols/Aws_json1_1.ts @@ -47,6 +47,10 @@ import { DescribeCertificateCommandInput, DescribeCertificateCommandOutput, } from "../commands/DescribeCertificateCommand"; +import { + DescribeClientAuthenticationSettingsCommandInput, + DescribeClientAuthenticationSettingsCommandOutput, +} from "../commands/DescribeClientAuthenticationSettingsCommand"; import { DescribeConditionalForwardersCommandInput, DescribeConditionalForwardersCommandOutput, @@ -161,6 +165,7 @@ import { CertificateInUseException, CertificateInfo, CertificateLimitExceededException, + ClientAuthenticationSettingInfo, ClientCertAuthSettings, ClientException, Computer, @@ -199,6 +204,8 @@ import { DeregisterEventTopicResult, DescribeCertificateRequest, DescribeCertificateResult, + DescribeClientAuthenticationSettingsRequest, + DescribeClientAuthenticationSettingsResult, DescribeConditionalForwardersRequest, DescribeConditionalForwardersResult, DescribeDirectoriesRequest, @@ -632,6 +639,19 @@ export const serializeAws_json1_1DescribeCertificateCommand = async ( return buildHttpRpcRequest(context, headers, "/", undefined, body); }; +export const serializeAws_json1_1DescribeClientAuthenticationSettingsCommand = async ( + input: DescribeClientAuthenticationSettingsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "DirectoryService_20150416.DescribeClientAuthenticationSettings", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DescribeClientAuthenticationSettingsRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + export const serializeAws_json1_1DescribeConditionalForwardersCommand = async ( input: DescribeConditionalForwardersCommandInput, context: __SerdeContext @@ -3124,6 +3144,100 @@ const deserializeAws_json1_1DescribeCertificateCommandError = async ( return Promise.reject(Object.assign(new Error(message), response)); }; +export const deserializeAws_json1_1DescribeClientAuthenticationSettingsCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): PromiseCreates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public + *
Creates an ED25519 or 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public * key and displays the private key for you to save to a file. The private key is returned * as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name * already exists, Amazon EC2 returns an error.
- *You can have up to five thousand key pairs per Region.
- *The key pair returned to you is available only in the Region in which you create it. + *
The key pair returned to you is available only in the Amazon Web Services Region in which you create it. * If you prefer, you can create your own key pair using a third-party tool and upload it * to any Region using ImportKeyPair.
- *For more information, see Key Pairs in the + *
You can have up to 5,000 key pairs per Amazon Web Services Region.
+ *For more information, see Amazon EC2 key pairs in the * Amazon Elastic Compute Cloud User Guide.
*/ public createKeyPair( @@ -5348,9 +5348,9 @@ export class EC2 extends EC2Client { *Creates a security group.
*A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. * For more information, see - * Amazon EC2 Security Groups in + * Amazon EC2 security groups in * the Amazon Elastic Compute Cloud User Guide and - * Security Groups for Your VPC in the + * Security groups for your VPC in the * Amazon Virtual Private Cloud User Guide.
*When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
*You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
@@ -10382,7 +10382,7 @@ export class EC2 extends EC2Client { /** *Describes the specified key pairs or all of your key pairs.
- *For more information about key pairs, see Key Pairs + *
For more information about key pairs, see Amazon EC2 key pairs * in the Amazon Elastic Compute Cloud User Guide.
*/ public describeKeyPairs( @@ -11504,9 +11504,9 @@ export class EC2 extends EC2Client { *Describes the specified security groups or all of your security groups.
*A security group is for use with instances either in the EC2-Classic platform * or in a specific VPC. For more information, see - * Amazon EC2 Security Groups in + * Amazon EC2 security groups in * the Amazon Elastic Compute Cloud User Guide and - * Security Groups for Your VPC in the + * Security groups for your VPC in the * Amazon Virtual Private Cloud User Guide.
*/ public describeSecurityGroups( @@ -15221,7 +15221,7 @@ export class EC2 extends EC2Client { *Creates an import instance task using metadata from the specified disk image.
*This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage * instead.
- *This API action is not supported by the AWS Command Line Interface (AWS CLI). For + *
This API action is not supported by the Command Line Interface (CLI). For * information about using the Amazon EC2 CLI, which is deprecated, see * Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.
*For information about the import manifest referenced by this API action, see VM Import Manifest.
@@ -15256,11 +15256,11 @@ export class EC2 extends EC2Client { } /** - *Imports the public key from an RSA key pair that you created with a third-party tool. + *
Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. * Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you * (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. * The private key is never transferred between you and Amazon Web Services.
- *For more information about key pairs, see Key Pairs + *
For more information about key pairs, see Amazon EC2 key pairs * in the Amazon Elastic Compute Cloud User Guide.
*/ public importKeyPair( @@ -15331,7 +15331,7 @@ export class EC2 extends EC2Client { *This API action supports only single-volume VMs. To import multi-volume VMs, use * ImportImage instead. To import a disk to a snapshot, use * ImportSnapshot instead.
- *This API action is not supported by the AWS Command Line Interface (AWS CLI). For + *
This API action is not supported by the Command Line Interface (CLI). For * information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.
*For information about the import manifest referenced by this API action, see VM Import Manifest.
*/ diff --git a/clients/client-ec2/commands/CreateKeyPairCommand.ts b/clients/client-ec2/commands/CreateKeyPairCommand.ts index cb7f54983de6..2b22fa9bb2cc 100644 --- a/clients/client-ec2/commands/CreateKeyPairCommand.ts +++ b/clients/client-ec2/commands/CreateKeyPairCommand.ts @@ -18,15 +18,15 @@ export interface CreateKeyPairCommandInput extends CreateKeyPairRequest {} export interface CreateKeyPairCommandOutput extends KeyPair, __MetadataBearer {} /** - *Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public + *
Creates an ED25519 or 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public * key and displays the private key for you to save to a file. The private key is returned * as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name * already exists, Amazon EC2 returns an error.
- *You can have up to five thousand key pairs per Region.
- *The key pair returned to you is available only in the Region in which you create it. + *
The key pair returned to you is available only in the Amazon Web Services Region in which you create it. * If you prefer, you can create your own key pair using a third-party tool and upload it * to any Region using ImportKeyPair.
- *For more information, see Key Pairs in the + *
You can have up to 5,000 key pairs per Amazon Web Services Region.
+ *For more information, see Amazon EC2 key pairs in the * Amazon Elastic Compute Cloud User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-ec2/commands/CreateSecurityGroupCommand.ts b/clients/client-ec2/commands/CreateSecurityGroupCommand.ts index 3ac7d80eab7f..0b2ae7a0381d 100644 --- a/clients/client-ec2/commands/CreateSecurityGroupCommand.ts +++ b/clients/client-ec2/commands/CreateSecurityGroupCommand.ts @@ -24,9 +24,9 @@ export interface CreateSecurityGroupCommandOutput extends CreateSecurityGroupRes *Creates a security group.
*A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. * For more information, see - * Amazon EC2 Security Groups in + * Amazon EC2 security groups in * the Amazon Elastic Compute Cloud User Guide and - * Security Groups for Your VPC in the + * Security groups for your VPC in the * Amazon Virtual Private Cloud User Guide.
*When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
*You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.
diff --git a/clients/client-ec2/commands/DeleteClientVpnEndpointCommand.ts b/clients/client-ec2/commands/DeleteClientVpnEndpointCommand.ts index ae390626dc6b..f3b1b2d57000 100644 --- a/clients/client-ec2/commands/DeleteClientVpnEndpointCommand.ts +++ b/clients/client-ec2/commands/DeleteClientVpnEndpointCommand.ts @@ -1,6 +1,5 @@ import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DeleteClientVpnEndpointRequest } from "../models/models_1"; -import { DeleteClientVpnEndpointResult } from "../models/models_2"; +import { DeleteClientVpnEndpointRequest, DeleteClientVpnEndpointResult } from "../models/models_2"; import { deserializeAws_ec2DeleteClientVpnEndpointCommand, serializeAws_ec2DeleteClientVpnEndpointCommand, diff --git a/clients/client-ec2/commands/DescribeInstanceEventNotificationAttributesCommand.ts b/clients/client-ec2/commands/DescribeInstanceEventNotificationAttributesCommand.ts index 8052c2e9149f..e4a783cdc4d7 100644 --- a/clients/client-ec2/commands/DescribeInstanceEventNotificationAttributesCommand.ts +++ b/clients/client-ec2/commands/DescribeInstanceEventNotificationAttributesCommand.ts @@ -1,8 +1,6 @@ import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { - DescribeInstanceEventNotificationAttributesRequest, - DescribeInstanceEventNotificationAttributesResult, -} from "../models/models_2"; +import { DescribeInstanceEventNotificationAttributesRequest } from "../models/models_2"; +import { DescribeInstanceEventNotificationAttributesResult } from "../models/models_3"; import { deserializeAws_ec2DescribeInstanceEventNotificationAttributesCommand, serializeAws_ec2DescribeInstanceEventNotificationAttributesCommand, diff --git a/clients/client-ec2/commands/DescribeKeyPairsCommand.ts b/clients/client-ec2/commands/DescribeKeyPairsCommand.ts index 5948bbe2319f..4f336525adcb 100644 --- a/clients/client-ec2/commands/DescribeKeyPairsCommand.ts +++ b/clients/client-ec2/commands/DescribeKeyPairsCommand.ts @@ -22,7 +22,7 @@ export interface DescribeKeyPairsCommandOutput extends DescribeKeyPairsResult, _ /** *Describes the specified key pairs or all of your key pairs.
- *For more information about key pairs, see Key Pairs + *
For more information about key pairs, see Amazon EC2 key pairs * in the Amazon Elastic Compute Cloud User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-ec2/commands/DescribeSecurityGroupsCommand.ts b/clients/client-ec2/commands/DescribeSecurityGroupsCommand.ts index 4d39b0255bbf..fa680e3ff840 100644 --- a/clients/client-ec2/commands/DescribeSecurityGroupsCommand.ts +++ b/clients/client-ec2/commands/DescribeSecurityGroupsCommand.ts @@ -24,9 +24,9 @@ export interface DescribeSecurityGroupsCommandOutput extends DescribeSecurityGro *Describes the specified security groups or all of your security groups.
*A security group is for use with instances either in the EC2-Classic platform * or in a specific VPC. For more information, see - * Amazon EC2 Security Groups in + * Amazon EC2 security groups in * the Amazon Elastic Compute Cloud User Guide and - * Security Groups for Your VPC in the + * Security groups for your VPC in the * Amazon Virtual Private Cloud User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-ec2/commands/DescribeVpcAttributeCommand.ts b/clients/client-ec2/commands/DescribeVpcAttributeCommand.ts index ed5d2db9dcfe..ad6c41314c61 100644 --- a/clients/client-ec2/commands/DescribeVpcAttributeCommand.ts +++ b/clients/client-ec2/commands/DescribeVpcAttributeCommand.ts @@ -1,6 +1,5 @@ import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeVpcAttributeRequest } from "../models/models_3"; -import { DescribeVpcAttributeResult } from "../models/models_4"; +import { DescribeVpcAttributeRequest, DescribeVpcAttributeResult } from "../models/models_4"; import { deserializeAws_ec2DescribeVpcAttributeCommand, serializeAws_ec2DescribeVpcAttributeCommand, diff --git a/clients/client-ec2/commands/ImportInstanceCommand.ts b/clients/client-ec2/commands/ImportInstanceCommand.ts index 6a470c6b6b1b..c7ab2aa12dba 100644 --- a/clients/client-ec2/commands/ImportInstanceCommand.ts +++ b/clients/client-ec2/commands/ImportInstanceCommand.ts @@ -21,7 +21,7 @@ export interface ImportInstanceCommandOutput extends ImportInstanceResult, __Met *Creates an import instance task using metadata from the specified disk image.
*This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage * instead.
- *This API action is not supported by the AWS Command Line Interface (AWS CLI). For + *
This API action is not supported by the Command Line Interface (CLI). For * information about using the Amazon EC2 CLI, which is deprecated, see * Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.
*For information about the import manifest referenced by this API action, see VM Import Manifest.
diff --git a/clients/client-ec2/commands/ImportKeyPairCommand.ts b/clients/client-ec2/commands/ImportKeyPairCommand.ts index 6bb2569958b4..022996646062 100644 --- a/clients/client-ec2/commands/ImportKeyPairCommand.ts +++ b/clients/client-ec2/commands/ImportKeyPairCommand.ts @@ -18,11 +18,11 @@ export interface ImportKeyPairCommandInput extends ImportKeyPairRequest {} export interface ImportKeyPairCommandOutput extends ImportKeyPairResult, __MetadataBearer {} /** - *Imports the public key from an RSA key pair that you created with a third-party tool. + *
Imports the public key from an RSA or ED25519 key pair that you created with a third-party tool. * Compare this with CreateKeyPair, in which Amazon Web Services creates the key pair and gives the keys to you * (Amazon Web Services keeps a copy of the public key). With ImportKeyPair, you create the key pair and give Amazon Web Services just the public key. * The private key is never transferred between you and Amazon Web Services.
- *For more information about key pairs, see Key Pairs + *
For more information about key pairs, see Amazon EC2 key pairs * in the Amazon Elastic Compute Cloud User Guide.
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-ec2/commands/ImportVolumeCommand.ts b/clients/client-ec2/commands/ImportVolumeCommand.ts index a34d448739e5..21c1730c02de 100644 --- a/clients/client-ec2/commands/ImportVolumeCommand.ts +++ b/clients/client-ec2/commands/ImportVolumeCommand.ts @@ -22,7 +22,7 @@ export interface ImportVolumeCommandOutput extends ImportVolumeResult, __Metadat *This API action supports only single-volume VMs. To import multi-volume VMs, use * ImportImage instead. To import a disk to a snapshot, use * ImportSnapshot instead.
- *This API action is not supported by the AWS Command Line Interface (AWS CLI). For + *
This API action is not supported by the Command Line Interface (CLI). For * information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.
*For information about the import manifest referenced by this API action, see VM Import Manifest.
* @example diff --git a/clients/client-ec2/commands/ModifyVpcPeeringConnectionOptionsCommand.ts b/clients/client-ec2/commands/ModifyVpcPeeringConnectionOptionsCommand.ts index 9b5b034ec803..dc991b3aa2d5 100644 --- a/clients/client-ec2/commands/ModifyVpcPeeringConnectionOptionsCommand.ts +++ b/clients/client-ec2/commands/ModifyVpcPeeringConnectionOptionsCommand.ts @@ -1,5 +1,6 @@ import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { ModifyVpcPeeringConnectionOptionsRequest, ModifyVpcPeeringConnectionOptionsResult } from "../models/models_4"; +import { ModifyVpcPeeringConnectionOptionsRequest } from "../models/models_4"; +import { ModifyVpcPeeringConnectionOptionsResult } from "../models/models_5"; import { deserializeAws_ec2ModifyVpcPeeringConnectionOptionsCommand, serializeAws_ec2ModifyVpcPeeringConnectionOptionsCommand, diff --git a/clients/client-ec2/models/models_0.ts b/clients/client-ec2/models/models_0.ts index 8aef5ac48a1d..f679dff43a04 100644 --- a/clients/client-ec2/models/models_0.ts +++ b/clients/client-ec2/models/models_0.ts @@ -8513,8 +8513,7 @@ export interface ExportToS3TaskSpecification { /** *The Amazon S3 bucket for the destination image. The destination bucket must exist and grant
- * WRITE and READ_ACP permissions to the AWS account
- * vm-import-export@amazon.com.
vm-import-export@amazon.com.
*/
S3Bucket?: string;
@@ -8589,8 +8588,7 @@ export interface ExportToS3Task {
/**
* The Amazon S3 bucket for the destination image. The destination bucket must exist and grant
- * WRITE and READ_ACP permissions to the AWS account
- * vm-import-export@amazon.com.
vm-import-export@amazon.com.
*/
S3Bucket?: string;
diff --git a/clients/client-ec2/models/models_1.ts b/clients/client-ec2/models/models_1.ts
index be1781a2fe11..67602aa740d9 100644
--- a/clients/client-ec2/models/models_1.ts
+++ b/clients/client-ec2/models/models_1.ts
@@ -79,6 +79,11 @@ export namespace CreateInternetGatewayResult {
});
}
+export enum KeyType {
+ ed25519 = "ed25519",
+ rsa = "rsa",
+}
+
export interface CreateKeyPairRequest {
/**
* A unique name for the key pair.
@@ -93,6 +98,13 @@ export interface CreateKeyPairRequest { */ DryRun?: boolean; + /** + *The type of key pair. Note that ED25519 keys are not supported for Windows instances, EC2 Instance Connect, and EC2 Serial Console.
+ *Default: rsa
+ *
The tags to apply to the new key pair.
*/ @@ -118,7 +130,7 @@ export interface KeyPair { KeyFingerprint?: string; /** - *An unencrypted PEM encoded RSA private key.
+ *An unencrypted PEM encoded RSA or ED25519 private key.
*/ KeyMaterial?: string; @@ -9663,24 +9675,3 @@ export namespace DeleteCarrierGatewayResult { ...obj, }); } - -export interface DeleteClientVpnEndpointRequest { - /** - *The ID of the Client VPN to be deleted.
- */ - 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.
The ID of the Client VPN to be deleted.
+ */ + 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.
The current state of the Client VPN endpoint.
@@ -8894,8 +8915,7 @@ export interface ImportImageTask { ImportTaskId?: string; /** - *The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create - * the encrypted image.
+ *The identifier for the KMS key that was used to create the encrypted image.
*/ KmsKeyId?: string; @@ -8938,6 +8958,11 @@ export interface ImportImageTask { *The ARNs of the license configurations that are associated with the import image task.
*/ LicenseSpecifications?: ImportImageLicenseConfigurationResponse[]; + + /** + *The usage operation value.
+ */ + UsageOperation?: string; } export namespace ImportImageTask { @@ -9036,8 +9061,7 @@ export interface SnapshotTaskDetail { Format?: string; /** - *The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create - * the encrypted snapshot.
+ *The identifier for the KMS key that was used to create the encrypted snapshot.
*/ KmsKeyId?: string; @@ -9499,19 +9523,3 @@ export namespace DescribeInstanceEventNotificationAttributesRequest { ...obj, }); } - -export interface DescribeInstanceEventNotificationAttributesResult { - /** - *Information about the registered tag keys.
- */ - InstanceTagAttribute?: InstanceTagNotificationAttribute; -} - -export namespace DescribeInstanceEventNotificationAttributesResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribeInstanceEventNotificationAttributesResult): any => ({ - ...obj, - }); -} diff --git a/clients/client-ec2/models/models_3.ts b/clients/client-ec2/models/models_3.ts index ef0575405f6d..71f60c81a64a 100644 --- a/clients/client-ec2/models/models_3.ts +++ b/clients/client-ec2/models/models_3.ts @@ -42,6 +42,7 @@ import { InternetGateway, Ipv4PrefixSpecificationRequest, Ipv6PrefixSpecificationRequest, + KeyType, LaunchTemplate, LaunchTemplateVersion, LocalGatewayRouteTableVpcAssociation, @@ -83,12 +84,29 @@ import { HypervisorType, IdFormat, InstanceBlockDeviceMapping, + InstanceTagNotificationAttribute, PermissionGroup, ProductCode, StateReason, VirtualizationType, } from "./models_2"; +export interface DescribeInstanceEventNotificationAttributesResult { + /** + *Information about the registered tag keys.
+ */ + InstanceTagAttribute?: InstanceTagNotificationAttribute; +} + +export namespace DescribeInstanceEventNotificationAttributesResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeInstanceEventNotificationAttributesResult): any => ({ + ...obj, + }); +} + /** *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.
+ *If you used CreateKeyPair to create the key pair:
+ *For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key. + *
+ *For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which + * is the default for OpenSSH, starting with OpenSSH 6.8.
+ *If you used ImportKeyPair to provide Amazon Web Services the public key:
+ *For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.
+ *For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 + * digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
+ *The type of key pair.
+ */ + KeyType?: KeyType | string; + /** *Any tags applied to the key pair.
*/ @@ -13013,31 +13055,3 @@ export namespace DescribeVolumeStatusResult { } export type VpcAttributeName = "enableDnsHostnames" | "enableDnsSupport"; - -export interface DescribeVpcAttributeRequest { - /** - *The VPC attribute.
- */ - Attribute: VpcAttributeName | string | undefined; - - /** - *The ID of the VPC.
- */ - VpcId: 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 VPC attribute.
+ */ + Attribute: VpcAttributeName | string | undefined; + + /** + *The ID of the VPC.
+ */ + VpcId: 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 VPC.
@@ -3229,7 +3258,7 @@ export interface ExportImageRequest { /** *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.
+ * and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com. */ S3ExportLocation: ExportTaskS3LocationRequest | undefined; @@ -5647,8 +5676,8 @@ export interface ImportImageRequest { DryRun?: boolean; /** - *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
+ *
Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used
+ * unless you specify a non-default KMS key 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 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
+ *
An identifier for the symmetric KMS key to use when creating the
+ * encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this
+ * parameter is not specified, the default KMS key 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:
+ *The KMS key 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.
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key 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 ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key 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.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key 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
+ *
Amazon Web Services 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.
+ *The specified KMS key must exist in the Region that the AMI is being copied to.
+ *Amazon EBS does not support asymmetric KMS keys.
*/ KmsKeyId?: string; /** *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
+ * AWS to replace the source-system license with an Amazon Web Services 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
+ * cloud, such as Amazon Web Services. For more information, see Prerequisites in the
* VM Import/Export User Guide.
The tags to apply to the import image task during creation.
*/ TagSpecifications?: TagSpecification[]; + + /** + *The usage operation value. For more information, see AMI billing information fields in the Amazon Elastic Compute Cloud User Guide.
+ */ + UsageOperation?: string; } export namespace ImportImageRequest { @@ -5762,8 +5796,7 @@ export interface ImportImageResult { ImportTaskId?: string; /** - *The identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key - * (CMK) that was used to create the encrypted AMI.
+ *The identifier for the symmetric KMS key that was used to create the encrypted AMI.
*/ KmsKeyId?: string; @@ -5806,6 +5839,11 @@ export interface ImportImageResult { *Any tags assigned to the import image task.
*/ Tags?: Tag[]; + + /** + *The usage operation value.
+ */ + UsageOperation?: string; } export namespace ImportImageResult { @@ -5903,7 +5941,7 @@ export namespace DiskImage { */ export interface UserData { /** - *The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you + *
The user data. 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.
*/ Data?: string; @@ -6177,36 +6215,36 @@ export interface ImportSnapshotRequest { DryRun?: boolean; /** - *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
+ *
Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is
+ * used unless you specify a non-default KMS key 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
+ *
An identifier for the symmetric KMS key to use when creating the
+ * encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this
+ * parameter is not specified, the default KMS key 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:
+ *The KMS key 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.
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key 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 ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key 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.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key 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
+ *
Amazon Web Services 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.
+ *The specified KMS key must exist in the Region that the snapshot is being copied to.
+ *Amazon EBS does not support asymmetric KMS keys.
*/ KmsKeyId?: string; @@ -9467,24 +9505,3 @@ export namespace PeeringConnectionOptions { ...obj, }); } - -export interface ModifyVpcPeeringConnectionOptionsResult { - /** - *Information about the VPC peering connection options for the accepter VPC.
- */ - AccepterPeeringConnectionOptions?: PeeringConnectionOptions; - - /** - *Information about the VPC peering connection options for the requester VPC.
- */ - RequesterPeeringConnectionOptions?: PeeringConnectionOptions; -} - -export namespace ModifyVpcPeeringConnectionOptionsResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ModifyVpcPeeringConnectionOptionsResult): any => ({ - ...obj, - }); -} diff --git a/clients/client-ec2/models/models_5.ts b/clients/client-ec2/models/models_5.ts index e68c5caa5daf..0b22e6a02e0e 100644 --- a/clients/client-ec2/models/models_5.ts +++ b/clients/client-ec2/models/models_5.ts @@ -63,7 +63,28 @@ import { SpotInstanceRequest, SpotPlacement, } from "./models_3"; -import { CapacityReservationSpecification, Purchase } from "./models_4"; +import { CapacityReservationSpecification, PeeringConnectionOptions, Purchase } from "./models_4"; + +export interface ModifyVpcPeeringConnectionOptionsResult { + /** + *Information about the VPC peering connection options for the accepter VPC.
+ */ + AccepterPeeringConnectionOptions?: PeeringConnectionOptions; + + /** + *Information about the VPC peering connection options for the requester VPC.
+ */ + RequesterPeeringConnectionOptions?: PeeringConnectionOptions; +} + +export namespace ModifyVpcPeeringConnectionOptionsResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyVpcPeeringConnectionOptionsResult): any => ({ + ...obj, + }); +} export type VpcTenancy = "default"; diff --git a/clients/client-ec2/protocols/Aws_ec2.ts b/clients/client-ec2/protocols/Aws_ec2.ts index 728e4b6bccd3..46a811711dcd 100644 --- a/clients/client-ec2/protocols/Aws_ec2.ts +++ b/clients/client-ec2/protocols/Aws_ec2.ts @@ -1887,7 +1887,6 @@ import { CreditSpecificationRequest, DeleteCarrierGatewayRequest, DeleteCarrierGatewayResult, - DeleteClientVpnEndpointRequest, DnsEntry, ElasticGpuSpecification, ElasticGpuSpecificationResponse, @@ -2046,6 +2045,7 @@ import { CoipPool, ConnectionLogResponseOptions, ConversionTask, + DeleteClientVpnEndpointRequest, DeleteClientVpnEndpointResult, DeleteClientVpnRouteRequest, DeleteClientVpnRouteResult, @@ -2237,7 +2237,6 @@ import { DescribeInstanceCreditSpecificationsRequest, DescribeInstanceCreditSpecificationsResult, DescribeInstanceEventNotificationAttributesRequest, - DescribeInstanceEventNotificationAttributesResult, DirectoryServiceAuthentication, DiskImageDescription, DiskImageVolumeDescription, @@ -2313,6 +2312,7 @@ import { ClassicLoadBalancersConfig, CpuOptions, CreateVolumePermission, + DescribeInstanceEventNotificationAttributesResult, DescribeInstanceEventWindowsRequest, DescribeInstanceEventWindowsResult, DescribeInstanceStatusRequest, @@ -2451,7 +2451,6 @@ import { DescribeVolumesModificationsResult, DescribeVolumesRequest, DescribeVolumesResult, - DescribeVpcAttributeRequest, DiskInfo, EbsInfo, EbsOptimizedInfo, @@ -2573,6 +2572,7 @@ import { ClientData, CoipAddressUsage, CreateVolumePermissionModifications, + DescribeVpcAttributeRequest, DescribeVpcAttributeResult, DescribeVpcClassicLinkDnsSupportRequest, DescribeVpcClassicLinkDnsSupportResult, @@ -2823,7 +2823,6 @@ import { ModifyVpcEndpointServicePermissionsRequest, ModifyVpcEndpointServicePermissionsResult, ModifyVpcPeeringConnectionOptionsRequest, - ModifyVpcPeeringConnectionOptionsResult, NetworkInterfaceAttachmentChanges, PeeringConnectionOptions, PeeringConnectionOptionsRequest, @@ -2868,6 +2867,7 @@ import { InstanceStateChange, LaunchTemplateSpecification, LicenseConfigurationRequest, + ModifyVpcPeeringConnectionOptionsResult, ModifyVpcTenancyRequest, ModifyVpcTenancyResult, ModifyVpnConnectionOptionsRequest, @@ -33795,6 +33795,9 @@ const serializeAws_ec2CreateKeyPairRequest = (input: CreateKeyPairRequest, conte if (input.DryRun !== undefined && input.DryRun !== null) { entries["DryRun"] = input.DryRun; } + if (input.KeyType !== undefined && input.KeyType !== null) { + entries["KeyType"] = input.KeyType; + } if (input.TagSpecifications !== undefined && input.TagSpecifications !== null) { const memberEntries = serializeAws_ec2TagSpecificationList(input.TagSpecifications, context); Object.entries(memberEntries).forEach(([key, value]) => { @@ -41960,6 +41963,9 @@ const serializeAws_ec2ImportImageRequest = (input: ImportImageRequest, context: entries[loc] = value; }); } + if (input.UsageOperation !== undefined && input.UsageOperation !== null) { + entries["UsageOperation"] = input.UsageOperation; + } return entries; }; @@ -61115,6 +61121,7 @@ const deserializeAws_ec2ImportImageResult = (output: any, context: __SerdeContex StatusMessage: undefined, LicenseSpecifications: undefined, Tags: undefined, + UsageOperation: undefined, }; if (output["architecture"] !== undefined) { contents.Architecture = __expectString(output["architecture"]); @@ -61176,6 +61183,9 @@ const deserializeAws_ec2ImportImageResult = (output: any, context: __SerdeContex if (output["tagSet"] !== undefined && output["tagSet"]["item"] !== undefined) { contents.Tags = deserializeAws_ec2TagList(__getArrayIfSingleItem(output["tagSet"]["item"]), context); } + if (output["usageOperation"] !== undefined) { + contents.UsageOperation = __expectString(output["usageOperation"]); + } return contents; }; @@ -61196,6 +61206,7 @@ const deserializeAws_ec2ImportImageTask = (output: any, context: __SerdeContext) StatusMessage: undefined, Tags: undefined, LicenseSpecifications: undefined, + UsageOperation: undefined, }; if (output["architecture"] !== undefined) { contents.Architecture = __expectString(output["architecture"]); @@ -61257,6 +61268,9 @@ const deserializeAws_ec2ImportImageTask = (output: any, context: __SerdeContext) context ); } + if (output["usageOperation"] !== undefined) { + contents.UsageOperation = __expectString(output["usageOperation"]); + } return contents; }; @@ -63604,6 +63618,7 @@ const deserializeAws_ec2KeyPairInfo = (output: any, context: __SerdeContext): Ke KeyPairId: undefined, KeyFingerprint: undefined, KeyName: undefined, + KeyType: undefined, Tags: undefined, }; if (output["keyPairId"] !== undefined) { @@ -63615,6 +63630,9 @@ const deserializeAws_ec2KeyPairInfo = (output: any, context: __SerdeContext): Ke if (output["keyName"] !== undefined) { contents.KeyName = __expectString(output["keyName"]); } + if (output["keyType"] !== undefined) { + contents.KeyType = __expectString(output["keyType"]); + } if (output.tagSet === "") { contents.Tags = []; } diff --git a/clients/client-iotsitewise/models/models_0.ts b/clients/client-iotsitewise/models/models_0.ts index 41aacb90a425..f30f75f2d467 100644 --- a/clients/client-iotsitewise/models/models_0.ts +++ b/clients/client-iotsitewise/models/models_0.ts @@ -766,12 +766,12 @@ export interface TumblingWindow { * and1d for interval, IoT SiteWise aggregates data in one of the following ways:
* If you create the metric before or at 6:00 p.m. (UTC), - * you get the first aggregation result at 6 p.m. (UTC) on the day when you create the metric.
+ *If you create the metric before or at 6:00 PM (UTC), + * you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
*If you create the metric after 6:00 p.m. (UTC), - * you get the first aggregation result at 6 p.m. (UTC) the next day.
+ *If you create the metric after 6:00 PM (UTC), + * you get the first aggregation result at 6 PM (UTC) the next day.
*1d for interval, IoT SiteWise aggregates data in one of the following ways:
* If you create the metric before or at 6:00 p.m. (UTC), - * you get the first aggregation result at 6 p.m. (UTC) on the day when you create the metric.
+ *If you create the metric before or at 6:00 PM (UTC), + * you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
*If you create the metric after 6:00 p.m. (UTC), - * you get the first aggregation result at 6 p.m. (UTC) the next day.
+ *If you create the metric after 6:00 PM (UTC), + * you get the first aggregation result at 6 PM (UTC) the next day.
*The 24-hour clock.
*For example, if you specify 00:03:00 for offset
- * and 5m for interval, and you create the metric at 2 p.m. (UTC),
- * you get the first aggregation result at 2:03 p.m. (UTC).
- * You get the second aggregation result at 2:08 p.m. (UTC).
5m for interval, and you create the metric at 2 PM (UTC),
+ * you get the first aggregation result at 2:03 PM (UTC).
+ * You get the second aggregation result at 2:08 PM (UTC).
* The offset time zone.
@@ -803,12 +803,12 @@ export interface TumblingWindow { * and1d for interval, IoT SiteWise aggregates data in one of the following ways:
* If you create the metric before or at 6:00 p.m. (PST), - * you get the first aggregation result at 6 p.m. (PST) on the day when you create the metric.
+ *If you create the metric before or at 6:00 PM (PST), + * you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
*If you create the metric after 6:00 p.m. (PST), - * you get the first aggregation result at 6 p.m. (PST) the next day.
+ *If you create the metric after 6:00 PM (PST), + * you get the first aggregation result at 6 PM (PST) the next day.
*The interpolation type.
- *Valid values: LINEAR_INTERPOLATION
+ *
Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION
*
For the LOCF_INTERPOLATION interpolation, if no data point is found for an interval,
+ * IoT SiteWise returns the same interpolated value calculated for the previous interval
+ * and carries forward this interpolated value until a new data point is found.
For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.
+ * If the LOCF_INTERPOLATION interpolation starts on July 1, 2021, at 9 AM, IoT SiteWise uses the data points from July 1, 2021,
+ * at 9 AM to July 2, 2021, at 9 AM to compute the first interpolated value.
+ * If no data points is found after 9 A.M. on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.
The query interval for the window in seconds. IoT SiteWise computes each interpolated value by using data points + * from the timestamp of each interval minus the window to the timestamp of each interval plus the window. + * If not specified, the window is between the start time minus the interval and the end time plus the interval.
+ *If you specify a value for the intervalWindowInSeconds parameter,
+ * the type parameter must be LINEAR_INTERPOLATION.
If no data point is found during the specified query window, + * IoT SiteWise won't return an interpolated value for the interval. + * This indicates that there's a gap in the ingested data points.
+ *For example, you can get the interpolated temperature values for a wind turbine + * every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, + * at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM - 2 hours) + * to 11 AM (9 AM + 2 hours) on July 2, 2021 to compute the first interpolated value, + * uses the data points from 7 AM (9 AM - 2 hours) to 11 AM (9 AM + 2 hours) on July 3, 2021 + * to compute the second interpolated value, and so on.
+ */ + intervalWindowInSeconds?: number; } export namespace GetInterpolatedAssetPropertyValuesRequest { diff --git a/clients/client-iotsitewise/protocols/Aws_restJson1.ts b/clients/client-iotsitewise/protocols/Aws_restJson1.ts index 6be9c3773af1..70f0df8e4d16 100644 --- a/clients/client-iotsitewise/protocols/Aws_restJson1.ts +++ b/clients/client-iotsitewise/protocols/Aws_restJson1.ts @@ -1554,6 +1554,9 @@ export const serializeAws_restJson1GetInterpolatedAssetPropertyValuesCommand = a ...(input.nextToken !== undefined && { nextToken: input.nextToken }), ...(input.maxResults !== undefined && { maxResults: input.maxResults.toString() }), ...(input.type !== undefined && { type: input.type }), + ...(input.intervalWindowInSeconds !== undefined && { + intervalWindowInSeconds: input.intervalWindowInSeconds.toString(), + }), }; let body: any; let { hostname: resolvedHostname } = await context.endpoint(); diff --git a/clients/client-license-manager/models/models_0.ts b/clients/client-license-manager/models/models_0.ts index 0cce91ca8e9f..e0400b29770c 100644 --- a/clients/client-license-manager/models/models_0.ts +++ b/clients/client-license-manager/models/models_0.ts @@ -532,6 +532,7 @@ export namespace UnsupportedDigitalSignatureMethodException { } export enum CheckoutType { + PERPETUAL = "PERPETUAL", PROVISIONAL = "PROVISIONAL", } diff --git a/clients/client-memorydb/.gitignore b/clients/client-memorydb/.gitignore new file mode 100644 index 000000000000..5f8b6ab5eab2 --- /dev/null +++ b/clients/client-memorydb/.gitignore @@ -0,0 +1,9 @@ +/node_modules/ +/build/ +/coverage/ +/docs/ +/dist/ +*.tsbuildinfo +*.tgz +*.log +package-lock.json diff --git a/clients/client-memorydb/.npmignore b/clients/client-memorydb/.npmignore new file mode 100644 index 000000000000..b7ff81137c4a --- /dev/null +++ b/clients/client-memorydb/.npmignore @@ -0,0 +1,4 @@ +/coverage/ +/docs/ +tsconfig.test.json +*.tsbuildinfo diff --git a/clients/client-memorydb/LICENSE b/clients/client-memorydb/LICENSE new file mode 100644 index 000000000000..f9e0c8672bca --- /dev/null +++ b/clients/client-memorydb/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/clients/client-memorydb/MemoryDB.ts b/clients/client-memorydb/MemoryDB.ts new file mode 100644 index 000000000000..74e728e0e76a --- /dev/null +++ b/clients/client-memorydb/MemoryDB.ts @@ -0,0 +1,1245 @@ +import { MemoryDBClient } from "./MemoryDBClient"; +import { + BatchUpdateClusterCommand, + BatchUpdateClusterCommandInput, + BatchUpdateClusterCommandOutput, +} from "./commands/BatchUpdateClusterCommand"; +import { + CopySnapshotCommand, + CopySnapshotCommandInput, + CopySnapshotCommandOutput, +} from "./commands/CopySnapshotCommand"; +import { CreateACLCommand, CreateACLCommandInput, CreateACLCommandOutput } from "./commands/CreateACLCommand"; +import { + CreateClusterCommand, + CreateClusterCommandInput, + CreateClusterCommandOutput, +} from "./commands/CreateClusterCommand"; +import { + CreateParameterGroupCommand, + CreateParameterGroupCommandInput, + CreateParameterGroupCommandOutput, +} from "./commands/CreateParameterGroupCommand"; +import { + CreateSnapshotCommand, + CreateSnapshotCommandInput, + CreateSnapshotCommandOutput, +} from "./commands/CreateSnapshotCommand"; +import { + CreateSubnetGroupCommand, + CreateSubnetGroupCommandInput, + CreateSubnetGroupCommandOutput, +} from "./commands/CreateSubnetGroupCommand"; +import { CreateUserCommand, CreateUserCommandInput, CreateUserCommandOutput } from "./commands/CreateUserCommand"; +import { DeleteACLCommand, DeleteACLCommandInput, DeleteACLCommandOutput } from "./commands/DeleteACLCommand"; +import { + DeleteClusterCommand, + DeleteClusterCommandInput, + DeleteClusterCommandOutput, +} from "./commands/DeleteClusterCommand"; +import { + DeleteParameterGroupCommand, + DeleteParameterGroupCommandInput, + DeleteParameterGroupCommandOutput, +} from "./commands/DeleteParameterGroupCommand"; +import { + DeleteSnapshotCommand, + DeleteSnapshotCommandInput, + DeleteSnapshotCommandOutput, +} from "./commands/DeleteSnapshotCommand"; +import { + DeleteSubnetGroupCommand, + DeleteSubnetGroupCommandInput, + DeleteSubnetGroupCommandOutput, +} from "./commands/DeleteSubnetGroupCommand"; +import { DeleteUserCommand, DeleteUserCommandInput, DeleteUserCommandOutput } from "./commands/DeleteUserCommand"; +import { + DescribeACLsCommand, + DescribeACLsCommandInput, + DescribeACLsCommandOutput, +} from "./commands/DescribeACLsCommand"; +import { + DescribeClustersCommand, + DescribeClustersCommandInput, + DescribeClustersCommandOutput, +} from "./commands/DescribeClustersCommand"; +import { + DescribeEngineVersionsCommand, + DescribeEngineVersionsCommandInput, + DescribeEngineVersionsCommandOutput, +} from "./commands/DescribeEngineVersionsCommand"; +import { + DescribeEventsCommand, + DescribeEventsCommandInput, + DescribeEventsCommandOutput, +} from "./commands/DescribeEventsCommand"; +import { + DescribeParameterGroupsCommand, + DescribeParameterGroupsCommandInput, + DescribeParameterGroupsCommandOutput, +} from "./commands/DescribeParameterGroupsCommand"; +import { + DescribeParametersCommand, + DescribeParametersCommandInput, + DescribeParametersCommandOutput, +} from "./commands/DescribeParametersCommand"; +import { + DescribeServiceUpdatesCommand, + DescribeServiceUpdatesCommandInput, + DescribeServiceUpdatesCommandOutput, +} from "./commands/DescribeServiceUpdatesCommand"; +import { + DescribeSnapshotsCommand, + DescribeSnapshotsCommandInput, + DescribeSnapshotsCommandOutput, +} from "./commands/DescribeSnapshotsCommand"; +import { + DescribeSubnetGroupsCommand, + DescribeSubnetGroupsCommandInput, + DescribeSubnetGroupsCommandOutput, +} from "./commands/DescribeSubnetGroupsCommand"; +import { + DescribeUsersCommand, + DescribeUsersCommandInput, + DescribeUsersCommandOutput, +} from "./commands/DescribeUsersCommand"; +import { + FailoverShardCommand, + FailoverShardCommandInput, + FailoverShardCommandOutput, +} from "./commands/FailoverShardCommand"; +import { + ListAllowedNodeTypeUpdatesCommand, + ListAllowedNodeTypeUpdatesCommandInput, + ListAllowedNodeTypeUpdatesCommandOutput, +} from "./commands/ListAllowedNodeTypeUpdatesCommand"; +import { ListTagsCommand, ListTagsCommandInput, ListTagsCommandOutput } from "./commands/ListTagsCommand"; +import { + ResetParameterGroupCommand, + ResetParameterGroupCommandInput, + ResetParameterGroupCommandOutput, +} from "./commands/ResetParameterGroupCommand"; +import { TagResourceCommand, TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; +import { + UntagResourceCommand, + UntagResourceCommandInput, + UntagResourceCommandOutput, +} from "./commands/UntagResourceCommand"; +import { UpdateACLCommand, UpdateACLCommandInput, UpdateACLCommandOutput } from "./commands/UpdateACLCommand"; +import { + UpdateClusterCommand, + UpdateClusterCommandInput, + UpdateClusterCommandOutput, +} from "./commands/UpdateClusterCommand"; +import { + UpdateParameterGroupCommand, + UpdateParameterGroupCommandInput, + UpdateParameterGroupCommandOutput, +} from "./commands/UpdateParameterGroupCommand"; +import { + UpdateSubnetGroupCommand, + UpdateSubnetGroupCommandInput, + UpdateSubnetGroupCommandOutput, +} from "./commands/UpdateSubnetGroupCommand"; +import { UpdateUserCommand, UpdateUserCommandInput, UpdateUserCommandOutput } from "./commands/UpdateUserCommand"; +import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; + +/** + *Amazon MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures. + * + * MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.
+ */ +export class MemoryDB extends MemoryDBClient { + /** + *Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.
+ */ + public batchUpdateCluster( + args: BatchUpdateClusterCommandInput, + options?: __HttpHandlerOptions + ): PromiseMakes a copy of an existing snapshot.
+ */ + public copySnapshot( + args: CopySnapshotCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).
+ */ + public createACL(args: CreateACLCommandInput, options?: __HttpHandlerOptions): PromiseCreates a cluster. All nodes in the cluster run the same protocol-compliant engine software.
+ */ + public createCluster( + args: CreateClusterCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For + * more information, see Configuring engine parameters using parameter groups. + * + *
+ */ + public createParameterGroup( + args: CreateParameterGroupCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreates a copy of an entire cluster at a specific moment in time.
+ */ + public createSnapshot( + args: CreateSnapshotCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreates a subnet group. A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment. + * + * When you create a cluster in an Amazon VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. + * For more information, see Subnets and subnet groups.
+ */ + public createSubnetGroup( + args: CreateSubnetGroupCommandInput, + options?: __HttpHandlerOptions + ): PromiseCreates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).
+ */ + public createUser(args: CreateUserCommandInput, options?: __HttpHandlerOptions): PromiseDeletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs).
+ */ + public deleteACL(args: DeleteACLCommandInput, options?: __HttpHandlerOptions): PromiseDeletes a cluster. It also deletes all associated nodes and node endpoints
+ */ + public deleteCluster( + args: DeleteClusterCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes the specified parameter group. You cannot delete a parameter group if it is associated with any clusters. + * You cannot delete the default parameter groups in your account.
+ */ + public deleteParameterGroup( + args: DeleteParameterGroupCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation.
+ */ + public deleteSnapshot( + args: DeleteSnapshotCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.
+ */ + public deleteSubnetGroup( + args: DeleteSubnetGroupCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes a user. The user will be removed from all ACLs and in turn removed from all clusters.
+ */ + public deleteUser(args: DeleteUserCommandInput, options?: __HttpHandlerOptions): PromiseReturns a list of ACLs
+ */ + public describeACLs( + args: DescribeACLsCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
+ */ + public describeClusters( + args: DescribeClustersCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns a list of the available Redis engine versions.
+ */ + public describeEngineVersions( + args: DescribeEngineVersionsCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, or parameter group by providing the name as a parameter. + * + * By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
+ */ + public describeEvents( + args: DescribeEventsCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.
+ */ + public describeParameterGroups( + args: DescribeParameterGroupsCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns the detailed parameter list for a particular parameter group.
+ */ + public describeParameters( + args: DescribeParametersCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns details of the service updates
+ */ + public describeServiceUpdates( + args: DescribeServiceUpdatesCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, + * or just the snapshots associated with a particular cluster.
+ */ + public describeSnapshots( + args: DescribeSnapshotsCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
+ */ + public describeSubnetGroups( + args: DescribeSubnetGroupsCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns a list of users.
+ */ + public describeUsers( + args: DescribeUsersCommandInput, + options?: __HttpHandlerOptions + ): PromiseUsed to failover a shard
+ */ + public failoverShard( + args: FailoverShardCommandInput, + options?: __HttpHandlerOptions + ): PromiseLists all available node types that you can scale to from your cluster's current node type. + * + * When you use the UpdateCluster operation to scale your cluster, the value of the NodeType parameter must be one of the node types returned by this operation.
+ */ + public listAllowedNodeTypeUpdates( + args: ListAllowedNodeTypeUpdatesCommandInput, + options?: __HttpHandlerOptions + ): PromiseLists all tags currently on a named resource. + * + * A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track your MemoryDB resources. + * For more information, see Tagging your MemoryDB resources + *
+ */ + public listTags(args: ListTagsCommandInput, options?: __HttpHandlerOptions): PromiseModifies the parameters of a parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire parameter group, specify the AllParameters and ParameterGroupName parameters.
+ */ + public resetParameterGroup( + args: ResetParameterGroupCommandInput, + options?: __HttpHandlerOptions + ): PromiseA tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your MemoryDB resources. + * + * When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. For more information, see + * + * Resource-level permissions.
+ * + *For example, you can use cost-allocation tags to your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value + * (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories + * (such as cost centers, application names, or owners) to organize your costs across multiple services. + * + * For more information, see Using Cost Allocation Tags.
+ */ + public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): PromiseUse this operation to remove tags on a resource
+ */ + public untagResource( + args: UntagResourceCommandInput, + options?: __HttpHandlerOptions + ): PromiseChanges the list of users that belong to the Access Control List.
+ */ + public updateACL(args: UpdateACLCommandInput, options?: __HttpHandlerOptions): PromiseModifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.
+ */ + public updateCluster( + args: UpdateClusterCommandInput, + options?: __HttpHandlerOptions + ): PromiseUpdates the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
+ */ + public updateParameterGroup( + args: UpdateParameterGroupCommandInput, + options?: __HttpHandlerOptions + ): PromiseUpdates a subnet group. For more information, see Updating a subnet group + *
+ */ + public updateSubnetGroup( + args: UpdateSubnetGroupCommandInput, + options?: __HttpHandlerOptions + ): PromiseChanges user password(s) and/or access string.
+ */ + public updateUser(args: UpdateUserCommandInput, options?: __HttpHandlerOptions): PromiseAmazon MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures. + * + * MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.
+ */ +export class MemoryDBClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + MemoryDBClientResolvedConfig +> { + /** + * The resolved configuration of MemoryDBClient class. This is resolved and normalized from the {@link MemoryDBClientConfig | constructor configuration interface}. + */ + readonly config: MemoryDBClientResolvedConfig; + + constructor(configuration: MemoryDBClientConfig) { + let _config_0 = __getRuntimeConfig(configuration); + let _config_1 = resolveRegionConfig(_config_0); + let _config_2 = resolveEndpointsConfig(_config_1); + let _config_3 = resolveRetryConfig(_config_2); + let _config_4 = resolveHostHeaderConfig(_config_3); + let _config_5 = resolveAwsAuthConfig(_config_4); + let _config_6 = resolveUserAgentConfig(_config_5); + super(_config_6); + this.config = _config_6; + this.middlewareStack.use(getRetryPlugin(this.config)); + this.middlewareStack.use(getContentLengthPlugin(this.config)); + this.middlewareStack.use(getHostHeaderPlugin(this.config)); + this.middlewareStack.use(getLoggerPlugin(this.config)); + this.middlewareStack.use(getAwsAuthPlugin(this.config)); + this.middlewareStack.use(getUserAgentPlugin(this.config)); + } + + /** + * Destroy underlying resources, like sockets. It's usually not necessary to do this. + * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. + * Otherwise, sockets might stay open for quite a long time before the server terminates them. + */ + destroy(): void { + super.destroy(); + } +} diff --git a/clients/client-memorydb/README.md b/clients/client-memorydb/README.md new file mode 100644 index 000000000000..b693d3afdacc --- /dev/null +++ b/clients/client-memorydb/README.md @@ -0,0 +1,205 @@ +# @aws-sdk/client-memorydb + +[](https://www.npmjs.com/package/@aws-sdk/client-memorydb) +[](https://www.npmjs.com/package/@aws-sdk/client-memorydb) + +## Description + +AWS SDK for JavaScript MemoryDB Client for Node.js, Browser and React Native. + +Amazon MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures. + +MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.
+ +## Installing + +To install the this package, simply type add or install @aws-sdk/client-memorydb +using your favorite package manager: + +- `npm install @aws-sdk/client-memorydb` +- `yarn add @aws-sdk/client-memorydb` +- `pnpm add @aws-sdk/client-memorydb` + +## Getting Started + +### Import + +The AWS SDK is modulized by clients and commands. +To send a request, you only need to import the `MemoryDBClient` and +the commands you need, for example `BatchUpdateClusterCommand`: + +```js +// ES5 example +const { MemoryDBClient, BatchUpdateClusterCommand } = require("@aws-sdk/client-memorydb"); +``` + +```ts +// ES6+ example +import { MemoryDBClient, BatchUpdateClusterCommand } from "@aws-sdk/client-memorydb"; +``` + +### Usage + +To send a request, you: + +- Initiate client with configuration (e.g. credentials, region). +- Initiate command with input parameters. +- Call `send` operation on client with command object as input. +- If you are using a custom http handler, you may call `destroy()` to close open connections. + +```js +// a client can be shared by different commands. +const client = new MemoryDBClient({ region: "REGION" }); + +const params = { + /** input parameters */ +}; +const command = new BatchUpdateClusterCommand(params); +``` + +#### Async/await + +We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) +operator to wait for the promise returned by send operation as follows: + +```js +// async/await. +try { + const data = await client.send(command); + // process data. +} catch (error) { + // error handling. +} finally { + // finally. +} +``` + +Async-await is clean, concise, intuitive, easy to debug and has better error handling +as compared to using Promise chains or callbacks. + +#### Promises + +You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining) +to execute send operation. + +```js +client.send(command).then( + (data) => { + // process data. + }, + (error) => { + // error handling. + } +); +``` + +Promises can also be called using `.catch()` and `.finally()` as follows: + +```js +client + .send(command) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }) + .finally(() => { + // finally. + }); +``` + +#### Callbacks + +We do not recommend using callbacks because of [callback hell](http://callbackhell.com/), +but they are supported by the send operation. + +```js +// callbacks. +client.send(command, (err, data) => { + // proccess err and data. +}); +``` + +#### v2 compatible style + +The client can also send requests using v2 compatible style. +However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post +on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/) + +```ts +import * as AWS from "@aws-sdk/client-memorydb"; +const client = new AWS.MemoryDB({ region: "REGION" }); + +// async/await. +try { + const data = await client.batchUpdateCluster(params); + // process data. +} catch (error) { + // error handling. +} + +// Promises. +client + .batchUpdateCluster(params) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }); + +// callbacks. +client.batchUpdateCluster(params, (err, data) => { + // proccess err and data. +}); +``` + +### Troubleshooting + +When the service returns an exception, the error will include the exception information, +as well as response metadata (e.g. request id). + +```js +try { + const data = await client.send(command); + // process data. +} catch (error) { + const { requestId, cfId, extendedRequestId } = error.$metadata; + console.log({ requestId, cfId, extendedRequestId }); + /** + * The keys within exceptions are also parsed. + * You can access them by specifying exception names: + * if (error.name === 'SomeServiceException') { + * const value = error.specialKeyInException; + * } + */ +} +``` + +## Getting Help + +Please use these community resources for getting help. +We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them. + +- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) + or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html). +- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) + on AWS Developer Blog. +- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`. +- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3). +- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). + +To test your universal JavaScript code in Node.js, browser and react-native environments, +visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests). + +## Contributing + +This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-memorydb` package is updated. +To contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients). + +## License + +This SDK is distributed under the +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), +see LICENSE for more information. diff --git a/clients/client-memorydb/commands/BatchUpdateClusterCommand.ts b/clients/client-memorydb/commands/BatchUpdateClusterCommand.ts new file mode 100644 index 000000000000..2b9bf6959926 --- /dev/null +++ b/clients/client-memorydb/commands/BatchUpdateClusterCommand.ts @@ -0,0 +1,94 @@ +import { MemoryDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MemoryDBClient"; +import { BatchUpdateClusterRequest, BatchUpdateClusterResponse } from "../models/models_0"; +import { + deserializeAws_json1_1BatchUpdateClusterCommand, + serializeAws_json1_1BatchUpdateClusterCommand, +} 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 BatchUpdateClusterCommandInput extends BatchUpdateClusterRequest {} +export interface BatchUpdateClusterCommandOutput extends BatchUpdateClusterResponse, __MetadataBearer {} + +/** + *Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, BatchUpdateClusterCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, BatchUpdateClusterCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new BatchUpdateClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link BatchUpdateClusterCommandInput} for command's `input` shape. + * @see {@link BatchUpdateClusterCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class BatchUpdateClusterCommand extends $Command< + BatchUpdateClusterCommandInput, + BatchUpdateClusterCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: BatchUpdateClusterCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackMakes a copy of an existing snapshot.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, CopySnapshotCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, CopySnapshotCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new CopySnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CopySnapshotCommandInput} for command's `input` shape. + * @see {@link CopySnapshotCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class CopySnapshotCommand extends $Command< + CopySnapshotCommandInput, + CopySnapshotCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: CopySnapshotCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, CreateACLCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, CreateACLCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new CreateACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateACLCommandInput} for command's `input` shape. + * @see {@link CreateACLCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class CreateACLCommand extends $Command< + CreateACLCommandInput, + CreateACLCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: CreateACLCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates a cluster. All nodes in the cluster run the same protocol-compliant engine software.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, CreateClusterCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, CreateClusterCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new CreateClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateClusterCommandInput} for command's `input` shape. + * @see {@link CreateClusterCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class CreateClusterCommand extends $Command< + CreateClusterCommandInput, + CreateClusterCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: CreateClusterCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For + * more information, see Configuring engine parameters using parameter groups. + * + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, CreateParameterGroupCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, CreateParameterGroupCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new CreateParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateParameterGroupCommandInput} for command's `input` shape. + * @see {@link CreateParameterGroupCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class CreateParameterGroupCommand extends $Command< + CreateParameterGroupCommandInput, + CreateParameterGroupCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: CreateParameterGroupCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates a copy of an entire cluster at a specific moment in time.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, CreateSnapshotCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, CreateSnapshotCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new CreateSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSnapshotCommandInput} for command's `input` shape. + * @see {@link CreateSnapshotCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class CreateSnapshotCommand extends $Command< + CreateSnapshotCommandInput, + CreateSnapshotCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: CreateSnapshotCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates a subnet group. A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment. + * + * When you create a cluster in an Amazon VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. + * For more information, see Subnets and subnet groups.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, CreateSubnetGroupCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, CreateSubnetGroupCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new CreateSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateSubnetGroupCommandInput} for command's `input` shape. + * @see {@link CreateSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class CreateSubnetGroupCommand extends $Command< + CreateSubnetGroupCommandInput, + CreateSubnetGroupCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: CreateSubnetGroupCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, CreateUserCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, CreateUserCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new CreateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateUserCommandInput} for command's `input` shape. + * @see {@link CreateUserCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class CreateUserCommand extends $Command< + CreateUserCommandInput, + CreateUserCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: CreateUserCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs).
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DeleteACLCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DeleteACLCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DeleteACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteACLCommandInput} for command's `input` shape. + * @see {@link DeleteACLCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DeleteACLCommand extends $Command< + DeleteACLCommandInput, + DeleteACLCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeleteACLCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes a cluster. It also deletes all associated nodes and node endpoints
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DeleteClusterCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DeleteClusterCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DeleteClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteClusterCommandInput} for command's `input` shape. + * @see {@link DeleteClusterCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DeleteClusterCommand extends $Command< + DeleteClusterCommandInput, + DeleteClusterCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeleteClusterCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes the specified parameter group. You cannot delete a parameter group if it is associated with any clusters. + * You cannot delete the default parameter groups in your account.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DeleteParameterGroupCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DeleteParameterGroupCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DeleteParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteParameterGroupCommandInput} for command's `input` shape. + * @see {@link DeleteParameterGroupCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DeleteParameterGroupCommand extends $Command< + DeleteParameterGroupCommandInput, + DeleteParameterGroupCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeleteParameterGroupCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DeleteSnapshotCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DeleteSnapshotCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DeleteSnapshotCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSnapshotCommandInput} for command's `input` shape. + * @see {@link DeleteSnapshotCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DeleteSnapshotCommand extends $Command< + DeleteSnapshotCommandInput, + DeleteSnapshotCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeleteSnapshotCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DeleteSubnetGroupCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DeleteSubnetGroupCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DeleteSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteSubnetGroupCommandInput} for command's `input` shape. + * @see {@link DeleteSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DeleteSubnetGroupCommand extends $Command< + DeleteSubnetGroupCommandInput, + DeleteSubnetGroupCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeleteSubnetGroupCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes a user. The user will be removed from all ACLs and in turn removed from all clusters.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DeleteUserCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DeleteUserCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DeleteUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteUserCommandInput} for command's `input` shape. + * @see {@link DeleteUserCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DeleteUserCommand extends $Command< + DeleteUserCommandInput, + DeleteUserCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeleteUserCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns a list of ACLs
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DescribeACLsCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DescribeACLsCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DescribeACLsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeACLsCommandInput} for command's `input` shape. + * @see {@link DescribeACLsCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DescribeACLsCommand extends $Command< + DescribeACLsCommandInput, + DescribeACLsCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeACLsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DescribeClustersCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DescribeClustersCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DescribeClustersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeClustersCommandInput} for command's `input` shape. + * @see {@link DescribeClustersCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DescribeClustersCommand extends $Command< + DescribeClustersCommandInput, + DescribeClustersCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeClustersCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns a list of the available Redis engine versions.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DescribeEngineVersionsCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DescribeEngineVersionsCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DescribeEngineVersionsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEngineVersionsCommandInput} for command's `input` shape. + * @see {@link DescribeEngineVersionsCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DescribeEngineVersionsCommand extends $Command< + DescribeEngineVersionsCommandInput, + DescribeEngineVersionsCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeEngineVersionsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, or parameter group by providing the name as a parameter. + * + * By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DescribeEventsCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DescribeEventsCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DescribeEventsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeEventsCommandInput} for command's `input` shape. + * @see {@link DescribeEventsCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DescribeEventsCommand extends $Command< + DescribeEventsCommandInput, + DescribeEventsCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeEventsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DescribeParameterGroupsCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DescribeParameterGroupsCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DescribeParameterGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeParameterGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeParameterGroupsCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DescribeParameterGroupsCommand extends $Command< + DescribeParameterGroupsCommandInput, + DescribeParameterGroupsCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeParameterGroupsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns the detailed parameter list for a particular parameter group.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DescribeParametersCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DescribeParametersCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DescribeParametersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeParametersCommandInput} for command's `input` shape. + * @see {@link DescribeParametersCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DescribeParametersCommand extends $Command< + DescribeParametersCommandInput, + DescribeParametersCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeParametersCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns details of the service updates
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DescribeServiceUpdatesCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DescribeServiceUpdatesCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DescribeServiceUpdatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeServiceUpdatesCommandInput} for command's `input` shape. + * @see {@link DescribeServiceUpdatesCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DescribeServiceUpdatesCommand extends $Command< + DescribeServiceUpdatesCommandInput, + DescribeServiceUpdatesCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeServiceUpdatesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, + * or just the snapshots associated with a particular cluster.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DescribeSnapshotsCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DescribeSnapshotsCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DescribeSnapshotsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSnapshotsCommandInput} for command's `input` shape. + * @see {@link DescribeSnapshotsCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DescribeSnapshotsCommand extends $Command< + DescribeSnapshotsCommandInput, + DescribeSnapshotsCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeSnapshotsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DescribeSubnetGroupsCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DescribeSubnetGroupsCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DescribeSubnetGroupsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeSubnetGroupsCommandInput} for command's `input` shape. + * @see {@link DescribeSubnetGroupsCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DescribeSubnetGroupsCommand extends $Command< + DescribeSubnetGroupsCommandInput, + DescribeSubnetGroupsCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeSubnetGroupsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns a list of users.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, DescribeUsersCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, DescribeUsersCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new DescribeUsersCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DescribeUsersCommandInput} for command's `input` shape. + * @see {@link DescribeUsersCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DescribeUsersCommand extends $Command< + DescribeUsersCommandInput, + DescribeUsersCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DescribeUsersCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUsed to failover a shard
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, FailoverShardCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, FailoverShardCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new FailoverShardCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link FailoverShardCommandInput} for command's `input` shape. + * @see {@link FailoverShardCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class FailoverShardCommand extends $Command< + FailoverShardCommandInput, + FailoverShardCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: FailoverShardCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists all available node types that you can scale to from your cluster's current node type. + * + * When you use the UpdateCluster operation to scale your cluster, the value of the NodeType parameter must be one of the node types returned by this operation.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, ListAllowedNodeTypeUpdatesCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, ListAllowedNodeTypeUpdatesCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new ListAllowedNodeTypeUpdatesCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAllowedNodeTypeUpdatesCommandInput} for command's `input` shape. + * @see {@link ListAllowedNodeTypeUpdatesCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class ListAllowedNodeTypeUpdatesCommand extends $Command< + ListAllowedNodeTypeUpdatesCommandInput, + ListAllowedNodeTypeUpdatesCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListAllowedNodeTypeUpdatesCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists all tags currently on a named resource. + * + * A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track your MemoryDB resources. + * For more information, see Tagging your MemoryDB resources + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, ListTagsCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, ListTagsCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new ListTagsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsCommandInput} for command's `input` shape. + * @see {@link ListTagsCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class ListTagsCommand extends $Command< + ListTagsCommandInput, + ListTagsCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListTagsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackModifies the parameters of a parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire parameter group, specify the AllParameters and ParameterGroupName parameters.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, ResetParameterGroupCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, ResetParameterGroupCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new ResetParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ResetParameterGroupCommandInput} for command's `input` shape. + * @see {@link ResetParameterGroupCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class ResetParameterGroupCommand extends $Command< + ResetParameterGroupCommandInput, + ResetParameterGroupCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ResetParameterGroupCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackA tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your MemoryDB resources. + * + * When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. For more information, see + * + * Resource-level permissions.
+ * + *For example, you can use cost-allocation tags to your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value + * (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories + * (such as cost centers, application names, or owners) to organize your costs across multiple services. + * + * For more information, see Using Cost Allocation Tags.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, TagResourceCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, TagResourceCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(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 MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class TagResourceCommand extends $Command< + TagResourceCommandInput, + TagResourceCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: TagResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUse this operation to remove tags on a resource
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, UntagResourceCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, UntagResourceCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(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 MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class UntagResourceCommand extends $Command< + UntagResourceCommandInput, + UntagResourceCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: UntagResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackChanges the list of users that belong to the Access Control List.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, UpdateACLCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, UpdateACLCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new UpdateACLCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateACLCommandInput} for command's `input` shape. + * @see {@link UpdateACLCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class UpdateACLCommand extends $Command< + UpdateACLCommandInput, + UpdateACLCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: UpdateACLCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackModifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, UpdateClusterCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, UpdateClusterCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new UpdateClusterCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateClusterCommandInput} for command's `input` shape. + * @see {@link UpdateClusterCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class UpdateClusterCommand extends $Command< + UpdateClusterCommandInput, + UpdateClusterCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: UpdateClusterCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, UpdateParameterGroupCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, UpdateParameterGroupCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new UpdateParameterGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateParameterGroupCommandInput} for command's `input` shape. + * @see {@link UpdateParameterGroupCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class UpdateParameterGroupCommand extends $Command< + UpdateParameterGroupCommandInput, + UpdateParameterGroupCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: UpdateParameterGroupCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates a subnet group. For more information, see Updating a subnet group + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, UpdateSubnetGroupCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, UpdateSubnetGroupCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new UpdateSubnetGroupCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateSubnetGroupCommandInput} for command's `input` shape. + * @see {@link UpdateSubnetGroupCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class UpdateSubnetGroupCommand extends $Command< + UpdateSubnetGroupCommandInput, + UpdateSubnetGroupCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: UpdateSubnetGroupCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackChanges user password(s) and/or access string.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { MemoryDBClient, UpdateUserCommand } from "@aws-sdk/client-memorydb"; // ES Modules import + * // const { MemoryDBClient, UpdateUserCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import + * const client = new MemoryDBClient(config); + * const command = new UpdateUserCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateUserCommandInput} for command's `input` shape. + * @see {@link UpdateUserCommandOutput} for command's `response` shape. + * @see {@link MemoryDBClientResolvedConfig | config} for command's `input` shape. + * + */ +export class UpdateUserCommand extends $Command< + UpdateUserCommandInput, + UpdateUserCommandOutput, + MemoryDBClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: UpdateUserCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns the updates being applied to the ACL.
+ */ +export interface ACLPendingChanges { + /** + *A list of user names being removed from the ACL
+ */ + UserNamesToRemove?: string[]; + + /** + *A list of users being added to the ACL
+ */ + UserNamesToAdd?: string[]; +} + +export namespace ACLPendingChanges { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ACLPendingChanges): any => ({ + ...obj, + }); +} + +/** + *An Access Control List. You can authenticate users with Access Contol Lists. + * + * ACLs enable you to control cluster access by grouping users. These Access control lists are designed as a way to organize access to clusters.
+ */ +export interface ACL { + /** + *The name of the Access Control List
+ */ + Name?: string; + + /** + *Indicates ACL status. Can be "creating", "active", "modifying", "deleting".
+ */ + Status?: string; + + /** + *The list of user names that belong to the ACL.
+ */ + UserNames?: string[]; + + /** + *The minimum engine version supported for the ACL
+ */ + MinimumEngineVersion?: string; + + /** + *A list of updates being applied to the ACL.
+ */ + PendingChanges?: ACLPendingChanges; + + /** + *A list of clusters associated with the ACL.
+ */ + Clusters?: string[]; + + /** + *The Amazon Resource Name (ARN) of the ACL
+ */ + ARN?: string; +} + +export namespace ACL { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ACL): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface ACLAlreadyExistsFault extends __SmithyException, $MetadataBearer { + name: "ACLAlreadyExistsFault"; + $fault: "client"; + message?: string; +} + +export namespace ACLAlreadyExistsFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ACLAlreadyExistsFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface ACLNotFoundFault extends __SmithyException, $MetadataBearer { + name: "ACLNotFoundFault"; + $fault: "client"; + message?: string; +} + +export namespace ACLNotFoundFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ACLNotFoundFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface ACLQuotaExceededFault extends __SmithyException, $MetadataBearer { + name: "ACLQuotaExceededFault"; + $fault: "client"; + message?: string; +} + +export namespace ACLQuotaExceededFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ACLQuotaExceededFault): any => ({ + ...obj, + }); +} + +/** + *The status of the ACL update
+ */ +export interface ACLsUpdateStatus { + /** + *A list of ACLs pending to be applied.
+ */ + ACLToApply?: string; +} + +export namespace ACLsUpdateStatus { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ACLsUpdateStatus): any => ({ + ...obj, + }); +} + +/** + *A request to apply a service update
+ */ +export interface ServiceUpdateRequest { + /** + *The unique ID of the service update
+ */ + ServiceUpdateNameToApply?: string; +} + +export namespace ServiceUpdateRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ServiceUpdateRequest): any => ({ + ...obj, + }); +} + +export interface BatchUpdateClusterRequest { + /** + *The cluster names to apply the updates.
+ */ + ClusterNames: string[] | undefined; + + /** + *The unique ID of the service update
+ */ + ServiceUpdate?: ServiceUpdateRequest; +} + +export namespace BatchUpdateClusterRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: BatchUpdateClusterRequest): any => ({ + ...obj, + }); +} + +export enum AZStatus { + MultiAZ = "multiaz", + SingleAZ = "singleaz", +} + +/** + *Represents the information required for client programs to connect to the cluster and its nodes.
+ */ +export interface Endpoint { + /** + *The DNS hostname of the node.
+ */ + Address?: string; + + /** + *The port number that the engine is listening on.
+ */ + Port?: number; +} + +export namespace Endpoint { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Endpoint): any => ({ + ...obj, + }); +} + +/** + *Represents the progress of an online resharding operation.
+ */ +export interface SlotMigration { + /** + *The percentage of the slot migration that is complete.
+ */ + ProgressPercentage?: number; +} + +export namespace SlotMigration { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SlotMigration): any => ({ + ...obj, + }); +} + +/** + *The status of the online resharding
+ */ +export interface ReshardingStatus { + /** + *The status of the online resharding slot migration
+ */ + SlotMigration?: SlotMigration; +} + +export namespace ReshardingStatus { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ReshardingStatus): any => ({ + ...obj, + }); +} + +export enum ServiceUpdateStatus { + COMPLETE = "complete", + IN_PROGRESS = "in-progress", + NOT_APPLIED = "available", + SCHEDULED = "scheduled", +} + +/** + *Update action that has yet to be processed for the corresponding apply/stop request
+ */ +export interface PendingModifiedServiceUpdate { + /** + *The unique ID of the service update
+ */ + ServiceUpdateName?: string; + + /** + *The status of the service update
+ */ + Status?: ServiceUpdateStatus | string; +} + +export namespace PendingModifiedServiceUpdate { + /** + * @internal + */ + export const filterSensitiveLog = (obj: PendingModifiedServiceUpdate): any => ({ + ...obj, + }); +} + +/** + *A list of updates being applied to the cluster
+ */ +export interface ClusterPendingUpdates { + /** + *The status of an online resharding operation.
+ */ + Resharding?: ReshardingStatus; + + /** + *A list of ACLs associated with the cluster that are being updated
+ */ + ACLs?: ACLsUpdateStatus; + + /** + *A list of service updates being applied to the cluster
+ */ + ServiceUpdates?: PendingModifiedServiceUpdate[]; +} + +export namespace ClusterPendingUpdates { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ClusterPendingUpdates): any => ({ + ...obj, + }); +} + +/** + *Represents a single security group and its status.
+ */ +export interface SecurityGroupMembership { + /** + *The identifier of the security group.
+ */ + SecurityGroupId?: string; + + /** + *The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.
+ */ + Status?: string; +} + +export namespace SecurityGroupMembership { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SecurityGroupMembership): any => ({ + ...obj, + }); +} + +/** + *Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
+ */ +export interface Node { + /** + *The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.
+ */ + Name?: string; + + /** + *The status of the service update on the node
+ */ + Status?: string; + + /** + *The Availability Zone in which the node resides
+ */ + AvailabilityZone?: string; + + /** + *The date and time when the node was created.
+ */ + CreateTime?: Date; + + /** + *The hostname for connecting to this node.
+ */ + Endpoint?: Endpoint; +} + +export namespace Node { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Node): any => ({ + ...obj, + }); +} + +/** + *Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
+ */ +export interface Shard { + /** + *The name of the shard
+ */ + Name?: string; + + /** + *The current state of this replication group - creating, available, modifying, deleting.
+ */ + Status?: string; + + /** + *The keyspace for this shard.
+ */ + Slots?: string; + + /** + *A list containing information about individual nodes within the shard
+ */ + Nodes?: Node[]; + + /** + *The number of nodes in the shard
+ */ + NumberOfNodes?: number; +} + +export namespace Shard { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Shard): any => ({ + ...obj, + }); +} + +/** + *Contains all of the attributes of a specific cluster.
+ */ +export interface Cluster { + /** + *The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
+ */ + Name?: string; + + /** + *A description of the cluster
+ */ + Description?: string; + + /** + *The status of the cluster. For example, Available, Updating, Creating.
+ */ + Status?: string; + + /** + *A group of settings that are currently being applied.
+ */ + PendingUpdates?: ClusterPendingUpdates; + + /** + *The number of shards in the cluster
+ */ + NumberOfShards?: number; + + /** + *A list of shards that are members of the cluster.
+ */ + Shards?: Shard[]; + + /** + *Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
+ */ + AvailabilityMode?: AZStatus | string; + + /** + *The cluster's configuration endpoint
+ */ + ClusterEndpoint?: Endpoint; + + /** + *The cluster's node type
+ */ + NodeType?: string; + + /** + *The Redis engine version used by the cluster
+ */ + EngineVersion?: string; + + /** + *The Redis engine patch version used by the cluster
+ */ + EnginePatchVersion?: string; + + /** + *The name of the parameter group used by the cluster
+ */ + ParameterGroupName?: string; + + /** + *The status of the parameter group used by the cluster, for example 'active' or 'applying'.
+ */ + ParameterGroupStatus?: string; + + /** + *A list of security groups used by the cluster
+ */ + SecurityGroups?: SecurityGroupMembership[]; + + /** + *The name of the subnet group used by the cluster
+ */ + SubnetGroupName?: string; + + /** + *A flag to indicate if In-transit encryption is enabled
+ */ + TLSEnabled?: boolean; + + /** + *The ID of the KMS key used to encrypt the cluster
+ */ + KmsKeyId?: string; + + /** + *The Amazon Resource Name (ARN) of the cluster.
+ */ + ARN?: string; + + /** + *The Amazon Resource Name (ARN) of the SNS notification topic
+ */ + SnsTopicArn?: string; + + /** + *The SNS topic must be in Active status to receive notifications
+ */ + SnsTopicStatus?: string; + + /** + *The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
+ */ + SnapshotRetentionLimit?: number; + + /** + *Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
+ */ + MaintenanceWindow?: string; + + /** + *The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. + * + * Example: 05:00-09:00 + * + * If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
+ */ + SnapshotWindow?: string; + + /** + *The name of the Access Control List associated with this cluster.
+ */ + ACLName?: string; + + /** + *When set to true, the cluster will automatically receive minor engine version upgrades after launch.
+ */ + AutoMinorVersionUpgrade?: boolean; +} + +export namespace Cluster { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Cluster): any => ({ + ...obj, + }); +} + +/** + *A cluster whose updates have failed
+ */ +export interface UnprocessedCluster { + /** + *The name of the cluster
+ */ + ClusterName?: string; + + /** + *The error type associated with the update failure
+ */ + ErrorType?: string; + + /** + *The error message associated with the update failure
+ */ + ErrorMessage?: string; +} + +export namespace UnprocessedCluster { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UnprocessedCluster): any => ({ + ...obj, + }); +} + +export interface BatchUpdateClusterResponse { + /** + *The list of clusters that have been updated.
+ */ + ProcessedClusters?: Cluster[]; + + /** + *The list of clusters where updates have not been applied.
+ */ + UnprocessedClusters?: UnprocessedCluster[]; +} + +export namespace BatchUpdateClusterResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: BatchUpdateClusterResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface InvalidParameterValueException extends __SmithyException, $MetadataBearer { + name: "InvalidParameterValueException"; + $fault: "client"; + message?: string; +} + +export namespace InvalidParameterValueException { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InvalidParameterValueException): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface ServiceUpdateNotFoundFault extends __SmithyException, $MetadataBearer { + name: "ServiceUpdateNotFoundFault"; + $fault: "client"; + message?: string; +} + +export namespace ServiceUpdateNotFoundFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ServiceUpdateNotFoundFault): any => ({ + ...obj, + }); +} + +/** + *A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. + * When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see + * Tagging your MemoryDB resources + *
+ */ +export interface Tag { + /** + *The key for the tag. May not be null.
+ */ + Key?: string; + + /** + *The tag's value. May be null.
+ */ + Value?: string; +} + +export namespace Tag { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Tag): any => ({ + ...obj, + }); +} + +export interface CopySnapshotRequest { + /** + *The name of an existing snapshot from which to make a copy.
+ */ + SourceSnapshotName: string | undefined; + + /** + *A name for the snapshot copy. MemoryDB does not permit overwriting a snapshot, therefore this name must be unique within its context - MemoryDB or an Amazon S3 bucket if exporting.
+ */ + TargetSnapshotName: string | undefined; + + /** + *The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access. + * + * When using this parameter to export a snapshot, be sure MemoryDB has the needed permissions to this S3 bucket. For more information, see + * + * Step 2: Grant MemoryDB Access to Your Amazon S3 Bucket. + * + *
+ */ + TargetBucket?: string; + + /** + *The ID of the KMS key used to encrypt the target snapshot.
+ */ + KmsKeyId?: string; + + /** + *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
+ */ + Tags?: Tag[]; +} + +export namespace CopySnapshotRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CopySnapshotRequest): any => ({ + ...obj, + }); +} + +/** + *Shard configuration options. Each shard configuration has the following: Slots and ReplicaCount.
+ */ +export interface ShardConfiguration { + /** + *A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.
+ */ + Slots?: string; + + /** + *The number of read replica nodes in this shard.
+ */ + ReplicaCount?: number; +} + +export namespace ShardConfiguration { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ShardConfiguration): any => ({ + ...obj, + }); +} + +/** + *Provides details of a shard in a snapshot
+ */ +export interface ShardDetail { + /** + *The name of the shard
+ */ + Name?: string; + + /** + *The configuration details of the shard
+ */ + Configuration?: ShardConfiguration; + + /** + *The size of the shard's snapshot
+ */ + Size?: string; + + /** + *The date and time that the shard's snapshot was created
+ */ + SnapshotCreationTime?: Date; +} + +export namespace ShardDetail { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ShardDetail): any => ({ + ...obj, + }); +} + +/** + *A list of cluster configuration options.
+ */ +export interface ClusterConfiguration { + /** + *The name of the cluster
+ */ + Name?: string; + + /** + *The description of the cluster configuration
+ */ + Description?: string; + + /** + *The node type used for the cluster
+ */ + NodeType?: string; + + /** + *The Redis engine version used by the cluster
+ */ + EngineVersion?: string; + + /** + *The specified maintenance window for the cluster
+ */ + MaintenanceWindow?: string; + + /** + *The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
+ */ + TopicArn?: string; + + /** + *The port used by the cluster
+ */ + Port?: number; + + /** + *The name of parameter group used by the cluster
+ */ + ParameterGroupName?: string; + + /** + *The name of the subnet group used by the cluster
+ */ + SubnetGroupName?: string; + + /** + *The ID of the VPC the cluster belongs to
+ */ + VpcId?: string; + + /** + *The snapshot retention limit set by the cluster
+ */ + SnapshotRetentionLimit?: number; + + /** + *The snapshot window set by the cluster
+ */ + SnapshotWindow?: string; + + /** + *The number of shards in the cluster
+ */ + NumShards?: number; + + /** + *The list of shards in the cluster
+ */ + Shards?: ShardDetail[]; +} + +export namespace ClusterConfiguration { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ClusterConfiguration): any => ({ + ...obj, + }); +} + +/** + *Represents a copy of an entire cluster as of the time when the snapshot was taken.
+ */ +export interface Snapshot { + /** + *The name of the snapshot
+ */ + Name?: string; + + /** + *The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
+ */ + Status?: string; + + /** + *Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
+ */ + Source?: string; + + /** + *The ID of the KMS key used to encrypt the snapshot.
+ */ + KmsKeyId?: string; + + /** + *The ARN (Amazon Resource Name) of the snapshot.
+ */ + ARN?: string; + + /** + *The configuration of the cluster from which the snapshot was taken
+ */ + ClusterConfiguration?: ClusterConfiguration; +} + +export namespace Snapshot { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Snapshot): any => ({ + ...obj, + }); +} + +export interface CopySnapshotResponse { + /** + *Represents a copy of an entire cluster as of the time when the snapshot was taken.
+ */ + Snapshot?: Snapshot; +} + +export namespace CopySnapshotResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CopySnapshotResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface InvalidParameterCombinationException extends __SmithyException, $MetadataBearer { + name: "InvalidParameterCombinationException"; + $fault: "client"; + message?: string; +} + +export namespace InvalidParameterCombinationException { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InvalidParameterCombinationException): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface InvalidSnapshotStateFault extends __SmithyException, $MetadataBearer { + name: "InvalidSnapshotStateFault"; + $fault: "client"; + message?: string; +} + +export namespace InvalidSnapshotStateFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InvalidSnapshotStateFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface ServiceLinkedRoleNotFoundFault extends __SmithyException, $MetadataBearer { + name: "ServiceLinkedRoleNotFoundFault"; + $fault: "client"; + message?: string; +} + +export namespace ServiceLinkedRoleNotFoundFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ServiceLinkedRoleNotFoundFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface SnapshotAlreadyExistsFault extends __SmithyException, $MetadataBearer { + name: "SnapshotAlreadyExistsFault"; + $fault: "client"; + message?: string; +} + +export namespace SnapshotAlreadyExistsFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SnapshotAlreadyExistsFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface SnapshotNotFoundFault extends __SmithyException, $MetadataBearer { + name: "SnapshotNotFoundFault"; + $fault: "client"; + message?: string; +} + +export namespace SnapshotNotFoundFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SnapshotNotFoundFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface SnapshotQuotaExceededFault extends __SmithyException, $MetadataBearer { + name: "SnapshotQuotaExceededFault"; + $fault: "client"; + message?: string; +} + +export namespace SnapshotQuotaExceededFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SnapshotQuotaExceededFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface TagQuotaPerResourceExceeded extends __SmithyException, $MetadataBearer { + name: "TagQuotaPerResourceExceeded"; + $fault: "client"; + message?: string; +} + +export namespace TagQuotaPerResourceExceeded { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TagQuotaPerResourceExceeded): any => ({ + ...obj, + }); +} + +export interface CreateACLRequest { + /** + *The name of the Access Control List.
+ */ + ACLName: string | undefined; + + /** + *The list of users that belong to the Access Control List.
+ */ + UserNames?: string[]; + + /** + *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
+ */ + Tags?: Tag[]; +} + +export namespace CreateACLRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateACLRequest): any => ({ + ...obj, + }); +} + +export interface CreateACLResponse { + /** + *The newly-created Access Control List.
+ */ + ACL?: ACL; +} + +export namespace CreateACLResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateACLResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface DefaultUserRequired extends __SmithyException, $MetadataBearer { + name: "DefaultUserRequired"; + $fault: "client"; + message?: string; +} + +export namespace DefaultUserRequired { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DefaultUserRequired): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface DuplicateUserNameFault extends __SmithyException, $MetadataBearer { + name: "DuplicateUserNameFault"; + $fault: "client"; + message?: string; +} + +export namespace DuplicateUserNameFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DuplicateUserNameFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface UserNotFoundFault extends __SmithyException, $MetadataBearer { + name: "UserNotFoundFault"; + $fault: "client"; + message?: string; +} + +export namespace UserNotFoundFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UserNotFoundFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface ClusterAlreadyExistsFault extends __SmithyException, $MetadataBearer { + name: "ClusterAlreadyExistsFault"; + $fault: "client"; + message?: string; +} + +export namespace ClusterAlreadyExistsFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ClusterAlreadyExistsFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface ClusterQuotaForCustomerExceededFault extends __SmithyException, $MetadataBearer { + name: "ClusterQuotaForCustomerExceededFault"; + $fault: "client"; + message?: string; +} + +export namespace ClusterQuotaForCustomerExceededFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ClusterQuotaForCustomerExceededFault): any => ({ + ...obj, + }); +} + +export interface CreateClusterRequest { + /** + *The name of the cluster. This value must be unique as it also serves as the cluster identifier.
+ */ + ClusterName: string | undefined; + + /** + *The compute and memory capacity of the nodes in the cluster.
+ */ + NodeType: string | undefined; + + /** + *The name of the parameter group associated with the cluster.
+ */ + ParameterGroupName?: string; + + /** + *An optional description of the cluster.
+ */ + Description?: string; + + /** + *The number of shards the cluster will contain.
+ *Clusters can have up to 500 shards, with your data partitioned across the shards. For example, you can choose to configure a 500 node cluster that ranges between + * 83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. + * Common pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters.
+ */ + NumShards?: number; + + /** + *The number of replicas to apply to each shard. The limit is 5.
+ */ + NumReplicasPerShard?: number; + + /** + *The name of the subnet group to be used for the cluster.
+ */ + SubnetGroupName?: string; + + /** + *A list of security group names to associate with this cluster.
+ */ + SecurityGroupIds?: string[]; + + /** + *Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
The port number on which each of the nodes accepts connections.
+ */ + Port?: number; + + /** + *The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
+ */ + SnsTopicArn?: string; + + /** + *A flag to enable in-transit encryption on the cluster.
+ */ + TLSEnabled?: boolean; + + /** + *The ID of the KMS key used to encrypt the cluster.
+ */ + KmsKeyId?: string; + + /** + *A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.
+ */ + SnapshotArns?: string[]; + + /** + *The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.
+ */ + SnapshotName?: string; + + /** + *The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
+ */ + SnapshotRetentionLimit?: number; + + /** + *A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.
+ */ + Tags?: Tag[]; + + /** + *The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
+ * + *Example: 05:00-09:00
+ * + *If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
+ */ + SnapshotWindow?: string; + + /** + *The name of the Access Control List to associate with the cluster.
+ */ + ACLName: string | undefined; + + /** + *The version number of the Redis engine to be used for the cluster.
+ */ + EngineVersion?: string; + + /** + *When set to true, the cluster will automatically receive minor engine version upgrades after launch.
+ */ + AutoMinorVersionUpgrade?: boolean; +} + +export namespace CreateClusterRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateClusterRequest): any => ({ + ...obj, + }); +} + +export interface CreateClusterResponse { + /** + *The newly-created cluster.
+ */ + Cluster?: Cluster; +} + +export namespace CreateClusterResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateClusterResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface InsufficientClusterCapacityFault extends __SmithyException, $MetadataBearer { + name: "InsufficientClusterCapacityFault"; + $fault: "client"; + message?: string; +} + +export namespace InsufficientClusterCapacityFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InsufficientClusterCapacityFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface InvalidACLStateFault extends __SmithyException, $MetadataBearer { + name: "InvalidACLStateFault"; + $fault: "client"; + message?: string; +} + +export namespace InvalidACLStateFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InvalidACLStateFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface InvalidCredentialsException extends __SmithyException, $MetadataBearer { + name: "InvalidCredentialsException"; + $fault: "client"; + message?: string; +} + +export namespace InvalidCredentialsException { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InvalidCredentialsException): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface InvalidVPCNetworkStateFault extends __SmithyException, $MetadataBearer { + name: "InvalidVPCNetworkStateFault"; + $fault: "client"; + message?: string; +} + +export namespace InvalidVPCNetworkStateFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InvalidVPCNetworkStateFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface NodeQuotaForClusterExceededFault extends __SmithyException, $MetadataBearer { + name: "NodeQuotaForClusterExceededFault"; + $fault: "client"; + message?: string; +} + +export namespace NodeQuotaForClusterExceededFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: NodeQuotaForClusterExceededFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface NodeQuotaForCustomerExceededFault extends __SmithyException, $MetadataBearer { + name: "NodeQuotaForCustomerExceededFault"; + $fault: "client"; + message?: string; +} + +export namespace NodeQuotaForCustomerExceededFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: NodeQuotaForCustomerExceededFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface ParameterGroupNotFoundFault extends __SmithyException, $MetadataBearer { + name: "ParameterGroupNotFoundFault"; + $fault: "client"; + message?: string; +} + +export namespace ParameterGroupNotFoundFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ParameterGroupNotFoundFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface ShardsPerClusterQuotaExceededFault extends __SmithyException, $MetadataBearer { + name: "ShardsPerClusterQuotaExceededFault"; + $fault: "client"; + message?: string; +} + +export namespace ShardsPerClusterQuotaExceededFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ShardsPerClusterQuotaExceededFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface SubnetGroupNotFoundFault extends __SmithyException, $MetadataBearer { + name: "SubnetGroupNotFoundFault"; + $fault: "client"; + message?: string; +} + +export namespace SubnetGroupNotFoundFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SubnetGroupNotFoundFault): any => ({ + ...obj, + }); +} + +export interface CreateParameterGroupRequest { + /** + *The name of the parameter group.
+ */ + ParameterGroupName: string | undefined; + + /** + *The name of the parameter group family that the parameter group can be used with.
+ */ + Family: string | undefined; + + /** + *An optional description of the parameter group.
+ */ + Description?: string; + + /** + *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
+ */ + Tags?: Tag[]; +} + +export namespace CreateParameterGroupRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateParameterGroupRequest): any => ({ + ...obj, + }); +} + +/** + *Represents the output of a CreateParameterGroup operation. A parameter group represents a combination of specific values for the parameters that are passed to the engine software during startup.
+ */ +export interface ParameterGroup { + /** + *The name of the parameter group
+ */ + Name?: string; + + /** + *The name of the parameter group family that this parameter group is compatible with.
+ */ + Family?: string; + + /** + *A description of the parameter group
+ */ + Description?: string; + + /** + *The Amazon Resource Name (ARN) of the parameter group
+ */ + ARN?: string; +} + +export namespace ParameterGroup { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ParameterGroup): any => ({ + ...obj, + }); +} + +export interface CreateParameterGroupResponse { + /** + *The newly-created parameter group.
+ */ + ParameterGroup?: ParameterGroup; +} + +export namespace CreateParameterGroupResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateParameterGroupResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface InvalidParameterGroupStateFault extends __SmithyException, $MetadataBearer { + name: "InvalidParameterGroupStateFault"; + $fault: "client"; + message?: string; +} + +export namespace InvalidParameterGroupStateFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InvalidParameterGroupStateFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface ParameterGroupAlreadyExistsFault extends __SmithyException, $MetadataBearer { + name: "ParameterGroupAlreadyExistsFault"; + $fault: "client"; + message?: string; +} + +export namespace ParameterGroupAlreadyExistsFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ParameterGroupAlreadyExistsFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface ParameterGroupQuotaExceededFault extends __SmithyException, $MetadataBearer { + name: "ParameterGroupQuotaExceededFault"; + $fault: "client"; + message?: string; +} + +export namespace ParameterGroupQuotaExceededFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ParameterGroupQuotaExceededFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface ClusterNotFoundFault extends __SmithyException, $MetadataBearer { + name: "ClusterNotFoundFault"; + $fault: "client"; + message?: string; +} + +export namespace ClusterNotFoundFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ClusterNotFoundFault): any => ({ + ...obj, + }); +} + +export interface CreateSnapshotRequest { + /** + *The snapshot is created from this cluster.
+ */ + ClusterName: string | undefined; + + /** + *A name for the snapshot being created.
+ */ + SnapshotName: string | undefined; + + /** + *The ID of the KMS key used to encrypt the snapshot.
+ */ + KmsKeyId?: string; + + /** + *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
+ */ + Tags?: Tag[]; +} + +export namespace CreateSnapshotRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateSnapshotRequest): any => ({ + ...obj, + }); +} + +export interface CreateSnapshotResponse { + /** + *The newly-created snapshot.
+ */ + Snapshot?: Snapshot; +} + +export namespace CreateSnapshotResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateSnapshotResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface InvalidClusterStateFault extends __SmithyException, $MetadataBearer { + name: "InvalidClusterStateFault"; + $fault: "client"; + message?: string; +} + +export namespace InvalidClusterStateFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InvalidClusterStateFault): any => ({ + ...obj, + }); +} + +export interface CreateSubnetGroupRequest { + /** + *The name of the subnet group.
+ */ + SubnetGroupName: string | undefined; + + /** + *A description for the subnet group.
+ */ + Description?: string; + + /** + *A list of VPC subnet IDs for the subnet group.
+ */ + SubnetIds: string[] | undefined; + + /** + *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
+ */ + Tags?: Tag[]; +} + +export namespace CreateSubnetGroupRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateSubnetGroupRequest): any => ({ + ...obj, + }); +} + +/** + *Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
+ */ +export interface AvailabilityZone { + /** + *The name of the Availability Zone.
+ */ + Name?: string; +} + +export namespace AvailabilityZone { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AvailabilityZone): any => ({ + ...obj, + }); +} + +/** + *Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.
+ */ +export interface Subnet { + /** + *The unique identifier for the subnet.
+ */ + Identifier?: string; + + /** + *The Availability Zone where the subnet resides
+ */ + AvailabilityZone?: AvailabilityZone; +} + +export namespace Subnet { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Subnet): any => ({ + ...obj, + }); +} + +/** + *Represents the output of one of the following operations:
+ *CreateSubnetGroup
+ *UpdateSubnetGroup
+ *A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment.
+ */ +export interface SubnetGroup { + /** + *The name of the subnet group
+ */ + Name?: string; + + /** + *A description of the subnet group
+ */ + Description?: string; + + /** + *The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.
+ */ + VpcId?: string; + + /** + *A list of subnets associated with the subnet group.
+ */ + Subnets?: Subnet[]; + + /** + *The ARN (Amazon Resource Name) of the subnet group.
+ */ + ARN?: string; +} + +export namespace SubnetGroup { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SubnetGroup): any => ({ + ...obj, + }); +} + +export interface CreateSubnetGroupResponse { + /** + *The newly-created subnet group
+ */ + SubnetGroup?: SubnetGroup; +} + +export namespace CreateSubnetGroupResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateSubnetGroupResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface InvalidSubnet extends __SmithyException, $MetadataBearer { + name: "InvalidSubnet"; + $fault: "client"; + message?: string; +} + +export namespace InvalidSubnet { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InvalidSubnet): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface SubnetGroupAlreadyExistsFault extends __SmithyException, $MetadataBearer { + name: "SubnetGroupAlreadyExistsFault"; + $fault: "client"; + message?: string; +} + +export namespace SubnetGroupAlreadyExistsFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SubnetGroupAlreadyExistsFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface SubnetGroupQuotaExceededFault extends __SmithyException, $MetadataBearer { + name: "SubnetGroupQuotaExceededFault"; + $fault: "client"; + message?: string; +} + +export namespace SubnetGroupQuotaExceededFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SubnetGroupQuotaExceededFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface SubnetNotAllowedFault extends __SmithyException, $MetadataBearer { + name: "SubnetNotAllowedFault"; + $fault: "client"; + message?: string; +} + +export namespace SubnetNotAllowedFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SubnetNotAllowedFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface SubnetQuotaExceededFault extends __SmithyException, $MetadataBearer { + name: "SubnetQuotaExceededFault"; + $fault: "client"; + message?: string; +} + +export namespace SubnetQuotaExceededFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SubnetQuotaExceededFault): any => ({ + ...obj, + }); +} + +export enum InputAuthenticationType { + PASSWORD = "password", +} + +/** + *Denotes the user's authentication properties, such as whether it requires a password to authenticate. Used in output responses.
+ */ +export interface AuthenticationMode { + /** + *Indicates whether the user requires a password to authenticate. All newly-created users require a password.
+ */ + Type?: InputAuthenticationType | string; + + /** + *The password(s) used for authentication
+ */ + Passwords?: string[]; +} + +export namespace AuthenticationMode { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AuthenticationMode): any => ({ + ...obj, + }); +} + +export interface CreateUserRequest { + /** + *The name of the user. This value must be unique as it also serves as the user identifier.
+ */ + UserName: string | undefined; + + /** + *Denotes the user's authentication properties, such as whether it requires a password to authenticate.
+ */ + AuthenticationMode: AuthenticationMode | undefined; + + /** + *Access permissions string used for this user.
+ */ + AccessString: string | undefined; + + /** + *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
+ */ + Tags?: Tag[]; +} + +export namespace CreateUserRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateUserRequest): any => ({ + ...obj, + }); +} + +export enum AuthenticationType { + NO_PASSWORD = "no-password", + PASSWORD = "password", +} + +/** + *Denotes the user's authentication properties, such as whether it requires a password to authenticate. Used in output responses.
+ */ +export interface Authentication { + /** + *Indicates whether the user requires a password to authenticate.
+ */ + Type?: AuthenticationType | string; + + /** + *The number of passwords belonging to the user. The maximum is two.
+ */ + PasswordCount?: number; +} + +export namespace Authentication { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Authentication): any => ({ + ...obj, + }); +} + +/** + *You create users and assign them specific permissions by using an access string. You assign the users to Access Control Lists aligned with a specific role (administrators, human resources) that are then deployed to one or more MemoryDB clusters.
+ */ +export interface User { + /** + *The name of the user
+ */ + Name?: string; + + /** + *Indicates the user status. Can be "active", "modifying" or "deleting".
+ */ + Status?: string; + + /** + *Access permissions string used for this user.
+ */ + AccessString?: string; + + /** + *The names of the Access Control Lists to which the user belongs
+ */ + ACLNames?: string[]; + + /** + *The minimum engine version supported for the user
+ */ + MinimumEngineVersion?: string; + + /** + *Denotes whether the user requires a password to authenticate.
+ */ + Authentication?: Authentication; + + /** + *The Amazon Resource Name (ARN) of the user. + * + *
+ */ + ARN?: string; +} + +export namespace User { + /** + * @internal + */ + export const filterSensitiveLog = (obj: User): any => ({ + ...obj, + }); +} + +export interface CreateUserResponse { + /** + *The newly-created user.
+ */ + User?: User; +} + +export namespace CreateUserResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateUserResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface UserAlreadyExistsFault extends __SmithyException, $MetadataBearer { + name: "UserAlreadyExistsFault"; + $fault: "client"; + message?: string; +} + +export namespace UserAlreadyExistsFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UserAlreadyExistsFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface UserQuotaExceededFault extends __SmithyException, $MetadataBearer { + name: "UserQuotaExceededFault"; + $fault: "client"; + message?: string; +} + +export namespace UserQuotaExceededFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UserQuotaExceededFault): any => ({ + ...obj, + }); +} + +export interface DeleteACLRequest { + /** + *The name of the Access Control List to delete
+ */ + ACLName: string | undefined; +} + +export namespace DeleteACLRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteACLRequest): any => ({ + ...obj, + }); +} + +export interface DeleteACLResponse { + /** + *The Access Control List object that has been deleted.
+ */ + ACL?: ACL; +} + +export namespace DeleteACLResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteACLResponse): any => ({ + ...obj, + }); +} + +export interface DeleteClusterRequest { + /** + *The name of the cluster to be deleted
+ */ + ClusterName: string | undefined; + + /** + *The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
+ */ + FinalSnapshotName?: string; +} + +export namespace DeleteClusterRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteClusterRequest): any => ({ + ...obj, + }); +} + +export interface DeleteClusterResponse { + /** + *The cluster object that has been deleted
+ */ + Cluster?: Cluster; +} + +export namespace DeleteClusterResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteClusterResponse): any => ({ + ...obj, + }); +} + +export interface DeleteParameterGroupRequest { + /** + *The name of the parameter group to delete.
+ */ + ParameterGroupName: string | undefined; +} + +export namespace DeleteParameterGroupRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteParameterGroupRequest): any => ({ + ...obj, + }); +} + +export interface DeleteParameterGroupResponse { + /** + *The parameter group that has been deleted.
+ */ + ParameterGroup?: ParameterGroup; +} + +export namespace DeleteParameterGroupResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteParameterGroupResponse): any => ({ + ...obj, + }); +} + +export interface DeleteSnapshotRequest { + /** + *The name of the snapshot to delete
+ */ + SnapshotName: string | undefined; +} + +export namespace DeleteSnapshotRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteSnapshotRequest): any => ({ + ...obj, + }); +} + +export interface DeleteSnapshotResponse { + /** + *The snapshot object that has been deleted.
+ */ + Snapshot?: Snapshot; +} + +export namespace DeleteSnapshotResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteSnapshotResponse): any => ({ + ...obj, + }); +} + +export interface DeleteSubnetGroupRequest { + /** + *The name of the subnet group to delete
+ */ + SubnetGroupName: string | undefined; +} + +export namespace DeleteSubnetGroupRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteSubnetGroupRequest): any => ({ + ...obj, + }); +} + +export interface DeleteSubnetGroupResponse { + /** + *The subnet group object that has been deleted.
+ */ + SubnetGroup?: SubnetGroup; +} + +export namespace DeleteSubnetGroupResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteSubnetGroupResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface SubnetGroupInUseFault extends __SmithyException, $MetadataBearer { + name: "SubnetGroupInUseFault"; + $fault: "client"; + message?: string; +} + +export namespace SubnetGroupInUseFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SubnetGroupInUseFault): any => ({ + ...obj, + }); +} + +export interface DeleteUserRequest { + /** + *The name of the user to delete
+ */ + UserName: string | undefined; +} + +export namespace DeleteUserRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteUserRequest): any => ({ + ...obj, + }); +} + +export interface DeleteUserResponse { + /** + *The user object that has been deleted.
+ */ + User?: User; +} + +export namespace DeleteUserResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteUserResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface InvalidUserStateFault extends __SmithyException, $MetadataBearer { + name: "InvalidUserStateFault"; + $fault: "client"; + message?: string; +} + +export namespace InvalidUserStateFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InvalidUserStateFault): any => ({ + ...obj, + }); +} + +export interface DescribeACLsRequest { + /** + *The name of the ACL
+ */ + ACLName?: string; + + /** + *The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
+ */ + MaxResults?: number; + + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; +} + +export namespace DescribeACLsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeACLsRequest): any => ({ + ...obj, + }); +} + +export interface DescribeACLsResponse { + /** + *The list of ACLs
+ */ + ACLs?: ACL[]; + + /** + *If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; +} + +export namespace DescribeACLsResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeACLsResponse): any => ({ + ...obj, + }); +} + +export interface DescribeClustersRequest { + /** + *The name of the cluster
+ */ + ClusterName?: string; + + /** + *The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
+ */ + MaxResults?: number; + + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; + + /** + *An optional flag that can be included in the request to retrieve information about the individual shard(s).
+ */ + ShowShardDetails?: boolean; +} + +export namespace DescribeClustersRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeClustersRequest): any => ({ + ...obj, + }); +} + +export interface DescribeClustersResponse { + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; + + /** + *A list of clusters
+ */ + Clusters?: Cluster[]; +} + +export namespace DescribeClustersResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeClustersResponse): any => ({ + ...obj, + }); +} + +export interface DescribeEngineVersionsRequest { + /** + *The Redis engine version
+ */ + EngineVersion?: string; + + /** + *The name of a specific parameter group family to return details for.
+ */ + ParameterGroupFamily?: string; + + /** + *The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
+ */ + MaxResults?: number; + + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; + + /** + *If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.
+ */ + DefaultOnly?: boolean; +} + +export namespace DescribeEngineVersionsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeEngineVersionsRequest): any => ({ + ...obj, + }); +} + +/** + *Provides details of the Redis engine version
+ */ +export interface EngineVersionInfo { + /** + *The engine version
+ */ + EngineVersion?: string; + + /** + *The patched engine version
+ */ + EnginePatchVersion?: string; + + /** + *Specifies the name of the parameter group family to which the engine default parameters apply.
+ */ + ParameterGroupFamily?: string; +} + +export namespace EngineVersionInfo { + /** + * @internal + */ + export const filterSensitiveLog = (obj: EngineVersionInfo): any => ({ + ...obj, + }); +} + +export interface DescribeEngineVersionsResponse { + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; + + /** + *A list of engine version details. Each element in the list contains detailed information about one engine version.
+ */ + EngineVersions?: EngineVersionInfo[]; +} + +export namespace DescribeEngineVersionsResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeEngineVersionsResponse): any => ({ + ...obj, + }); +} + +export enum SourceType { + acl = "acl", + cluster = "cluster", + node = "node", + parameter_group = "parameter-group", + subnet_group = "subnet-group", + user = "user", +} + +export interface DescribeEventsRequest { + /** + *The identifier of the event source for which events are returned. If not specified, all sources are included in the response.
+ */ + SourceName?: string; + + /** + *The event source to retrieve events for. If no value is specified, all events are returned.
+ */ + SourceType?: SourceType | string; + + /** + *The beginning of the time interval to retrieve events for, specified in ISO 8601 format. + * + * Example: 2017-03-30T07:03:49.555Z
+ */ + StartTime?: Date; + + /** + *The end of the time interval for which to retrieve events, specified in ISO 8601 format. + * + * Example: 2017-03-30T07:03:49.555Z
+ */ + EndTime?: Date; + + /** + *The number of minutes worth of events to retrieve.
+ */ + Duration?: number; + + /** + *The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
+ */ + MaxResults?: number; + + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; +} + +export namespace DescribeEventsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeEventsRequest): any => ({ + ...obj, + }); +} + +/** + *Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a + * node.
+ */ +export interface Event { + /** + *The name for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.
+ */ + SourceName?: string; + + /** + *Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
+ */ + SourceType?: SourceType | string; + + /** + *The text of the event.
+ */ + Message?: string; + + /** + *The date and time when the event occurred.
+ */ + Date?: Date; +} + +export namespace Event { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Event): any => ({ + ...obj, + }); +} + +export interface DescribeEventsResponse { + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; + + /** + *A list of events. Each element in the list contains detailed information about one event.
+ */ + Events?: Event[]; +} + +export namespace DescribeEventsResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeEventsResponse): any => ({ + ...obj, + }); +} + +export interface DescribeParameterGroupsRequest { + /** + *The name of a specific parameter group to return details for.
+ */ + ParameterGroupName?: string; + + /** + *The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
+ */ + MaxResults?: number; + + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; +} + +export namespace DescribeParameterGroupsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeParameterGroupsRequest): any => ({ + ...obj, + }); +} + +export interface DescribeParameterGroupsResponse { + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; + + /** + *A list of parameter groups. Each element in the list contains detailed information about one parameter group.
+ */ + ParameterGroups?: ParameterGroup[]; +} + +export namespace DescribeParameterGroupsResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeParameterGroupsResponse): any => ({ + ...obj, + }); +} + +export interface DescribeParametersRequest { + /** + *he name of a specific parameter group to return details for.
+ */ + ParameterGroupName: string | undefined; + + /** + *The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
+ */ + MaxResults?: number; + + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; +} + +export namespace DescribeParametersRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeParametersRequest): any => ({ + ...obj, + }); +} + +/** + *Describes an individual setting that controls some aspect of MemoryDB behavior.
+ */ +export interface Parameter { + /** + *The name of the parameter
+ */ + Name?: string; + + /** + *The value of the parameter
+ */ + Value?: string; + + /** + *A description of the parameter
+ */ + Description?: string; + + /** + *The parameter's data type
+ */ + DataType?: string; + + /** + *The valid range of values for the parameter.
+ */ + AllowedValues?: string; + + /** + *The earliest engine version to which the parameter can apply.
+ */ + MinimumEngineVersion?: string; +} + +export namespace Parameter { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Parameter): any => ({ + ...obj, + }); +} + +export interface DescribeParametersResponse { + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; + + /** + *A list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter.
+ */ + Parameters?: Parameter[]; +} + +export namespace DescribeParametersResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeParametersResponse): any => ({ + ...obj, + }); +} + +export interface DescribeServiceUpdatesRequest { + /** + *The unique ID of the service update to describe.
+ */ + ServiceUpdateName?: string; + + /** + *The list of cluster names to identify service updates to apply
+ */ + ClusterNames?: string[]; + + /** + *The status(es) of the service updates to filter on
+ */ + Status?: (ServiceUpdateStatus | string)[]; + + /** + *The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
+ */ + MaxResults?: number; + + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; +} + +export namespace DescribeServiceUpdatesRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeServiceUpdatesRequest): any => ({ + ...obj, + }); +} + +export enum ServiceUpdateType { + SECURITY_UPDATE = "security-update", +} + +/** + *An update that you can apply to your MemoryDB clusters.
+ */ +export interface ServiceUpdate { + /** + *The name of the cluster to which the service update applies
+ */ + ClusterName?: string; + + /** + *The unique ID of the service update
+ */ + ServiceUpdateName?: string; + + /** + *The date when the service update is initially available
+ */ + ReleaseDate?: Date; + + /** + *Provides details of the service update
+ */ + Description?: string; + + /** + *The status of the service update
+ */ + Status?: ServiceUpdateStatus | string; + + /** + *Reflects the nature of the service update
+ */ + Type?: ServiceUpdateType | string; + + /** + *A list of nodes updated by the service update
+ */ + NodesUpdated?: string; + + /** + *The date at which the service update will be automatically applied
+ */ + AutoUpdateStartDate?: Date; +} + +export namespace ServiceUpdate { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ServiceUpdate): any => ({ + ...obj, + }); +} + +export interface DescribeServiceUpdatesResponse { + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; + + /** + *A list of service updates
+ */ + ServiceUpdates?: ServiceUpdate[]; +} + +export namespace DescribeServiceUpdatesResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeServiceUpdatesResponse): any => ({ + ...obj, + }); +} + +export interface DescribeSnapshotsRequest { + /** + *A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
+ */ + ClusterName?: string; + + /** + *A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.
+ */ + SnapshotName?: string; + + /** + *If set to system, the output shows snapshots that were automatically created by MemoryDB. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.
+ */ + Source?: string; + + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; + + /** + *The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
+ */ + MaxResults?: number; + + /** + *A Boolean value which if true, the shard configuration is included in the snapshot description.
+ */ + ShowDetail?: boolean; +} + +export namespace DescribeSnapshotsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeSnapshotsRequest): any => ({ + ...obj, + }); +} + +export interface DescribeSnapshotsResponse { + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; + + /** + *A list of snapshots. Each item in the list contains detailed information about one snapshot.
+ */ + Snapshots?: Snapshot[]; +} + +export namespace DescribeSnapshotsResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeSnapshotsResponse): any => ({ + ...obj, + }); +} + +export interface DescribeSubnetGroupsRequest { + /** + *The name of the subnet group to return details for.
+ */ + SubnetGroupName?: string; + + /** + *The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
+ */ + MaxResults?: number; + + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; +} + +export namespace DescribeSubnetGroupsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeSubnetGroupsRequest): any => ({ + ...obj, + }); +} + +export interface DescribeSubnetGroupsResponse { + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; + + /** + *A list of subnet groups. Each element in the list contains detailed information about one group.
+ */ + SubnetGroups?: SubnetGroup[]; +} + +export namespace DescribeSubnetGroupsResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeSubnetGroupsResponse): any => ({ + ...obj, + }); +} + +/** + *Used to streamline results of a search based on the property being filtered.
+ */ +export interface Filter { + /** + *The property being filtered. For example, UserName.
+ */ + Name: string | undefined; + + /** + *The property values to filter on. For example, "user-123".
+ */ + Values: string[] | undefined; +} + +export namespace Filter { + /** + * @internal + */ + export const filterSensitiveLog = (obj: Filter): any => ({ + ...obj, + }); +} + +export interface DescribeUsersRequest { + /** + *The name of the user
+ */ + UserName?: string; + + /** + *Filter to determine the list of users to return.
+ */ + Filters?: Filter[]; + + /** + *The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
+ */ + MaxResults?: number; + + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; +} + +export namespace DescribeUsersRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeUsersRequest): any => ({ + ...obj, + }); +} + +export interface DescribeUsersResponse { + /** + *A list of users.
+ */ + Users?: User[]; + + /** + *An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
+ */ + NextToken?: string; +} + +export namespace DescribeUsersResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeUsersResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface APICallRateForCustomerExceededFault extends __SmithyException, $MetadataBearer { + name: "APICallRateForCustomerExceededFault"; + $fault: "client"; + message?: string; +} + +export namespace APICallRateForCustomerExceededFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: APICallRateForCustomerExceededFault): any => ({ + ...obj, + }); +} + +export interface FailoverShardRequest { + /** + *The cluster being failed over
+ */ + ClusterName: string | undefined; + + /** + *The name of the shard
+ */ + ShardName: string | undefined; +} + +export namespace FailoverShardRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: FailoverShardRequest): any => ({ + ...obj, + }); +} + +export interface FailoverShardResponse { + /** + *The cluster being failed over
+ */ + Cluster?: Cluster; +} + +export namespace FailoverShardResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: FailoverShardResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface InvalidKMSKeyFault extends __SmithyException, $MetadataBearer { + name: "InvalidKMSKeyFault"; + $fault: "client"; + message?: string; +} + +export namespace InvalidKMSKeyFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InvalidKMSKeyFault): any => ({ + ...obj, + }); +} + +export interface ShardNotFoundFault extends __SmithyException, $MetadataBearer { + name: "ShardNotFoundFault"; + $fault: "client"; + message?: string; +} + +export namespace ShardNotFoundFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ShardNotFoundFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface TestFailoverNotAvailableFault extends __SmithyException, $MetadataBearer { + name: "TestFailoverNotAvailableFault"; + $fault: "client"; + message?: string; +} + +export namespace TestFailoverNotAvailableFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TestFailoverNotAvailableFault): any => ({ + ...obj, + }); +} + +export interface ListAllowedNodeTypeUpdatesRequest { + /** + *The name of the cluster you want to scale. MemoryDB uses the cluster name to identify the current node type being used by this cluster, and from that to create a list of node types + * you can scale up to.
+ */ + ClusterName: string | undefined; +} + +export namespace ListAllowedNodeTypeUpdatesRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListAllowedNodeTypeUpdatesRequest): any => ({ + ...obj, + }); +} + +export interface ListAllowedNodeTypeUpdatesResponse { + /** + *A list node types which you can use to scale up your cluster.
+ */ + ScaleUpNodeTypes?: string[]; + + /** + *A list node types which you can use to scale down your cluster.
+ */ + ScaleDownNodeTypes?: string[]; +} + +export namespace ListAllowedNodeTypeUpdatesResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListAllowedNodeTypeUpdatesResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface InvalidARNFault extends __SmithyException, $MetadataBearer { + name: "InvalidARNFault"; + $fault: "client"; + message?: string; +} + +export namespace InvalidARNFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InvalidARNFault): any => ({ + ...obj, + }); +} + +export interface ListTagsRequest { + /** + *The Amazon Resource Name (ARN) of the resource for which you want the list of tags
+ */ + ResourceArn: string | undefined; +} + +export namespace ListTagsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListTagsRequest): any => ({ + ...obj, + }); +} + +export interface ListTagsResponse { + /** + *A list of tags as key-value pairs.
+ */ + TagList?: Tag[]; +} + +export namespace ListTagsResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListTagsResponse): any => ({ + ...obj, + }); +} + +export interface ResetParameterGroupRequest { + /** + *The name of the parameter group to reset.
+ */ + ParameterGroupName: string | undefined; + + /** + *If true, all parameters in the parameter group are reset to their default values. If false, only the parameters listed by ParameterNames are reset to their default values.
+ */ + AllParameters?: boolean; + + /** + *An array of parameter names to reset to their default values. If AllParameters is true, do not use ParameterNames. If AllParameters is false, you must specify the name of at least one parameter to reset.
+ */ + ParameterNames?: string[]; +} + +export namespace ResetParameterGroupRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ResetParameterGroupRequest): any => ({ + ...obj, + }); +} + +export interface ResetParameterGroupResponse { + /** + *The parameter group being reset.
+ */ + ParameterGroup?: ParameterGroup; +} + +export namespace ResetParameterGroupResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ResetParameterGroupResponse): any => ({ + ...obj, + }); +} + +export interface TagResourceRequest { + /** + *The Amazon Resource Name (ARN) of the resource to which the tags are to be added
+ */ + ResourceArn: string | undefined; + + /** + *A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
+ */ + Tags: Tag[] | undefined; +} + +export namespace TagResourceRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TagResourceRequest): any => ({ + ...obj, + }); +} + +export interface TagResourceResponse { + /** + *A list of tags as key-value pairs.
+ */ + TagList?: Tag[]; +} + +export namespace TagResourceResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TagResourceResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface TagNotFoundFault extends __SmithyException, $MetadataBearer { + name: "TagNotFoundFault"; + $fault: "client"; + message?: string; +} + +export namespace TagNotFoundFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TagNotFoundFault): any => ({ + ...obj, + }); +} + +export interface UntagResourceRequest { + /** + *The Amazon Resource Name (ARN) of the resource to which the tags are to be removed
+ */ + ResourceArn: string | undefined; + + /** + *The list of keys of the tags that are to be removed
+ */ + TagKeys: string[] | undefined; +} + +export namespace UntagResourceRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({ + ...obj, + }); +} + +export interface UntagResourceResponse { + /** + *The list of tags removed
+ */ + TagList?: Tag[]; +} + +export namespace UntagResourceResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({ + ...obj, + }); +} + +export interface UpdateACLRequest { + /** + *The name of the Access Control List
+ */ + ACLName: string | undefined; + + /** + *The list of users to add to the Access Control List
+ */ + UserNamesToAdd?: string[]; + + /** + *The list of users to remove from the Access Control List
+ */ + UserNamesToRemove?: string[]; +} + +export namespace UpdateACLRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateACLRequest): any => ({ + ...obj, + }); +} + +export interface UpdateACLResponse { + /** + *The updated Access Control List
+ */ + ACL?: ACL; +} + +export namespace UpdateACLResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateACLResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface InvalidNodeStateFault extends __SmithyException, $MetadataBearer { + name: "InvalidNodeStateFault"; + $fault: "client"; + message?: string; +} + +export namespace InvalidNodeStateFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InvalidNodeStateFault): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface NoOperationFault extends __SmithyException, $MetadataBearer { + name: "NoOperationFault"; + $fault: "client"; + message?: string; +} + +export namespace NoOperationFault { + /** + * @internal + */ + export const filterSensitiveLog = (obj: NoOperationFault): any => ({ + ...obj, + }); +} + +/** + *A request to configure the number of replicas in a shard
+ */ +export interface ReplicaConfigurationRequest { + /** + *The number of replicas to scale up or down to
+ */ + ReplicaCount?: number; +} + +export namespace ReplicaConfigurationRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ReplicaConfigurationRequest): any => ({ + ...obj, + }); +} + +/** + *A request to configure the sharding properties of a cluster
+ */ +export interface ShardConfigurationRequest { + /** + *The number of shards in the cluster
+ */ + ShardCount?: number; +} + +export namespace ShardConfigurationRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ShardConfigurationRequest): any => ({ + ...obj, + }); +} + +export interface UpdateClusterRequest { + /** + *The name of the cluster to update
+ */ + ClusterName: string | undefined; + + /** + *The description of the cluster to update
+ */ + Description?: string; + + /** + *The SecurityGroupIds to update
+ */ + SecurityGroupIds?: string[]; + + /** + *The maintenance window to update
+ */ + MaintenanceWindow?: string; + + /** + *The SNS topic ARN to update
+ */ + SnsTopicArn?: string; + + /** + *The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.
+ */ + SnsTopicStatus?: string; + + /** + *The name of the parameter group to update
+ */ + ParameterGroupName?: string; + + /** + *The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.
+ */ + SnapshotWindow?: string; + + /** + *The number of days for which MemoryDB retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
+ */ + SnapshotRetentionLimit?: number; + + /** + *A valid node type that you want to scale this cluster up or down to.
+ */ + NodeType?: string; + + /** + *The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
+ */ + EngineVersion?: string; + + /** + *The number of replicas that will reside in each shard
+ */ + ReplicaConfiguration?: ReplicaConfigurationRequest; + + /** + *The number of shards in the cluster
+ */ + ShardConfiguration?: ShardConfigurationRequest; + + /** + *The Access Control List that is associated with the cluster
+ */ + ACLName?: string; +} + +export namespace UpdateClusterRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateClusterRequest): any => ({ + ...obj, + }); +} + +export interface UpdateClusterResponse { + /** + *The updated cluster
+ */ + Cluster?: Cluster; +} + +export namespace UpdateClusterResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateClusterResponse): any => ({ + ...obj, + }); +} + +/** + *Describes a name-value pair that is used to update the value of a parameter.
+ */ +export interface ParameterNameValue { + /** + *The name of the parameter
+ */ + ParameterName?: string; + + /** + *The value of the parameter
+ */ + ParameterValue?: string; +} + +export namespace ParameterNameValue { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ParameterNameValue): any => ({ + ...obj, + }); +} + +export interface UpdateParameterGroupRequest { + /** + *The name of the parameter group to update.
+ */ + ParameterGroupName: string | undefined; + + /** + *An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be updated per request.
+ */ + ParameterNameValues: ParameterNameValue[] | undefined; +} + +export namespace UpdateParameterGroupRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateParameterGroupRequest): any => ({ + ...obj, + }); +} + +export interface UpdateParameterGroupResponse { + /** + *The updated parameter group
+ */ + ParameterGroup?: ParameterGroup; +} + +export namespace UpdateParameterGroupResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateParameterGroupResponse): any => ({ + ...obj, + }); +} + +/** + * + */ +export interface SubnetInUse extends __SmithyException, $MetadataBearer { + name: "SubnetInUse"; + $fault: "client"; + message?: string; +} + +export namespace SubnetInUse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SubnetInUse): any => ({ + ...obj, + }); +} + +export interface UpdateSubnetGroupRequest { + /** + *The name of the subnet group
+ */ + SubnetGroupName: string | undefined; + + /** + *A description of the subnet group
+ */ + Description?: string; + + /** + *The EC2 subnet IDs for the subnet group.
+ */ + SubnetIds?: string[]; +} + +export namespace UpdateSubnetGroupRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateSubnetGroupRequest): any => ({ + ...obj, + }); +} + +export interface UpdateSubnetGroupResponse { + /** + *The updated subnet group
+ */ + SubnetGroup?: SubnetGroup; +} + +export namespace UpdateSubnetGroupResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateSubnetGroupResponse): any => ({ + ...obj, + }); +} + +export interface UpdateUserRequest { + /** + *The name of the user
+ */ + UserName: string | undefined; + + /** + *Denotes the user's authentication properties, such as whether it requires a password to authenticate.
+ */ + AuthenticationMode?: AuthenticationMode; + + /** + *Access permissions string used for this user.
+ */ + AccessString?: string; +} + +export namespace UpdateUserRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateUserRequest): any => ({ + ...obj, + }); +} + +export interface UpdateUserResponse { + /** + *The updated user
+ */ + User?: User; +} + +export namespace UpdateUserResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateUserResponse): any => ({ + ...obj, + }); +} diff --git a/clients/client-memorydb/package.json b/clients/client-memorydb/package.json new file mode 100644 index 000000000000..df1e5fed067c --- /dev/null +++ b/clients/client-memorydb/package.json @@ -0,0 +1,91 @@ +{ + "name": "@aws-sdk/client-memorydb", + "description": "AWS SDK for JavaScript Memorydb Client for Node.js, Browser and React Native", + "version": "3.0.0", + "scripts": { + "clean": "yarn remove-definitions && yarn remove-dist && yarn remove-documentation", + "build-documentation": "yarn remove-documentation && typedoc ./", + "downlevel-dts": "downlevel-dts dist/types dist/types/ts3.4", + "remove-definitions": "rimraf ./types", + "remove-dist": "rimraf ./dist", + "remove-documentation": "rimraf ./docs", + "test": "jest --coverage --passWithNoTests", + "build:cjs": "tsc -p tsconfig.json", + "build:es": "tsc -p tsconfig.es.json", + "build": "yarn build:cjs && yarn build:es" + }, + "main": "./dist/cjs/index.js", + "types": "./dist/types/index.d.ts", + "module": "./dist/es/index.js", + "browser": { + "./runtimeConfig": "./runtimeConfig.browser" + }, + "react-native": { + "./runtimeConfig": "./runtimeConfig.native" + }, + "sideEffects": false, + "dependencies": { + "@aws-crypto/sha256-browser": "^1.1.0", + "@aws-crypto/sha256-js": "^1.1.0", + "@aws-sdk/client-sts": "3.26.0", + "@aws-sdk/config-resolver": "3.25.0", + "@aws-sdk/credential-provider-node": "3.26.0", + "@aws-sdk/fetch-http-handler": "3.25.0", + "@aws-sdk/hash-node": "3.25.0", + "@aws-sdk/invalid-dependency": "3.25.0", + "@aws-sdk/middleware-content-length": "3.25.0", + "@aws-sdk/middleware-host-header": "3.25.0", + "@aws-sdk/middleware-logger": "3.25.0", + "@aws-sdk/middleware-retry": "3.25.0", + "@aws-sdk/middleware-serde": "3.25.0", + "@aws-sdk/middleware-signing": "3.25.0", + "@aws-sdk/middleware-stack": "3.25.0", + "@aws-sdk/middleware-user-agent": "3.25.0", + "@aws-sdk/node-config-provider": "3.25.0", + "@aws-sdk/node-http-handler": "3.25.0", + "@aws-sdk/protocol-http": "3.25.0", + "@aws-sdk/smithy-client": "3.25.0", + "@aws-sdk/types": "3.25.0", + "@aws-sdk/url-parser": "3.25.0", + "@aws-sdk/util-base64-browser": "3.23.0", + "@aws-sdk/util-base64-node": "3.23.0", + "@aws-sdk/util-body-length-browser": "3.23.0", + "@aws-sdk/util-body-length-node": "3.23.0", + "@aws-sdk/util-user-agent-browser": "3.25.0", + "@aws-sdk/util-user-agent-node": "3.25.0", + "@aws-sdk/util-utf8-browser": "3.23.0", + "@aws-sdk/util-utf8-node": "3.23.0", + "tslib": "^2.3.0" + }, + "devDependencies": { + "@aws-sdk/client-documentation-generator": "3.23.0", + "@types/node": "^12.7.5", + "downlevel-dts": "0.7.0", + "jest": "^26.1.0", + "rimraf": "^3.0.0", + "ts-jest": "^26.4.1", + "typedoc": "^0.19.2", + "typescript": "~4.3.2" + }, + "engines": { + "node": ">=10.0.0" + }, + "typesVersions": { + "<4.0": { + "dist/types/*": [ + "dist/types/ts3.4/*" + ] + } + }, + "author": { + "name": "AWS SDK for JavaScript Team", + "url": "https://aws.amazon.com/javascript/" + }, + "license": "Apache-2.0", + "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-memorydb", + "repository": { + "type": "git", + "url": "https://github.com/aws/aws-sdk-js-v3.git", + "directory": "clients/client-memorydb" + } +} diff --git a/clients/client-memorydb/protocols/Aws_json1_1.ts b/clients/client-memorydb/protocols/Aws_json1_1.ts new file mode 100644 index 000000000000..918254455479 --- /dev/null +++ b/clients/client-memorydb/protocols/Aws_json1_1.ts @@ -0,0 +1,6693 @@ +import { BatchUpdateClusterCommandInput, BatchUpdateClusterCommandOutput } from "../commands/BatchUpdateClusterCommand"; +import { CopySnapshotCommandInput, CopySnapshotCommandOutput } from "../commands/CopySnapshotCommand"; +import { CreateACLCommandInput, CreateACLCommandOutput } from "../commands/CreateACLCommand"; +import { CreateClusterCommandInput, CreateClusterCommandOutput } from "../commands/CreateClusterCommand"; +import { + CreateParameterGroupCommandInput, + CreateParameterGroupCommandOutput, +} from "../commands/CreateParameterGroupCommand"; +import { CreateSnapshotCommandInput, CreateSnapshotCommandOutput } from "../commands/CreateSnapshotCommand"; +import { CreateSubnetGroupCommandInput, CreateSubnetGroupCommandOutput } from "../commands/CreateSubnetGroupCommand"; +import { CreateUserCommandInput, CreateUserCommandOutput } from "../commands/CreateUserCommand"; +import { DeleteACLCommandInput, DeleteACLCommandOutput } from "../commands/DeleteACLCommand"; +import { DeleteClusterCommandInput, DeleteClusterCommandOutput } from "../commands/DeleteClusterCommand"; +import { + DeleteParameterGroupCommandInput, + DeleteParameterGroupCommandOutput, +} from "../commands/DeleteParameterGroupCommand"; +import { DeleteSnapshotCommandInput, DeleteSnapshotCommandOutput } from "../commands/DeleteSnapshotCommand"; +import { DeleteSubnetGroupCommandInput, DeleteSubnetGroupCommandOutput } from "../commands/DeleteSubnetGroupCommand"; +import { DeleteUserCommandInput, DeleteUserCommandOutput } from "../commands/DeleteUserCommand"; +import { DescribeACLsCommandInput, DescribeACLsCommandOutput } from "../commands/DescribeACLsCommand"; +import { DescribeClustersCommandInput, DescribeClustersCommandOutput } from "../commands/DescribeClustersCommand"; +import { + DescribeEngineVersionsCommandInput, + DescribeEngineVersionsCommandOutput, +} from "../commands/DescribeEngineVersionsCommand"; +import { DescribeEventsCommandInput, DescribeEventsCommandOutput } from "../commands/DescribeEventsCommand"; +import { + DescribeParameterGroupsCommandInput, + DescribeParameterGroupsCommandOutput, +} from "../commands/DescribeParameterGroupsCommand"; +import { DescribeParametersCommandInput, DescribeParametersCommandOutput } from "../commands/DescribeParametersCommand"; +import { + DescribeServiceUpdatesCommandInput, + DescribeServiceUpdatesCommandOutput, +} from "../commands/DescribeServiceUpdatesCommand"; +import { DescribeSnapshotsCommandInput, DescribeSnapshotsCommandOutput } from "../commands/DescribeSnapshotsCommand"; +import { + DescribeSubnetGroupsCommandInput, + DescribeSubnetGroupsCommandOutput, +} from "../commands/DescribeSubnetGroupsCommand"; +import { DescribeUsersCommandInput, DescribeUsersCommandOutput } from "../commands/DescribeUsersCommand"; +import { FailoverShardCommandInput, FailoverShardCommandOutput } from "../commands/FailoverShardCommand"; +import { + ListAllowedNodeTypeUpdatesCommandInput, + ListAllowedNodeTypeUpdatesCommandOutput, +} from "../commands/ListAllowedNodeTypeUpdatesCommand"; +import { ListTagsCommandInput, ListTagsCommandOutput } from "../commands/ListTagsCommand"; +import { + ResetParameterGroupCommandInput, + ResetParameterGroupCommandOutput, +} from "../commands/ResetParameterGroupCommand"; +import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand"; +import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand"; +import { UpdateACLCommandInput, UpdateACLCommandOutput } from "../commands/UpdateACLCommand"; +import { UpdateClusterCommandInput, UpdateClusterCommandOutput } from "../commands/UpdateClusterCommand"; +import { + UpdateParameterGroupCommandInput, + UpdateParameterGroupCommandOutput, +} from "../commands/UpdateParameterGroupCommand"; +import { UpdateSubnetGroupCommandInput, UpdateSubnetGroupCommandOutput } from "../commands/UpdateSubnetGroupCommand"; +import { UpdateUserCommandInput, UpdateUserCommandOutput } from "../commands/UpdateUserCommand"; +import { + ACL, + ACLAlreadyExistsFault, + ACLNotFoundFault, + ACLPendingChanges, + ACLQuotaExceededFault, + ACLsUpdateStatus, + APICallRateForCustomerExceededFault, + Authentication, + AuthenticationMode, + AvailabilityZone, + BatchUpdateClusterRequest, + BatchUpdateClusterResponse, + Cluster, + ClusterAlreadyExistsFault, + ClusterConfiguration, + ClusterNotFoundFault, + ClusterPendingUpdates, + ClusterQuotaForCustomerExceededFault, + CopySnapshotRequest, + CopySnapshotResponse, + CreateACLRequest, + CreateACLResponse, + CreateClusterRequest, + CreateClusterResponse, + CreateParameterGroupRequest, + CreateParameterGroupResponse, + CreateSnapshotRequest, + CreateSnapshotResponse, + CreateSubnetGroupRequest, + CreateSubnetGroupResponse, + CreateUserRequest, + CreateUserResponse, + DefaultUserRequired, + DeleteACLRequest, + DeleteACLResponse, + DeleteClusterRequest, + DeleteClusterResponse, + DeleteParameterGroupRequest, + DeleteParameterGroupResponse, + DeleteSnapshotRequest, + DeleteSnapshotResponse, + DeleteSubnetGroupRequest, + DeleteSubnetGroupResponse, + DeleteUserRequest, + DeleteUserResponse, + DescribeACLsRequest, + DescribeACLsResponse, + DescribeClustersRequest, + DescribeClustersResponse, + DescribeEngineVersionsRequest, + DescribeEngineVersionsResponse, + DescribeEventsRequest, + DescribeEventsResponse, + DescribeParameterGroupsRequest, + DescribeParameterGroupsResponse, + DescribeParametersRequest, + DescribeParametersResponse, + DescribeServiceUpdatesRequest, + DescribeServiceUpdatesResponse, + DescribeSnapshotsRequest, + DescribeSnapshotsResponse, + DescribeSubnetGroupsRequest, + DescribeSubnetGroupsResponse, + DescribeUsersRequest, + DescribeUsersResponse, + DuplicateUserNameFault, + Endpoint, + EngineVersionInfo, + Event, + FailoverShardRequest, + FailoverShardResponse, + Filter, + InsufficientClusterCapacityFault, + InvalidACLStateFault, + InvalidARNFault, + InvalidClusterStateFault, + InvalidCredentialsException, + InvalidKMSKeyFault, + InvalidNodeStateFault, + InvalidParameterCombinationException, + InvalidParameterGroupStateFault, + InvalidParameterValueException, + InvalidSnapshotStateFault, + InvalidSubnet, + InvalidUserStateFault, + InvalidVPCNetworkStateFault, + ListAllowedNodeTypeUpdatesRequest, + ListAllowedNodeTypeUpdatesResponse, + ListTagsRequest, + ListTagsResponse, + NoOperationFault, + Node, + NodeQuotaForClusterExceededFault, + NodeQuotaForCustomerExceededFault, + Parameter, + ParameterGroup, + ParameterGroupAlreadyExistsFault, + ParameterGroupNotFoundFault, + ParameterGroupQuotaExceededFault, + ParameterNameValue, + PendingModifiedServiceUpdate, + ReplicaConfigurationRequest, + ResetParameterGroupRequest, + ResetParameterGroupResponse, + ReshardingStatus, + SecurityGroupMembership, + ServiceLinkedRoleNotFoundFault, + ServiceUpdate, + ServiceUpdateNotFoundFault, + ServiceUpdateRequest, + ServiceUpdateStatus, + Shard, + ShardConfiguration, + ShardConfigurationRequest, + ShardDetail, + ShardNotFoundFault, + ShardsPerClusterQuotaExceededFault, + SlotMigration, + Snapshot, + SnapshotAlreadyExistsFault, + SnapshotNotFoundFault, + SnapshotQuotaExceededFault, + Subnet, + SubnetGroup, + SubnetGroupAlreadyExistsFault, + SubnetGroupInUseFault, + SubnetGroupNotFoundFault, + SubnetGroupQuotaExceededFault, + SubnetInUse, + SubnetNotAllowedFault, + SubnetQuotaExceededFault, + Tag, + TagNotFoundFault, + TagQuotaPerResourceExceeded, + TagResourceRequest, + TagResourceResponse, + TestFailoverNotAvailableFault, + UnprocessedCluster, + UntagResourceRequest, + UntagResourceResponse, + UpdateACLRequest, + UpdateACLResponse, + UpdateClusterRequest, + UpdateClusterResponse, + UpdateParameterGroupRequest, + UpdateParameterGroupResponse, + UpdateSubnetGroupRequest, + UpdateSubnetGroupResponse, + UpdateUserRequest, + UpdateUserResponse, + User, + UserAlreadyExistsFault, + UserNotFoundFault, + UserQuotaExceededFault, +} from "../models/models_0"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { + expectBoolean as __expectBoolean, + expectInt as __expectInt, + expectString as __expectString, + limitedParseFloat as __limitedParseFloat, +} from "@aws-sdk/smithy-client"; +import { + Endpoint as __Endpoint, + HeaderBag as __HeaderBag, + MetadataBearer as __MetadataBearer, + ResponseMetadata as __ResponseMetadata, + SerdeContext as __SerdeContext, + SmithyException as __SmithyException, +} from "@aws-sdk/types"; + +export const serializeAws_json1_1BatchUpdateClusterCommand = async ( + input: BatchUpdateClusterCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.BatchUpdateCluster", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1BatchUpdateClusterRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1CopySnapshotCommand = async ( + input: CopySnapshotCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.CopySnapshot", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1CopySnapshotRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1CreateACLCommand = async ( + input: CreateACLCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.CreateACL", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1CreateACLRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1CreateClusterCommand = async ( + input: CreateClusterCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.CreateCluster", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1CreateClusterRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1CreateParameterGroupCommand = async ( + input: CreateParameterGroupCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.CreateParameterGroup", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1CreateParameterGroupRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1CreateSnapshotCommand = async ( + input: CreateSnapshotCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.CreateSnapshot", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1CreateSnapshotRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1CreateSubnetGroupCommand = async ( + input: CreateSubnetGroupCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.CreateSubnetGroup", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1CreateSubnetGroupRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1CreateUserCommand = async ( + input: CreateUserCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.CreateUser", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1CreateUserRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DeleteACLCommand = async ( + input: DeleteACLCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DeleteACL", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DeleteACLRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DeleteClusterCommand = async ( + input: DeleteClusterCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DeleteCluster", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DeleteClusterRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DeleteParameterGroupCommand = async ( + input: DeleteParameterGroupCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DeleteParameterGroup", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DeleteParameterGroupRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DeleteSnapshotCommand = async ( + input: DeleteSnapshotCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DeleteSnapshot", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DeleteSnapshotRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DeleteSubnetGroupCommand = async ( + input: DeleteSubnetGroupCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DeleteSubnetGroup", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DeleteSubnetGroupRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DeleteUserCommand = async ( + input: DeleteUserCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DeleteUser", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DeleteUserRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DescribeACLsCommand = async ( + input: DescribeACLsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DescribeACLs", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DescribeACLsRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DescribeClustersCommand = async ( + input: DescribeClustersCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DescribeClusters", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DescribeClustersRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DescribeEngineVersionsCommand = async ( + input: DescribeEngineVersionsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DescribeEngineVersions", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DescribeEngineVersionsRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DescribeEventsCommand = async ( + input: DescribeEventsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DescribeEvents", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DescribeEventsRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DescribeParameterGroupsCommand = async ( + input: DescribeParameterGroupsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DescribeParameterGroups", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DescribeParameterGroupsRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DescribeParametersCommand = async ( + input: DescribeParametersCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DescribeParameters", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DescribeParametersRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DescribeServiceUpdatesCommand = async ( + input: DescribeServiceUpdatesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DescribeServiceUpdates", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DescribeServiceUpdatesRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DescribeSnapshotsCommand = async ( + input: DescribeSnapshotsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DescribeSnapshots", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DescribeSnapshotsRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DescribeSubnetGroupsCommand = async ( + input: DescribeSubnetGroupsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DescribeSubnetGroups", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DescribeSubnetGroupsRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1DescribeUsersCommand = async ( + input: DescribeUsersCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.DescribeUsers", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1DescribeUsersRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1FailoverShardCommand = async ( + input: FailoverShardCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.FailoverShard", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1FailoverShardRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1ListAllowedNodeTypeUpdatesCommand = async ( + input: ListAllowedNodeTypeUpdatesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.ListAllowedNodeTypeUpdates", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1ListAllowedNodeTypeUpdatesRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1ListTagsCommand = async ( + input: ListTagsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.ListTags", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1ListTagsRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1ResetParameterGroupCommand = async ( + input: ResetParameterGroupCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.ResetParameterGroup", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1ResetParameterGroupRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1TagResourceCommand = async ( + input: TagResourceCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.TagResource", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1TagResourceRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1UntagResourceCommand = async ( + input: UntagResourceCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.UntagResource", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1UntagResourceRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1UpdateACLCommand = async ( + input: UpdateACLCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.UpdateACL", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1UpdateACLRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1UpdateClusterCommand = async ( + input: UpdateClusterCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.UpdateCluster", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1UpdateClusterRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1UpdateParameterGroupCommand = async ( + input: UpdateParameterGroupCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.UpdateParameterGroup", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1UpdateParameterGroupRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1UpdateSubnetGroupCommand = async ( + input: UpdateSubnetGroupCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.UpdateSubnetGroup", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1UpdateSubnetGroupRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const serializeAws_json1_1UpdateUserCommand = async ( + input: UpdateUserCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = { + "content-type": "application/x-amz-json-1.1", + "x-amz-target": "AmazonMemoryDB.UpdateUser", + }; + let body: any; + body = JSON.stringify(serializeAws_json1_1UpdateUserRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +export const deserializeAws_json1_1BatchUpdateClusterCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise