Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors.
-Audit Manager is a service that provides automated evidence collection so that you -can continuously audit your Amazon Web Services usage, and assess the effectiveness of your controls to -better manage risk and simplify compliance.
-Audit Manager provides pre-built frameworks that structure and automate assessments -for a given compliance standard. Frameworks include a pre-built collection of controls with -descriptions and testing procedures, which are grouped according to the requirements of the -specified compliance standard or regulation. You can also customize frameworks and controls -to support internal audits with unique requirements.
- +Welcome to the Audit Manager API reference. This guide is for developers who +need detailed information about the Audit Manager API operations, data types, and +errors.
+Audit Manager is a service that provides automated evidence collection so that +you can continually audit your Amazon Web Services usage. You can use it to assess the +effectiveness of your controls, manage risk, and simplify compliance.
+Audit Manager provides prebuilt frameworks that structure and automate +assessments for a given compliance standard. Frameworks include a prebuilt collection of +controls with descriptions and testing procedures. These controls are grouped according to +the requirements of the specified compliance standard or regulation. You can also customize +frameworks and controls to support internal audits with specific requirements.
Use the following links to get started with the Audit Manager API:
-Actions: An alphabetical list of all Audit Manager API operations.
+Actions: An +alphabetical list of all Audit Manager API operations.-Data types: An alphabetical list of all Audit Manager data types.
+Data types: An alphabetical list of all Audit Manager data +types.-Common parameters: Parameters that all Query operations can use.
+Common +parameters: Parameters that all Query operations can use.-Common errors: Client and server errors that all operations can return.
+Common errors: +Client and server errors that all operations can return.If you're new to Audit Manager, we recommend that you review the Audit Manager User Guide.
+If you're new to Audit Manager, we recommend that you review the +Audit Manager User Guide.
## Installing diff --git a/clients/client-auditmanager/src/AuditManager.ts b/clients/client-auditmanager/src/AuditManager.ts index 3f723502d6c6..c7013e91b5dd 100644 --- a/clients/client-auditmanager/src/AuditManager.ts +++ b/clients/client-auditmanager/src/AuditManager.ts @@ -61,6 +61,11 @@ import { DeleteAssessmentFrameworkCommandInput, DeleteAssessmentFrameworkCommandOutput, } from "./commands/DeleteAssessmentFrameworkCommand"; +import { + DeleteAssessmentFrameworkShareCommand, + DeleteAssessmentFrameworkShareCommandInput, + DeleteAssessmentFrameworkShareCommandOutput, +} from "./commands/DeleteAssessmentFrameworkShareCommand"; import { DeleteAssessmentReportCommand, DeleteAssessmentReportCommandInput, @@ -154,6 +159,11 @@ import { ListAssessmentFrameworksCommandInput, ListAssessmentFrameworksCommandOutput, } from "./commands/ListAssessmentFrameworksCommand"; +import { + ListAssessmentFrameworkShareRequestsCommand, + ListAssessmentFrameworkShareRequestsCommandInput, + ListAssessmentFrameworkShareRequestsCommandOutput, +} from "./commands/ListAssessmentFrameworkShareRequestsCommand"; import { ListAssessmentReportsCommand, ListAssessmentReportsCommandInput, @@ -194,6 +204,11 @@ import { RegisterOrganizationAdminAccountCommandInput, RegisterOrganizationAdminAccountCommandOutput, } from "./commands/RegisterOrganizationAdminAccountCommand"; +import { + StartAssessmentFrameworkShareCommand, + StartAssessmentFrameworkShareCommandInput, + StartAssessmentFrameworkShareCommandOutput, +} from "./commands/StartAssessmentFrameworkShareCommand"; import { TagResourceCommand, TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; import { UntagResourceCommand, @@ -220,6 +235,11 @@ import { UpdateAssessmentFrameworkCommandInput, UpdateAssessmentFrameworkCommandOutput, } from "./commands/UpdateAssessmentFrameworkCommand"; +import { + UpdateAssessmentFrameworkShareCommand, + UpdateAssessmentFrameworkShareCommandInput, + UpdateAssessmentFrameworkShareCommandOutput, +} from "./commands/UpdateAssessmentFrameworkShareCommand"; import { UpdateAssessmentStatusCommand, UpdateAssessmentStatusCommandInput, @@ -242,43 +262,47 @@ import { } from "./commands/ValidateAssessmentReportIntegrityCommand"; /** - *Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors.
- *Audit Manager is a service that provides automated evidence collection so that you - * can continuously audit your Amazon Web Services usage, and assess the effectiveness of your controls to - * better manage risk and simplify compliance.
- *Audit Manager provides pre-built frameworks that structure and automate assessments - * for a given compliance standard. Frameworks include a pre-built collection of controls with - * descriptions and testing procedures, which are grouped according to the requirements of the - * specified compliance standard or regulation. You can also customize frameworks and controls - * to support internal audits with unique requirements.
- * + *Welcome to the Audit Manager API reference. This guide is for developers who + * need detailed information about the Audit Manager API operations, data types, and + * errors.
+ *Audit Manager is a service that provides automated evidence collection so that + * you can continually audit your Amazon Web Services usage. You can use it to assess the + * effectiveness of your controls, manage risk, and simplify compliance.
+ *Audit Manager provides prebuilt frameworks that structure and automate + * assessments for a given compliance standard. Frameworks include a prebuilt collection of + * controls with descriptions and testing procedures. These controls are grouped according to + * the requirements of the specified compliance standard or regulation. You can also customize + * frameworks and controls to support internal audits with specific requirements.
*Use the following links to get started with the Audit Manager API:
*- * Actions: An alphabetical list of all Audit Manager API operations.
+ * Actions: An + * alphabetical list of all Audit Manager API operations. *- * Data types: An alphabetical list of all Audit Manager data types.
+ * Data types: An alphabetical list of all Audit Manager data + * types. *- * Common parameters: Parameters that all Query operations can use.
+ * Common + * parameters: Parameters that all Query operations can use. *- * Common errors: Client and server errors that all operations can return.
+ * Common errors: + * Client and server errors that all operations can return. *If you're new to Audit Manager, we recommend that you review the Audit Manager User Guide.
+ *If you're new to Audit Manager, we recommend that you review the + * Audit Manager User Guide.
*/ export class AuditManager extends AuditManagerClient { /** - *- * Associates an evidence folder to the specified assessment report in Audit Manager. - *
+ *Associates an evidence folder to an assessment report in a Audit Manager + * assessment.
*/ public associateAssessmentReportEvidenceFolder( args: AssociateAssessmentReportEvidenceFolderCommandInput, @@ -312,9 +336,8 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Associates a list of evidence to an assessment report in an Audit Manager assessment. - *
+ *Associates a list of evidence to an assessment report in an Audit Manager + * assessment.
*/ public batchAssociateAssessmentReportEvidence( args: BatchAssociateAssessmentReportEvidenceCommandInput, @@ -348,9 +371,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Create a batch of delegations for a specified assessment in Audit Manager. - *
+ *Creates a batch of delegations for an assessment in Audit Manager.
*/ public batchCreateDelegationByAssessment( args: BatchCreateDelegationByAssessmentCommandInput, @@ -382,9 +403,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Deletes the delegations in the specified Audit Manager assessment. - *
+ *Deletes a batch of delegations for an assessment in Audit Manager.
*/ public batchDeleteDelegationByAssessment( args: BatchDeleteDelegationByAssessmentCommandInput, @@ -416,8 +435,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Disassociates a list of evidence from the specified assessment report in Audit Manager. + *
Disassociates a list of evidence from an assessment report in Audit Manager. *
*/ public batchDisassociateAssessmentReportEvidence( @@ -452,9 +470,8 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Uploads one or more pieces of evidence to the specified control in the assessment in Audit Manager. - *
+ *Uploads one or more pieces of evidence to a control in an Audit Manager + * assessment.
*/ public batchImportEvidenceToAssessmentControl( args: BatchImportEvidenceToAssessmentControlCommandInput, @@ -488,9 +505,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Creates an assessment in Audit Manager. - *
+ *Creates an assessment in Audit Manager.
*/ public createAssessment( args: CreateAssessmentCommandInput, @@ -522,9 +537,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Creates a custom framework in Audit Manager. - *
+ *Creates a custom framework in Audit Manager.
*/ public createAssessmentFramework( args: CreateAssessmentFrameworkCommandInput, @@ -556,9 +569,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Creates an assessment report for the specified assessment. - *
+ *Creates an assessment report for the specified assessment.
*/ public createAssessmentReport( args: CreateAssessmentReportCommandInput, @@ -590,9 +601,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Creates a new custom control in Audit Manager. - *
+ *Creates a new custom control in Audit Manager.
*/ public createControl( args: CreateControlCommandInput, @@ -624,9 +633,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Deletes an assessment in Audit Manager. - *
+ *Deletes an assessment in Audit Manager.
*/ public deleteAssessment( args: DeleteAssessmentCommandInput, @@ -658,9 +665,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Deletes a custom framework in Audit Manager. - *
+ *Deletes a custom framework in Audit Manager.
*/ public deleteAssessmentFramework( args: DeleteAssessmentFrameworkCommandInput, @@ -693,8 +698,40 @@ export class AuditManager extends AuditManagerClient { /** *- * Deletes an assessment report from an assessment in Audit Manager. - *
+ * Deletes a share request for a custom framework in Audit Manager. + * + */ + public deleteAssessmentFrameworkShare( + args: DeleteAssessmentFrameworkShareCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes an assessment report from an assessment in Audit Manager.
*/ public deleteAssessmentReport( args: DeleteAssessmentReportCommandInput, @@ -726,9 +763,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Deletes a custom control in Audit Manager. - *
+ *Deletes a custom control in Audit Manager.
*/ public deleteControl( args: DeleteControlCommandInput, @@ -760,9 +795,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Deregisters an account in Audit Manager. - *
+ *Deregisters an account in Audit Manager.
*/ public deregisterAccount( args: DeregisterAccountCommandInput, @@ -794,13 +827,14 @@ export class AuditManager extends AuditManagerClient { } /** - *Removes the specified member Amazon Web Services account as a delegated administrator for Audit Manager.
+ *Removes the specified member Amazon Web Services account as a delegated administrator for + * Audit Manager.
*When you remove a delegated administrator from your Audit Manager settings, or when you - * deregister a delegated administrator from Organizations, you continue to have access - * to the evidence that you previously collected under that account. However, Audit Manager - * will stop collecting and attaching evidence to that delegated administrator account - * moving forward.
+ *When you remove a delegated administrator from your Audit Manager settings, you + * continue to have access to the evidence that you previously collected under that + * account. This is also the case when you deregister a delegated administrator from + * Audit Manager. However, Audit Manager will stop collecting and attaching + * evidence to that delegated administrator account moving forward.
*- * Disassociates an evidence folder from the specified assessment report in Audit Manager. - *
+ *Disassociates an evidence folder from the specified assessment report in Audit Manager.
*/ public disassociateAssessmentReportEvidenceFolder( args: DisassociateAssessmentReportEvidenceFolderCommandInput, @@ -869,9 +901,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns the registration status of an account in Audit Manager. - *
+ *Returns the registration status of an account in Audit Manager.
*/ public getAccountStatus( args: GetAccountStatusCommandInput, @@ -903,9 +933,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns an assessment from Audit Manager. - *
+ *Returns an assessment from Audit Manager.
*/ public getAssessment( args: GetAssessmentCommandInput, @@ -937,9 +965,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns a framework from Audit Manager. - *
+ *Returns a framework from Audit Manager.
*/ public getAssessmentFramework( args: GetAssessmentFrameworkCommandInput, @@ -971,9 +997,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns the URL of a specified assessment report in Audit Manager. - *
+ *Returns the URL of an assessment report in Audit Manager.
*/ public getAssessmentReportUrl( args: GetAssessmentReportUrlCommandInput, @@ -1005,9 +1029,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns a list of changelogs from Audit Manager. - *
+ *Returns a list of changelogs from Audit Manager.
*/ public getChangeLogs( args: GetChangeLogsCommandInput, @@ -1039,9 +1061,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns a control from Audit Manager. - *
+ *Returns a control from Audit Manager.
*/ public getControl(args: GetControlCommandInput, options?: __HttpHandlerOptions): Promise- * Returns a list of delegations from an audit owner to a delegate. - *
+ *Returns a list of delegations from an audit owner to a delegate.
*/ public getDelegations( args: GetDelegationsCommandInput, @@ -1101,9 +1119,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns evidence from Audit Manager. - *
+ *Returns evidence from Audit Manager.
*/ public getEvidence(args: GetEvidenceCommandInput, options?: __HttpHandlerOptions): Promise- * Returns all evidence from a specified evidence folder in Audit Manager. - *
+ *Returns all evidence from a specified evidence folder in Audit Manager.
*/ public getEvidenceByEvidenceFolder( args: GetEvidenceByEvidenceFolderCommandInput, @@ -1163,9 +1177,8 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns an evidence folder from the specified assessment in Audit Manager. - *
+ *Returns an evidence folder from the specified assessment in Audit Manager. + *
*/ public getEvidenceFolder( args: GetEvidenceFolderCommandInput, @@ -1197,9 +1210,8 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns the evidence folders from a specified assessment in Audit Manager. - *
+ *Returns the evidence folders from a specified assessment in Audit Manager. + *
*/ public getEvidenceFoldersByAssessment( args: GetEvidenceFoldersByAssessmentCommandInput, @@ -1231,9 +1243,8 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns a list of evidence folders associated with a specified control of an assessment in Audit Manager. - *
+ *Returns a list of evidence folders that are associated with a specified control of an + * assessment in Audit Manager.
*/ public getEvidenceFoldersByAssessmentControl( args: GetEvidenceFoldersByAssessmentControlCommandInput, @@ -1267,9 +1278,8 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns the name of the delegated Amazon Web Services administrator account for the organization. - *
+ *Returns the name of the delegated Amazon Web Services administrator account for the + * organization.
*/ public getOrganizationAdminAccount( args: GetOrganizationAdminAccountCommandInput, @@ -1301,9 +1311,8 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns a list of the in-scope Amazon Web Services services for the specified assessment. - *
+ *Returns a list of the in-scope Amazon Web Services services for the specified + * assessment.
*/ public getServicesInScope( args: GetServicesInScopeCommandInput, @@ -1335,9 +1344,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns the settings for the specified Amazon Web Services account. - *
+ *Returns the settings for the specified Amazon Web Services account.
*/ public getSettings(args: GetSettingsCommandInput, options?: __HttpHandlerOptions): Promise- * Returns a list of the frameworks available in the Audit Manager framework library. - *
+ *Returns a list of the frameworks that are available in the Audit Manager + * framework library.
*/ public listAssessmentFrameworks( args: ListAssessmentFrameworksCommandInput, @@ -1397,9 +1403,39 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns a list of assessment reports created in Audit Manager. - *
+ *Returns a list of sent or received share requests for custom frameworks in Audit Manager.
+ */ + public listAssessmentFrameworkShareRequests( + args: ListAssessmentFrameworkShareRequestsCommandInput, + options?: __HttpHandlerOptions + ): PromiseReturns a list of assessment reports created in Audit Manager.
*/ public listAssessmentReports( args: ListAssessmentReportsCommandInput, @@ -1431,9 +1467,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns a list of current and past assessments from Audit Manager. - *
+ *Returns a list of current and past assessments from Audit Manager.
*/ public listAssessments( args: ListAssessmentsCommandInput, @@ -1465,9 +1499,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns a list of controls from Audit Manager. - *
+ *Returns a list of controls from Audit Manager.
*/ public listControls( args: ListControlsCommandInput, @@ -1496,9 +1528,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns a list of keywords that pre-mapped to the specified control data source. - *
+ *Returns a list of keywords that are pre-mapped to the specified control data source.
*/ public listKeywordsForDataSource( args: ListKeywordsForDataSourceCommandInput, @@ -1530,9 +1560,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns a list of all Audit Manager notifications. - *
+ *Returns a list of all Audit Manager notifications.
*/ public listNotifications( args: ListNotificationsCommandInput, @@ -1564,9 +1592,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Returns a list of tags for the specified resource in Audit Manager. - *
+ *Returns a list of tags for the specified resource in Audit Manager.
*/ public listTagsForResource( args: ListTagsForResourceCommandInput, @@ -1598,9 +1624,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Enables Audit Manager for the specified Amazon Web Services account. - *
+ *Enables Audit Manager for the specified Amazon Web Services account.
*/ public registerAccount( args: RegisterAccountCommandInput, @@ -1632,9 +1656,8 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager. - *
+ *Enables an Amazon Web Services account within the organization as the delegated + * administrator for Audit Manager.
*/ public registerOrganizationAdminAccount( args: RegisterOrganizationAdminAccountCommandInput, @@ -1666,9 +1689,49 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Tags the specified resource in Audit Manager. - *
+ *Creates a share request for a custom framework in Audit Manager.
+ *The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires.
+ *When you invoke the StartAssessmentFrameworkShare API, you are about to
+ * share a custom framework with another Amazon Web Services account. You may not share a
+ * custom framework that is derived from a standard framework if the standard framework is
+ * designated as not eligible for sharing by Amazon Web Services, unless you have obtained
+ * permission to do so from the owner of the standard framework. To learn more about which
+ * standard frameworks are eligible for sharing, see Framework sharing eligibility in the Audit Manager User
+ * Guide.
Tags the specified resource in Audit Manager.
*/ public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise- * Removes a tag from a resource in Audit Manager. - *
+ *Removes a tag from a resource in Audit Manager.
*/ public untagResource( args: UntagResourceCommandInput, @@ -1728,9 +1789,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Edits an Audit Manager assessment. - *
+ *Edits an Audit Manager assessment.
*/ public updateAssessment( args: UpdateAssessmentCommandInput, @@ -1762,9 +1821,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Updates a control within an assessment in Audit Manager. - *
+ *Updates a control within an assessment in Audit Manager.
*/ public updateAssessmentControl( args: UpdateAssessmentControlCommandInput, @@ -1796,9 +1853,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Updates the status of a control set in an Audit Manager assessment. - *
+ *Updates the status of a control set in an Audit Manager assessment.
*/ public updateAssessmentControlSetStatus( args: UpdateAssessmentControlSetStatusCommandInput, @@ -1830,9 +1885,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Updates a custom framework in Audit Manager. - *
+ *Updates a custom framework in Audit Manager.
*/ public updateAssessmentFramework( args: UpdateAssessmentFrameworkCommandInput, @@ -1864,9 +1917,39 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Updates the status of an assessment in Audit Manager. - *
+ *Updates a share request for a custom framework in Audit Manager.
+ */ + public updateAssessmentFrameworkShare( + args: UpdateAssessmentFrameworkShareCommandInput, + options?: __HttpHandlerOptions + ): PromiseUpdates the status of an assessment in Audit Manager.
*/ public updateAssessmentStatus( args: UpdateAssessmentStatusCommandInput, @@ -1898,9 +1981,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Updates a custom control in Audit Manager. - *
+ *Updates a custom control in Audit Manager.
*/ public updateControl( args: UpdateControlCommandInput, @@ -1932,9 +2013,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Updates Audit Manager settings for the current user account. - *
+ *Updates Audit Manager settings for the current user account.
*/ public updateSettings( args: UpdateSettingsCommandInput, @@ -1966,9 +2045,7 @@ export class AuditManager extends AuditManagerClient { } /** - *- * Validates the integrity of an assessment report in Audit Manager. - *
+ *Validates the integrity of an assessment report in Audit Manager.
*/ public validateAssessmentReportIntegrity( args: ValidateAssessmentReportIntegrityCommandInput, diff --git a/clients/client-auditmanager/src/AuditManagerClient.ts b/clients/client-auditmanager/src/AuditManagerClient.ts index 49ec9bd5051a..4042010d5f24 100644 --- a/clients/client-auditmanager/src/AuditManagerClient.ts +++ b/clients/client-auditmanager/src/AuditManagerClient.ts @@ -88,6 +88,10 @@ import { DeleteAssessmentFrameworkCommandInput, DeleteAssessmentFrameworkCommandOutput, } from "./commands/DeleteAssessmentFrameworkCommand"; +import { + DeleteAssessmentFrameworkShareCommandInput, + DeleteAssessmentFrameworkShareCommandOutput, +} from "./commands/DeleteAssessmentFrameworkShareCommand"; import { DeleteAssessmentReportCommandInput, DeleteAssessmentReportCommandOutput, @@ -139,6 +143,10 @@ import { ListAssessmentFrameworksCommandInput, ListAssessmentFrameworksCommandOutput, } from "./commands/ListAssessmentFrameworksCommand"; +import { + ListAssessmentFrameworkShareRequestsCommandInput, + ListAssessmentFrameworkShareRequestsCommandOutput, +} from "./commands/ListAssessmentFrameworkShareRequestsCommand"; import { ListAssessmentReportsCommandInput, ListAssessmentReportsCommandOutput, @@ -159,6 +167,10 @@ import { RegisterOrganizationAdminAccountCommandInput, RegisterOrganizationAdminAccountCommandOutput, } from "./commands/RegisterOrganizationAdminAccountCommand"; +import { + StartAssessmentFrameworkShareCommandInput, + StartAssessmentFrameworkShareCommandOutput, +} from "./commands/StartAssessmentFrameworkShareCommand"; import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; import { UpdateAssessmentCommandInput, UpdateAssessmentCommandOutput } from "./commands/UpdateAssessmentCommand"; @@ -174,6 +186,10 @@ import { UpdateAssessmentFrameworkCommandInput, UpdateAssessmentFrameworkCommandOutput, } from "./commands/UpdateAssessmentFrameworkCommand"; +import { + UpdateAssessmentFrameworkShareCommandInput, + UpdateAssessmentFrameworkShareCommandOutput, +} from "./commands/UpdateAssessmentFrameworkShareCommand"; import { UpdateAssessmentStatusCommandInput, UpdateAssessmentStatusCommandOutput, @@ -199,6 +215,7 @@ export type ServiceInputTypes = | CreateControlCommandInput | DeleteAssessmentCommandInput | DeleteAssessmentFrameworkCommandInput + | DeleteAssessmentFrameworkShareCommandInput | DeleteAssessmentReportCommandInput | DeleteControlCommandInput | DeregisterAccountCommandInput @@ -219,6 +236,7 @@ export type ServiceInputTypes = | GetOrganizationAdminAccountCommandInput | GetServicesInScopeCommandInput | GetSettingsCommandInput + | ListAssessmentFrameworkShareRequestsCommandInput | ListAssessmentFrameworksCommandInput | ListAssessmentReportsCommandInput | ListAssessmentsCommandInput @@ -228,12 +246,14 @@ export type ServiceInputTypes = | ListTagsForResourceCommandInput | RegisterAccountCommandInput | RegisterOrganizationAdminAccountCommandInput + | StartAssessmentFrameworkShareCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAssessmentCommandInput | UpdateAssessmentControlCommandInput | UpdateAssessmentControlSetStatusCommandInput | UpdateAssessmentFrameworkCommandInput + | UpdateAssessmentFrameworkShareCommandInput | UpdateAssessmentStatusCommandInput | UpdateControlCommandInput | UpdateSettingsCommandInput @@ -252,6 +272,7 @@ export type ServiceOutputTypes = | CreateControlCommandOutput | DeleteAssessmentCommandOutput | DeleteAssessmentFrameworkCommandOutput + | DeleteAssessmentFrameworkShareCommandOutput | DeleteAssessmentReportCommandOutput | DeleteControlCommandOutput | DeregisterAccountCommandOutput @@ -272,6 +293,7 @@ export type ServiceOutputTypes = | GetOrganizationAdminAccountCommandOutput | GetServicesInScopeCommandOutput | GetSettingsCommandOutput + | ListAssessmentFrameworkShareRequestsCommandOutput | ListAssessmentFrameworksCommandOutput | ListAssessmentReportsCommandOutput | ListAssessmentsCommandOutput @@ -281,12 +303,14 @@ export type ServiceOutputTypes = | ListTagsForResourceCommandOutput | RegisterAccountCommandOutput | RegisterOrganizationAdminAccountCommandOutput + | StartAssessmentFrameworkShareCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAssessmentCommandOutput | UpdateAssessmentControlCommandOutput | UpdateAssessmentControlSetStatusCommandOutput | UpdateAssessmentFrameworkCommandOutput + | UpdateAssessmentFrameworkShareCommandOutput | UpdateAssessmentStatusCommandOutput | UpdateControlCommandOutput | UpdateSettingsCommandOutput @@ -431,37 +455,42 @@ type AuditManagerClientResolvedConfigType = __SmithyResolvedConfiguration<__Http export interface AuditManagerClientResolvedConfig extends AuditManagerClientResolvedConfigType {} /** - *Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors.
- *Audit Manager is a service that provides automated evidence collection so that you - * can continuously audit your Amazon Web Services usage, and assess the effectiveness of your controls to - * better manage risk and simplify compliance.
- *Audit Manager provides pre-built frameworks that structure and automate assessments - * for a given compliance standard. Frameworks include a pre-built collection of controls with - * descriptions and testing procedures, which are grouped according to the requirements of the - * specified compliance standard or regulation. You can also customize frameworks and controls - * to support internal audits with unique requirements.
- * + *Welcome to the Audit Manager API reference. This guide is for developers who + * need detailed information about the Audit Manager API operations, data types, and + * errors.
+ *Audit Manager is a service that provides automated evidence collection so that + * you can continually audit your Amazon Web Services usage. You can use it to assess the + * effectiveness of your controls, manage risk, and simplify compliance.
+ *Audit Manager provides prebuilt frameworks that structure and automate + * assessments for a given compliance standard. Frameworks include a prebuilt collection of + * controls with descriptions and testing procedures. These controls are grouped according to + * the requirements of the specified compliance standard or regulation. You can also customize + * frameworks and controls to support internal audits with specific requirements.
*Use the following links to get started with the Audit Manager API:
*- * Actions: An alphabetical list of all Audit Manager API operations.
+ * Actions: An + * alphabetical list of all Audit Manager API operations. *- * Data types: An alphabetical list of all Audit Manager data types.
+ * Data types: An alphabetical list of all Audit Manager data + * types. *- * Common parameters: Parameters that all Query operations can use.
+ * Common + * parameters: Parameters that all Query operations can use. *- * Common errors: Client and server errors that all operations can return.
+ * Common errors: + * Client and server errors that all operations can return. *If you're new to Audit Manager, we recommend that you review the Audit Manager User Guide.
+ *If you're new to Audit Manager, we recommend that you review the + * Audit Manager User Guide.
*/ export class AuditManagerClient extends __Client< __HttpHandlerOptions, diff --git a/clients/client-auditmanager/src/commands/AssociateAssessmentReportEvidenceFolderCommand.ts b/clients/client-auditmanager/src/commands/AssociateAssessmentReportEvidenceFolderCommand.ts index c3a7e78502b8..885c9195aac7 100644 --- a/clients/client-auditmanager/src/commands/AssociateAssessmentReportEvidenceFolderCommand.ts +++ b/clients/client-auditmanager/src/commands/AssociateAssessmentReportEvidenceFolderCommand.ts @@ -28,9 +28,8 @@ export interface AssociateAssessmentReportEvidenceFolderCommandOutput __MetadataBearer {} /** - *- * Associates an evidence folder to the specified assessment report in Audit Manager. - *
+ *Associates an evidence folder to an assessment report in a Audit Manager + * assessment.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/BatchAssociateAssessmentReportEvidenceCommand.ts b/clients/client-auditmanager/src/commands/BatchAssociateAssessmentReportEvidenceCommand.ts index bbf1c51435b8..cd91f9b058ac 100644 --- a/clients/client-auditmanager/src/commands/BatchAssociateAssessmentReportEvidenceCommand.ts +++ b/clients/client-auditmanager/src/commands/BatchAssociateAssessmentReportEvidenceCommand.ts @@ -28,9 +28,8 @@ export interface BatchAssociateAssessmentReportEvidenceCommandOutput __MetadataBearer {} /** - *- * Associates a list of evidence to an assessment report in an Audit Manager assessment. - *
+ *Associates a list of evidence to an assessment report in an Audit Manager + * assessment.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/BatchCreateDelegationByAssessmentCommand.ts b/clients/client-auditmanager/src/commands/BatchCreateDelegationByAssessmentCommand.ts index 91cadbed599c..d000040ba0ca 100644 --- a/clients/client-auditmanager/src/commands/BatchCreateDelegationByAssessmentCommand.ts +++ b/clients/client-auditmanager/src/commands/BatchCreateDelegationByAssessmentCommand.ts @@ -27,9 +27,7 @@ export interface BatchCreateDelegationByAssessmentCommandOutput __MetadataBearer {} /** - *- * Create a batch of delegations for a specified assessment in Audit Manager. - *
+ *Creates a batch of delegations for an assessment in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/BatchDeleteDelegationByAssessmentCommand.ts b/clients/client-auditmanager/src/commands/BatchDeleteDelegationByAssessmentCommand.ts index 66558f0d3b53..788bfcea3862 100644 --- a/clients/client-auditmanager/src/commands/BatchDeleteDelegationByAssessmentCommand.ts +++ b/clients/client-auditmanager/src/commands/BatchDeleteDelegationByAssessmentCommand.ts @@ -27,9 +27,7 @@ export interface BatchDeleteDelegationByAssessmentCommandOutput __MetadataBearer {} /** - *- * Deletes the delegations in the specified Audit Manager assessment. - *
+ *Deletes a batch of delegations for an assessment in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/BatchDisassociateAssessmentReportEvidenceCommand.ts b/clients/client-auditmanager/src/commands/BatchDisassociateAssessmentReportEvidenceCommand.ts index 6243d6eadf63..269710904fc9 100644 --- a/clients/client-auditmanager/src/commands/BatchDisassociateAssessmentReportEvidenceCommand.ts +++ b/clients/client-auditmanager/src/commands/BatchDisassociateAssessmentReportEvidenceCommand.ts @@ -28,8 +28,7 @@ export interface BatchDisassociateAssessmentReportEvidenceCommandOutput __MetadataBearer {} /** - *- * Disassociates a list of evidence from the specified assessment report in Audit Manager. + *
Disassociates a list of evidence from an assessment report in Audit Manager. *
* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-auditmanager/src/commands/BatchImportEvidenceToAssessmentControlCommand.ts b/clients/client-auditmanager/src/commands/BatchImportEvidenceToAssessmentControlCommand.ts index 3ea402ddadbc..027092cd32f6 100644 --- a/clients/client-auditmanager/src/commands/BatchImportEvidenceToAssessmentControlCommand.ts +++ b/clients/client-auditmanager/src/commands/BatchImportEvidenceToAssessmentControlCommand.ts @@ -28,9 +28,8 @@ export interface BatchImportEvidenceToAssessmentControlCommandOutput __MetadataBearer {} /** - *- * Uploads one or more pieces of evidence to the specified control in the assessment in Audit Manager. - *
+ *Uploads one or more pieces of evidence to a control in an Audit Manager + * assessment.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/CreateAssessmentCommand.ts b/clients/client-auditmanager/src/commands/CreateAssessmentCommand.ts index bd712218ae4b..df25cfcab9c4 100644 --- a/clients/client-auditmanager/src/commands/CreateAssessmentCommand.ts +++ b/clients/client-auditmanager/src/commands/CreateAssessmentCommand.ts @@ -22,9 +22,7 @@ export interface CreateAssessmentCommandInput extends CreateAssessmentRequest {} export interface CreateAssessmentCommandOutput extends CreateAssessmentResponse, __MetadataBearer {} /** - *- * Creates an assessment in Audit Manager. - *
+ *Creates an assessment in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/CreateAssessmentFrameworkCommand.ts b/clients/client-auditmanager/src/commands/CreateAssessmentFrameworkCommand.ts index 5f464563ef2b..fa3e52277ef3 100644 --- a/clients/client-auditmanager/src/commands/CreateAssessmentFrameworkCommand.ts +++ b/clients/client-auditmanager/src/commands/CreateAssessmentFrameworkCommand.ts @@ -22,9 +22,7 @@ export interface CreateAssessmentFrameworkCommandInput extends CreateAssessmentF export interface CreateAssessmentFrameworkCommandOutput extends CreateAssessmentFrameworkResponse, __MetadataBearer {} /** - *- * Creates a custom framework in Audit Manager. - *
+ *Creates a custom framework in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/CreateAssessmentReportCommand.ts b/clients/client-auditmanager/src/commands/CreateAssessmentReportCommand.ts index bb44bd406165..b8a6105f56e9 100644 --- a/clients/client-auditmanager/src/commands/CreateAssessmentReportCommand.ts +++ b/clients/client-auditmanager/src/commands/CreateAssessmentReportCommand.ts @@ -22,9 +22,7 @@ export interface CreateAssessmentReportCommandInput extends CreateAssessmentRepo export interface CreateAssessmentReportCommandOutput extends CreateAssessmentReportResponse, __MetadataBearer {} /** - *- * Creates an assessment report for the specified assessment. - *
+ *Creates an assessment report for the specified assessment.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/CreateControlCommand.ts b/clients/client-auditmanager/src/commands/CreateControlCommand.ts index 66e8db60fb2b..e20fc10e15f8 100644 --- a/clients/client-auditmanager/src/commands/CreateControlCommand.ts +++ b/clients/client-auditmanager/src/commands/CreateControlCommand.ts @@ -22,9 +22,7 @@ export interface CreateControlCommandInput extends CreateControlRequest {} export interface CreateControlCommandOutput extends CreateControlResponse, __MetadataBearer {} /** - *- * Creates a new custom control in Audit Manager. - *
+ *Creates a new custom control in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/DeleteAssessmentCommand.ts b/clients/client-auditmanager/src/commands/DeleteAssessmentCommand.ts index 42228e32cc7b..a68d1b45bc6c 100644 --- a/clients/client-auditmanager/src/commands/DeleteAssessmentCommand.ts +++ b/clients/client-auditmanager/src/commands/DeleteAssessmentCommand.ts @@ -22,9 +22,7 @@ export interface DeleteAssessmentCommandInput extends DeleteAssessmentRequest {} export interface DeleteAssessmentCommandOutput extends DeleteAssessmentResponse, __MetadataBearer {} /** - *- * Deletes an assessment in Audit Manager. - *
+ *Deletes an assessment in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/DeleteAssessmentFrameworkCommand.ts b/clients/client-auditmanager/src/commands/DeleteAssessmentFrameworkCommand.ts index 7e2b2442b262..71124d9210e3 100644 --- a/clients/client-auditmanager/src/commands/DeleteAssessmentFrameworkCommand.ts +++ b/clients/client-auditmanager/src/commands/DeleteAssessmentFrameworkCommand.ts @@ -22,9 +22,7 @@ export interface DeleteAssessmentFrameworkCommandInput extends DeleteAssessmentF export interface DeleteAssessmentFrameworkCommandOutput extends DeleteAssessmentFrameworkResponse, __MetadataBearer {} /** - *- * Deletes a custom framework in Audit Manager. - *
+ *Deletes a custom framework in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/DeleteAssessmentFrameworkShareCommand.ts b/clients/client-auditmanager/src/commands/DeleteAssessmentFrameworkShareCommand.ts new file mode 100644 index 000000000000..88ef478fce4b --- /dev/null +++ b/clients/client-auditmanager/src/commands/DeleteAssessmentFrameworkShareCommand.ts @@ -0,0 +1,105 @@ +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, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { AuditManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AuditManagerClient"; +import { DeleteAssessmentFrameworkShareRequest, DeleteAssessmentFrameworkShareResponse } from "../models/models_0"; +import { + deserializeAws_restJson1DeleteAssessmentFrameworkShareCommand, + serializeAws_restJson1DeleteAssessmentFrameworkShareCommand, +} from "../protocols/Aws_restJson1"; + +export interface DeleteAssessmentFrameworkShareCommandInput extends DeleteAssessmentFrameworkShareRequest {} +export interface DeleteAssessmentFrameworkShareCommandOutput + extends DeleteAssessmentFrameworkShareResponse, + __MetadataBearer {} + +/** + *+ * Deletes a share request for a custom framework in Audit Manager. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, DeleteAssessmentFrameworkShareCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, DeleteAssessmentFrameworkShareCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new DeleteAssessmentFrameworkShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteAssessmentFrameworkShareCommandInput} for command's `input` shape. + * @see {@link DeleteAssessmentFrameworkShareCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * + */ +export class DeleteAssessmentFrameworkShareCommand extends $Command< + DeleteAssessmentFrameworkShareCommandInput, + DeleteAssessmentFrameworkShareCommandOutput, + AuditManagerClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: DeleteAssessmentFrameworkShareCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack- * Deletes an assessment report from an assessment in Audit Manager. - *
+ *Deletes an assessment report from an assessment in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/DeleteControlCommand.ts b/clients/client-auditmanager/src/commands/DeleteControlCommand.ts index 642449c1c48b..0a560a9fed21 100644 --- a/clients/client-auditmanager/src/commands/DeleteControlCommand.ts +++ b/clients/client-auditmanager/src/commands/DeleteControlCommand.ts @@ -22,9 +22,7 @@ export interface DeleteControlCommandInput extends DeleteControlRequest {} export interface DeleteControlCommandOutput extends DeleteControlResponse, __MetadataBearer {} /** - *- * Deletes a custom control in Audit Manager. - *
+ *Deletes a custom control in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/DeregisterAccountCommand.ts b/clients/client-auditmanager/src/commands/DeregisterAccountCommand.ts index d811c9c930b4..3090e4a7094f 100644 --- a/clients/client-auditmanager/src/commands/DeregisterAccountCommand.ts +++ b/clients/client-auditmanager/src/commands/DeregisterAccountCommand.ts @@ -22,9 +22,7 @@ export interface DeregisterAccountCommandInput extends DeregisterAccountRequest export interface DeregisterAccountCommandOutput extends DeregisterAccountResponse, __MetadataBearer {} /** - *- * Deregisters an account in Audit Manager. - *
+ *Deregisters an account in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/DeregisterOrganizationAdminAccountCommand.ts b/clients/client-auditmanager/src/commands/DeregisterOrganizationAdminAccountCommand.ts index 89331793cf28..0f62b4743356 100644 --- a/clients/client-auditmanager/src/commands/DeregisterOrganizationAdminAccountCommand.ts +++ b/clients/client-auditmanager/src/commands/DeregisterOrganizationAdminAccountCommand.ts @@ -27,13 +27,14 @@ export interface DeregisterOrganizationAdminAccountCommandOutput __MetadataBearer {} /** - *Removes the specified member Amazon Web Services account as a delegated administrator for Audit Manager.
+ *Removes the specified member Amazon Web Services account as a delegated administrator for + * Audit Manager.
*When you remove a delegated administrator from your Audit Manager settings, or when you - * deregister a delegated administrator from Organizations, you continue to have access - * to the evidence that you previously collected under that account. However, Audit Manager - * will stop collecting and attaching evidence to that delegated administrator account - * moving forward.
+ *When you remove a delegated administrator from your Audit Manager settings, you + * continue to have access to the evidence that you previously collected under that + * account. This is also the case when you deregister a delegated administrator from + * Audit Manager. However, Audit Manager will stop collecting and attaching + * evidence to that delegated administrator account moving forward.
*- * Disassociates an evidence folder from the specified assessment report in Audit Manager. - *
+ *Disassociates an evidence folder from the specified assessment report in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/GetAccountStatusCommand.ts b/clients/client-auditmanager/src/commands/GetAccountStatusCommand.ts index f3affe26f535..b18dedbd9ee8 100644 --- a/clients/client-auditmanager/src/commands/GetAccountStatusCommand.ts +++ b/clients/client-auditmanager/src/commands/GetAccountStatusCommand.ts @@ -22,9 +22,7 @@ export interface GetAccountStatusCommandInput extends GetAccountStatusRequest {} export interface GetAccountStatusCommandOutput extends GetAccountStatusResponse, __MetadataBearer {} /** - *- * Returns the registration status of an account in Audit Manager. - *
+ *Returns the registration status of an account in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/GetAssessmentCommand.ts b/clients/client-auditmanager/src/commands/GetAssessmentCommand.ts index c80d37286830..76671f041cab 100644 --- a/clients/client-auditmanager/src/commands/GetAssessmentCommand.ts +++ b/clients/client-auditmanager/src/commands/GetAssessmentCommand.ts @@ -22,9 +22,7 @@ export interface GetAssessmentCommandInput extends GetAssessmentRequest {} export interface GetAssessmentCommandOutput extends GetAssessmentResponse, __MetadataBearer {} /** - *- * Returns an assessment from Audit Manager. - *
+ *Returns an assessment from Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/GetAssessmentFrameworkCommand.ts b/clients/client-auditmanager/src/commands/GetAssessmentFrameworkCommand.ts index 9acffb762fd1..20a2f0c1b2c2 100644 --- a/clients/client-auditmanager/src/commands/GetAssessmentFrameworkCommand.ts +++ b/clients/client-auditmanager/src/commands/GetAssessmentFrameworkCommand.ts @@ -22,9 +22,7 @@ export interface GetAssessmentFrameworkCommandInput extends GetAssessmentFramewo export interface GetAssessmentFrameworkCommandOutput extends GetAssessmentFrameworkResponse, __MetadataBearer {} /** - *- * Returns a framework from Audit Manager. - *
+ *Returns a framework from Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/GetAssessmentReportUrlCommand.ts b/clients/client-auditmanager/src/commands/GetAssessmentReportUrlCommand.ts index 5c36e857dbf3..9c2a9726ceca 100644 --- a/clients/client-auditmanager/src/commands/GetAssessmentReportUrlCommand.ts +++ b/clients/client-auditmanager/src/commands/GetAssessmentReportUrlCommand.ts @@ -22,9 +22,7 @@ export interface GetAssessmentReportUrlCommandInput extends GetAssessmentReportU export interface GetAssessmentReportUrlCommandOutput extends GetAssessmentReportUrlResponse, __MetadataBearer {} /** - *- * Returns the URL of a specified assessment report in Audit Manager. - *
+ *Returns the URL of an assessment report in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/GetChangeLogsCommand.ts b/clients/client-auditmanager/src/commands/GetChangeLogsCommand.ts index f6b7ba759711..a60f8184ab0e 100644 --- a/clients/client-auditmanager/src/commands/GetChangeLogsCommand.ts +++ b/clients/client-auditmanager/src/commands/GetChangeLogsCommand.ts @@ -22,9 +22,7 @@ export interface GetChangeLogsCommandInput extends GetChangeLogsRequest {} export interface GetChangeLogsCommandOutput extends GetChangeLogsResponse, __MetadataBearer {} /** - *- * Returns a list of changelogs from Audit Manager. - *
+ *Returns a list of changelogs from Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/GetControlCommand.ts b/clients/client-auditmanager/src/commands/GetControlCommand.ts index 765c3fe4ed41..f118cf90f3aa 100644 --- a/clients/client-auditmanager/src/commands/GetControlCommand.ts +++ b/clients/client-auditmanager/src/commands/GetControlCommand.ts @@ -22,9 +22,7 @@ export interface GetControlCommandInput extends GetControlRequest {} export interface GetControlCommandOutput extends GetControlResponse, __MetadataBearer {} /** - *- * Returns a control from Audit Manager. - *
+ *Returns a control from Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/GetDelegationsCommand.ts b/clients/client-auditmanager/src/commands/GetDelegationsCommand.ts index d1e421ea69ea..b6e04602a94a 100644 --- a/clients/client-auditmanager/src/commands/GetDelegationsCommand.ts +++ b/clients/client-auditmanager/src/commands/GetDelegationsCommand.ts @@ -22,9 +22,7 @@ export interface GetDelegationsCommandInput extends GetDelegationsRequest {} export interface GetDelegationsCommandOutput extends GetDelegationsResponse, __MetadataBearer {} /** - *- * Returns a list of delegations from an audit owner to a delegate. - *
+ *Returns a list of delegations from an audit owner to a delegate.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/GetEvidenceByEvidenceFolderCommand.ts b/clients/client-auditmanager/src/commands/GetEvidenceByEvidenceFolderCommand.ts index 448395baa919..7b7430392211 100644 --- a/clients/client-auditmanager/src/commands/GetEvidenceByEvidenceFolderCommand.ts +++ b/clients/client-auditmanager/src/commands/GetEvidenceByEvidenceFolderCommand.ts @@ -24,9 +24,7 @@ export interface GetEvidenceByEvidenceFolderCommandOutput __MetadataBearer {} /** - *- * Returns all evidence from a specified evidence folder in Audit Manager. - *
+ *Returns all evidence from a specified evidence folder in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/GetEvidenceCommand.ts b/clients/client-auditmanager/src/commands/GetEvidenceCommand.ts index a5c5259927ca..1af339723a6a 100644 --- a/clients/client-auditmanager/src/commands/GetEvidenceCommand.ts +++ b/clients/client-auditmanager/src/commands/GetEvidenceCommand.ts @@ -22,9 +22,7 @@ export interface GetEvidenceCommandInput extends GetEvidenceRequest {} export interface GetEvidenceCommandOutput extends GetEvidenceResponse, __MetadataBearer {} /** - *- * Returns evidence from Audit Manager. - *
+ *Returns evidence from Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/GetEvidenceFolderCommand.ts b/clients/client-auditmanager/src/commands/GetEvidenceFolderCommand.ts index 27204f3fbef7..974078be8974 100644 --- a/clients/client-auditmanager/src/commands/GetEvidenceFolderCommand.ts +++ b/clients/client-auditmanager/src/commands/GetEvidenceFolderCommand.ts @@ -22,9 +22,8 @@ export interface GetEvidenceFolderCommandInput extends GetEvidenceFolderRequest export interface GetEvidenceFolderCommandOutput extends GetEvidenceFolderResponse, __MetadataBearer {} /** - *- * Returns an evidence folder from the specified assessment in Audit Manager. - *
+ *Returns an evidence folder from the specified assessment in Audit Manager. + *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/GetEvidenceFoldersByAssessmentCommand.ts b/clients/client-auditmanager/src/commands/GetEvidenceFoldersByAssessmentCommand.ts index 559002e39f96..3bcc07237879 100644 --- a/clients/client-auditmanager/src/commands/GetEvidenceFoldersByAssessmentCommand.ts +++ b/clients/client-auditmanager/src/commands/GetEvidenceFoldersByAssessmentCommand.ts @@ -24,9 +24,8 @@ export interface GetEvidenceFoldersByAssessmentCommandOutput __MetadataBearer {} /** - *- * Returns the evidence folders from a specified assessment in Audit Manager. - *
+ *Returns the evidence folders from a specified assessment in Audit Manager. + *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/GetEvidenceFoldersByAssessmentControlCommand.ts b/clients/client-auditmanager/src/commands/GetEvidenceFoldersByAssessmentControlCommand.ts index e54182da02c1..1be9dd511aa1 100644 --- a/clients/client-auditmanager/src/commands/GetEvidenceFoldersByAssessmentControlCommand.ts +++ b/clients/client-auditmanager/src/commands/GetEvidenceFoldersByAssessmentControlCommand.ts @@ -28,9 +28,8 @@ export interface GetEvidenceFoldersByAssessmentControlCommandOutput __MetadataBearer {} /** - *- * Returns a list of evidence folders associated with a specified control of an assessment in Audit Manager. - *
+ *Returns a list of evidence folders that are associated with a specified control of an + * assessment in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/GetOrganizationAdminAccountCommand.ts b/clients/client-auditmanager/src/commands/GetOrganizationAdminAccountCommand.ts index 2d110d066fed..b2b182c4dc6f 100644 --- a/clients/client-auditmanager/src/commands/GetOrganizationAdminAccountCommand.ts +++ b/clients/client-auditmanager/src/commands/GetOrganizationAdminAccountCommand.ts @@ -24,9 +24,8 @@ export interface GetOrganizationAdminAccountCommandOutput __MetadataBearer {} /** - *- * Returns the name of the delegated Amazon Web Services administrator account for the organization. - *
+ *Returns the name of the delegated Amazon Web Services administrator account for the + * organization.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/GetServicesInScopeCommand.ts b/clients/client-auditmanager/src/commands/GetServicesInScopeCommand.ts index e056a40f90f5..56234f5bc0f2 100644 --- a/clients/client-auditmanager/src/commands/GetServicesInScopeCommand.ts +++ b/clients/client-auditmanager/src/commands/GetServicesInScopeCommand.ts @@ -22,9 +22,8 @@ export interface GetServicesInScopeCommandInput extends GetServicesInScopeReques export interface GetServicesInScopeCommandOutput extends GetServicesInScopeResponse, __MetadataBearer {} /** - *- * Returns a list of the in-scope Amazon Web Services services for the specified assessment. - *
+ *Returns a list of the in-scope Amazon Web Services services for the specified + * assessment.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/GetSettingsCommand.ts b/clients/client-auditmanager/src/commands/GetSettingsCommand.ts index 69a58b7c7dc6..3c9a630b7aff 100644 --- a/clients/client-auditmanager/src/commands/GetSettingsCommand.ts +++ b/clients/client-auditmanager/src/commands/GetSettingsCommand.ts @@ -22,9 +22,7 @@ export interface GetSettingsCommandInput extends GetSettingsRequest {} export interface GetSettingsCommandOutput extends GetSettingsResponse, __MetadataBearer {} /** - *- * Returns the settings for the specified Amazon Web Services account. - *
+ *Returns the settings for the specified 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-auditmanager/src/commands/ListAssessmentFrameworkShareRequestsCommand.ts b/clients/client-auditmanager/src/commands/ListAssessmentFrameworkShareRequestsCommand.ts new file mode 100644 index 000000000000..8a3594fa9178 --- /dev/null +++ b/clients/client-auditmanager/src/commands/ListAssessmentFrameworkShareRequestsCommand.ts @@ -0,0 +1,106 @@ +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, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { AuditManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AuditManagerClient"; +import { + ListAssessmentFrameworkShareRequestsRequest, + ListAssessmentFrameworkShareRequestsResponse, +} from "../models/models_0"; +import { + deserializeAws_restJson1ListAssessmentFrameworkShareRequestsCommand, + serializeAws_restJson1ListAssessmentFrameworkShareRequestsCommand, +} from "../protocols/Aws_restJson1"; + +export interface ListAssessmentFrameworkShareRequestsCommandInput extends ListAssessmentFrameworkShareRequestsRequest {} +export interface ListAssessmentFrameworkShareRequestsCommandOutput + extends ListAssessmentFrameworkShareRequestsResponse, + __MetadataBearer {} + +/** + *Returns a list of sent or received share requests for custom frameworks in Audit Manager.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, ListAssessmentFrameworkShareRequestsCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, ListAssessmentFrameworkShareRequestsCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new ListAssessmentFrameworkShareRequestsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListAssessmentFrameworkShareRequestsCommandInput} for command's `input` shape. + * @see {@link ListAssessmentFrameworkShareRequestsCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * + */ +export class ListAssessmentFrameworkShareRequestsCommand extends $Command< + ListAssessmentFrameworkShareRequestsCommandInput, + ListAssessmentFrameworkShareRequestsCommandOutput, + AuditManagerClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: ListAssessmentFrameworkShareRequestsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack- * Returns a list of the frameworks available in the Audit Manager framework library. - *
+ *Returns a list of the frameworks that are available in the Audit Manager + * framework library.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/ListAssessmentReportsCommand.ts b/clients/client-auditmanager/src/commands/ListAssessmentReportsCommand.ts index f44b8b54b4b5..a8eedb6b0730 100644 --- a/clients/client-auditmanager/src/commands/ListAssessmentReportsCommand.ts +++ b/clients/client-auditmanager/src/commands/ListAssessmentReportsCommand.ts @@ -22,9 +22,7 @@ export interface ListAssessmentReportsCommandInput extends ListAssessmentReports export interface ListAssessmentReportsCommandOutput extends ListAssessmentReportsResponse, __MetadataBearer {} /** - *- * Returns a list of assessment reports created in Audit Manager. - *
+ *Returns a list of assessment reports created in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/ListAssessmentsCommand.ts b/clients/client-auditmanager/src/commands/ListAssessmentsCommand.ts index 715662527a17..c54fd5d020e4 100644 --- a/clients/client-auditmanager/src/commands/ListAssessmentsCommand.ts +++ b/clients/client-auditmanager/src/commands/ListAssessmentsCommand.ts @@ -22,9 +22,7 @@ export interface ListAssessmentsCommandInput extends ListAssessmentsRequest {} export interface ListAssessmentsCommandOutput extends ListAssessmentsResponse, __MetadataBearer {} /** - *- * Returns a list of current and past assessments from Audit Manager. - *
+ *Returns a list of current and past assessments from Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/ListControlsCommand.ts b/clients/client-auditmanager/src/commands/ListControlsCommand.ts index e61bc9231412..f0e86f4d59f4 100644 --- a/clients/client-auditmanager/src/commands/ListControlsCommand.ts +++ b/clients/client-auditmanager/src/commands/ListControlsCommand.ts @@ -22,9 +22,7 @@ export interface ListControlsCommandInput extends ListControlsRequest {} export interface ListControlsCommandOutput extends ListControlsResponse, __MetadataBearer {} /** - *- * Returns a list of controls from Audit Manager. - *
+ *Returns a list of controls from Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/ListKeywordsForDataSourceCommand.ts b/clients/client-auditmanager/src/commands/ListKeywordsForDataSourceCommand.ts index 6f78720e3354..2a3f6596cdb9 100644 --- a/clients/client-auditmanager/src/commands/ListKeywordsForDataSourceCommand.ts +++ b/clients/client-auditmanager/src/commands/ListKeywordsForDataSourceCommand.ts @@ -22,9 +22,7 @@ export interface ListKeywordsForDataSourceCommandInput extends ListKeywordsForDa export interface ListKeywordsForDataSourceCommandOutput extends ListKeywordsForDataSourceResponse, __MetadataBearer {} /** - *- * Returns a list of keywords that pre-mapped to the specified control data source. - *
+ *Returns a list of keywords that are pre-mapped to the specified control data source.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/ListNotificationsCommand.ts b/clients/client-auditmanager/src/commands/ListNotificationsCommand.ts index c798ce06345a..eb80a93c0915 100644 --- a/clients/client-auditmanager/src/commands/ListNotificationsCommand.ts +++ b/clients/client-auditmanager/src/commands/ListNotificationsCommand.ts @@ -22,9 +22,7 @@ export interface ListNotificationsCommandInput extends ListNotificationsRequest export interface ListNotificationsCommandOutput extends ListNotificationsResponse, __MetadataBearer {} /** - *- * Returns a list of all Audit Manager notifications. - *
+ *Returns a list of all Audit Manager notifications.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/ListTagsForResourceCommand.ts b/clients/client-auditmanager/src/commands/ListTagsForResourceCommand.ts index 0b10ab68249d..9a2abfafd63d 100644 --- a/clients/client-auditmanager/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-auditmanager/src/commands/ListTagsForResourceCommand.ts @@ -22,9 +22,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {} /** - *- * Returns a list of tags for the specified resource in Audit Manager. - *
+ *Returns a list of tags for the specified resource in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/RegisterAccountCommand.ts b/clients/client-auditmanager/src/commands/RegisterAccountCommand.ts index b74d1fb3a83f..fb6878cd4fda 100644 --- a/clients/client-auditmanager/src/commands/RegisterAccountCommand.ts +++ b/clients/client-auditmanager/src/commands/RegisterAccountCommand.ts @@ -22,9 +22,7 @@ export interface RegisterAccountCommandInput extends RegisterAccountRequest {} export interface RegisterAccountCommandOutput extends RegisterAccountResponse, __MetadataBearer {} /** - *- * Enables Audit Manager for the specified Amazon Web Services account. - *
+ *Enables Audit Manager for the specified 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-auditmanager/src/commands/RegisterOrganizationAdminAccountCommand.ts b/clients/client-auditmanager/src/commands/RegisterOrganizationAdminAccountCommand.ts index 758ad67561ad..4cd88d5237db 100644 --- a/clients/client-auditmanager/src/commands/RegisterOrganizationAdminAccountCommand.ts +++ b/clients/client-auditmanager/src/commands/RegisterOrganizationAdminAccountCommand.ts @@ -24,9 +24,8 @@ export interface RegisterOrganizationAdminAccountCommandOutput __MetadataBearer {} /** - *- * Enables an Amazon Web Services account within the organization as the delegated administrator for Audit Manager. - *
+ *Enables an Amazon Web Services account within the organization as the delegated + * administrator for Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/StartAssessmentFrameworkShareCommand.ts b/clients/client-auditmanager/src/commands/StartAssessmentFrameworkShareCommand.ts new file mode 100644 index 000000000000..35d2f475de20 --- /dev/null +++ b/clients/client-auditmanager/src/commands/StartAssessmentFrameworkShareCommand.ts @@ -0,0 +1,110 @@ +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, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { AuditManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AuditManagerClient"; +import { StartAssessmentFrameworkShareRequest, StartAssessmentFrameworkShareResponse } from "../models/models_0"; +import { + deserializeAws_restJson1StartAssessmentFrameworkShareCommand, + serializeAws_restJson1StartAssessmentFrameworkShareCommand, +} from "../protocols/Aws_restJson1"; + +export interface StartAssessmentFrameworkShareCommandInput extends StartAssessmentFrameworkShareRequest {} +export interface StartAssessmentFrameworkShareCommandOutput + extends StartAssessmentFrameworkShareResponse, + __MetadataBearer {} + +/** + *Creates a share request for a custom framework in Audit Manager.
+ *The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires.
+ *When you invoke the StartAssessmentFrameworkShare API, you are about to
+ * share a custom framework with another Amazon Web Services account. You may not share a
+ * custom framework that is derived from a standard framework if the standard framework is
+ * designated as not eligible for sharing by Amazon Web Services, unless you have obtained
+ * permission to do so from the owner of the standard framework. To learn more about which
+ * standard frameworks are eligible for sharing, see Framework sharing eligibility in the Audit Manager User
+ * Guide.
- * Tags the specified resource in Audit Manager. - *
+ *Tags the specified resource in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/UntagResourceCommand.ts b/clients/client-auditmanager/src/commands/UntagResourceCommand.ts index 930e619c646d..1cf70cd70461 100644 --- a/clients/client-auditmanager/src/commands/UntagResourceCommand.ts +++ b/clients/client-auditmanager/src/commands/UntagResourceCommand.ts @@ -22,9 +22,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {} export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {} /** - *- * Removes a tag from a resource in Audit Manager. - *
+ *Removes a tag from a resource in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/UpdateAssessmentCommand.ts b/clients/client-auditmanager/src/commands/UpdateAssessmentCommand.ts index 5a3b7a28150f..846b955943a9 100644 --- a/clients/client-auditmanager/src/commands/UpdateAssessmentCommand.ts +++ b/clients/client-auditmanager/src/commands/UpdateAssessmentCommand.ts @@ -22,9 +22,7 @@ export interface UpdateAssessmentCommandInput extends UpdateAssessmentRequest {} export interface UpdateAssessmentCommandOutput extends UpdateAssessmentResponse, __MetadataBearer {} /** - *- * Edits an Audit Manager assessment. - *
+ *Edits an Audit Manager assessment.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/UpdateAssessmentControlCommand.ts b/clients/client-auditmanager/src/commands/UpdateAssessmentControlCommand.ts index 777b8209c23b..790a4f17fac1 100644 --- a/clients/client-auditmanager/src/commands/UpdateAssessmentControlCommand.ts +++ b/clients/client-auditmanager/src/commands/UpdateAssessmentControlCommand.ts @@ -22,9 +22,7 @@ export interface UpdateAssessmentControlCommandInput extends UpdateAssessmentCon export interface UpdateAssessmentControlCommandOutput extends UpdateAssessmentControlResponse, __MetadataBearer {} /** - *- * Updates a control within an assessment in Audit Manager. - *
+ *Updates a control within an assessment in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/UpdateAssessmentControlSetStatusCommand.ts b/clients/client-auditmanager/src/commands/UpdateAssessmentControlSetStatusCommand.ts index ccf2a158dfac..90c65d164d25 100644 --- a/clients/client-auditmanager/src/commands/UpdateAssessmentControlSetStatusCommand.ts +++ b/clients/client-auditmanager/src/commands/UpdateAssessmentControlSetStatusCommand.ts @@ -24,9 +24,7 @@ export interface UpdateAssessmentControlSetStatusCommandOutput __MetadataBearer {} /** - *- * Updates the status of a control set in an Audit Manager assessment. - *
+ *Updates the status of a control set in an Audit Manager assessment.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/UpdateAssessmentFrameworkCommand.ts b/clients/client-auditmanager/src/commands/UpdateAssessmentFrameworkCommand.ts index 23f301558064..d5bba4340759 100644 --- a/clients/client-auditmanager/src/commands/UpdateAssessmentFrameworkCommand.ts +++ b/clients/client-auditmanager/src/commands/UpdateAssessmentFrameworkCommand.ts @@ -22,9 +22,7 @@ export interface UpdateAssessmentFrameworkCommandInput extends UpdateAssessmentF export interface UpdateAssessmentFrameworkCommandOutput extends UpdateAssessmentFrameworkResponse, __MetadataBearer {} /** - *- * Updates a custom framework in Audit Manager. - *
+ *Updates a custom framework in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/UpdateAssessmentFrameworkShareCommand.ts b/clients/client-auditmanager/src/commands/UpdateAssessmentFrameworkShareCommand.ts new file mode 100644 index 000000000000..554733f69974 --- /dev/null +++ b/clients/client-auditmanager/src/commands/UpdateAssessmentFrameworkShareCommand.ts @@ -0,0 +1,103 @@ +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, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { AuditManagerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AuditManagerClient"; +import { UpdateAssessmentFrameworkShareRequest, UpdateAssessmentFrameworkShareResponse } from "../models/models_0"; +import { + deserializeAws_restJson1UpdateAssessmentFrameworkShareCommand, + serializeAws_restJson1UpdateAssessmentFrameworkShareCommand, +} from "../protocols/Aws_restJson1"; + +export interface UpdateAssessmentFrameworkShareCommandInput extends UpdateAssessmentFrameworkShareRequest {} +export interface UpdateAssessmentFrameworkShareCommandOutput + extends UpdateAssessmentFrameworkShareResponse, + __MetadataBearer {} + +/** + *Updates a share request for a custom framework in Audit Manager.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { AuditManagerClient, UpdateAssessmentFrameworkShareCommand } from "@aws-sdk/client-auditmanager"; // ES Modules import + * // const { AuditManagerClient, UpdateAssessmentFrameworkShareCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import + * const client = new AuditManagerClient(config); + * const command = new UpdateAssessmentFrameworkShareCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateAssessmentFrameworkShareCommandInput} for command's `input` shape. + * @see {@link UpdateAssessmentFrameworkShareCommandOutput} for command's `response` shape. + * @see {@link AuditManagerClientResolvedConfig | config} for command's `input` shape. + * + */ +export class UpdateAssessmentFrameworkShareCommand extends $Command< + UpdateAssessmentFrameworkShareCommandInput, + UpdateAssessmentFrameworkShareCommandOutput, + AuditManagerClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: UpdateAssessmentFrameworkShareCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStack- * Updates the status of an assessment in Audit Manager. - *
+ *Updates the status of an assessment in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/UpdateControlCommand.ts b/clients/client-auditmanager/src/commands/UpdateControlCommand.ts index 4b1647cacd81..bb1f2b089338 100644 --- a/clients/client-auditmanager/src/commands/UpdateControlCommand.ts +++ b/clients/client-auditmanager/src/commands/UpdateControlCommand.ts @@ -22,9 +22,7 @@ export interface UpdateControlCommandInput extends UpdateControlRequest {} export interface UpdateControlCommandOutput extends UpdateControlResponse, __MetadataBearer {} /** - *- * Updates a custom control in Audit Manager. - *
+ *Updates a custom control in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/UpdateSettingsCommand.ts b/clients/client-auditmanager/src/commands/UpdateSettingsCommand.ts index 31bf1418792b..29d12dddd57d 100644 --- a/clients/client-auditmanager/src/commands/UpdateSettingsCommand.ts +++ b/clients/client-auditmanager/src/commands/UpdateSettingsCommand.ts @@ -22,9 +22,7 @@ export interface UpdateSettingsCommandInput extends UpdateSettingsRequest {} export interface UpdateSettingsCommandOutput extends UpdateSettingsResponse, __MetadataBearer {} /** - *- * Updates Audit Manager settings for the current user account. - *
+ *Updates Audit Manager settings for the current user account.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/ValidateAssessmentReportIntegrityCommand.ts b/clients/client-auditmanager/src/commands/ValidateAssessmentReportIntegrityCommand.ts index f8b833fe8abd..90b4d4e57720 100644 --- a/clients/client-auditmanager/src/commands/ValidateAssessmentReportIntegrityCommand.ts +++ b/clients/client-auditmanager/src/commands/ValidateAssessmentReportIntegrityCommand.ts @@ -27,9 +27,7 @@ export interface ValidateAssessmentReportIntegrityCommandOutput __MetadataBearer {} /** - *- * Validates the integrity of an assessment report in Audit Manager. - *
+ *Validates the integrity of an assessment report in Audit Manager.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-auditmanager/src/commands/index.ts b/clients/client-auditmanager/src/commands/index.ts index dc83e7a25185..22aa2e52745c 100644 --- a/clients/client-auditmanager/src/commands/index.ts +++ b/clients/client-auditmanager/src/commands/index.ts @@ -10,6 +10,7 @@ export * from "./CreateAssessmentReportCommand"; export * from "./CreateControlCommand"; export * from "./DeleteAssessmentCommand"; export * from "./DeleteAssessmentFrameworkCommand"; +export * from "./DeleteAssessmentFrameworkShareCommand"; export * from "./DeleteAssessmentReportCommand"; export * from "./DeleteControlCommand"; export * from "./DeregisterAccountCommand"; @@ -30,6 +31,7 @@ export * from "./GetEvidenceFoldersByAssessmentControlCommand"; export * from "./GetOrganizationAdminAccountCommand"; export * from "./GetServicesInScopeCommand"; export * from "./GetSettingsCommand"; +export * from "./ListAssessmentFrameworkShareRequestsCommand"; export * from "./ListAssessmentFrameworksCommand"; export * from "./ListAssessmentReportsCommand"; export * from "./ListAssessmentsCommand"; @@ -39,12 +41,14 @@ export * from "./ListNotificationsCommand"; export * from "./ListTagsForResourceCommand"; export * from "./RegisterAccountCommand"; export * from "./RegisterOrganizationAdminAccountCommand"; +export * from "./StartAssessmentFrameworkShareCommand"; export * from "./TagResourceCommand"; export * from "./UntagResourceCommand"; export * from "./UpdateAssessmentCommand"; export * from "./UpdateAssessmentControlCommand"; export * from "./UpdateAssessmentControlSetStatusCommand"; export * from "./UpdateAssessmentFrameworkCommand"; +export * from "./UpdateAssessmentFrameworkShareCommand"; export * from "./UpdateAssessmentStatusCommand"; export * from "./UpdateControlCommand"; export * from "./UpdateSettingsCommand"; diff --git a/clients/client-auditmanager/src/models/models_0.ts b/clients/client-auditmanager/src/models/models_0.ts index 639b0bf5404b..a3e5c6f644b0 100644 --- a/clients/client-auditmanager/src/models/models_0.ts +++ b/clients/client-auditmanager/src/models/models_0.ts @@ -1,9 +1,8 @@ import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types"; /** - *- * Your account is not registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. - *
+ *Your account isn't registered with Audit Manager. Check the delegated + * administrator setup on the Audit Manager settings page, and try again.
*/ export interface AccessDeniedException extends __SmithyException, $MetadataBearer { name: "AccessDeniedException"; @@ -38,29 +37,22 @@ export enum ActionEnum { } /** - *- * The wrapper of Amazon Web Services account details, such as account ID, email address, and so on. - *
+ *The wrapper of Amazon Web Services account details, such as account ID or email address. + *
*/ export interface AWSAccount { /** - *- * The identifier for the specified Amazon Web Services account. - *
+ *The identifier for the Amazon Web Services account.
*/ id?: string; /** - *- * The email address associated with the specified Amazon Web Services account. - *
+ *The email address that's associated with the Amazon Web Services account.
*/ emailAddress?: string; /** - *- * The name of the specified Amazon Web Services account. - *
+ *The name of the Amazon Web Services account.
*/ name?: string; } @@ -75,29 +67,22 @@ export namespace AWSAccount { } /** - *- * A comment posted by a user on a control. This includes the author's name, the comment text, and a timestamp. - *
+ *A comment that's posted by a user on a control. This includes the author's name, the + * comment text, and a timestamp.
*/ export interface ControlComment { /** - *- * The name of the user who authored the comment. - *
+ *The name of the user who authored the comment.
*/ authorName?: string; /** - *- * The body text of a control comment. - *
+ *The body text of a control comment.
*/ commentBody?: string; /** - *- * The time when the comment was posted. - *
+ *The time when the comment was posted.
*/ postedDate?: Date; } @@ -125,71 +110,51 @@ export enum ControlStatus { } /** - *- * The control entity that represents a standard or custom control used in an Audit Manager assessment. - *
+ *The control entity that represents a standard control or a custom control in an Audit Manager assessment.
*/ export interface AssessmentControl { /** - *- * The identifier for the specified control. - *
+ *The identifier for the control.
*/ id?: string; /** - *- * The name of the specified control. - *
+ *The name of the control.
*/ name?: string; /** - *- * The description of the specified control. - *
+ *The description of the control.
*/ description?: string; /** - *- * The status of the specified control. - *
+ *The status of the control.
*/ status?: ControlStatus | string; /** - *- * The response of the specified control. - *
+ *The response of the control.
*/ response?: ControlResponse | string; /** - *- * The list of comments attached to the specified control. - *
+ *The list of comments that's attached to the control.
*/ comments?: ControlComment[]; /** - *- * The list of data sources for the specified evidence. - *
+ *The list of data sources for the evidence.
*/ evidenceSources?: string[]; /** - *- * The amount of evidence generated for the control. - *
+ *The amount of evidence that's generated for the control.
*/ evidenceCount?: number; /** - *- * The amount of evidence in the assessment report. - *
+ *The amount of evidence in the assessment report.
*/ assessmentReportEvidenceCount?: number; } @@ -215,54 +180,43 @@ export enum DelegationStatus { } /** - *- * The assignment of a control set to a delegate for review. - *
+ *The assignment of a control set to a delegate for review.
*/ export interface Delegation { /** - *- * The unique identifier for the delegation. - *
+ *The unique identifier for the delegation.
*/ id?: string; /** - *- * The name of the associated assessment. - *
+ *The name of the assessment that's associated with the delegation.
*/ assessmentName?: string; /** - *- * The identifier for the associated assessment. - *
+ *The identifier for the assessment that's associated with the delegation.
*/ assessmentId?: string; /** - *- * The status of the delegation. - *
+ *The status of the delegation.
*/ status?: DelegationStatus | string; /** - *- * The Amazon Resource Name (ARN) of the IAM role. - *
+ *The Amazon Resource Name (ARN) of the IAM role.
*/ roleArn?: string; /** - *- * The type of customer persona. - *
+ *The type of customer persona.
*In CreateAssessment, roleType can only be PROCESS_OWNER.
In UpdateSettings, roleType can only be PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
In CreateAssessment, roleType can only be
+ * PROCESS_OWNER.
In UpdateSettings, roleType can only be
+ * PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be
+ * RESOURCE_OWNER.
- * Specifies when the delegation was last updated. - *
+ *Specifies when the delegation was last updated.
*/ lastUpdated?: Date; /** - *- * The identifier for the associated control set. - *
+ *The identifier for the control set that's associated with the delegation.
*/ controlSetId?: string; /** - *- * The comment related to the delegation. - *
+ *The comment that's related to the delegation.
*/ comment?: string; @@ -309,27 +257,26 @@ export namespace Delegation { } /** - *- * The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN). - *
+ *The wrapper that contains the Audit Manager role information of the current + * user. This includes the role type and IAM Amazon Resource Name (ARN). + *
*/ export interface Role { /** - *- * The type of customer persona. - *
+ *The type of customer persona.
*In CreateAssessment, roleType can only be PROCESS_OWNER.
In UpdateSettings, roleType can only be PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
In CreateAssessment, roleType can only be
+ * PROCESS_OWNER.
In UpdateSettings, roleType can only be
+ * PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be
+ * RESOURCE_OWNER.
- * The Amazon Resource Name (ARN) of the IAM role. - *
+ *The Amazon Resource Name (ARN) of the IAM role.
*/ roleArn?: string; } @@ -350,64 +297,49 @@ export enum ControlSetStatus { } /** - *- * Represents a set of controls in an Audit Manager assessment. - *
+ *Represents a set of controls in an Audit Manager assessment.
*/ export interface AssessmentControlSet { /** - *- * The identifier of the control set in the assessment. This is the control set name in a plain string format. - *
+ *The identifier of the control set in the assessment. This is the control set name in a + * plain string format.
*/ id?: string; /** - *- * The description for the control set. - *
+ *The description for the control set.
*/ description?: string; /** - *- * Specifies the current status of the control set. - *
+ *Specifies the current status of the control set.
*/ status?: ControlSetStatus | string; /** - *- * The roles associated with the control set. - *
+ *The roles that are associated with the control set.
*/ roles?: Role[]; /** - *- * The list of controls contained with the control set. - *
+ *The list of controls that's contained with the control set.
*/ controls?: AssessmentControl[]; /** - *- * The delegations associated with the control set. - *
+ *The delegations that are associated with the control set.
*/ delegations?: Delegation[]; /** - *- * The total number of evidence objects retrieved automatically for the control set. - *
+ *The total number of evidence objects that are retrieved automatically for the control + * set.
*/ systemEvidenceCount?: number; /** - *- * The total number of evidence objects uploaded manually to the control set. - *
+ *The total number of evidence objects that are uploaded manually to the control set. + *
*/ manualEvidenceCount?: number; } @@ -422,36 +354,27 @@ export namespace AssessmentControlSet { } /** - *- * The metadata of a framework, such as the name, ID, description, and so on. - *
+ *The metadata of a framework, such as the name, ID, or description.
*/ export interface FrameworkMetadata { /** - *- * The name of the framework. - *
+ *The name of the framework.
*/ name?: string; /** - *- * The description of the framework. - *
+ *The description of the framework.
*/ description?: string; /** - *- * The logo associated with the framework. - *
+ *The logo that's associated with the framework.
*/ logo?: string; /** - *- * The compliance standard associated with the framework, such as PCI-DSS or HIPAA. - *
+ *The compliance standard that's associated with the framework. For example, this could + * be PCI DSS or HIPAA.
*/ complianceType?: string; } @@ -466,36 +389,27 @@ export namespace FrameworkMetadata { } /** - *- * The file used to structure and automate Audit Manager assessments for a given compliance standard. - *
+ *The file used to structure and automate Audit Manager assessments for a given + * compliance standard.
*/ export interface AssessmentFramework { /** - *- * The unique identifier for the framework. - *
+ *The unique identifier for the framework.
*/ id?: string; /** - *- * The Amazon Resource Name (ARN) of the specified framework. - *
+ *The Amazon Resource Name (ARN) of the framework.
*/ arn?: string; /** - *- * The metadata of a framework, such as the name, ID, description, and so on. - *
+ *The metadata of a framework, such as the name, ID, or description.
*/ metadata?: FrameworkMetadata; /** - *- * The control sets associated with the framework. - *
+ *The control sets that are associated with the framework.
*/ controlSets?: AssessmentControlSet[]; } @@ -514,22 +428,17 @@ export enum AssessmentReportDestinationType { } /** - *- * The location in which Audit Manager saves assessment reports for the given assessment. - *
+ *The location where Audit Manager saves assessment reports for the given + * assessment.
*/ export interface AssessmentReportsDestination { /** - *- * The destination type, such as Amazon S3. - *
+ *The destination type, such as Amazon S3.
*/ destinationType?: AssessmentReportDestinationType | string; /** - *- * The destination of the assessment report. - *
+ *The destination of the assessment report.
*/ destination?: string; } @@ -544,15 +453,12 @@ export namespace AssessmentReportsDestination { } /** - *- * An Amazon Web Service such as Amazon S3, CloudTrail, and so on. - *
+ *An Amazon Web Service such as Amazon S3 or CloudTrail. + *
*/ export interface AWSService { /** - *- * The name of the Amazon Web Service. - *
+ *The name of the Amazon Web Service.
*/ serviceName?: string; } @@ -567,22 +473,19 @@ export namespace AWSService { } /** - *- * The wrapper that contains the Amazon Web Services accounts and services in scope for the assessment. - *
+ *The wrapper that contains the Amazon Web Services accounts and services that are in + * scope for the assessment.
*/ export interface Scope { /** - *- * The Amazon Web Services accounts included in the scope of the assessment. - *
+ *The Amazon Web Services accounts that are included in the scope of the assessment. + *
*/ awsAccounts?: AWSAccount[]; /** - *- * The Amazon Web Services services included in the scope of the assessment. - *
+ *The Amazon Web Services services that are included in the scope of the assessment. + *
*/ awsServices?: AWSService[]; } @@ -602,85 +505,63 @@ export enum AssessmentStatus { } /** - *- * The metadata associated with the specified assessment. - *
+ *The metadata that's associated with the specified assessment.
*/ export interface AssessmentMetadata { /** - *- * The name of the assessment. - *
+ *The name of the assessment.
*/ name?: string; /** - *- * The unique identifier for the assessment. - *
+ *The unique identifier for the assessment.
*/ id?: string; /** - *- * The description of the assessment. - *
+ *The description of the assessment.
*/ description?: string; /** - *- * The name of a compliance standard related to the assessment, such as PCI-DSS. + *
The name of the compliance standard that's related to the assessment, such as PCI-DSS. *
*/ complianceType?: string; /** - *- * The overall status of the assessment. - *
+ *The overall status of the assessment.
*/ status?: AssessmentStatus | string; /** - *- * The destination in which evidence reports are stored for the specified assessment. - *
+ *The destination that evidence reports are stored in for the assessment.
*/ assessmentReportsDestination?: AssessmentReportsDestination; /** - *- * The wrapper of Amazon Web Services accounts and services in scope for the assessment. - *
+ *The wrapper of Amazon Web Services accounts and services that are in scope for the + * assessment.
*/ scope?: Scope; /** - *- * The roles associated with the assessment. - *
+ *The roles that are associated with the assessment.
*/ roles?: Role[]; /** - *- * The delegations associated with the assessment. - *
+ *The delegations that are associated with the assessment.
*/ delegations?: Delegation[]; /** - *- * Specifies when the assessment was created. - *
+ *Specifies when the assessment was created.
*/ creationTime?: Date; /** - *- * The time of the most recent update. - *
+ *The time of the most recent update.
*/ lastUpdated?: Date; } @@ -695,43 +576,33 @@ export namespace AssessmentMetadata { } /** - *- * An entity that defines the scope of audit evidence collected by Audit Manager. An Audit Manager assessment is an implementation of an Audit Manager framework. - *
+ *An entity that defines the scope of audit evidence collected by Audit Manager. + * An Audit Manager assessment is an implementation of an Audit Manager + * framework.
*/ export interface Assessment { /** - *- * The Amazon Resource Name (ARN) of the assessment. - *
+ *The Amazon Resource Name (ARN) of the assessment.
*/ arn?: string; /** - *- * The Amazon Web Services account associated with the assessment. - *
+ *The Amazon Web Services account that's associated with the assessment.
*/ awsAccount?: AWSAccount; /** - *- * The metadata for the specified assessment. - *
+ *The metadata for the assessment.
*/ metadata?: AssessmentMetadata; /** - *- * The framework from which the assessment was created. - *
+ *The framework that the assessment was created from.
*/ framework?: AssessmentFramework; /** - *- * The tags associated with the assessment. - *
+ *The tags that are associated with the assessment.
*/ tags?: { [key: string]: string }; } @@ -746,135 +617,102 @@ export namespace Assessment { } /** - *- * The folder in which Audit Manager stores evidence for an assessment. - *
+ *The folder where Audit Manager stores evidence for an assessment.
*/ export interface AssessmentEvidenceFolder { /** - *- * The name of the specified evidence folder. - *
+ *The name of the evidence folder.
*/ name?: string; /** - *- * The date when the first evidence was added to the evidence folder. - *
+ *The date when the first evidence was added to the evidence folder.
*/ date?: Date; /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId?: string; /** - *- * The identifier for the control set. - *
+ *The identifier for the control set.
*/ controlSetId?: string; /** - *- * - * The unique identifier for the specified control. - *
+ *The unique identifier for the control.
*/ controlId?: string; /** - *- * The identifier for the folder in which evidence is stored. - *
+ *The identifier for the folder that the evidence is stored in.
*/ id?: string; /** - *- * The Amazon Web Service from which the evidence was collected. - *
+ *The Amazon Web Service that the evidence was collected from.
*/ dataSource?: string; /** - *- * The name of the user who created the evidence folder. - *
+ *The name of the user who created the evidence folder.
*/ author?: string; /** - *- * The total amount of evidence in the evidence folder. - *
+ *The total amount of evidence in the evidence folder.
*/ totalEvidence?: number; /** - *- * The total count of evidence included in the assessment report. - *
+ *The total count of evidence that's included in the assessment report.
*/ assessmentReportSelectionCount?: number; /** - *- * The name of the control. - *
+ *The name of the control.
*/ controlName?: string; /** - *- * The amount of evidence included in the evidence folder. - *
+ *The amount of evidence that's included in the evidence folder.
*/ evidenceResourcesIncludedCount?: number; /** - *- * The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other Amazon Web Services services such as Amazon EC2, Amazon S3, or IAM. - *
+ *The number of evidence that falls under the configuration data category. This + * evidence is collected from configuration snapshots of other Amazon Web Services services such as Amazon EC2, Amazon S3, or IAM.
*/ evidenceByTypeConfigurationDataCount?: number; /** - *- * The number of evidence that falls under the manual category. This evidence is imported manually. - *
+ *The number of evidence that falls under the manual category. This evidence is imported + * manually.
*/ evidenceByTypeManualCount?: number; /** - *- * The number of evidence that falls under the compliance check category. This evidence is collected from Config or Security Hub. - *
+ *The number of evidence that falls under the compliance check category. This evidence is + * collected from Config or Security Hub.
*/ evidenceByTypeComplianceCheckCount?: number; /** - *- * The total number of issues that were reported directly from Security Hub, Config, or both. - *
+ *The total number of issues that were reported directly from Security Hub, + * Config, or both.
*/ evidenceByTypeComplianceCheckIssuesCount?: number; /** - *- * The number of evidence that falls under the user activity category. This evidence is collected from CloudTrail logs. - *
+ *The number of evidence that falls under the user activity category. This evidence is + * collected from CloudTrail logs.
*/ evidenceByTypeUserActivityCount?: number; /** - *- * The total number of Amazon Web Services resources assessed to generate the evidence. - *
+ *The total number of Amazon Web Services resources that were assessed to generate the + * evidence.
*/ evidenceAwsServiceSourceCount?: number; } @@ -894,85 +732,62 @@ export enum FrameworkType { } /** - *- * The metadata associated with a standard or custom framework. - *
+ *The metadata that's associated with a standard framework or a custom framework.
*/ export interface AssessmentFrameworkMetadata { /** - *- * The Amazon Resource Name (ARN) of the framework. - *
+ *The Amazon Resource Name (ARN) of the framework.
*/ arn?: string; /** - *- * The unique identified for the specified framework. - *
+ *The unique identifier for the framework.
*/ id?: string; /** - *- * The framework type, such as standard or custom. - *
+ *The framework type, such as a standard framework or a custom framework.
*/ type?: FrameworkType | string; /** - *- * The name of the specified framework. - *
+ *The name of the framework.
*/ name?: string; /** - *- * The description of the specified framework. - *
+ *The description of the framework.
*/ description?: string; /** - *- * The logo associated with the framework. - *
+ *The logo that's associated with the framework.
*/ logo?: string; /** - *- * The compliance type that the new custom framework supports, such as CIS or HIPAA. - *
+ *The compliance type that the new custom framework supports, such as CIS or HIPAA. + *
*/ complianceType?: string; /** - *- * The number of controls associated with the specified framework. - *
+ *The number of controls that are associated with the framework.
*/ controlsCount?: number; /** - *- * The number of control sets associated with the specified framework. - *
+ *The number of control sets that are associated with the framework.
*/ controlSetsCount?: number; /** - *- * Specifies when the framework was created. - *
+ *Specifies when the framework was created.
*/ createdAt?: Date; /** - *- * Specifies when the framework was most recently updated. - *
+ *Specifies when the framework was most recently updated.
*/ lastUpdatedAt?: Date; } @@ -986,65 +801,149 @@ export namespace AssessmentFrameworkMetadata { }); } +export enum ShareRequestStatus { + ACTIVE = "ACTIVE", + DECLINED = "DECLINED", + EXPIRED = "EXPIRED", + EXPIRING = "EXPIRING", + FAILED = "FAILED", + REPLICATING = "REPLICATING", + REVOKED = "REVOKED", + SHARED = "SHARED", +} + +/** + *Represents a share request for a custom framework in Audit Manager.
+ */ +export interface AssessmentFrameworkShareRequest { + /** + *The unique identifier for the share request.
+ */ + id?: string; + + /** + *The unique identifier for the shared custom framework.
+ */ + frameworkId?: string; + + /** + *The name of the custom framework that the share request is for.
+ */ + frameworkName?: string; + + /** + *The description of the shared custom framework.
+ */ + frameworkDescription?: string; + + /** + *The status of the share request.
+ */ + status?: ShareRequestStatus | string; + + /** + *The Amazon Web Services account of the sender.
+ */ + sourceAccount?: string; + + /** + *The Amazon Web Services account of the recipient.
+ */ + destinationAccount?: string; + + /** + *The Amazon Web Services Region of the recipient.
+ */ + destinationRegion?: string; + + /** + *The time when the share request expires.
+ */ + expirationTime?: Date; + + /** + *The time when the share request was created.
+ */ + creationTime?: Date; + + /** + *Specifies when the share request was last updated.
+ */ + lastUpdated?: Date; + + /** + *An optional comment from the sender about the share request.
+ */ + comment?: string; + + /** + *The number of standard controls that are part of the shared custom framework.
+ */ + standardControlsCount?: number; + + /** + *The number of custom controls that are part of the shared custom framework.
+ */ + customControlsCount?: number; + + /** + *The compliance type that the shared custom framework supports, such as CIS or HIPAA.
+ */ + complianceType?: string; +} + +export namespace AssessmentFrameworkShareRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AssessmentFrameworkShareRequest): any => ({ + ...obj, + }); +} + /** - *- * A metadata object associated with an assessment in Audit Manager. - *
+ *A metadata object that's associated with an assessment in Audit Manager. + *
*/ export interface AssessmentMetadataItem { /** - *- * The name of the assessment. - *
+ *The name of the assessment.
*/ name?: string; /** - *- * The unique identifier for the assessment. - *
+ *The unique identifier for the assessment.
*/ id?: string; /** - *- * The name of the compliance standard related to the assessment, such as PCI-DSS. + *
The name of the compliance standard that's related to the assessment, such as PCI-DSS. *
*/ complianceType?: string; /** - *- * The current status of the assessment. - *
+ *The current status of the assessment.
*/ status?: AssessmentStatus | string; /** - *- * The roles associated with the assessment. - *
+ *The roles that are associated with the assessment.
*/ roles?: Role[]; /** - *- * The delegations associated with the assessment. - *
+ *The delegations that are associated with the assessment.
*/ delegations?: Delegation[]; /** - *- * Specifies when the assessment was created. - *
+ *Specifies when the assessment was created.
*/ creationTime?: Date; /** - *- * The time of the most recent update. - *
+ *The time of the most recent update.
*/ lastUpdated?: Date; } @@ -1065,71 +964,54 @@ export enum AssessmentReportStatus { } /** - *- * A finalized document generated from an Audit Manager assessment. These reports summarize the relevant evidence collected for your audit, and link to the relevant evidence folders which are named and organized according to the controls specified in your assessment. - *
+ *A finalized document that's generated from an Audit Manager assessment. These + * reports summarize the relevant evidence that was collected for your audit, and link to the + * relevant evidence folders. These evidence folders are named and organized according to the + * controls that are specified in your assessment.
*/ export interface AssessmentReport { /** - *- * The unique identifier for the specified assessment report. - *
+ *The unique identifier for the assessment report.
*/ id?: string; /** - *- * The name given to the assessment report. - *
+ *The name that's given to the assessment report.
*/ name?: string; /** - *- * The description of the specified assessment report. - *
+ *The description of the specified assessment report.
*/ description?: string; /** - *- * The identifier for the specified Amazon Web Services account. - *
+ *The identifier for the specified Amazon Web Services account.
*/ awsAccountId?: string; /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the specified assessment.
*/ assessmentId?: string; /** - *- * The name of the associated assessment. - *
+ *The name of the associated assessment.
*/ assessmentName?: string; /** - *- * The name of the user who created the assessment report. - *
+ *The name of the user who created the assessment report.
*/ author?: string; /** - *- * The current status of the specified assessment report. - *
+ *The current status of the specified assessment report.
*/ status?: AssessmentReportStatus | string; /** - *- * Specifies when the assessment report was created. - *
+ *Specifies when the assessment report was created.
*/ creationTime?: Date; } @@ -1144,29 +1026,22 @@ export namespace AssessmentReport { } /** - *
- * An error entity for the AssessmentReportEvidence API. This is used to provide more meaningful errors than a simple string message.
- *
An error entity for the AssessmentReportEvidence API. This is used to
+ * provide more meaningful errors than a simple string message.
- * The identifier for the evidence. - *
+ *The identifier for the evidence.
*/ evidenceId?: string; /** - *
- * The error code returned by the AssessmentReportEvidence API.
- *
The error code that the AssessmentReportEvidence API returned.
- * The error message returned by the AssessmentReportEvidence API.
- *
The error message that the AssessmentReportEvidence API returned.
- * The metadata objects associated with the specified assessment report. - *
+ *The metadata objects that are associated with the specified assessment report.
*/ export interface AssessmentReportMetadata { /** - *- * The unique identifier for the assessment report. - *
+ *The unique identifier for the assessment report.
*/ id?: string; /** - *- * The name of the assessment report. - *
+ *The name of the assessment report.
*/ name?: string; /** - *- * The description of the specified assessment report. - *
+ *The description of the assessment report.
*/ description?: string; /** - *- * The unique identifier for the associated assessment. - *
+ *The unique identifier for the associated assessment.
*/ assessmentId?: string; /** - *The name of the associated assessment. - *
+ *The name of the associated assessment.
*/ assessmentName?: string; /** - *- * The name of the user who created the assessment report. - *
+ *The name of the user who created the assessment report.
*/ author?: string; /** - *- * The current status of the assessment report. - *
+ *The current status of the assessment report.
*/ status?: AssessmentReportStatus | string; /** - *- * Specifies when the assessment report was created. - *
+ *Specifies when the assessment report was created.
*/ creationTime?: Date; } @@ -1253,16 +1111,12 @@ export namespace AssessmentReportMetadata { export interface AssociateAssessmentReportEvidenceFolderRequest { /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The identifier for the folder in which evidence is stored. - *
+ *The identifier for the folder that the evidence is stored in.
*/ evidenceFolderId: string | undefined; } @@ -1288,9 +1142,8 @@ export namespace AssociateAssessmentReportEvidenceFolderResponse { } /** - *- * An internal service error occurred during the processing of your request. Try again later. - *
+ *An internal service error occurred during the processing of your request. Try again + * later.
*/ export interface InternalServerException extends __SmithyException, $MetadataBearer { name: "InternalServerException"; @@ -1308,25 +1161,19 @@ export namespace InternalServerException { } /** - *- * The resource specified in the request cannot be found. - *
+ *The resource that's specified in the request can't be found.
*/ export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer { name: "ResourceNotFoundException"; $fault: "client"; message: string | undefined; /** - *- * The unique identifier for the specified resource. - *
+ *The unique identifier for the resource.
*/ resourceId: string | undefined; /** - *- * The type of resource affected by the error. - *
+ *The type of resource that's affected by the error.
*/ resourceType: string | undefined; } @@ -1341,22 +1188,16 @@ export namespace ResourceNotFoundException { } /** - *- * Indicates that the request has invalid or missing parameters for the specified field. - *
+ *Indicates that the request has invalid or missing parameters for the field.
*/ export interface ValidationExceptionField { /** - *- * The name of the validation error. - *
+ *The name of the validation error.
*/ name: string | undefined; /** - *- * The body of the error message. - *
+ *The body of the error message.
*/ message: string | undefined; } @@ -1378,25 +1219,19 @@ export enum ValidationExceptionReason { } /** - *- * The request has invalid or missing parameters. - *
+ *The request has invalid or missing parameters.
*/ export interface ValidationException extends __SmithyException, $MetadataBearer { name: "ValidationException"; $fault: "client"; message: string | undefined; /** - *- * The reason the request failed validation. - *
+ *The reason the request failed validation.
*/ reason?: ValidationExceptionReason | string; /** - *- * The fields that caused the error, if applicable. - *
+ *The fields that caused the error, if applicable.
*/ fields?: ValidationExceptionField[]; } @@ -1412,23 +1247,17 @@ export namespace ValidationException { export interface BatchAssociateAssessmentReportEvidenceRequest { /** - *- * The unique identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The identifier for the folder in which the evidence is stored. - *
+ *The identifier for the folder that the evidence is stored in.
*/ evidenceFolderId: string | undefined; /** - *- * The list of evidence identifiers. - *
+ *The list of evidence identifiers.
*/ evidenceIds: string[] | undefined; } @@ -1444,16 +1273,13 @@ export namespace BatchAssociateAssessmentReportEvidenceRequest { export interface BatchAssociateAssessmentReportEvidenceResponse { /** - *- * The identifier for the evidence. - *
+ *The list of evidence identifiers.
*/ evidenceIds?: string[]; /** - *
- * A list of errors returned by the BatchAssociateAssessmentReportEvidence API.
- *
A list of errors that the BatchAssociateAssessmentReportEvidence API
+ * returned.
- * A collection of attributes used to create a delegation for an assessment in Audit Manager. - *
+ *A collection of attributes that's used to create a delegation for an assessment in + * Audit Manager.
*/ export interface CreateDelegationRequest { /** - *- * A comment related to the delegation request. - *
+ *A comment that's related to the delegation request.
*/ comment?: string; /** - *- * The unique identifier for the control set. - *
+ *The unique identifier for the control set.
*/ controlSetId?: string; /** - *- * The Amazon Resource Name (ARN) of the IAM role. - *
+ *The Amazon Resource Name (ARN) of the IAM role.
*/ roleArn?: string; /** - *- * The type of customer persona. - *
+ *The type of customer persona.
*In CreateAssessment, roleType can only be PROCESS_OWNER.
In UpdateSettings, roleType can only be PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
In CreateAssessment, roleType can only be
+ * PROCESS_OWNER.
In UpdateSettings, roleType can only be
+ * PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be
+ * RESOURCE_OWNER.
- * The API request to batch create delegations in Audit Manager. - *
+ *The API request to batch create delegations in Audit Manager.
*/ createDelegationRequests: CreateDelegationRequest[] | undefined; /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; } @@ -1542,29 +1358,24 @@ export namespace BatchCreateDelegationByAssessmentRequest { } /** - *
- * An error entity for the BatchCreateDelegationByAssessment API. This is used to provide more meaningful errors than a simple string message.
- *
An error entity for the BatchCreateDelegationByAssessment API. This is
+ * used to provide more meaningful errors than a simple string message.
- * The API request to batch create delegations in Audit Manager. - *
+ *The API request to batch create delegations in Audit Manager.
*/ createDelegationRequest?: CreateDelegationRequest; /** - *
- * The error code returned by the BatchCreateDelegationByAssessment API.
- *
The error code that the BatchCreateDelegationByAssessment API returned.
+ *
- * The error message returned by the BatchCreateDelegationByAssessment API.
- *
The error message that the BatchCreateDelegationByAssessment API returned.
+ *
- * The delegations associated with the assessment. - *
+ *The delegations that are associated with the assessment.
*/ delegations?: Delegation[]; /** - *
- * A list of errors returned by the BatchCreateDelegationByAssessment API.
+ *
A list of errors that the BatchCreateDelegationByAssessment API returned.
*
- * The identifiers for the specified delegations. - *
+ *The identifiers for the delegations.
*/ delegationIds: string[] | undefined; /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; } @@ -1629,29 +1433,24 @@ export namespace BatchDeleteDelegationByAssessmentRequest { } /** - *
- * An error entity for the BatchDeleteDelegationByAssessment API. This is used to provide more meaningful errors than a simple string message.
- *
An error entity for the BatchDeleteDelegationByAssessment API. This is
+ * used to provide more meaningful errors than a simple string message.
- * The identifier for the specified delegation. - *
+ *The identifier for the delegation.
*/ delegationId?: string; /** - *
- * The error code returned by the BatchDeleteDelegationByAssessment API.
- *
The error code that the BatchDeleteDelegationByAssessment API returned.
+ *
- * The error message returned by the BatchDeleteDelegationByAssessment API.
- *
The error message that the BatchDeleteDelegationByAssessment API returned.
+ *
- * A list of errors returned by the BatchDeleteDelegationByAssessment API.
+ *
A list of errors that the BatchDeleteDelegationByAssessment API returned.
*
- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The identifier for the folder in which evidence is stored. - *
+ *The identifier for the folder that the evidence is stored in.
*/ evidenceFolderId: string | undefined; /** - *- * The list of evidence identifiers. - *
+ *The list of evidence identifiers.
*/ evidenceIds: string[] | undefined; } @@ -1717,16 +1509,13 @@ export namespace BatchDisassociateAssessmentReportEvidenceRequest { export interface BatchDisassociateAssessmentReportEvidenceResponse { /** - *- * The identifier for the evidence. - *
+ *The identifier for the evidence.
*/ evidenceIds?: string[]; /** - *
- * A list of errors returned by the BatchDisassociateAssessmentReportEvidence API.
- *
A list of errors that the BatchDisassociateAssessmentReportEvidence API
+ * returned.
- * Evidence that is uploaded to Audit Manager manually. - *
+ *Evidence that's uploaded to Audit Manager manually.
*/ export interface ManualEvidence { /** - *- * The Amazon S3 URL that points to a manual evidence object. - *
+ *The Amazon S3 URL that points to a manual evidence object.
*/ s3ResourcePath?: string; } @@ -1765,31 +1550,22 @@ export namespace ManualEvidence { export interface BatchImportEvidenceToAssessmentControlRequest { /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The identifier for the specified control set. - *
+ *The identifier for the control set.
*/ controlSetId: string | undefined; /** - *- * - * The identifier for the specified control. - *
+ *The identifier for the control.
*/ controlId: string | undefined; /** - *- * The list of manual evidence objects. - *
+ *The list of manual evidence objects.
*/ manualEvidence: ManualEvidence[] | undefined; } @@ -1804,29 +1580,24 @@ export namespace BatchImportEvidenceToAssessmentControlRequest { } /** - *
- * An error entity for the BatchImportEvidenceToAssessmentControl API. This is used to provide more meaningful errors than a simple string message.
- *
An error entity for the BatchImportEvidenceToAssessmentControl API. This
+ * is used to provide more meaningful errors than a simple string message.
- * Manual evidence that cannot be collected automatically by Audit Manager. - *
+ *Manual evidence that can't be collected automatically by Audit Manager.
*/ manualEvidence?: ManualEvidence; /** - *
- * The error code returned by the BatchImportEvidenceToAssessmentControl API.
- *
The error code that the BatchImportEvidenceToAssessmentControl API
+ * returned.
- * The error message returned by the BatchImportEvidenceToAssessmentControl API.
- *
The error message that the BatchImportEvidenceToAssessmentControl API
+ * returned.
- * A list of errors returned by the BatchImportEvidenceToAssessmentControl API.
- *
A list of errors that the BatchImportEvidenceToAssessmentControl API
+ * returned.
- * The name of the assessment to be created. - *
+ *The name of the assessment to be created.
*/ name: string | undefined; /** - *- * The optional description of the assessment to be created. - *
+ *The optional description of the assessment to be created.
*/ description?: string; /** - *- * The assessment report storage destination for the specified assessment that is being created. - *
+ *The assessment report storage destination for the assessment that's being created.
*/ assessmentReportsDestination: AssessmentReportsDestination | undefined; /** - *- * The wrapper that contains the Amazon Web Services accounts and services in scope for the assessment. - *
+ *The wrapper that contains the Amazon Web Services accounts and services that are in + * scope for the assessment.
*/ scope: Scope | undefined; /** - *- * The list of roles for the specified assessment. - *
+ *The list of roles for the assessment.
*/ roles: Role[] | undefined; /** - *- * The identifier for the specified framework. - *
+ *The identifier for the framework that the assessment will be created from.
*/ frameworkId: string | undefined; /** - *- * The tags associated with the assessment. - *
+ *The tags that are associated with the assessment.
*/ tags?: { [key: string]: string }; } @@ -1920,9 +1677,9 @@ export namespace CreateAssessmentRequest { export interface CreateAssessmentResponse { /** - *- * An entity that defines the scope of audit evidence collected by Audit Manager. An Audit Manager assessment is an implementation of an Audit Manager framework. - *
+ *An entity that defines the scope of audit evidence collected by Audit Manager. + * An Audit Manager assessment is an implementation of an Audit Manager + * framework.
*/ assessment?: Assessment; } @@ -1937,15 +1694,12 @@ export namespace CreateAssessmentResponse { } /** - *- * Control entity attributes that uniquely identify an existing control to be added to a framework in Audit Manager. - *
+ *The control entity attributes that uniquely identify an existing control to be added to + * a framework in Audit Manager.
*/ export interface CreateAssessmentFrameworkControl { /** - *- * The unique identifier of the control. - *
+ *The unique identifier of the control.
*/ id?: string; } @@ -1960,22 +1714,17 @@ export namespace CreateAssessmentFrameworkControl { } /** - *
- * A controlSet entity that represents a collection of controls in Audit Manager. This does not contain the control set ID.
- *
A controlSet entity that represents a collection of controls in Audit Manager. This doesn't contain the control set ID.
- * The name of the specified control set. - *
+ *The name of the control set.
*/ name: string | undefined; /** - *- * The list of controls within the control set. This does not contain the control set ID. - *
+ *The list of controls within the control set. This doesn't contain the control set ID. + *
*/ controls?: CreateAssessmentFrameworkControl[]; } @@ -1991,37 +1740,28 @@ export namespace CreateAssessmentFrameworkControlSet { export interface CreateAssessmentFrameworkRequest { /** - *- * The name of the new custom framework. - *
+ *The name of the new custom framework.
*/ name: string | undefined; /** - *- * An optional description for the new custom framework. - *
+ *An optional description for the new custom framework.
*/ description?: string; /** - *- * The compliance type that the new custom framework supports, such as CIS or HIPAA. - *
+ *The compliance type that the new custom framework supports, such as CIS or HIPAA. + *
*/ complianceType?: string; /** - *- * The control sets to be associated with the framework. - *
+ *The control sets that are associated with the framework.
*/ controlSets: CreateAssessmentFrameworkControlSet[] | undefined; /** - *- * The tags associated with the framework. - *
+ *The tags that are associated with the framework.
*/ tags?: { [key: string]: string }; } @@ -2046,22 +1786,18 @@ export enum KeywordInputType { } /** - *- * The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names. - *
+ *The keyword to search for in CloudTrail logs, Config rules, + * Security Hub checks, and Amazon Web Services API names.
*/ export interface SourceKeyword { /** - *- * The method of input for the specified keyword. - *
+ *The method of input for the keyword.
*/ keywordInputType?: KeywordInputType | string; /** - *- * The value of the keyword used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names when mapping a control data source. - *
+ *The value of the keyword that's used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names + * when mapping a control data source.
*/ keywordValue?: string; } @@ -2089,64 +1825,49 @@ export enum SourceType { } /** - *- * The data source that determines from where Audit Manager collects evidence for the control. - *
+ *The data source that determines where Audit Manager collects evidence from for + * the control.
*/ export interface ControlMappingSource { /** - *- * The unique identifier for the specified source. - *
+ *The unique identifier for the source.
*/ sourceId?: string; /** - *- * The name of the specified source. - *
+ *The name of the source.
*/ sourceName?: string; /** - *- * The description of the specified source. - *
+ *The description of the source.
*/ sourceDescription?: string; /** - *- * The setup option for the data source, which reflects if the evidence collection is automated or manual. - *
+ *The setup option for the data source. This option reflects if the evidence collection + * is automated or manual.
*/ sourceSetUpOption?: SourceSetUpOption | string; /** - *- * Specifies one of the five types of data sources for evidence collection. - *
+ *Specifies one of the five types of data sources for evidence collection.
*/ sourceType?: SourceType | string; /** - *- * The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names. - *
+ *The keyword to search for in CloudTrail logs, Config rules, + * Security Hub checks, and Amazon Web Services API names.
*/ sourceKeyword?: SourceKeyword; /** - *- * The frequency of evidence collection for the specified control mapping source. - *
+ *The frequency of evidence collection for the control mapping source.
*/ sourceFrequency?: SourceFrequency | string; /** - *- * The instructions for troubleshooting the specified control. - *
+ *The instructions for troubleshooting the control.
*/ troubleshootingText?: string; } @@ -2166,114 +1887,83 @@ export enum ControlType { } /** - *- * A control in Audit Manager. - *
+ *A control in Audit Manager.
*/ export interface Control { /** - *- * The Amazon Resource Name (ARN) of the specified control. - *
+ *The Amazon Resource Name (ARN) of the control.
*/ arn?: string; /** - *- * The unique identifier for the control. - *
+ *The unique identifier for the control.
*/ id?: string; /** - *- * The type of control, such as custom or standard. - *
+ *The type of control, such as a custom control or a standard control.
*/ type?: ControlType | string; /** - *- * The name of the specified control. - *
+ *The name of the control.
*/ name?: string; /** - *- * The description of the specified control. - *
+ *The description of the control.
*/ description?: string; /** - *- * The steps to follow to determine if the control has been satisfied. + *
The steps that you should follow to determine if the control has been satisfied. *
*/ testingInformation?: string; /** - *- * The title of the action plan for remediating the control. - *
+ *The title of the action plan for remediating the control.
*/ actionPlanTitle?: string; /** - *- * - * The recommended actions to carry out if the control is not fulfilled. - *
+ *The recommended actions to carry out if the control isn't fulfilled.
*/ actionPlanInstructions?: string; /** - *- * The data source that determines from where Audit Manager collects evidence for the control. - *
+ *The data source that determines where Audit Manager collects evidence from for + * the control.
*/ controlSources?: string; /** - *- * The data mapping sources for the specified control. - *
+ *The data mapping sources for the control.
*/ controlMappingSources?: ControlMappingSource[]; /** - *- * Specifies when the control was created. - *
+ *Specifies when the control was created.
*/ createdAt?: Date; /** - *- * Specifies when the control was most recently updated. - *
+ *Specifies when the control was most recently updated.
*/ lastUpdatedAt?: Date; /** - *- * The IAM user or role that created the control. - *
+ *The IAM user or role that created the control.
*/ createdBy?: string; /** - *- * The IAM user or role that most recently updated the control. - *
+ *The IAM user or role that most recently updated the control.
*/ lastUpdatedBy?: string; /** - *- * The tags associated with the control. - *
+ *The tags associated with the control.
*/ tags?: { [key: string]: string }; } @@ -2288,29 +1978,22 @@ export namespace Control { } /** - *- * A set of controls in Audit Manager. - *
+ *A set of controls in Audit Manager.
*/ export interface ControlSet { /** - *- * The identifier of the control set in the assessment. This is the control set name in a plain string format. - *
+ *The identifier of the control set in the assessment. This is the control set name in a + * plain string format.
*/ id?: string; /** - *- * The name of the control set. - *
+ *The name of the control set.
*/ name?: string; /** - *- * The list of controls within the control set. - *
+ *The list of controls within the control set.
*/ controls?: Control[]; } @@ -2325,106 +2008,78 @@ export namespace ControlSet { } /** - *- * The file used to structure and automate Audit Manager assessments for a given compliance standard. - *
+ *The file that's used to structure and automate Audit Manager assessments for a + * given compliance standard.
*/ export interface Framework { /** - *- * The Amazon Resource Name (ARN) of the specified framework. - *
+ *The Amazon Resource Name (ARN) of the framework.
*/ arn?: string; /** - *- * The unique identifier for the specified framework. - *
+ *The unique identifier for the framework.
*/ id?: string; /** - *- * The name of the specified framework. - *
+ *The name of the framework.
*/ name?: string; /** - *- * The framework type, such as custom or standard. - *
+ *The framework type, such as a custom framework or a standard framework.
*/ type?: FrameworkType | string; /** - *- * The compliance type that the new custom framework supports, such as CIS or HIPAA. - *
+ *The compliance type that the new custom framework supports, such as CIS or HIPAA. + *
*/ complianceType?: string; /** - *- * The description of the specified framework. - *
+ *The description of the framework.
*/ description?: string; /** - *- * The logo associated with the framework. - *
+ *The logo that's associated with the framework.
*/ logo?: string; /** - *- * The sources from which Audit Manager collects evidence for the control. - *
+ *The sources that Audit Manager collects evidence from for the control.
*/ controlSources?: string; /** - *- * The control sets associated with the framework. - *
+ *The control sets that are associated with the framework.
*/ controlSets?: ControlSet[]; /** - *- * Specifies when the framework was created. - *
+ *Specifies when the framework was created.
*/ createdAt?: Date; /** - *- * Specifies when the framework was most recently updated. - *
+ *Specifies when the framework was most recently updated.
*/ lastUpdatedAt?: Date; /** - *- * The IAM user or role that created the framework. - *
+ *The IAM user or role that created the framework.
*/ createdBy?: string; /** - *- * The IAM user or role that most recently updated the framework. - *
+ *The IAM user or role that most recently updated the framework.
*/ lastUpdatedBy?: string; /** - *- * The tags associated with the framework. - *
+ *The tags that are associated with the framework.
*/ tags?: { [key: string]: string }; } @@ -2440,9 +2095,8 @@ export namespace Framework { export interface CreateAssessmentFrameworkResponse { /** - *
- * The name of the new framework returned by the CreateAssessmentFramework API.
- *
The name of the new framework that the CreateAssessmentFramework API
+ * returned.
- * The name of the new assessment report. - *
+ *The name of the new assessment report.
*/ name: string | undefined; /** - *- * The description of the assessment report. - *
+ *The description of the assessment report.
*/ description?: string; /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; } @@ -2490,9 +2138,8 @@ export namespace CreateAssessmentReportRequest { export interface CreateAssessmentReportResponse { /** - *
- * The new assessment report returned by the CreateAssessmentReport API.
- *
The new assessment report that the CreateAssessmentReport API returned.
+ *
- * Control mapping fields that represent the source for evidence collection, along with related parameters and metadata. This does not contain mappingID.
- *
The control mapping fields that represent the source for evidence collection, along
+ * with related parameters and metadata. This doesn't contain mappingID.
- * The name of the control mapping data source. - *
+ *The name of the control mapping data source.
*/ sourceName?: string; /** - *- * The description of the data source that determines from where Audit Manager collects evidence for the control. - *
+ *The description of the data source that determines where Audit Manager collects + * evidence from for the control.
*/ sourceDescription?: string; /** - *- * The setup option for the data source, which reflects if the evidence collection is automated or manual. - *
+ *The setup option for the data source, which reflects if the evidence collection is + * automated or manual.
*/ sourceSetUpOption?: SourceSetUpOption | string; /** - *- * Specifies one of the five types of data sources for evidence collection. - * - *
+ *Specifies one of the five types of data sources for evidence collection.
*/ sourceType?: SourceType | string; /** - *- * The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names. - *
+ *The keyword to search for in CloudTrail logs, Config rules, + * Security Hub checks, and Amazon Web Services API names.
*/ sourceKeyword?: SourceKeyword; /** - *- * The frequency of evidence collection for the specified control mapping source. - *
+ *The frequency of evidence collection for the control mapping source.
*/ sourceFrequency?: SourceFrequency | string; /** - *- * The instructions for troubleshooting the specified control. - *
+ *The instructions for troubleshooting the control.
*/ troubleshootingText?: string; } @@ -2574,51 +2208,37 @@ export namespace CreateControlMappingSource { export interface CreateControlRequest { /** - *- * The name of the control. - *
+ *The name of the control.
*/ name: string | undefined; /** - *- * The description of the control. - *
+ *The description of the control.
*/ description?: string; /** - *- * The steps to follow to determine if the control has been satisfied. - *
+ *The steps to follow to determine if the control is satisfied.
*/ testingInformation?: string; /** - *- * The title of the action plan for remediating the control. - *
+ *The title of the action plan for remediating the control.
*/ actionPlanTitle?: string; /** - *- * The recommended actions to carry out if the control is not fulfilled. - *
+ *The recommended actions to carry out if the control isn't fulfilled.
*/ actionPlanInstructions?: string; /** - *- * The data mapping sources for the specified control. - *
+ *The data mapping sources for the control.
*/ controlMappingSources: CreateControlMappingSource[] | undefined; /** - *- * The tags associated with the control. - *
+ *The tags that are associated with the control.
*/ tags?: { [key: string]: string }; } @@ -2634,9 +2254,7 @@ export namespace CreateControlRequest { export interface CreateControlResponse { /** - *
- * The new control returned by the CreateControl API.
- *
The new control that the CreateControl API returned.
- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; } @@ -2681,9 +2297,7 @@ export namespace DeleteAssessmentResponse { export interface DeleteAssessmentFrameworkRequest { /** - *- * The identifier for the specified framework. - *
+ *The identifier for the framework.
*/ frameworkId: string | undefined; } @@ -2708,18 +2322,51 @@ export namespace DeleteAssessmentFrameworkResponse { }); } +export enum ShareRequestType { + RECEIVED = "RECEIVED", + SENT = "SENT", +} + +export interface DeleteAssessmentFrameworkShareRequest { + /** + *The unique identifier for the share request to be deleted.
+ */ + requestId: string | undefined; + + /** + *Specifies whether the share request is a sent request or a received request.
+ */ + requestType: ShareRequestType | string | undefined; +} + +export namespace DeleteAssessmentFrameworkShareRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteAssessmentFrameworkShareRequest): any => ({ + ...obj, + }); +} + +export interface DeleteAssessmentFrameworkShareResponse {} + +export namespace DeleteAssessmentFrameworkShareResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteAssessmentFrameworkShareResponse): any => ({ + ...obj, + }); +} + export interface DeleteAssessmentReportRequest { /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The unique identifier for the assessment report. - *
+ *The unique identifier for the assessment report.
*/ assessmentReportId: string | undefined; } @@ -2746,9 +2393,7 @@ export namespace DeleteAssessmentReportResponse { export interface DeleteControlRequest { /** - *- * The identifier for the specified control. - *
+ *The identifier for the control.
*/ controlId: string | undefined; } @@ -2786,9 +2431,7 @@ export namespace DeregisterAccountRequest { export interface DeregisterAccountResponse { /** - *- * The registration status of the account. - *
+ *The registration status of the account.
*/ status?: AccountStatus | string; } @@ -2804,9 +2447,7 @@ export namespace DeregisterAccountResponse { export interface DeregisterOrganizationAdminAccountRequest { /** - *- * The identifier for the specified administrator account. - *
+ *The identifier for the administrator account.
*/ adminAccountId?: string; } @@ -2833,16 +2474,12 @@ export namespace DeregisterOrganizationAdminAccountResponse { export interface DisassociateAssessmentReportEvidenceFolderRequest { /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The identifier for the folder in which evidence is stored. - *
+ *The identifier for the folder in which evidence is stored.
*/ evidenceFolderId: string | undefined; } @@ -2880,9 +2517,7 @@ export namespace GetAccountStatusRequest { export interface GetAccountStatusResponse { /** - *- * The status of the specified Amazon Web Services account. - *
+ *The status of the Amazon Web Services account.
*/ status?: AccountStatus | string; } @@ -2898,9 +2533,7 @@ export namespace GetAccountStatusResponse { export interface GetAssessmentRequest { /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; } @@ -2916,16 +2549,16 @@ export namespace GetAssessmentRequest { export interface GetAssessmentResponse { /** - *- * An entity that defines the scope of audit evidence collected by Audit Manager. An Audit Manager assessment is an implementation of an Audit Manager framework. - *
+ *An entity that defines the scope of audit evidence collected by Audit Manager. + * An Audit Manager assessment is an implementation of an Audit Manager + * framework.
*/ assessment?: Assessment; /** - *- * The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN). - *
+ *The wrapper that contains the Audit Manager role information of the current + * user. This includes the role type and IAM Amazon Resource Name (ARN). + *
*/ userRole?: Role; } @@ -2941,9 +2574,7 @@ export namespace GetAssessmentResponse { export interface GetAssessmentFrameworkRequest { /** - *- * The identifier for the specified framework. - *
+ *The identifier for the framework.
*/ frameworkId: string | undefined; } @@ -2959,9 +2590,7 @@ export namespace GetAssessmentFrameworkRequest { export interface GetAssessmentFrameworkResponse { /** - *
- * The framework returned by the GetAssessmentFramework API.
- *
The framework that the GetAssessmentFramework API returned.
- * The identifier for the assessment report. - *
+ *The identifier for the assessment report.
*/ assessmentReportId: string | undefined; /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; } @@ -3001,22 +2626,17 @@ export namespace GetAssessmentReportUrlRequest { } /** - *- * A uniform resource locator, used as a unique identifier to locate a resource on the internet. - *
+ *Short for uniform resource locator. A URL is used as a unique identifier to locate a + * resource on the internet.
*/ export interface URL { /** - *- * The name or word used as a hyperlink to the URL. - *
+ *The name or word that's used as a hyperlink to the URL.
*/ hyperlinkName?: string; /** - *- * The unique identifier for the internet resource. - *
+ *The unique identifier for the internet resource.
*/ link?: string; } @@ -3032,9 +2652,8 @@ export namespace URL { export interface GetAssessmentReportUrlResponse { /** - *- * A uniform resource locator, used as a unique identifier to locate a resource on the internet. - *
+ *Short for uniform resource locator. A URL is used as a unique identifier to locate a + * resource on the internet.
*/ preSignedUrl?: URL; } @@ -3050,38 +2669,27 @@ export namespace GetAssessmentReportUrlResponse { export interface GetChangeLogsRequest { /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The identifier for the specified control set. - *
+ *The identifier for the control set.
*/ controlSetId?: string; /** - *- * - * The identifier for the specified control. - *
+ *The identifier for the control.
*/ controlId?: string; /** - *- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; /** - *- * Represents the maximum number of results per page, or per API request call. - *
+ *Represents the maximum number of results on a page or for an API request call.
*/ maxResults?: number; } @@ -3104,43 +2712,33 @@ export enum ObjectTypeEnum { } /** - *- * The record of a change within Audit Manager, such as a modified assessment, a delegated control set, and so on. - *
+ *The record of a change within Audit Manager. For example, this could be the + * status change of an assessment or the delegation of a control set.
*/ export interface ChangeLog { /** - *- * The changelog object type, such as an assessment, control, or control set. - *
+ *The object that was changed, such as an assessment, control, or control set.
*/ objectType?: ObjectTypeEnum | string; /** - *- * The name of the changelog object. - *
+ *The name of the object that changed. This could be the name of an assessment, control, + * or control set.
*/ objectName?: string; /** - *- * The action performed. - *
+ *The action that was performed.
*/ action?: ActionEnum | string; /** - *- * The time of creation for the changelog object. - *
+ *The time when the action was performed and the changelog record was created.
*/ createdAt?: Date; /** - *- * The IAM user or role that performed the action. - *
+ *The IAM user or role that performed the action.
*/ createdBy?: string; } @@ -3156,16 +2754,12 @@ export namespace ChangeLog { export interface GetChangeLogsResponse { /** - *- * The list of user activity for the control. - *
+ *The list of user activity for the control.
*/ changeLogs?: ChangeLog[]; /** - *- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; } @@ -3181,10 +2775,7 @@ export namespace GetChangeLogsResponse { export interface GetControlRequest { /** - *- * - * The identifier for the specified control. - *
+ *The identifier for the control.
*/ controlId: string | undefined; } @@ -3200,9 +2791,7 @@ export namespace GetControlRequest { export interface GetControlResponse { /** - *
- * The name of the control returned by the GetControl API.
- *
The name of the control that the GetControl API returned.
- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; /** - *- * Represents the maximum number of results per page, or per API request call. - *
+ *Represents the maximum number of results on a page or for an API request call.
*/ maxResults?: number; } @@ -3242,57 +2827,41 @@ export namespace GetDelegationsRequest { } /** - *- * The metadata associated with the specified delegation. - *
+ *The metadata that's associated with the delegation.
*/ export interface DelegationMetadata { /** - *- * The unique identifier for the delegation. - *
+ *The unique identifier for the delegation.
*/ id?: string; /** - *- * The name of the associated assessment. - *
+ *The name of the associated assessment.
*/ assessmentName?: string; /** - *- * The unique identifier for the specified assessment. - *
+ *The unique identifier for the assessment.
*/ assessmentId?: string; /** - *- * The current status of the delgation. - *
+ *The current status of the delegation.
*/ status?: DelegationStatus | string; /** - *- * The Amazon Resource Name (ARN) of the IAM role. - *
+ *The Amazon Resource Name (ARN) of the IAM role.
*/ roleArn?: string; /** - *- * Specifies when the delegation was created. - *
+ *Specifies when the delegation was created.
*/ creationTime?: Date; /** - *- * Specifies the name of the control set delegated for review. - *
+ *Specifies the name of the control set that was delegated for review.
*/ controlSetName?: string; } @@ -3308,16 +2877,12 @@ export namespace DelegationMetadata { export interface GetDelegationsResponse { /** - *
- * The list of delegations returned by the GetDelegations API.
- *
The list of delegations that the GetDelegations API returned.
- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; } @@ -3333,30 +2898,22 @@ export namespace GetDelegationsResponse { export interface GetEvidenceRequest { /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The identifier for the specified control set. - *
+ *The identifier for the control set.
*/ controlSetId: string | undefined; /** - *- * The identifier for the folder in which the evidence is stored. - *
+ *The identifier for the folder that the evidence is stored in.
*/ evidenceFolderId: string | undefined; /** - *- * The identifier for the evidence. - *
+ *The identifier for the evidence.
*/ evidenceId: string | undefined; } @@ -3371,22 +2928,16 @@ export namespace GetEvidenceRequest { } /** - *- * A system asset that is evaluated in an Audit Manager assessment. - *
+ *A system asset that's evaluated in an Audit Manager assessment.
*/ export interface Resource { /** - *- * The Amazon Resource Name (ARN) for the specified resource. - *
+ *The Amazon Resource Name (ARN) for the resource.
*/ arn?: string; /** - *- * The value of the specified resource. - *
+ *The value of the resource.
*/ value?: string; } @@ -3401,113 +2952,90 @@ export namespace Resource { } /** - *- * A record that contains the information needed to demonstrate compliance with the requirements specified by a control. Examples of evidence include change activity triggered by a user, or a system configuration snapshot. - *
+ *A record that contains the information needed to demonstrate compliance with the + * requirements specified by a control. Examples of evidence include change activity triggered + * by a user, or a system configuration snapshot.
*/ export interface Evidence { /** - *- * The data source from which the specified evidence was collected. - *
+ *The data source where the evidence was collected from.
*/ dataSource?: string; /** - *- * The identifier for the specified Amazon Web Services account. - *
+ *The identifier for the Amazon Web Services account.
*/ evidenceAwsAccountId?: string; /** - *- * The timestamp that represents when the evidence was collected. - *
+ *The timestamp that represents when the evidence was collected.
*/ time?: Date; /** - *- * The Amazon Web Service from which the evidence is collected. - *
+ *The Amazon Web Service that the evidence is collected from.
*/ eventSource?: string; /** - *- * The name of the specified evidence event. - *
+ *The name of the evidence event.
*/ eventName?: string; /** - *- * The type of automated evidence. - *
+ *The type of automated evidence.
*/ evidenceByType?: string; /** - *- * The list of resources assessed to generate the evidence. - *
+ *The list of resources that are assessed to generate the evidence.
*/ resourcesIncluded?: Resource[]; /** - *
- * The names and values used by the evidence event, including an attribute name (such as allowUsersToChangePassword) and value (such as true or false).
- *
The names and values that are used by the evidence event. This includes an attribute
+ * name (such as allowUsersToChangePassword) and value (such as true
+ * or false).
- * The unique identifier for the IAM user or role associated with the evidence. - *
+ *The unique identifier for the IAM user or role that's associated with + * the evidence.
*/ iamId?: string; /** *The evaluation status for evidence that falls under the compliance check category. For - * evidence collected from Security Hub, a Pass or - * Fail result is shown. For evidence collected from Config, a - * Compliant or Noncompliant result is shown.
+ * evidence collected from Security Hub, a Pass or + * Fail result is shown. For evidence collected from Config, a Compliant or Noncompliant + * result is shown. */ complianceCheck?: string; /** - *- * The Amazon Web Services account from which the evidence is collected, and its organization path. - *
+ *The Amazon Web Services account that the evidence is collected from, and its + * organization path.
*/ awsOrganization?: string; /** - *- * The identifier for the specified Amazon Web Services account. - *
+ *The identifier for the Amazon Web Services account.
*/ awsAccountId?: string; /** - *- * The identifier for the folder in which the evidence is stored. - *
+ *The identifier for the folder that the evidence is stored in.
*/ evidenceFolderId?: string; /** - *The identifier for the evidence. - *
+ *The identifier for the evidence.
*/ id?: string; /** - *- * Specifies whether the evidence is included in the assessment report. - *
+ *Specifies whether the evidence is included in the assessment report.
*/ assessmentReportSelection?: string; } @@ -3523,9 +3051,7 @@ export namespace Evidence { export interface GetEvidenceResponse { /** - *
- * The evidence returned by the GetEvidenceResponse API.
- *
The evidence that the GetEvidenceResponse API returned.
- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The identifier for the control set. - *
+ *The identifier for the control set.
*/ controlSetId: string | undefined; /** - *- * The unique identifier for the folder in which the evidence is stored. - *
+ *The unique identifier for the folder that the evidence is stored in.
*/ evidenceFolderId: string | undefined; /** - *- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; /** - *- * Represents the maximum number of results per page, or per API request call. - *
+ *Represents the maximum number of results on a page or for an API request call.
*/ maxResults?: number; } @@ -3587,16 +3103,13 @@ export namespace GetEvidenceByEvidenceFolderRequest { export interface GetEvidenceByEvidenceFolderResponse { /** - *
- * The list of evidence returned by the GetEvidenceByEvidenceFolder API.
- *
The list of evidence that the GetEvidenceByEvidenceFolder API returned.
+ *
- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; } @@ -3612,23 +3125,17 @@ export namespace GetEvidenceByEvidenceFolderResponse { export interface GetEvidenceFolderRequest { /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The identifier for the specified control set. - *
+ *The identifier for the control set.
*/ controlSetId: string | undefined; /** - *- * The identifier for the folder in which the evidence is stored. - *
+ *The identifier for the folder that the evidence is stored in.
*/ evidenceFolderId: string | undefined; } @@ -3644,9 +3151,7 @@ export namespace GetEvidenceFolderRequest { export interface GetEvidenceFolderResponse { /** - *- * The folder in which evidence is stored. - *
+ *The folder that the evidence is stored in.
*/ evidenceFolder?: AssessmentEvidenceFolder; } @@ -3662,23 +3167,17 @@ export namespace GetEvidenceFolderResponse { export interface GetEvidenceFoldersByAssessmentRequest { /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; /** - *- * Represents the maximum number of results per page, or per API request call. - *
+ *Represents the maximum number of results on a page or for an API request call.
*/ maxResults?: number; } @@ -3694,16 +3193,13 @@ export namespace GetEvidenceFoldersByAssessmentRequest { export interface GetEvidenceFoldersByAssessmentResponse { /** - *
- * The list of evidence folders returned by the GetEvidenceFoldersByAssessment API.
- *
The list of evidence folders that the GetEvidenceFoldersByAssessment API
+ * returned.
- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; } @@ -3719,37 +3215,27 @@ export namespace GetEvidenceFoldersByAssessmentResponse { export interface GetEvidenceFoldersByAssessmentControlRequest { /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The identifier for the specified control set. - *
+ *The identifier for the control set.
*/ controlSetId: string | undefined; /** - *- * The identifier for the specified control. - *
+ *The identifier for the control.
*/ controlId: string | undefined; /** - *- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; /** - *- * Represents the maximum number of results per page, or per API request call. - *
+ *Represents the maximum number of results on a page or for an API request call.
*/ maxResults?: number; } @@ -3765,16 +3251,13 @@ export namespace GetEvidenceFoldersByAssessmentControlRequest { export interface GetEvidenceFoldersByAssessmentControlResponse { /** - *
- * The list of evidence folders returned by the GetEvidenceFoldersByAssessmentControl API.
- *
The list of evidence folders that the
+ * GetEvidenceFoldersByAssessmentControl API returned.
- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; } @@ -3801,16 +3284,12 @@ export namespace GetOrganizationAdminAccountRequest { export interface GetOrganizationAdminAccountResponse { /** - *- * The identifier for the specified administrator account. - *
+ *The identifier for the administrator account.
*/ adminAccountId?: string; /** - *- * The identifier for the specified organization. - *
+ *The identifier for the organization.
*/ organizationId?: string; } @@ -3836,36 +3315,27 @@ export namespace GetServicesInScopeRequest { } /** - *- * The metadata associated with the specified Amazon Web Service. - *
+ *The metadata that's associated with the Amazon Web Service.
*/ export interface ServiceMetadata { /** - *- * The name of the Amazon Web Service. - *
+ *The name of the Amazon Web Service.
*/ name?: string; /** - *- * The display name of the Amazon Web Service. - *
+ *The display name of the Amazon Web Service.
*/ displayName?: string; /** - *- * The description of the specified Amazon Web Service. - *
+ *The description of the Amazon Web Service.
*/ description?: string; /** - *- * The category in which the Amazon Web Service belongs, such as compute, storage, database, and so on. - *
+ *The category that the Amazon Web Service belongs to, such as compute, storage, + * or database.
*/ category?: string; } @@ -3881,9 +3351,7 @@ export namespace ServiceMetadata { export interface GetServicesInScopeResponse { /** - *- * The metadata associated with the Amazon Web Service. - *
+ *The metadata that's associated with the Amazon Web Service.
*/ serviceMetadata?: ServiceMetadata[]; } @@ -3907,9 +3375,7 @@ export enum SettingAttribute { export interface GetSettingsRequest { /** - *
- * The list of SettingAttribute enum values.
- *
The list of SettingAttribute enum values.
- * The settings object that holds all supported Audit Manager settings. - *
+ *The settings object that holds all supported Audit Manager settings.
*/ export interface Settings { /** - *- * Specifies whether Organizations is enabled. - *
+ *Specifies whether Organizations is enabled.
*/ isAwsOrgEnabled?: boolean; /** - *- * The designated Amazon Simple Notification Service (Amazon SNS) topic. - *
+ *The designated Amazon Simple Notification Service (Amazon SNS) topic.
*/ snsTopic?: string; /** - *- * The default storage destination for assessment reports. - *
+ *The default storage destination for assessment reports.
*/ defaultAssessmentReportsDestination?: AssessmentReportsDestination; /** - *- * The designated default audit owners. - *
+ *The designated default audit owners.
*/ defaultProcessOwners?: Role[]; /** - *- * The KMS key details. - *
+ *The KMS key details.
*/ kmsKey?: string; } @@ -3976,9 +3430,7 @@ export namespace Settings { export interface GetSettingsResponse { /** - *- * The settings object that holds all supported Audit Manager settings. - *
+ *The settings object that holds all supported Audit Manager settings.
*/ settings?: Settings; } @@ -3994,23 +3446,17 @@ export namespace GetSettingsResponse { export interface ListAssessmentFrameworksRequest { /** - *- * The type of framework, such as standard or custom. - *
+ *The type of framework, such as a standard framework or a custom framework.
*/ frameworkType: FrameworkType | string | undefined; /** - *- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; /** - *- * Represents the maximum number of results per page, or per API request call. - *
+ *Represents the maximum number of results on a page or for an API request call.
*/ maxResults?: number; } @@ -4026,16 +3472,12 @@ export namespace ListAssessmentFrameworksRequest { export interface ListAssessmentFrameworksResponse { /** - *- * The list of metadata objects for the specified framework. - *
+ *The list of metadata objects for the framework.
*/ frameworkMetadataList?: AssessmentFrameworkMetadata[]; /** - *- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; } @@ -4049,18 +3491,62 @@ export namespace ListAssessmentFrameworksResponse { }); } +export interface ListAssessmentFrameworkShareRequestsRequest { + /** + *Specifies whether the share request is a sent request or a received request.
+ */ + requestType: ShareRequestType | string | undefined; + + /** + *The pagination token that's used to fetch the next set of results.
+ */ + nextToken?: string; + + /** + *Represents the maximum number of results on a page or for an API request call.
+ */ + maxResults?: number; +} + +export namespace ListAssessmentFrameworkShareRequestsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListAssessmentFrameworkShareRequestsRequest): any => ({ + ...obj, + }); +} + +export interface ListAssessmentFrameworkShareRequestsResponse { + /** + * The list of share requests that the ListAssessmentFrameworkShareRequests
+ * API returned.
The pagination token that's used to fetch the next set of results.
+ */ + nextToken?: string; +} + +export namespace ListAssessmentFrameworkShareRequestsResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ListAssessmentFrameworkShareRequestsResponse): any => ({ + ...obj, + }); +} + export interface ListAssessmentReportsRequest { /** - *- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; /** - *- * Represents the maximum number of results per page, or per API request call. - *
+ *Represents the maximum number of results on a page or for an API request call.
*/ maxResults?: number; } @@ -4076,16 +3562,13 @@ export namespace ListAssessmentReportsRequest { export interface ListAssessmentReportsResponse { /** - *
- * The list of assessment reports returned by the ListAssessmentReports API.
- *
The list of assessment reports that the ListAssessmentReports API
+ * returned.
- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; } @@ -4101,16 +3584,12 @@ export namespace ListAssessmentReportsResponse { export interface ListAssessmentsRequest { /** - *- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; /** - *- * Represents the maximum number of results per page, or per API request call. - *
+ *Represents the maximum number of results on a page or for an API request call.
*/ maxResults?: number; } @@ -4126,16 +3605,12 @@ export namespace ListAssessmentsRequest { export interface ListAssessmentsResponse { /** - *- * The metadata associated with the assessment. - *
+ *The metadata that's associated with the assessment.
*/ assessmentMetadata?: AssessmentMetadataItem[]; /** - *- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; } @@ -4151,23 +3626,17 @@ export namespace ListAssessmentsResponse { export interface ListControlsRequest { /** - *- * The type of control, such as standard or custom. - *
+ *The type of control, such as a standard control or a custom control.
*/ controlType: ControlType | string | undefined; /** - *- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; /** - *- * Represents the maximum number of results per page, or per API request call. - *
+ *Represents the maximum number of results on a page or for an API request call.
*/ maxResults?: number; } @@ -4182,50 +3651,37 @@ export namespace ListControlsRequest { } /** - *- * The metadata associated with the specified standard or custom control. - *
+ *The metadata that's associated with the standard control or custom control.
*/ export interface ControlMetadata { /** - *- * The Amazon Resource Name (ARN) of the specified control. - *
+ *The Amazon Resource Name (ARN) of the control.
*/ arn?: string; /** - *- * The unique identifier for the specified control. - *
+ *The unique identifier for the control.
*/ id?: string; /** - *- * The name of the specified control. - *
+ *The name of the control.
*/ name?: string; /** - *- * The data source that determines from where Audit Manager collects evidence for the control. - *
+ *The data source that determines where Audit Manager collects evidence from for + * the control.
*/ controlSources?: string; /** - *- * Specifies when the control was created. - *
+ *Specifies when the control was created.
*/ createdAt?: Date; /** - *- * Specifies when the control was most recently updated. - *
+ *Specifies when the control was most recently updated.
*/ lastUpdatedAt?: Date; } @@ -4241,16 +3697,13 @@ export namespace ControlMetadata { export interface ListControlsResponse { /** - *
- * The list of control metadata objects returned by the ListControls API.
- *
The list of control metadata objects that the ListControls API returned.
+ *
- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; } @@ -4266,23 +3719,17 @@ export namespace ListControlsResponse { export interface ListKeywordsForDataSourceRequest { /** - *- * The control mapping data source to which the keywords apply. - *
+ *The control mapping data source that the keywords apply to.
*/ source: SourceType | string | undefined; /** - *- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; /** - *- * Represents the maximum number of results per page, or per API request call. - *
+ *Represents the maximum number of results on a page or for an API request call.
*/ maxResults?: number; } @@ -4298,16 +3745,12 @@ export namespace ListKeywordsForDataSourceRequest { export interface ListKeywordsForDataSourceResponse { /** - *- * The list of keywords for the specified event mapping source. - *
+ *The list of keywords for the event mapping source.
*/ keywords?: string[]; /** - *- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; } @@ -4323,16 +3766,12 @@ export namespace ListKeywordsForDataSourceResponse { export interface ListNotificationsRequest { /** - *- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; /** - *- * Represents the maximum number of results per page, or per API request call. - *
+ *Represents the maximum number of results on a page or for an API request call.
*/ maxResults?: number; } @@ -4347,64 +3786,48 @@ export namespace ListNotificationsRequest { } /** - *- * The notification used to inform a user of an update in Audit Manager. For example, this includes the notification that is sent when a control set is delegated for review. - *
+ *The notification that informs a user of an update in Audit Manager. For + * example, this includes the notification that's sent when a control set is delegated for + * review.
*/ export interface Notification { /** - *- * The unique identifier for the notification. - *
+ *The unique identifier for the notification.
*/ id?: string; /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId?: string; /** - *- * The name of the related assessment. - *
+ *The name of the related assessment.
*/ assessmentName?: string; /** - *- * The identifier for the specified control set. - *
+ *The identifier for the control set.
*/ controlSetId?: string; /** - *- * Specifies the name of the control set that the notification is about. - *
+ *Specifies the name of the control set that the notification is about.
*/ controlSetName?: string; /** - *- * The description of the notification. - *
+ *The description of the notification.
*/ description?: string; /** - *- * The time when the notification was sent. - *
+ *The time when the notification was sent.
*/ eventTime?: Date; /** - *- * The sender of the notification. - *
+ *The sender of the notification.
*/ source?: string; } @@ -4420,16 +3843,12 @@ export namespace Notification { export interface ListNotificationsResponse { /** - *- * The returned list of notifications. - *
+ *The returned list of notifications.
*/ notifications?: Notification[]; /** - *- * The pagination token used to fetch the next set of results. - *
+ *The pagination token that's used to fetch the next set of results.
*/ nextToken?: string; } @@ -4445,9 +3864,7 @@ export namespace ListNotificationsResponse { export interface ListTagsForResourceRequest { /** - *- * The Amazon Resource Name (ARN) of the specified resource. - *
+ *The Amazon Resource Name (ARN) of the resource.
*/ resourceArn: string | undefined; } @@ -4463,9 +3880,7 @@ export namespace ListTagsForResourceRequest { export interface ListTagsForResourceResponse { /** - *
- * The list of tags returned by the ListTagsForResource API.
- *
The list of tags that the ListTagsForResource API returned.
- * The KMS key details. - *
+ *The KMS key details.
*/ kmsKey?: string; /** - *- * The delegated administrator account for Audit Manager. - *
+ *The delegated administrator account for Audit Manager.
*/ delegatedAdminAccount?: string; } @@ -4506,9 +3917,7 @@ export namespace RegisterAccountRequest { export interface RegisterAccountResponse { /** - *- * The status of the account registration request. - *
+ *The status of the account registration request.
*/ status?: AccountStatus | string; } @@ -4524,9 +3933,7 @@ export namespace RegisterAccountResponse { export interface RegisterOrganizationAdminAccountRequest { /** - *- * The identifier for the specified delegated administrator account. - *
+ *The identifier for the delegated administrator account.
*/ adminAccountId: string | undefined; } @@ -4542,16 +3949,12 @@ export namespace RegisterOrganizationAdminAccountRequest { export interface RegisterOrganizationAdminAccountResponse { /** - *- * The identifier for the specified delegated administrator account. - *
+ *The identifier for the delegated administrator account.
*/ adminAccountId?: string; /** - *- * The identifier for the specified organization. - *
+ *The identifier for the organization.
*/ organizationId?: string; } @@ -4565,18 +3968,62 @@ export namespace RegisterOrganizationAdminAccountResponse { }); } +export interface StartAssessmentFrameworkShareRequest { + /** + *The unique identifier for the custom framework to be shared.
+ */ + frameworkId: string | undefined; + + /** + *The Amazon Web Services account of the recipient.
+ */ + destinationAccount: string | undefined; + + /** + *The Amazon Web Services Region of the recipient.
+ */ + destinationRegion: string | undefined; + + /** + *An optional comment from the sender about the share request.
+ */ + comment?: string; +} + +export namespace StartAssessmentFrameworkShareRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: StartAssessmentFrameworkShareRequest): any => ({ + ...obj, + }); +} + +export interface StartAssessmentFrameworkShareResponse { + /** + * The share request that's created by the StartAssessmentFrameworkShare API.
+ *
- * The Amazon Resource Name (ARN) of the specified resource. - *
+ *The Amazon Resource Name (ARN) of the resource.
*/ resourceArn: string | undefined; /** - *- * The tags to be associated with the resource. - *
+ *The tags that are associated with the resource.
*/ tags: { [key: string]: string } | undefined; } @@ -4603,16 +4050,12 @@ export namespace TagResourceResponse { export interface UntagResourceRequest { /** - *- * The Amazon Resource Name (ARN) of the specified resource. - *
+ *The Amazon Resource Name (ARN) of the specified resource.
*/ resourceArn: string | undefined; /** - *- * The name or key of the tag. - *
+ *The name or key of the tag.
*/ tagKeys: string[] | undefined; } @@ -4639,44 +4082,33 @@ export namespace UntagResourceResponse { export interface UpdateAssessmentRequest { /** - *- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The name of the specified assessment to be updated. - *
+ *The name of the assessment to be updated.
*/ assessmentName?: string; /** - *- * The description of the specified assessment. - *
+ *The description of the assessment.
*/ assessmentDescription?: string; /** - *- * The scope of the specified assessment. - *
+ *The scope of the assessment.
*/ scope: Scope | undefined; /** - *- * The assessment report storage destination for the specified assessment that is being updated. - *
+ *The assessment report storage destination for the assessment that's being updated. + *
*/ assessmentReportsDestination?: AssessmentReportsDestination; /** - *- * The list of roles for the specified assessment. - *
+ *The list of roles for the assessment.
*/ roles?: Role[]; } @@ -4692,9 +4124,8 @@ export namespace UpdateAssessmentRequest { export interface UpdateAssessmentResponse { /** - *
- * The response object (name of the updated assessment) for the UpdateAssessmentRequest API.
- *
The response object for the UpdateAssessmentRequest API. This is the name
+ * of the updated assessment.
- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The identifier for the specified control set. - *
+ *The identifier for the control set.
*/ controlSetId: string | undefined; /** - *- * - * The identifier for the specified control. - *
+ *The identifier for the control.
*/ controlId: string | undefined; /** - *- * The status of the specified control. - *
+ *The status of the control.
*/ controlStatus?: ControlStatus | string; /** - *- * The comment body text for the specified control. - *
+ *The comment body text for the control.
*/ commentBody?: string; } @@ -4757,9 +4177,8 @@ export namespace UpdateAssessmentControlRequest { export interface UpdateAssessmentControlResponse { /** - *
- * The name of the updated control set returned by the UpdateAssessmentControl API.
- *
The name of the updated control set that the UpdateAssessmentControl API
+ * returned.
- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The identifier for the specified control set. - *
+ *The identifier for the control set.
*/ controlSetId: string | undefined; /** - *- * The status of the control set that is being updated. - *
+ *The status of the control set that's being updated.
*/ status: ControlSetStatus | string | undefined; /** - *- * The comment related to the status update. - *
+ *The comment that's related to the status update.
*/ comment: string | undefined; } @@ -4814,9 +4225,8 @@ export namespace UpdateAssessmentControlSetStatusRequest { export interface UpdateAssessmentControlSetStatusResponse { /** - *
- * The name of the updated control set returned by the UpdateAssessmentControlSetStatus API.
- *
The name of the updated control set that the
+ * UpdateAssessmentControlSetStatus API returned.
- * A controlSet entity that represents a collection of controls in Audit Manager. This does not contain the control set ID.
- *
A controlSet entity that represents a collection of controls in Audit Manager. This doesn't contain the control set ID.
- * The unique identifier for the control set. - *
+ *The unique identifier for the control set.
*/ id?: string; /** - *- * The name of the control set. - *
+ *The name of the control set.
*/ name: string | undefined; /** - *- * The list of controls contained within the control set. - *
+ *The list of controls that are contained within the control set.
*/ controls?: CreateAssessmentFrameworkControl[]; } @@ -4869,37 +4271,28 @@ export namespace UpdateAssessmentFrameworkControlSet { export interface UpdateAssessmentFrameworkRequest { /** - *- * The identifier for the specified framework. - *
+ *The identifier for the framework.
*/ frameworkId: string | undefined; /** - *- * The name of the framework to be updated. - *
+ *The name of the framework to be updated.
*/ name: string | undefined; /** - *- * The description of the framework that is to be updated. - *
+ *The description of the updated framework.
*/ description?: string; /** - *- * The compliance type that the new custom framework supports, such as CIS or HIPAA. - *
+ *The compliance type that the new custom framework supports, such as CIS or HIPAA. + *
*/ complianceType?: string; /** - *- * The control sets associated with the framework. - *
+ *The control sets that are associated with the framework.
*/ controlSets: UpdateAssessmentFrameworkControlSet[] | undefined; } @@ -4915,9 +4308,7 @@ export namespace UpdateAssessmentFrameworkRequest { export interface UpdateAssessmentFrameworkResponse { /** - *- * The name of the specified framework. - *
+ *The name of the framework.
*/ framework?: Framework; } @@ -4931,18 +4322,63 @@ export namespace UpdateAssessmentFrameworkResponse { }); } +export enum ShareRequestAction { + ACCEPT = "ACCEPT", + DECLINE = "DECLINE", + REVOKE = "REVOKE", +} + +export interface UpdateAssessmentFrameworkShareRequest { + /** + *The unique identifier for the share request.
+ */ + requestId: string | undefined; + + /** + *Specifies whether the share request is a sent request or a received request.
+ */ + requestType: ShareRequestType | string | undefined; + + /** + *Specifies the update action for the share request.
+ */ + action: ShareRequestAction | string | undefined; +} + +export namespace UpdateAssessmentFrameworkShareRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UpdateAssessmentFrameworkShareRequest): any => ({ + ...obj, + }); +} + +export interface UpdateAssessmentFrameworkShareResponse { + /** + * The updated share request that's returned by the
+ * UpdateAssessmentFrameworkShare operation.
- * The identifier for the specified assessment. - *
+ *The identifier for the assessment.
*/ assessmentId: string | undefined; /** - *- * The current status of the specified assessment. - *
+ *The current status of the assessment.
*/ status: AssessmentStatus | string | undefined; } @@ -4958,9 +4394,8 @@ export namespace UpdateAssessmentStatusRequest { export interface UpdateAssessmentStatusResponse { /** - *
- * The name of the updated assessment returned by the UpdateAssessmentStatus API.
- *
The name of the updated assessment that the UpdateAssessmentStatus API
+ * returned.
- * The identifier for the specified control. - *
+ *The identifier for the control.
*/ controlId: string | undefined; /** - *- * The name of the control to be updated. - *
+ *The name of the updated control.
*/ name: string | undefined; /** - *- * The optional description of the control. - *
+ *The optional description of the control.
*/ description?: string; /** - *- * The steps that to follow to determine if the control has been satisfied. - *
+ *The steps that you should follow to determine if the control is met.
*/ testingInformation?: string; /** - *- * The title of the action plan for remediating the control. - *
+ *The title of the action plan for remediating the control.
*/ actionPlanTitle?: string; /** - *- * - * The recommended actions to carry out if the control is not fulfilled. - *
+ *The recommended actions to carry out if the control isn't fulfilled.
*/ actionPlanInstructions?: string; /** - *- * The data mapping sources for the specified control. - *
+ *The data mapping sources for the control.
*/ controlMappingSources: ControlMappingSource[] | undefined; } @@ -5037,9 +4457,8 @@ export namespace UpdateControlRequest { export interface UpdateControlResponse { /** - *
- * The name of the updated control set returned by the UpdateControl API.
- *
The name of the updated control set that the UpdateControl API returned.
+ *
- * The Amazon Simple Notification Service (Amazon SNS) topic to which Audit Manager sends notifications. - *
+ *The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends + * notifications to.
*/ snsTopic?: string; /** - *- * The default storage destination for assessment reports. - *
+ *The default storage destination for assessment reports.
*/ defaultAssessmentReportsDestination?: AssessmentReportsDestination; /** - *- * A list of the default audit owners. - *
+ *A list of the default audit owners.
*/ defaultProcessOwners?: Role[]; /** - *- * The KMS key details. - *
+ *The KMS key details.
*/ kmsKey?: string; } @@ -5094,9 +4506,7 @@ export namespace UpdateSettingsRequest { export interface UpdateSettingsResponse { /** - *- * The current list of settings. - *
+ *The current list of settings.
*/ settings?: Settings; } @@ -5112,9 +4522,8 @@ export namespace UpdateSettingsResponse { export interface ValidateAssessmentReportIntegrityRequest { /** - *- * The relative path of the specified Amazon S3 bucket in which the assessment report is stored. - *
+ *The relative path of the Amazon S3 bucket that the assessment report is stored + * in.
*/ s3RelativePath: string | undefined; } @@ -5130,37 +4539,28 @@ export namespace ValidateAssessmentReportIntegrityRequest { export interface ValidateAssessmentReportIntegrityResponse { /** - *- * Specifies whether the signature key is valid. - *
+ *Specifies whether the signature key is valid.
*/ signatureValid?: boolean; /** - *- * The signature algorithm used to code sign the assessment report file. - *
+ *The signature algorithm that's used to code sign the assessment report file.
*/ signatureAlgorithm?: string; /** - *- * The date and time signature that specifies when the assessment report was created. - *
+ *The date and time signature that specifies when the assessment report was created. + *
*/ signatureDateTime?: string; /** - *- * The unique identifier for the validation signature key. - *
+ *The unique identifier for the validation signature key.
*/ signatureKeyId?: string; /** - *- * Represents any errors that occurred when validating the assessment report. - *
+ *Represents any errors that occurred when validating the assessment report.
*/ validationErrors?: string[]; } diff --git a/clients/client-auditmanager/src/pagination/ListAssessmentFrameworkShareRequestsPaginator.ts b/clients/client-auditmanager/src/pagination/ListAssessmentFrameworkShareRequestsPaginator.ts new file mode 100644 index 000000000000..08fbe52bd535 --- /dev/null +++ b/clients/client-auditmanager/src/pagination/ListAssessmentFrameworkShareRequestsPaginator.ts @@ -0,0 +1,59 @@ +import { Paginator } from "@aws-sdk/types"; + +import { AuditManager } from "../AuditManager"; +import { AuditManagerClient } from "../AuditManagerClient"; +import { + ListAssessmentFrameworkShareRequestsCommand, + ListAssessmentFrameworkShareRequestsCommandInput, + ListAssessmentFrameworkShareRequestsCommandOutput, +} from "../commands/ListAssessmentFrameworkShareRequestsCommand"; +import { AuditManagerPaginationConfiguration } from "./Interfaces"; + +/** + * @private + */ +const makePagedClientRequest = async ( + client: AuditManagerClient, + input: ListAssessmentFrameworkShareRequestsCommandInput, + ...args: any +): PromiseSpecifies the minimum and maximum for the AcceleratorCount object when
+ * you specify InstanceRequirements for an Auto Scaling group.
The minimum value.
+ */ + Min?: number; + + /** + *The maximum value.
+ */ + Max?: number; +} + +export namespace AcceleratorCountRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AcceleratorCountRequest): any => ({ + ...obj, + }); +} + +export enum AcceleratorManufacturer { + AMAZON_WEB_SERVICES = "amazon-web-services", + AMD = "amd", + NVIDIA = "nvidia", + XILINX = "xilinx", +} + +export enum AcceleratorName { + A100 = "a100", + K80 = "k80", + M60 = "m60", + RADEON_PRO_V520 = "radeon-pro-v520", + T4 = "t4", + V100 = "v100", + VU9P = "vu9p", +} + +/** + *Specifies the minimum and maximum for the AcceleratorTotalMemoryMiB
+ * object when you specify InstanceRequirements for an Auto Scaling group.
The memory minimum in MiB.
+ */ + Min?: number; + + /** + *The memory maximum in MiB.
+ */ + Max?: number; +} + +export namespace AcceleratorTotalMemoryMiBRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AcceleratorTotalMemoryMiBRequest): any => ({ + ...obj, + }); +} + +export enum AcceleratorType { + FPGA = "fpga", + GPU = "gpu", + INFERENCE = "inference", +} + /** *The request failed because an active instance refresh for the specified Auto Scaling group was * not found.
@@ -771,44 +844,41 @@ export namespace LifecycleHookSpecification { } /** - *Describes an instances distribution for an Auto Scaling group with a MixedInstancesPolicy.
- *The instances distribution specifies the distribution of On-Demand Instances and Spot - * Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates - * instance types to fulfill On-Demand and Spot capacities.
- *When you modify SpotAllocationStrategy, SpotInstancePools,
- * or SpotMaxPrice in the UpdateAutoScalingGroup API call,
- * this update action does not deploy any changes across the running Amazon EC2 instances
- * in the group. Your existing Spot Instances continue to run as long as the maximum price
- * for those instances is higher than the current Spot price. When scale out occurs,
- * Amazon EC2 Auto Scaling launches instances based on the new settings. When scale in occurs, Amazon EC2 Auto Scaling
- * terminates instances according to the group's termination policies.
Describes an instances distribution for an Auto Scaling group.
*/ export interface InstancesDistribution { /** - *Indicates how to allocate instance types to fulfill On-Demand capacity. The only valid
- * value is prioritized, which is also the default value. This strategy uses
- * the order of instance types in the LaunchTemplateOverrides to define the
- * launch priority of each instance type. The first instance type in the array is
- * prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled
- * using your highest priority instance, then the Auto Scaling groups launches the remaining
- * capacity using the second priority instance type, and so on.
The order of the launch template overrides to use in fulfilling On-Demand capacity.
+ *If you specify lowest-price, Amazon EC2 Auto Scaling uses price to determine the order,
+ * launching the lowest price first.
If you specify prioritized, Amazon EC2 Auto Scaling uses the priority that you assigned
+ * to each launch template override, launching the highest priority first. If all your
+ * On-Demand capacity cannot be fulfilled using your highest priority instance, then
+ * Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so
+ * on.
Default: lowest-price for Auto Scaling groups that specify InstanceRequirements in the overrides and prioritized for
+ * Auto Scaling groups that don't.
The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand
- * Instances. This base portion is provisioned first as your group scales. Defaults to 0 if
- * not specified. If you specify weights for the instance types in the overrides, set the
- * value of OnDemandBaseCapacity in terms of the number of capacity units, and
- * not the number of instances.
If you specify weights for the instance types in the overrides, the base capacity is + * measured in the same unit of measurement as the instance types. If you specify InstanceRequirements in the overrides, the base capacity is measured in + * the same unit of measurement as your group's desired capacity.
+ *Default: 0
+ *
Controls the percentages of On-Demand Instances and Spot Instances for your additional
* capacity beyond OnDemandBaseCapacity. Expressed as a number (for example,
- * 20 specifies 20% On-Demand Instances, 80% Spot Instances). Defaults to 100 if not
- * specified. If set to 100, only On-Demand Instances are provisioned.
Default: 100
+ *
Indicates how to allocate instances across Spot Instance pools.
*If the allocation strategy is lowest-price, the Auto Scaling group launches
* instances using the Spot pools with the lowest price, and evenly allocates your
- * instances across the number of Spot pools that you specify. Defaults to
- * lowest-price if not specified.
If the allocation strategy is capacity-optimized (recommended), the Auto Scaling
* group launches instances using Spot pools that are optimally chosen based on the
* available Spot capacity. Alternatively, you can use
@@ -825,6 +894,8 @@ export interface InstancesDistribution {
* the list of launch template overrides from highest to lowest priority (from first to
* last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best-effort basis
* but optimizes for capacity first.
Default: lowest-price
+ *
The number of Spot Instance pools across which to allocate your Spot Instances. The
* Spot pools are determined from the different instance types in the overrides. Valid only
* when the Spot allocation strategy is lowest-price. Value must be in the
- * range of 1 to 20. Defaults to 2 if not specified.
Default: 2
+ *
The maximum price per unit hour that you are willing to pay for a Spot Instance. If - * you leave the value at its default (empty), Amazon EC2 Auto Scaling uses the On-Demand price as the - * maximum Spot price. To remove a value that you previously set, include the property but - * specify an empty string ("") for the value.
+ * you keep the value at its default (unspecified), Amazon EC2 Auto Scaling uses the On-Demand price as + * the maximum Spot price. To remove a value that you previously set, include the property + * but specify an empty string ("") for the value. */ SpotMaxPrice?: string; } @@ -854,12 +927,465 @@ export namespace InstancesDistribution { }); } +export enum BareMetal { + EXCLUDED = "excluded", + INCLUDED = "included", + REQUIRED = "required", +} + +/** + *Specifies the minimum and maximum for the BaselineEbsBandwidthMbps object
+ * when you specify InstanceRequirements for an Auto Scaling group.
The minimum value in Mbps.
+ */ + Min?: number; + + /** + *The maximum value in Mbps.
+ */ + Max?: number; +} + +export namespace BaselineEbsBandwidthMbpsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: BaselineEbsBandwidthMbpsRequest): any => ({ + ...obj, + }); +} + +export enum BurstablePerformance { + EXCLUDED = "excluded", + INCLUDED = "included", + REQUIRED = "required", +} + +export enum CpuManufacturer { + AMAZON_WEB_SERVICES = "amazon-web-services", + AMD = "amd", + INTEL = "intel", +} + +export enum InstanceGeneration { + CURRENT = "current", + PREVIOUS = "previous", +} + +export enum LocalStorage { + EXCLUDED = "excluded", + INCLUDED = "included", + REQUIRED = "required", +} + +export enum LocalStorageType { + HDD = "hdd", + SSD = "ssd", +} + +/** + *Specifies the minimum and maximum for the MemoryGiBPerVCpu object when
+ * you specify InstanceRequirements for an Auto Scaling group.
The memory minimum in GiB.
+ */ + Min?: number; + + /** + *The memory maximum in GiB.
+ */ + Max?: number; +} + +export namespace MemoryGiBPerVCpuRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: MemoryGiBPerVCpuRequest): any => ({ + ...obj, + }); +} + +/** + *Specifies the minimum and maximum for the MemoryMiB object when you
+ * specify InstanceRequirements for an Auto Scaling group.
The memory minimum in MiB.
+ */ + Min: number | undefined; + + /** + *The memory maximum in MiB.
+ */ + Max?: number; +} + +export namespace MemoryMiBRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: MemoryMiBRequest): any => ({ + ...obj, + }); +} + +/** + *Specifies the minimum and maximum for the NetworkInterfaceCount object
+ * when you specify InstanceRequirements for an Auto Scaling group.
The minimum number of network interfaces.
+ */ + Min?: number; + + /** + *The maximum number of network interfaces.
+ */ + Max?: number; +} + +export namespace NetworkInterfaceCountRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: NetworkInterfaceCountRequest): any => ({ + ...obj, + }); +} + +/** + *Specifies the minimum and maximum for the TotalLocalStorageGB object when
+ * you specify InstanceRequirements for an Auto Scaling group.
The storage minimum in GB.
+ */ + Min?: number; + + /** + *The storage maximum in GB.
+ */ + Max?: number; +} + +export namespace TotalLocalStorageGBRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: TotalLocalStorageGBRequest): any => ({ + ...obj, + }); +} + +/** + *Specifies the minimum and maximum for the VCpuCount object when you
+ * specify InstanceRequirements for an Auto Scaling group.
The minimum number of vCPUs.
+ */ + Min: number | undefined; + + /** + *The maximum number of vCPUs.
+ */ + Max?: number; +} + +export namespace VCpuCountRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: VCpuCountRequest): any => ({ + ...obj, + }); +} + +/** + *When you specify multiple parameters, you get instance types that satisfy all of the + * specified parameters. If you specify multiple values for a parameter, you get instance + * types that satisfy any of the specified values.
+ * + * + *Represents requirements for the types of instances that can be launched. You
+ * must specify VCpuCount and MemoryMiB, but all other parameters
+ * are optional. For more information, see Creating
+ * an Auto Scaling group using attribute-based instance type selection in the
+ * Amazon EC2 Auto Scaling User Guide.
The minimum and maximum number of vCPUs for an instance type.
+ */ + VCpuCount: VCpuCountRequest | undefined; + + /** + *The minimum and maximum instance memory size for an instance type, in MiB.
+ */ + MemoryMiB: MemoryMiBRequest | undefined; + + /** + *Lists which specific CPU manufacturers to include.
+ *For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify
+ * amazon-web-services.
Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. + * Instances will be launched with a compatible CPU architecture based on the Amazon + * Machine Image (AMI) that you specify in your launch template.
+ *Default: Any manufacturer
+ */ + CpuManufacturers?: (CpuManufacturer | string)[]; + + /** + *The minimum and maximum amount of memory per vCPU for an instance type, in GiB.
+ *Default: No minimum or maximum
+ */ + MemoryGiBPerVCpu?: MemoryGiBPerVCpuRequest; + + /** + *Lists which instance types to exclude. You can use strings with one or more wild
+ * cards, represented by an asterisk (*). The following are examples:
+ * c5*, m5a.*, r*, *3*.
For example, if you specify c5*, you are excluding the entire C5 instance
+ * family, which includes all C5a and C5n instance types. If you specify
+ * m5a.*, you are excluding all the M5a instance types, but not the M5n
+ * instance types.
Default: No excluded instance types
+ */ + ExcludedInstanceTypes?: string[]; + + /** + *Indicates whether current or previous generation instance types are included.
+ *For current generation instance types, specify current. The
+ * current generation includes EC2 instance types currently recommended for use.
+ * This typically includes the latest two to three generations in each instance
+ * family. For more information, see Instance types in
+ * the Amazon EC2 User Guide for Linux Instances.
For previous generation instance types, specify previous.
Default: Any current or previous generation
+ */ + InstanceGenerations?: (InstanceGeneration | string)[]; + + /** + *The price protection threshold for Spot Instances. This is the maximum you’ll pay for
+ * a Spot Instance, expressed as a percentage higher than the cheapest M, C, or R instance
+ * type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your
+ * attributes, we will exclude instance types whose price is higher than your threshold.
+ * The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off
+ * price protection, specify a high value, such as 999999.
Default: 100
+ *
The price protection threshold for On-Demand Instances. This is the maximum you’ll pay
+ * for an On-Demand Instance, expressed as a percentage higher than the cheapest M, C, or R
+ * instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with
+ * your attributes, we will exclude instance types whose price is higher than your
+ * threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
+ * To turn off price protection, specify a high value, such as 999999.
Default: 20
+ *
Indicates whether bare metal instance types are included, excluded, or + * required.
+ *Default: excluded
+ *
Indicates whether burstable performance instance types are included, excluded, or + * required. For more information, see Burstable + * performance instances in the Amazon EC2 User Guide for Linux + * Instances.
+ *Default: excluded
+ *
Indicates whether instance types must provide On-Demand Instance hibernation + * support.
+ *Default: false
+ *
The minimum and maximum number of network interfaces for an instance type.
+ *Default: No minimum or maximum
+ */ + NetworkInterfaceCount?: NetworkInterfaceCountRequest; + + /** + *Indicates whether instance types with instance store volumes are included, excluded, + * or required. For more information, see Amazon EC2 instance store in + * the Amazon EC2 User Guide for Linux Instances.
+ *Default: included
+ *
Indicates the type of local storage that is required.
+ *For instance types with hard disk drive (HDD) storage, specify
+ * hdd.
For instance types with solid state drive (SSD) storage, specify
+ * sdd.
Default: Any local storage type
+ */ + LocalStorageTypes?: (LocalStorageType | string)[]; + + /** + *The minimum and maximum total local storage size for an instance type, in GB.
+ *Default: No minimum or maximum
+ */ + TotalLocalStorageGB?: TotalLocalStorageGBRequest; + + /** + *The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. + * For more information, see Amazon EBS–optimized instances + * in the Amazon EC2 User Guide for Linux Instances.
+ *Default: No minimum or maximum
+ */ + BaselineEbsBandwidthMbps?: BaselineEbsBandwidthMbpsRequest; + + /** + *Lists the accelerator types that must be on an instance type.
+ *For instance types with GPU accelerators, specify gpu.
For instance types with FPGA accelerators, specify fpga.
For instance types with inference accelerators, specify
+ * inference.
Default: Any accelerator type
+ */ + AcceleratorTypes?: (AcceleratorType | string)[]; + + /** + *The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia + * chips) for an instance type.
+ *To exclude accelerator-enabled instance types, set Max to
+ * 0.
Default: No minimum or maximum
+ */ + AcceleratorCount?: AcceleratorCountRequest; + + /** + *Indicates whether instance types must have accelerators by specific + * manufacturers.
+ *For instance types with NVIDIA devices, specify nvidia.
For instance types with AMD devices, specify amd.
For instance types with Amazon Web Services devices, specify
+ * amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
+ */ + AcceleratorManufacturers?: (AcceleratorManufacturer | string)[]; + + /** + *Lists the accelerators that must be on an instance type.
+ *For instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA V100 GPUs, specify v100.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify
+ * radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
Default: Any accelerator
+ */ + AcceleratorNames?: (AcceleratorName | string)[]; + + /** + *The minimum and maximum total memory size for the accelerators on an instance type, in + * MiB.
+ *Default: No minimum or maximum
+ */ + AcceleratorTotalMemoryMiB?: AcceleratorTotalMemoryMiBRequest; +} + +export namespace InstanceRequirements { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InstanceRequirements): any => ({ + ...obj, + }); +} + /** - *Describes an override for a launch template. The maximum number of instance types that - * can be associated with an Auto Scaling group is 40. The maximum number of distinct launch - * templates you can define for an Auto Scaling group is 20. For more information about configuring - * overrides, see Configuring - * overrides in the Amazon EC2 Auto Scaling User Guide.
+ *Describes an override for a launch template. For more information, see Configuring overrides in the Amazon EC2 Auto Scaling User Guide.
*/ export interface LaunchTemplateOverrides { /** @@ -871,27 +1397,37 @@ export interface LaunchTemplateOverrides { InstanceType?: string; /** - *The number of capacity units provided by the specified instance type in terms of
- * virtual CPUs, memory, storage, throughput, or other relative performance characteristic.
- * When a Spot or On-Demand Instance is provisioned, the capacity units count toward the
- * desired capacity. Amazon EC2 Auto Scaling provisions instances until the desired capacity is totally
- * fulfilled, even if this results in an overage. For example, if there are 2 units
- * remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only provision an instance with a
- * WeightedCapacity of 5 units, the instance is provisioned, and the
- * desired capacity is exceeded by 3 units. For more information, see Instance weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
- * Value must be in the range of 1 to 999.
The number of capacity units provided by the instance type specified in
+ * InstanceType in terms of virtual CPUs, memory, storage, throughput, or
+ * other relative performance characteristic. When a Spot or On-Demand Instance is
+ * launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches
+ * instances until the desired capacity is totally fulfilled, even if this results in an
+ * overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling
+ * can only launch an instance with a WeightedCapacity of five units, the
+ * instance is launched, and the desired capacity is exceeded by three units. For more
+ * information, see Instance weighting for
+ * Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Value must be in the
+ * range of 1–999.
Provides the launch template to be used when launching the instance type. For example,
- * some instance types might require a launch template with a different AMI. If not
- * provided, Amazon EC2 Auto Scaling uses the launch template that's defined for your mixed instances
- * policy. For more information, see Specifying a
+ * Provides the launch template to be used when launching the instance type specified in
+ * The instance requirements. When you specify instance requirements, Amazon EC2 Auto Scaling finds
+ * instance types that satisfy your requirements, and then uses your On-Demand and Spot
+ * allocation strategies to launch instances from these instance types, in the same way as
+ * when you specify a list of specific instance types. Describes a launch template and overrides. You specify these properties as part of a mixed instances policy. When you update the launch template or overrides in the UpdateAutoScalingGroup API call, existing Amazon EC2 instances continue to
- * run. When scale out occurs, Amazon EC2 Auto Scaling launches instances to match the new settings. When
- * scale in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination
- * policies. Describes a launch template and overrides. You specify these properties as part of a
+ * mixed instances policy. Any properties that you specify override the same properties in the launch template.
- * If not provided, Amazon EC2 Auto Scaling uses the instance type specified in the launch template when
- * it launches an instance. InstanceType. For example, some instance types might require a launch
+ * template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's
+ * defined for your mixed instances policy. For more information, see Specifying a
* different launch template for an instance type in the
* Amazon EC2 Auto Scaling User Guide.
The overrides can include either one or more instance types or a set of instance + * requirements, but not both.
*/ Overrides?: LaunchTemplateOverrides[]; } @@ -936,22 +1470,21 @@ export namespace LaunchTemplate { /** *Describes a mixed instances policy. A mixed instances policy contains the instance - * types Amazon EC2 Auto Scaling can launch, and other information Amazon EC2 Auto Scaling can use to launch instances to - * help you optimize your costs. For more information, see Auto Scaling groups with multiple - * instance types and purchase options in the Amazon EC2 Auto Scaling User - * Guide.
+ * types that Amazon EC2 Auto Scaling can launch and other information that Amazon EC2 Auto Scaling can use to launch + * instances and help optimize your costs. For more information, see Auto Scaling + * groups with multiple instance types and purchase options in the + * Amazon EC2 Auto Scaling User Guide. */ export interface MixedInstancesPolicy { /** *Specifies the launch template to use and the instance types (overrides) that are used - * to provision EC2 instances to fulfill On-Demand and Spot capacities. Required when - * creating a mixed instances policy.
+ * to launch EC2 instances to fulfill On-Demand and Spot capacities. Required when creating + * a mixed instances policy. */ LaunchTemplate?: LaunchTemplate; /** - *Specifies the instances distribution. If not provided, the value for each property in
- * InstancesDistribution uses a default value.
Specifies the instances distribution.
*/ InstancesDistribution?: InstancesDistribution; } @@ -1035,16 +1568,11 @@ export interface CreateAutoScalingGroupType { LaunchTemplate?: LaunchTemplateSpecification; /** - *An embedded object that specifies a mixed instances policy. The required properties - * must be specified. If optional properties are unspecified, their default values are - * used.
- *The policy includes properties that not only define the distribution of On-Demand
- * Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the
- * Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also
- * the properties that specify the instance configuration information—the launch template
- * and instance types. The policy can also include a weight for each instance type and
- * different launch templates for individual instance types. For more information, see
- * Auto Scaling groups with multiple
+ * An embedded object that specifies a mixed instances policy. For more information, see Auto Scaling groups with multiple
* instance types and purchase options in the Amazon EC2 Auto Scaling User
* Guide. Reserved. The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling
+ * supports By default, Amazon EC2 Auto Scaling specifies Valid values: Describes a filter that is used to return a more specific list of results from a
* describe operation. If you specify multiple filters, the filters are joined with an If you specify multiple filters, the filters are automatically logically joined with
+ * an For more information, see Tagging Auto Scaling groups and
* instances in the Amazon EC2 Auto Scaling User Guide. The name of the filter. The valid values for The valid values for
* DescribeAutoScalingGroups
*
- * DesiredCapacityType for attribute-based instance type selection
+ * only. For more information, see Creating
+ * an Auto Scaling group using attribute-based instance type selection in the
+ * Amazon EC2 Auto Scaling User Guide.units, which translates into number of
+ * instances.units | vcpu | memory-mib
+ * AND, and
- * the request returns only results that match all of the specified filters. AND, and the request returns only the results that match all of the
+ * specified filters. Name depend on the API operation that you are
- * including the filter in, DescribeAutoScalingGroups or DescribeTags.Name depend on which API operation you're using with
+ * the filter (DescribeAutoScalingGroups or DescribeTags).
*
tag-key - Accepts tag keys. The results will only include
- * information about the Auto Scaling groups associated with these tag keys. tag-key - Accepts tag keys. The results only include information
+ * about the Auto Scaling groups associated with these tag keys.
- * tag-value - Accepts tag values. The results will only include
+ * tag-value - Accepts tag values. The results only include
* information about the Auto Scaling groups associated with these tag values.
* tag: - Accepts the key/value combination of the tag.
* Use the tag key in the filter name and the tag value as the filter value. The
- * results will only include information about the Auto Scaling groups associated with the
+ * results only include information about the Auto Scaling groups associated with the
* specified key/value combination.
* auto-scaling-group - Accepts the names of Auto Scaling groups. The
- * results will only include information about the tags associated with these Auto Scaling
+ * results only include information about the tags associated with these Auto Scaling
* groups.
- * key - Accepts tag keys. The results will only include information
+ * key - Accepts tag keys. The results only include information
* about the tags associated with these tag keys.
- * value - Accepts tag values. The results will only include
- * information about the tags associated with these tag values.
value - Accepts tag values. The results only include information
+ * about the tags associated with these tag values.
*
- * propagate-at-launch - Accepts a boolean value, which specifies
- * whether tags propagate to instances at launch. The results will only include
- * information about the tags associated with the specified boolean value.
propagate-at-launch - Accepts a Boolean value, which specifies
+ * whether tags propagate to instances at launch. The results only include
+ * information about the tags associated with the specified Boolean value.
* One or more filter values. Filter values are case-sensitive.
- *If you specify multiple values for a filter, the values are joined with an
- * OR, and the request returns all results that match any of the specified
- * values. For example, specify "tag:environment" for the filter name and
+ *
If you specify multiple values for a filter, the values are automatically logically
+ * joined with an OR, and the request returns all results that match any of
+ * the specified values. For example, specify "tag:environment" for the filter name and
* "production,development" for the filter values to find Auto Scaling groups with the tag
* "environment=production" or "environment=development".
Reserved.
*/ Context?: string; + + /** + *The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling
+ * supports DesiredCapacityType for attribute-based instance type selection
+ * only. For more information, see Creating
+ * an Auto Scaling group using attribute-based instance type selection in the
+ * Amazon EC2 Auto Scaling User Guide.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of
+ * instances.
Valid values: units | vcpu | memory-mib
+ *
Describes a mixed instances policy. A mixed instances policy contains the instance - * types Amazon EC2 Auto Scaling can launch, and other information Amazon EC2 Auto Scaling can use to launch instances to - * help you optimize your costs. For more information, see Auto Scaling groups with multiple - * instance types and purchase options in the Amazon EC2 Auto Scaling User - * Guide.
+ * types that Amazon EC2 Auto Scaling can launch and other information that Amazon EC2 Auto Scaling can use to launch + * instances and help optimize your costs. For more information, see Auto Scaling + * groups with multiple instance types and purchase options in the + * Amazon EC2 Auto Scaling User Guide. */ MixedInstancesPolicy?: MixedInstancesPolicy; } @@ -6586,9 +7142,8 @@ export interface UpdateAutoScalingGroupType { LaunchTemplate?: LaunchTemplateSpecification; /** - *An embedded object that specifies a mixed instances policy. When you make changes to
- * an existing policy, all optional properties are left unchanged if not specified. For
- * more information, see Auto Scaling groups with multiple
+ * An embedded object that specifies a mixed instances policy. For more information, see
+ * Auto Scaling groups with multiple
* instance types and purchase options in the Amazon EC2 Auto Scaling User
* Guide. Reserved. The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling
+ * supports By default, Amazon EC2 Auto Scaling specifies Valid values: The Amazon Chime SDK Identity APIs in this section allow software developers to create
@@ -302,6 +338,38 @@ export class ChimeSDKIdentity extends ChimeSDKIdentityClient {
}
}
+ /**
+ * Deregisters an Returns the full details of an Returns the full details of an Gets the retention settings for an Lists all the List all Lists the tags applied to an Amazon Chime SDK identity resource. Sets the amount of time in days that a given Registers an endpoint under an Amazon Chime Applies the specified tags to the specified Amazon Chime SDK identity resource. Removes the specified tags from the specified Amazon Chime SDK identity resource. Updates Updates the details of an Deregisters an Returns the full details of an Lists all the Lists the tags applied to an Amazon Chime SDK identity resource. Registers an endpoint under an Amazon Chime Applies the specified tags to the specified Amazon Chime SDK identity resource. Removes the specified tags from the specified Amazon Chime SDK identity resource. Updates the details of an The details of an The attributes of an The device token for the GCM, APNS, and APNS_SANDBOX endpoint types. The VOIP device token for the APNS and APNS_SANDBOX endpoint types. A read-only field that represents the state of an
+ *
+ *
+ *
+ * Enum that indicates the Status of an The reason for the An endpoint under an Amazon Chime The ARN of the The unique identifier of the The name of the The type of the The ARN of the resource to which the endpoint belongs. The attributes of an The time at which an The time at which an Boolean that controls whether the A read-only field that represents the state of an
+ *
+ *
+ *
+ * Summary of the details of an The ARN of the The unique identifier of the The name of the The type of the BBoolean that controls whether the A read-only field that represent the state of an Summary of the details of an Describes a tag applied to a resource. A tag object containing a key-value pair. The key of the tag. The key in a tag. The value of the tag. The value in a tag. The ARN of the The unique identifier of the The ARN of the The ARN of the The unique identifier of the The full details of an The ARN of the The ARN of the The maximum number of endpoints that you want to return. The token passed by previous API calls until all requested endpoints are returned. The information for each requested The token passed by previous API calls until all requested endpoints are returned. The ARN of the The ARN of the resource. The tag key-value pairs. The ARN of the The ARN of the The name of the The type of the
+ *
+ *
+ * Populate the The ARN of the resource to which the endpoint belongs. The attributes of an The idempotency token for each client request. Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. The ARN of the The unique identifier of the The resource ARN. The tag key-value pairs. The resource ARN. The tag keys. The ARN of the The ARN of the The unique identifier of the The name of the Boolean that controls whether the The ARN of the The unique identifier of the Adds a user to a channel. The Adds a user to a channel. The Gets the membership preferences of an Gets the full details of a channel message. Lists all channel memberships in a channel. The If you want to list the channels to which a specific app instance user belongs, see the
+ * ListChannelMembershipsForAppInstanceUser API. Sets the membership preferences of an Redacts message content, but not metadata. The message exists in the back end, but the
* action returns null content, and the state shows as redacted. Adds a user to a channel. The Adds a user to a channel. The Gets the membership preferences of an Lists all channel memberships in a channel. The If you want to list the channels to which a specific app instance user belongs, see the
+ * ListChannelMembershipsForAppInstanceUser API. Sets the membership preferences of an The ARNs of the members you want to add to the channel. The The ARN of the member that the service couldn't add. The Determines whether to continue or stop processing if communication with processor fails. If the last processor in a channel flow sequence has a fallback action of CONTINUE, and communication
- * with the processor fails, the message is considered processed and sent to the recipients in the channel. Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of The channel membership preferences for push notification. Enum value that indicates which push notifications to send to the requested member of a channel.
+ * The simple JSON object used to send a subset of a push notification to the requsted member. The channel membership preferences for an The push notification configuration of a message. Summary of the details of a A list of message attribute values. The strings in a message attribute value. The status of the channel message. The attributes for the message, used for message filtering along with a DesiredCapacityType for attribute-based instance type selection
+ * only. For more information, see Creating
+ * an Auto Scaling group using attribute-based instance type selection in the
+ * Amazon EC2 Auto Scaling User Guide.units, which translates into number of
+ * instances.units | vcpu | memory-mib
+ * AppInstanceUserEndpoint.AppInstance.AppInstanceUserEndpoint.AppInstance.AppInstanceUserEndpoints created under a single AppInstanceUser.AppInstanceUsers created under a single
* AppInstance.AppInstance retains
* data.AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.AppInstance metadata.AppInstanceUserEndpoint. You can update the name and AllowMessage values.AppInstanceUserEndpoint.AppInstanceUserEndpoint.AppInstanceUserEndpoints created under a single AppInstanceUser.AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.AppInstanceUserEndpoint. You can update the name and AllowMessage values.AppInstance, an instance of an Amazon Chime SDK messaging
* application.Endpoint.AppInstanceUserEndpoint. Supported values:
+ *
+ */
+export interface EndpointState {
+ /**
+ * ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive
+ * message. When INACTIVE, the corresponding reason will be conveyed through
+ * EndpointStatusReason.INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device tokenINVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.AppInstanceUserEndpoint.EndpointStatus.AppInstanceUser that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.AppInstanceUser.AppInstanceUserEndpoint.AppInstanceUserEndpoint.AppInstanceUserEndpoint.Endpoint.AppInstanceUserEndpoint was created.AppInstanceUserEndpoint was last updated.AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages.
+ * NONE indicates the endpoint will receive no messages.AppInstanceUserEndpoint. Supported values:
+ *
+ */
+ EndpointState?: EndpointState;
+}
+
+export namespace AppInstanceUserEndpoint {
+ /**
+ * @internal
+ */
+ export const filterSensitiveLog = (obj: AppInstanceUserEndpoint): any => ({
+ ...obj,
+ ...(obj.AppInstanceUserArn && { AppInstanceUserArn: SENSITIVE_STRING }),
+ ...(obj.EndpointId && { EndpointId: SENSITIVE_STRING }),
+ ...(obj.Name && { Name: SENSITIVE_STRING }),
+ ...(obj.ResourceArn && { ResourceArn: SENSITIVE_STRING }),
+ ...(obj.EndpointAttributes && {
+ EndpointAttributes: EndpointAttributes.filterSensitiveLog(obj.EndpointAttributes),
+ }),
+ });
+}
+
+/**
+ * ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be
+ * conveyed through EndpointStatusReason.INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device tokenINVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input
+ * through the ResourceArn field.AppInstanceUserEndpoint.AppInstanceUser.AppInstanceUserEndpoint.AppInstanceUserEndpoint.AppInstanceUserEndpoint.AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages.
+ * NONE indicates the endpoint will receive no messages.AppInstanceUserEndpoint.AppInstanceUser.AppInstanceUser.AppInstanceUserEndpoint.AppInstance.AppInstanceUser.AppInstanceUserEndpoint.AppInstanceUserEndpoint: the AppInstanceUserArn, ID, name, type, resource ARN, attributes,
+ * allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.AppInstance.AppInstanceUser.AppInstanceUserEndpoint.AppInstance.AppInstance.AppInstanceUser.AppInstanceUserEndpoint.AppInstanceUserEndpoint. Supported types:
+ *
+ * APNS: The mobile notification service for an Apple device.APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.GCM: The mobile notification service for an Android device.ResourceArn value of each type as PinpointAppArn.Endpoint.ALL indicates the endpoint receives all messages.
+ * NONE indicates the endpoint receives no messages.AppInstanceUser.AppInstanceUserEndpoint.AppInstance.AppInstanceUser.AppInstanceUserEndpoint.AppInstanceUserEndpoint.AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages.
+ * NONE indicates the endpoint will receive no messages.AppInstanceUser.AppInstanceUserEndpoint.InvitedBy response field is derived from the
+ * InvitedBy field in ChannelMembership is derived from the
* request header. A channel member can:
@@ -1131,6 +1141,40 @@ export class ChimeSDKMessaging extends ChimeSDKMessagingClient {
}
}
+ /**
+ *
AppInstanceUser for the specified channel. The AppInstanceUser must be a member of the channel.
+ * Only the AppInstanceUser who owns the membership can retrieve preferences. Users in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users.
+ * Banned users can't retrieve membership preferences for the channel from which they are banned.x-amz-chime-bearer request header is mandatory. Use the
* AppInstanceUserArn of the user that makes the API call as the value in
* the header.AppInstanceUser for the specified channel. The AppInstanceUser must be a member of the channel.
+ * Only the AppInstanceUser who owns the membership can set preferences. Users in the AppInstanceAdmin and channel moderator roles can't set preferences for other users.
+ * Banned users can't set membership preferences for the channel from which they are banned.InvitedBy response field is derived from the
+ * InvitedBy field in ChannelMembership is derived from the
* request header. A channel member can:
diff --git a/clients/client-chime-sdk-messaging/src/commands/GetChannelMembershipPreferencesCommand.ts b/clients/client-chime-sdk-messaging/src/commands/GetChannelMembershipPreferencesCommand.ts
new file mode 100644
index 000000000000..579bcfa01e90
--- /dev/null
+++ b/clients/client-chime-sdk-messaging/src/commands/GetChannelMembershipPreferencesCommand.ts
@@ -0,0 +1,109 @@
+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,
+ HttpHandlerOptions as __HttpHandlerOptions,
+ MetadataBearer as __MetadataBearer,
+ MiddlewareStack,
+ SerdeContext as __SerdeContext,
+} from "@aws-sdk/types";
+
+import {
+ ChimeSDKMessagingClientResolvedConfig,
+ ServiceInputTypes,
+ ServiceOutputTypes,
+} from "../ChimeSDKMessagingClient";
+import { GetChannelMembershipPreferencesRequest, GetChannelMembershipPreferencesResponse } from "../models/models_0";
+import {
+ deserializeAws_restJson1GetChannelMembershipPreferencesCommand,
+ serializeAws_restJson1GetChannelMembershipPreferencesCommand,
+} from "../protocols/Aws_restJson1";
+
+export interface GetChannelMembershipPreferencesCommandInput extends GetChannelMembershipPreferencesRequest {}
+export interface GetChannelMembershipPreferencesCommandOutput
+ extends GetChannelMembershipPreferencesResponse,
+ __MetadataBearer {}
+
+/**
+ *
AppInstanceUser for the specified channel. The AppInstanceUser must be a member of the channel.
+ * Only the AppInstanceUser who owns the membership can retrieve preferences. Users in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users.
+ * Banned users can't retrieve membership preferences for the channel from which they are banned.x-amz-chime-bearer request header is mandatory. Use the
* AppInstanceUserArn of the user that makes the API call as the value in
* the header.AppInstanceUser for the specified channel. The AppInstanceUser must be a member of the channel.
+ * Only the AppInstanceUser who owns the membership can set preferences. Users in the AppInstanceAdmin and channel moderator roles can't set preferences for other users.
+ * Banned users can't set membership preferences for the channel from which they are banned.AppInstanceUserArns of the members you want to add to the channel.AppInstanceUserArn of the member that the service couldn't add.ABORT and
+ * communication with it fails, the processor sets the message status to FAILED and does not send the message to any recipients. Note that if the last processor in the channel flow sequence
+ * has a fallback action of CONTINUE and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered push notifications.
+ * AppInstanceUser.ChannelMembership.FilterRule defined in the PushNotificationPreferences.
The message attribues listed in a the summary of a channel message.
+ */ + MessageAttributes?: { [key: string]: MessageAttributeValue }; } export namespace ChannelMessageSummary { @@ -1117,6 +1212,15 @@ export namespace ChannelMessageSummary { ...(obj.Content && { Content: SENSITIVE_STRING }), ...(obj.Metadata && { Metadata: SENSITIVE_STRING }), ...(obj.Sender && { Sender: Identity.filterSensitiveLog(obj.Sender) }), + ...(obj.MessageAttributes && { + MessageAttributes: Object.entries(obj.MessageAttributes).reduce( + (acc: any, [key, value]: [string, MessageAttributeValue]) => ({ + ...acc, + [key]: MessageAttributeValue.filterSensitiveLog(value), + }), + {} + ), + }), }); } @@ -1323,7 +1427,7 @@ export interface CreateChannelBanRequest { ChannelArn: string | undefined; /** - *The ARN of the member being banned.
+ *The AppInstanceUserArn of the member being banned.
The ARN of the member you want to add to the channel.
+ *The AppInstanceUserArn of the member you want to add to the channel.
The ARN of the moderator.
+ *The AppInstanceUserArn of the moderator.
The ARN of the member that you're removing from the channel.
+ *The AppInstanceUserArn of the member that you're removing from the channel.
The ARN of the moderator being deleted.
+ *The AppInstanceUserArn of the moderator being deleted.
The ARN of the member being banned.
+ *The AppInstanceUserArn of the member being banned.
The ARN of the member.
+ *The AppInstanceUserArn of the member.
The ARN of the channel moderator.
+ *The AppInstanceUserArn of the channel moderator.
The ARN of the channel.
+ */ + ChannelArn: string | undefined; + + /** + *The AppInstanceUserArn of the member retrieving the preferences.
The AppInstanceUserARN of the user making the API call.
The ARN of the channel.
+ */ + ChannelArn?: string; + + /** + *The details of a user.
+ */ + Member?: Identity; + + /** + *The channel membership preferences for an AppInstanceUser .
The ARN of the channel.
@@ -2710,6 +2868,66 @@ export namespace ListTagsForResourceResponse { }); } +export interface PutChannelMembershipPreferencesRequest { + /** + *The ARN of the channel.
+ */ + ChannelArn: string | undefined; + + /** + *The AppInstanceUserArn of the member setting the preferences.
The AppInstanceUserARN of the user making the API call.
The channel membership preferences of an AppInstanceUser .
The ARN of the channel.
+ */ + ChannelArn?: string; + + /** + *The details of a user.
+ */ + Member?: Identity; + + /** + *The ARN and metadata of the member being added.
+ */ + Preferences?: ChannelMembershipPreferences; +} + +export namespace PutChannelMembershipPreferencesResponse { + /** + * @internal + */ + export const filterSensitiveLog = (obj: PutChannelMembershipPreferencesResponse): any => ({ + ...obj, + ...(obj.Member && { Member: Identity.filterSensitiveLog(obj.Member) }), + ...(obj.Preferences && { Preferences: ChannelMembershipPreferences.filterSensitiveLog(obj.Preferences) }), + }); +} + export interface RedactChannelMessageRequest { /** *The ARN of the channel containing the messages that you want to redact.
@@ -2757,6 +2975,44 @@ export namespace RedactChannelMessageResponse { }); } +export enum PushNotificationType { + DEFAULT = "DEFAULT", + VOIP = "VOIP", +} + +/** + *The push notification configuration of the message.
+ */ +export interface PushNotificationConfiguration { + /** + *The title of the push notification.
+ */ + Title: string | undefined; + + /** + *The body of the push notification.
+ */ + Body: string | undefined; + + /** + *Enum value that indicates the type of the push notification for a message.
+ * DEFAULT: Normal mobile push notification.
+ * VOIP: VOIP mobile push notification.
The ARN of the channel.
@@ -2792,6 +3048,16 @@ export interface SendChannelMessageRequest { *The AppInstanceUserArn of the user that makes the API call.
The push notification configuration of the message.
+ */ + PushNotification?: PushNotificationConfiguration; + + /** + *The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
Allows you to confirm that the attachment has been uploaded using the pre-signed URL * provided in StartAttachmentUpload API.
+ *The Amazon Connect Participant Service APIs do not use Signature Version 4 + * authentication.
*/ public completeAttachmentUpload( args: CompleteAttachmentUploadCommandInput, @@ -77,29 +79,35 @@ export class ConnectParticipant extends ConnectParticipantClient { } /** - *Creates the participant's connection. Note that ParticipantToken is used for invoking - * this API instead of ConnectionToken.
- *The participant token is valid for the lifetime of the participant – until they are - * part of a contact.
+ *Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of + * ConnectionToken.
+ *The participant token is valid for the lifetime of the participant – + * until they are part of a contact.
*The response URL for WEBSOCKET Type has a connect expiry timeout of 100s.
* Clients must manually connect to the returned websocket URL and subscribe to the desired
* topic.
For chat, you need to publish the following on the established websocket * connection:
- * - * *
* {"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}
*
Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, * clients need to call this API again to obtain a new websocket URL and perform the same * steps as before.
- * + *+ * Message streaming support: This API can also be used together with the + * StartContactStreaming + * API to create a participant connection for chat contacts that are + * not using a websocket. For more information about message streaming, Enable real-time chat message streaming in the Amazon Connect + * Administrator Guide.
+ *+ * Feature specifications: For information about feature specifications, such as the allowed number of open + * websocket connections per participant, see Feature specifications in the Amazon Connect Administrator + * Guide.
*The Amazon Connect Participant Service APIs do not use Signature Version 4 * authentication.
- *Disconnects a participant. Note that ConnectionToken is used for invoking this API * instead of ParticipantToken.
- *The Amazon Connect Participant Service APIs do not use Signature Version 4 - * authentication.
+ *The Amazon Connect Participant Service APIs do not use Signature Version 4 + * authentication.
*/ public disconnectParticipant( args: DisconnectParticipantCommandInput, @@ -168,6 +176,8 @@ export class ConnectParticipant extends ConnectParticipantClient { /** *Provides a pre-signed URL for download of a completed attachment. This is an * asynchronous API for use with active contacts.
+ *The Amazon Connect Participant Service APIs do not use Signature Version 4 + * authentication.
*/ public getAttachment( args: GetAttachmentCommandInput, @@ -202,7 +212,7 @@ export class ConnectParticipant extends ConnectParticipantClient { *Retrieves a transcript of the session, including details about any attachments. Note * that ConnectionToken is used for invoking this API instead of ParticipantToken.
*The Amazon Connect Participant Service APIs do not use Signature Version 4 - * authentication.
+ * authentication. */ public getTranscript( args: GetTranscriptCommandInput, @@ -236,8 +246,8 @@ export class ConnectParticipant extends ConnectParticipantClient { /** *Sends an event. Note that ConnectionToken is used for invoking this API instead of * ParticipantToken.
- *The Amazon Connect Participant Service APIs do not use Signature Version 4 - * authentication.
+ *The Amazon Connect Participant Service APIs do not use Signature Version 4 + * authentication.
*/ public sendEvent(args: SendEventCommandInput, options?: __HttpHandlerOptions): PromiseSends a message. Note that ConnectionToken is used for invoking this API instead of * ParticipantToken.
- *The Amazon Connect Participant Service APIs do not use Signature Version 4
+ * The Amazon Connect Participant Service APIs do not use Signature Version 4
* authentication.
Provides a pre-signed Amazon S3 URL in response for uploading the file directly to * S3.
+ *The Amazon Connect Participant Service APIs do not use Signature Version 4 + * authentication.
*/ public startAttachmentUpload( args: StartAttachmentUploadCommandInput, diff --git a/clients/client-connectparticipant/src/commands/CompleteAttachmentUploadCommand.ts b/clients/client-connectparticipant/src/commands/CompleteAttachmentUploadCommand.ts index f503251875e8..ccd06bf2a13b 100644 --- a/clients/client-connectparticipant/src/commands/CompleteAttachmentUploadCommand.ts +++ b/clients/client-connectparticipant/src/commands/CompleteAttachmentUploadCommand.ts @@ -28,6 +28,8 @@ export interface CompleteAttachmentUploadCommandOutput extends CompleteAttachmen /** *Allows you to confirm that the attachment has been uploaded using the pre-signed URL * provided in StartAttachmentUpload API.
+ *The Amazon Connect Participant Service APIs do not use Signature Version 4 + * authentication.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connectparticipant/src/commands/CreateParticipantConnectionCommand.ts b/clients/client-connectparticipant/src/commands/CreateParticipantConnectionCommand.ts index 7a894a377bcd..2bbb2d9cb9a0 100644 --- a/clients/client-connectparticipant/src/commands/CreateParticipantConnectionCommand.ts +++ b/clients/client-connectparticipant/src/commands/CreateParticipantConnectionCommand.ts @@ -28,29 +28,35 @@ export interface CreateParticipantConnectionCommandOutput __MetadataBearer {} /** - *Creates the participant's connection. Note that ParticipantToken is used for invoking - * this API instead of ConnectionToken.
- *The participant token is valid for the lifetime of the participant – until they are - * part of a contact.
+ *Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of + * ConnectionToken.
+ *The participant token is valid for the lifetime of the participant – + * until they are part of a contact.
*The response URL for WEBSOCKET Type has a connect expiry timeout of 100s.
* Clients must manually connect to the returned websocket URL and subscribe to the desired
* topic.
For chat, you need to publish the following on the established websocket * connection:
- * - * *
* {"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}
*
Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, * clients need to call this API again to obtain a new websocket URL and perform the same * steps as before.
- * + *+ * Message streaming support: This API can also be used together with the + * StartContactStreaming + * API to create a participant connection for chat contacts that are + * not using a websocket. For more information about message streaming, Enable real-time chat message streaming in the Amazon Connect + * Administrator Guide.
+ *+ * Feature specifications: For information about feature specifications, such as the allowed number of open + * websocket connections per participant, see Feature specifications in the Amazon Connect Administrator + * Guide.
*The Amazon Connect Participant Service APIs do not use Signature Version 4 * authentication.
- *Disconnects a participant. Note that ConnectionToken is used for invoking this API * instead of ParticipantToken.
- *The Amazon Connect Participant Service APIs do not use Signature Version 4 - * authentication.
+ *The Amazon Connect Participant Service APIs do not use Signature Version 4 + * authentication.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connectparticipant/src/commands/GetAttachmentCommand.ts b/clients/client-connectparticipant/src/commands/GetAttachmentCommand.ts index 4cda233a4e98..faddd544426a 100644 --- a/clients/client-connectparticipant/src/commands/GetAttachmentCommand.ts +++ b/clients/client-connectparticipant/src/commands/GetAttachmentCommand.ts @@ -28,6 +28,8 @@ export interface GetAttachmentCommandOutput extends GetAttachmentResponse, __Met /** *Provides a pre-signed URL for download of a completed attachment. This is an * asynchronous API for use with active contacts.
+ *The Amazon Connect Participant Service APIs do not use Signature Version 4 + * authentication.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connectparticipant/src/commands/GetTranscriptCommand.ts b/clients/client-connectparticipant/src/commands/GetTranscriptCommand.ts index da8f0f7f3357..22bc7748747e 100644 --- a/clients/client-connectparticipant/src/commands/GetTranscriptCommand.ts +++ b/clients/client-connectparticipant/src/commands/GetTranscriptCommand.ts @@ -29,7 +29,7 @@ export interface GetTranscriptCommandOutput extends GetTranscriptResponse, __Met *Retrieves a transcript of the session, including details about any attachments. Note * that ConnectionToken is used for invoking this API instead of ParticipantToken.
*The Amazon Connect Participant Service APIs do not use Signature Version 4 - * authentication.
+ * authentication. * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connectparticipant/src/commands/SendEventCommand.ts b/clients/client-connectparticipant/src/commands/SendEventCommand.ts index d35f210e4634..074d637b2690 100644 --- a/clients/client-connectparticipant/src/commands/SendEventCommand.ts +++ b/clients/client-connectparticipant/src/commands/SendEventCommand.ts @@ -28,8 +28,8 @@ export interface SendEventCommandOutput extends SendEventResponse, __MetadataBea /** *Sends an event. Note that ConnectionToken is used for invoking this API instead of * ParticipantToken.
- *The Amazon Connect Participant Service APIs do not use Signature Version 4 - * authentication.
+ *The Amazon Connect Participant Service APIs do not use Signature Version 4 + * authentication.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connectparticipant/src/commands/SendMessageCommand.ts b/clients/client-connectparticipant/src/commands/SendMessageCommand.ts index 4f91f2e8cfc4..345c9628ad54 100644 --- a/clients/client-connectparticipant/src/commands/SendMessageCommand.ts +++ b/clients/client-connectparticipant/src/commands/SendMessageCommand.ts @@ -28,10 +28,8 @@ export interface SendMessageCommandOutput extends SendMessageResponse, __Metadat /** *Sends a message. Note that ConnectionToken is used for invoking this API instead of * ParticipantToken.
- *The Amazon Connect Participant Service APIs do not use Signature Version 4
+ * The Amazon Connect Participant Service APIs do not use Signature Version 4
* authentication.
Provides a pre-signed Amazon S3 URL in response for uploading the file directly to * S3.
+ *The Amazon Connect Participant Service APIs do not use Signature Version 4 + * authentication.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connectparticipant/src/models/models_0.ts b/clients/client-connectparticipant/src/models/models_0.ts index 7a531d7a1ad8..e13f4937ce62 100644 --- a/clients/client-connectparticipant/src/models/models_0.ts +++ b/clients/client-connectparticipant/src/models/models_0.ts @@ -159,10 +159,16 @@ export interface CreateParticipantConnectionRequest { /** *This is a header parameter.
- *The Participant Token as obtained from StartChatContact + *
The ParticipantToken as obtained from StartChatContact * API response.
*/ ParticipantToken: string | undefined; + + /** + *Amazon Connect Participant is used to mark the participant as connected for message + * streaming.
+ */ + ConnectParticipant?: boolean; } export namespace CreateParticipantConnectionRequest { @@ -304,7 +310,8 @@ export namespace GetAttachmentRequest { export interface GetAttachmentResponse { /** - *The pre-signed URL using which file would be downloaded from Amazon S3 by the API caller.
+ *This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response + * to StartAttachmentUpload.
*/ Url?: string; @@ -466,6 +473,10 @@ export enum ChatItemType { CONNECTION_ACK = "CONNECTION_ACK", EVENT = "EVENT", MESSAGE = "MESSAGE", + PARTICIPANT_ACTIVE = "PARTICIPANT_ACTIVE", + PARTICIPANT_DISENGAGED = "PARTICIPANT_DISENGAGED", + PARTICIPANT_ENGAGED = "PARTICIPANT_ENGAGED", + PARTICIPANT_INACTIVE = "PARTICIPANT_INACTIVE", PARTICIPANT_JOINED = "PARTICIPANT_JOINED", PARTICIPANT_LEFT = "PARTICIPANT_LEFT", TRANSFER_FAILED = "TRANSFER_FAILED", @@ -722,7 +733,8 @@ export namespace StartAttachmentUploadRequest { */ export interface UploadMetadata { /** - *The pre-signed URL using which file would be downloaded from Amazon S3 by the API caller.
+ *This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response + * to StartAttachmentUpload.
*/ Url?: string; diff --git a/clients/client-connectparticipant/src/protocols/Aws_restJson1.ts b/clients/client-connectparticipant/src/protocols/Aws_restJson1.ts index 9448780b461d..2a1e6e4f0a1a 100644 --- a/clients/client-connectparticipant/src/protocols/Aws_restJson1.ts +++ b/clients/client-connectparticipant/src/protocols/Aws_restJson1.ts @@ -92,6 +92,8 @@ export const serializeAws_restJson1CreateParticipantConnectionCommand = async ( `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/participant/connection"; let body: any; body = JSON.stringify({ + ...(input.ConnectParticipant !== undefined && + input.ConnectParticipant !== null && { ConnectParticipant: input.ConnectParticipant }), ...(input.Type !== undefined && input.Type !== null && { Type: serializeAws_restJson1ConnectionTypeList(input.Type, context) }), }); diff --git a/clients/client-ec2/src/EC2.ts b/clients/client-ec2/src/EC2.ts index 430ca3078122..ff9426a4e057 100644 --- a/clients/client-ec2/src/EC2.ts +++ b/clients/client-ec2/src/EC2.ts @@ -1695,6 +1695,11 @@ import { GetHostReservationPurchasePreviewCommandInput, GetHostReservationPurchasePreviewCommandOutput, } from "./commands/GetHostReservationPurchasePreviewCommand"; +import { + GetInstanceTypesFromInstanceRequirementsCommand, + GetInstanceTypesFromInstanceRequirementsCommandInput, + GetInstanceTypesFromInstanceRequirementsCommandOutput, +} from "./commands/GetInstanceTypesFromInstanceRequirementsCommand"; import { GetLaunchTemplateDataCommand, GetLaunchTemplateDataCommandInput, @@ -1725,6 +1730,11 @@ import { GetSerialConsoleAccessStatusCommandInput, GetSerialConsoleAccessStatusCommandOutput, } from "./commands/GetSerialConsoleAccessStatusCommand"; +import { + GetSpotPlacementScoresCommand, + GetSpotPlacementScoresCommandInput, + GetSpotPlacementScoresCommandOutput, +} from "./commands/GetSpotPlacementScoresCommand"; import { GetSubnetCidrReservationsCommand, GetSubnetCidrReservationsCommandInput, @@ -14931,6 +14941,49 @@ export class EC2 extends EC2Client { } } + /** + *Returns a list of instance types with the specified instance attributes. You can + * use the response to preview the instance types without launching instances. Note + * that the response does not consider capacity.
+ *When you specify multiple parameters, you get instance types that satisfy all of the + * specified parameters. If you specify multiple values for a parameter, you get instance + * types that satisfy any of the specified values.
+ *For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot + * placement score in the Amazon EC2 User Guide, and Creating an + * Auto Scaling group using attribute-based instance type selection in the + * Amazon EC2 Auto Scaling User Guide.
+ */ + public getInstanceTypesFromInstanceRequirements( + args: GetInstanceTypesFromInstanceRequirementsCommandInput, + options?: __HttpHandlerOptions + ): PromiseRetrieves the configuration data of the specified instance. You can use this data * to create a launch template.
@@ -15144,6 +15197,45 @@ export class EC2 extends EC2Client { } } + /** + *Calculates the Spot placement score for a Region or Availability Zone based on the + * specified target capacity and compute requirements.
+ *You can specify your compute requirements either by using
+ * InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal
+ * instance types to fulfill your Spot request, or you can specify the instance types by using
+ * InstanceTypes.
For more information, see Spot placement score in + * the Amazon EC2 User Guide.
+ */ + public getSpotPlacementScores( + args: GetSpotPlacementScoresCommandInput, + options?: __HttpHandlerOptions + ): PromiseGets information about the subnet CIDR reservations.
*/ diff --git a/clients/client-ec2/src/EC2Client.ts b/clients/client-ec2/src/EC2Client.ts index d926719cc6fd..cb738a20013d 100644 --- a/clients/client-ec2/src/EC2Client.ts +++ b/clients/client-ec2/src/EC2Client.ts @@ -1218,6 +1218,10 @@ import { GetHostReservationPurchasePreviewCommandInput, GetHostReservationPurchasePreviewCommandOutput, } from "./commands/GetHostReservationPurchasePreviewCommand"; +import { + GetInstanceTypesFromInstanceRequirementsCommandInput, + GetInstanceTypesFromInstanceRequirementsCommandOutput, +} from "./commands/GetInstanceTypesFromInstanceRequirementsCommand"; import { GetLaunchTemplateDataCommandInput, GetLaunchTemplateDataCommandOutput, @@ -1239,6 +1243,10 @@ import { GetSerialConsoleAccessStatusCommandInput, GetSerialConsoleAccessStatusCommandOutput, } from "./commands/GetSerialConsoleAccessStatusCommand"; +import { + GetSpotPlacementScoresCommandInput, + GetSpotPlacementScoresCommandOutput, +} from "./commands/GetSpotPlacementScoresCommand"; import { GetSubnetCidrReservationsCommandInput, GetSubnetCidrReservationsCommandOutput, @@ -1980,12 +1988,14 @@ export type ServiceInputTypes = | GetFlowLogsIntegrationTemplateCommandInput | GetGroupsForCapacityReservationCommandInput | GetHostReservationPurchasePreviewCommandInput + | GetInstanceTypesFromInstanceRequirementsCommandInput | GetLaunchTemplateDataCommandInput | GetManagedPrefixListAssociationsCommandInput | GetManagedPrefixListEntriesCommandInput | GetPasswordDataCommandInput | GetReservedInstancesExchangeQuoteCommandInput | GetSerialConsoleAccessStatusCommandInput + | GetSpotPlacementScoresCommandInput | GetSubnetCidrReservationsCommandInput | GetTransitGatewayAttachmentPropagationsCommandInput | GetTransitGatewayMulticastDomainAssociationsCommandInput @@ -2453,12 +2463,14 @@ export type ServiceOutputTypes = | GetFlowLogsIntegrationTemplateCommandOutput | GetGroupsForCapacityReservationCommandOutput | GetHostReservationPurchasePreviewCommandOutput + | GetInstanceTypesFromInstanceRequirementsCommandOutput | GetLaunchTemplateDataCommandOutput | GetManagedPrefixListAssociationsCommandOutput | GetManagedPrefixListEntriesCommandOutput | GetPasswordDataCommandOutput | GetReservedInstancesExchangeQuoteCommandOutput | GetSerialConsoleAccessStatusCommandOutput + | GetSpotPlacementScoresCommandOutput | GetSubnetCidrReservationsCommandOutput | GetTransitGatewayAttachmentPropagationsCommandOutput | GetTransitGatewayMulticastDomainAssociationsCommandOutput diff --git a/clients/client-ec2/src/commands/CreateFleetCommand.ts b/clients/client-ec2/src/commands/CreateFleetCommand.ts index 13a72a92ef75..0ae5f9296b92 100644 --- a/clients/client-ec2/src/commands/CreateFleetCommand.ts +++ b/clients/client-ec2/src/commands/CreateFleetCommand.ts @@ -12,7 +12,8 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { CreateFleetRequest, CreateFleetResult } from "../models/models_0"; +import { CreateFleetRequest } from "../models/models_0"; +import { CreateFleetResult } from "../models/models_1"; import { deserializeAws_ec2CreateFleetCommand, serializeAws_ec2CreateFleetCommand } from "../protocols/Aws_ec2"; export interface CreateFleetCommandInput extends CreateFleetRequest {} diff --git a/clients/client-ec2/src/commands/CreateFlowLogsCommand.ts b/clients/client-ec2/src/commands/CreateFlowLogsCommand.ts index bca6e79cb37a..b39ae72eaf21 100644 --- a/clients/client-ec2/src/commands/CreateFlowLogsCommand.ts +++ b/clients/client-ec2/src/commands/CreateFlowLogsCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { CreateFlowLogsRequest, CreateFlowLogsResult } from "../models/models_0"; +import { CreateFlowLogsRequest, CreateFlowLogsResult } from "../models/models_1"; import { deserializeAws_ec2CreateFlowLogsCommand, serializeAws_ec2CreateFlowLogsCommand } from "../protocols/Aws_ec2"; export interface CreateFlowLogsCommandInput extends CreateFlowLogsRequest {} diff --git a/clients/client-ec2/src/commands/CreateFpgaImageCommand.ts b/clients/client-ec2/src/commands/CreateFpgaImageCommand.ts index 7739a2239247..69778b9e8fc3 100644 --- a/clients/client-ec2/src/commands/CreateFpgaImageCommand.ts +++ b/clients/client-ec2/src/commands/CreateFpgaImageCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { CreateFpgaImageRequest, CreateFpgaImageResult } from "../models/models_0"; +import { CreateFpgaImageRequest, CreateFpgaImageResult } from "../models/models_1"; import { deserializeAws_ec2CreateFpgaImageCommand, serializeAws_ec2CreateFpgaImageCommand } from "../protocols/Aws_ec2"; export interface CreateFpgaImageCommandInput extends CreateFpgaImageRequest {} diff --git a/clients/client-ec2/src/commands/CreateImageCommand.ts b/clients/client-ec2/src/commands/CreateImageCommand.ts index 3d40f1666f53..9404ff1fdd5f 100644 --- a/clients/client-ec2/src/commands/CreateImageCommand.ts +++ b/clients/client-ec2/src/commands/CreateImageCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { CreateImageRequest, CreateImageResult } from "../models/models_0"; +import { CreateImageRequest, CreateImageResult } from "../models/models_1"; import { deserializeAws_ec2CreateImageCommand, serializeAws_ec2CreateImageCommand } from "../protocols/Aws_ec2"; export interface CreateImageCommandInput extends CreateImageRequest {} diff --git a/clients/client-ec2/src/commands/CreateVpcEndpointServiceConfigurationCommand.ts b/clients/client-ec2/src/commands/CreateVpcEndpointServiceConfigurationCommand.ts index 3e46a7ff24a2..01e8befa27f4 100644 --- a/clients/client-ec2/src/commands/CreateVpcEndpointServiceConfigurationCommand.ts +++ b/clients/client-ec2/src/commands/CreateVpcEndpointServiceConfigurationCommand.ts @@ -15,7 +15,7 @@ import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from " import { CreateVpcEndpointServiceConfigurationRequest, CreateVpcEndpointServiceConfigurationResult, -} from "../models/models_1"; +} from "../models/models_2"; import { deserializeAws_ec2CreateVpcEndpointServiceConfigurationCommand, serializeAws_ec2CreateVpcEndpointServiceConfigurationCommand, diff --git a/clients/client-ec2/src/commands/CreateVpcPeeringConnectionCommand.ts b/clients/client-ec2/src/commands/CreateVpcPeeringConnectionCommand.ts index aa059cadf143..3292ba092260 100644 --- a/clients/client-ec2/src/commands/CreateVpcPeeringConnectionCommand.ts +++ b/clients/client-ec2/src/commands/CreateVpcPeeringConnectionCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { CreateVpcPeeringConnectionRequest, CreateVpcPeeringConnectionResult } from "../models/models_1"; +import { CreateVpcPeeringConnectionRequest, CreateVpcPeeringConnectionResult } from "../models/models_2"; import { deserializeAws_ec2CreateVpcPeeringConnectionCommand, serializeAws_ec2CreateVpcPeeringConnectionCommand, diff --git a/clients/client-ec2/src/commands/CreateVpnConnectionCommand.ts b/clients/client-ec2/src/commands/CreateVpnConnectionCommand.ts index 6ef2d62afbc9..01d67302a754 100644 --- a/clients/client-ec2/src/commands/CreateVpnConnectionCommand.ts +++ b/clients/client-ec2/src/commands/CreateVpnConnectionCommand.ts @@ -12,8 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { CreateVpnConnectionRequest } from "../models/models_1"; -import { CreateVpnConnectionResult } from "../models/models_2"; +import { CreateVpnConnectionRequest, CreateVpnConnectionResult } from "../models/models_2"; import { deserializeAws_ec2CreateVpnConnectionCommand, serializeAws_ec2CreateVpnConnectionCommand, diff --git a/clients/client-ec2/src/commands/DescribeHostsCommand.ts b/clients/client-ec2/src/commands/DescribeHostsCommand.ts index 7379d5e5ddc5..e5fb7d2fa0cb 100644 --- a/clients/client-ec2/src/commands/DescribeHostsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeHostsCommand.ts @@ -12,7 +12,8 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeHostsRequest, DescribeHostsResult } from "../models/models_2"; +import { DescribeHostsRequest } from "../models/models_2"; +import { DescribeHostsResult } from "../models/models_3"; import { deserializeAws_ec2DescribeHostsCommand, serializeAws_ec2DescribeHostsCommand } from "../protocols/Aws_ec2"; export interface DescribeHostsCommandInput extends DescribeHostsRequest {} diff --git a/clients/client-ec2/src/commands/DescribeIamInstanceProfileAssociationsCommand.ts b/clients/client-ec2/src/commands/DescribeIamInstanceProfileAssociationsCommand.ts index e7790f15d7fb..70fca9545241 100644 --- a/clients/client-ec2/src/commands/DescribeIamInstanceProfileAssociationsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeIamInstanceProfileAssociationsCommand.ts @@ -15,7 +15,7 @@ import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from " import { DescribeIamInstanceProfileAssociationsRequest, DescribeIamInstanceProfileAssociationsResult, -} from "../models/models_2"; +} from "../models/models_3"; import { deserializeAws_ec2DescribeIamInstanceProfileAssociationsCommand, serializeAws_ec2DescribeIamInstanceProfileAssociationsCommand, diff --git a/clients/client-ec2/src/commands/DescribeIdFormatCommand.ts b/clients/client-ec2/src/commands/DescribeIdFormatCommand.ts index 484dc35ef93a..5f8f5ba90b8b 100644 --- a/clients/client-ec2/src/commands/DescribeIdFormatCommand.ts +++ b/clients/client-ec2/src/commands/DescribeIdFormatCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeIdFormatRequest, DescribeIdFormatResult } from "../models/models_2"; +import { DescribeIdFormatRequest, DescribeIdFormatResult } from "../models/models_3"; import { deserializeAws_ec2DescribeIdFormatCommand, serializeAws_ec2DescribeIdFormatCommand, diff --git a/clients/client-ec2/src/commands/DescribeIdentityIdFormatCommand.ts b/clients/client-ec2/src/commands/DescribeIdentityIdFormatCommand.ts index 47640b20de48..96cf6d0bc502 100644 --- a/clients/client-ec2/src/commands/DescribeIdentityIdFormatCommand.ts +++ b/clients/client-ec2/src/commands/DescribeIdentityIdFormatCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeIdentityIdFormatRequest, DescribeIdentityIdFormatResult } from "../models/models_2"; +import { DescribeIdentityIdFormatRequest, DescribeIdentityIdFormatResult } from "../models/models_3"; import { deserializeAws_ec2DescribeIdentityIdFormatCommand, serializeAws_ec2DescribeIdentityIdFormatCommand, diff --git a/clients/client-ec2/src/commands/DescribeImageAttributeCommand.ts b/clients/client-ec2/src/commands/DescribeImageAttributeCommand.ts index b70551f64cb0..20cc7a0a283c 100644 --- a/clients/client-ec2/src/commands/DescribeImageAttributeCommand.ts +++ b/clients/client-ec2/src/commands/DescribeImageAttributeCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeImageAttributeRequest, ImageAttribute } from "../models/models_2"; +import { DescribeImageAttributeRequest, ImageAttribute } from "../models/models_3"; import { deserializeAws_ec2DescribeImageAttributeCommand, serializeAws_ec2DescribeImageAttributeCommand, diff --git a/clients/client-ec2/src/commands/DescribeImagesCommand.ts b/clients/client-ec2/src/commands/DescribeImagesCommand.ts index d4a5af5636fa..df47304bf670 100644 --- a/clients/client-ec2/src/commands/DescribeImagesCommand.ts +++ b/clients/client-ec2/src/commands/DescribeImagesCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeImagesRequest, DescribeImagesResult } from "../models/models_2"; +import { DescribeImagesRequest, DescribeImagesResult } from "../models/models_3"; import { deserializeAws_ec2DescribeImagesCommand, serializeAws_ec2DescribeImagesCommand } from "../protocols/Aws_ec2"; export interface DescribeImagesCommandInput extends DescribeImagesRequest {} diff --git a/clients/client-ec2/src/commands/DescribeImportImageTasksCommand.ts b/clients/client-ec2/src/commands/DescribeImportImageTasksCommand.ts index 45849eb6f1cb..7e74496e58f3 100644 --- a/clients/client-ec2/src/commands/DescribeImportImageTasksCommand.ts +++ b/clients/client-ec2/src/commands/DescribeImportImageTasksCommand.ts @@ -12,8 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeImportImageTasksRequest } from "../models/models_2"; -import { DescribeImportImageTasksResult } from "../models/models_3"; +import { DescribeImportImageTasksRequest, DescribeImportImageTasksResult } from "../models/models_3"; import { deserializeAws_ec2DescribeImportImageTasksCommand, serializeAws_ec2DescribeImportImageTasksCommand, diff --git a/clients/client-ec2/src/commands/DescribeTagsCommand.ts b/clients/client-ec2/src/commands/DescribeTagsCommand.ts index 2ea6bb9dbe3e..dd17001478bb 100644 --- a/clients/client-ec2/src/commands/DescribeTagsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeTagsCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeTagsRequest, DescribeTagsResult } from "../models/models_3"; +import { DescribeTagsRequest, DescribeTagsResult } from "../models/models_4"; import { deserializeAws_ec2DescribeTagsCommand, serializeAws_ec2DescribeTagsCommand } from "../protocols/Aws_ec2"; export interface DescribeTagsCommandInput extends DescribeTagsRequest {} diff --git a/clients/client-ec2/src/commands/DescribeTrafficMirrorFiltersCommand.ts b/clients/client-ec2/src/commands/DescribeTrafficMirrorFiltersCommand.ts index 9b973b54b3fd..1c910975c215 100644 --- a/clients/client-ec2/src/commands/DescribeTrafficMirrorFiltersCommand.ts +++ b/clients/client-ec2/src/commands/DescribeTrafficMirrorFiltersCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeTrafficMirrorFiltersRequest, DescribeTrafficMirrorFiltersResult } from "../models/models_3"; +import { DescribeTrafficMirrorFiltersRequest, DescribeTrafficMirrorFiltersResult } from "../models/models_4"; import { deserializeAws_ec2DescribeTrafficMirrorFiltersCommand, serializeAws_ec2DescribeTrafficMirrorFiltersCommand, diff --git a/clients/client-ec2/src/commands/DescribeTrafficMirrorSessionsCommand.ts b/clients/client-ec2/src/commands/DescribeTrafficMirrorSessionsCommand.ts index e8d5f3c38c24..a67a142e83c5 100644 --- a/clients/client-ec2/src/commands/DescribeTrafficMirrorSessionsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeTrafficMirrorSessionsCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeTrafficMirrorSessionsRequest, DescribeTrafficMirrorSessionsResult } from "../models/models_3"; +import { DescribeTrafficMirrorSessionsRequest, DescribeTrafficMirrorSessionsResult } from "../models/models_4"; import { deserializeAws_ec2DescribeTrafficMirrorSessionsCommand, serializeAws_ec2DescribeTrafficMirrorSessionsCommand, diff --git a/clients/client-ec2/src/commands/DescribeTrafficMirrorTargetsCommand.ts b/clients/client-ec2/src/commands/DescribeTrafficMirrorTargetsCommand.ts index d9992644042c..c4b6bf2d6bac 100644 --- a/clients/client-ec2/src/commands/DescribeTrafficMirrorTargetsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeTrafficMirrorTargetsCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeTrafficMirrorTargetsRequest, DescribeTrafficMirrorTargetsResult } from "../models/models_3"; +import { DescribeTrafficMirrorTargetsRequest, DescribeTrafficMirrorTargetsResult } from "../models/models_4"; import { deserializeAws_ec2DescribeTrafficMirrorTargetsCommand, serializeAws_ec2DescribeTrafficMirrorTargetsCommand, diff --git a/clients/client-ec2/src/commands/DescribeTransitGatewayAttachmentsCommand.ts b/clients/client-ec2/src/commands/DescribeTransitGatewayAttachmentsCommand.ts index e155f6d2516f..73c4f79bdc3c 100644 --- a/clients/client-ec2/src/commands/DescribeTransitGatewayAttachmentsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeTransitGatewayAttachmentsCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeTransitGatewayAttachmentsRequest, DescribeTransitGatewayAttachmentsResult } from "../models/models_3"; +import { DescribeTransitGatewayAttachmentsRequest, DescribeTransitGatewayAttachmentsResult } from "../models/models_4"; import { deserializeAws_ec2DescribeTransitGatewayAttachmentsCommand, serializeAws_ec2DescribeTransitGatewayAttachmentsCommand, diff --git a/clients/client-ec2/src/commands/DescribeTransitGatewayConnectPeersCommand.ts b/clients/client-ec2/src/commands/DescribeTransitGatewayConnectPeersCommand.ts index b55d3b74e13b..39055fbd34d7 100644 --- a/clients/client-ec2/src/commands/DescribeTransitGatewayConnectPeersCommand.ts +++ b/clients/client-ec2/src/commands/DescribeTransitGatewayConnectPeersCommand.ts @@ -15,7 +15,7 @@ import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from " import { DescribeTransitGatewayConnectPeersRequest, DescribeTransitGatewayConnectPeersResult, -} from "../models/models_3"; +} from "../models/models_4"; import { deserializeAws_ec2DescribeTransitGatewayConnectPeersCommand, serializeAws_ec2DescribeTransitGatewayConnectPeersCommand, diff --git a/clients/client-ec2/src/commands/DescribeTransitGatewayConnectsCommand.ts b/clients/client-ec2/src/commands/DescribeTransitGatewayConnectsCommand.ts index 43a22c27dc0d..d58719a73fcf 100644 --- a/clients/client-ec2/src/commands/DescribeTransitGatewayConnectsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeTransitGatewayConnectsCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeTransitGatewayConnectsRequest, DescribeTransitGatewayConnectsResult } from "../models/models_3"; +import { DescribeTransitGatewayConnectsRequest, DescribeTransitGatewayConnectsResult } from "../models/models_4"; import { deserializeAws_ec2DescribeTransitGatewayConnectsCommand, serializeAws_ec2DescribeTransitGatewayConnectsCommand, diff --git a/clients/client-ec2/src/commands/DescribeTransitGatewayMulticastDomainsCommand.ts b/clients/client-ec2/src/commands/DescribeTransitGatewayMulticastDomainsCommand.ts index 8c3d737c92b0..497996458500 100644 --- a/clients/client-ec2/src/commands/DescribeTransitGatewayMulticastDomainsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeTransitGatewayMulticastDomainsCommand.ts @@ -15,7 +15,7 @@ import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from " import { DescribeTransitGatewayMulticastDomainsRequest, DescribeTransitGatewayMulticastDomainsResult, -} from "../models/models_3"; +} from "../models/models_4"; import { deserializeAws_ec2DescribeTransitGatewayMulticastDomainsCommand, serializeAws_ec2DescribeTransitGatewayMulticastDomainsCommand, diff --git a/clients/client-ec2/src/commands/DescribeTransitGatewayPeeringAttachmentsCommand.ts b/clients/client-ec2/src/commands/DescribeTransitGatewayPeeringAttachmentsCommand.ts index e31a0dd1584d..35525a3bd082 100644 --- a/clients/client-ec2/src/commands/DescribeTransitGatewayPeeringAttachmentsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeTransitGatewayPeeringAttachmentsCommand.ts @@ -15,7 +15,7 @@ import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from " import { DescribeTransitGatewayPeeringAttachmentsRequest, DescribeTransitGatewayPeeringAttachmentsResult, -} from "../models/models_3"; +} from "../models/models_4"; import { deserializeAws_ec2DescribeTransitGatewayPeeringAttachmentsCommand, serializeAws_ec2DescribeTransitGatewayPeeringAttachmentsCommand, diff --git a/clients/client-ec2/src/commands/DescribeTransitGatewayRouteTablesCommand.ts b/clients/client-ec2/src/commands/DescribeTransitGatewayRouteTablesCommand.ts index 901540fa90ce..337dad3bf6bf 100644 --- a/clients/client-ec2/src/commands/DescribeTransitGatewayRouteTablesCommand.ts +++ b/clients/client-ec2/src/commands/DescribeTransitGatewayRouteTablesCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeTransitGatewayRouteTablesRequest, DescribeTransitGatewayRouteTablesResult } from "../models/models_3"; +import { DescribeTransitGatewayRouteTablesRequest, DescribeTransitGatewayRouteTablesResult } from "../models/models_4"; import { deserializeAws_ec2DescribeTransitGatewayRouteTablesCommand, serializeAws_ec2DescribeTransitGatewayRouteTablesCommand, diff --git a/clients/client-ec2/src/commands/DescribeTransitGatewayVpcAttachmentsCommand.ts b/clients/client-ec2/src/commands/DescribeTransitGatewayVpcAttachmentsCommand.ts index 1fdd97ed9dfb..7dc50da4528f 100644 --- a/clients/client-ec2/src/commands/DescribeTransitGatewayVpcAttachmentsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeTransitGatewayVpcAttachmentsCommand.ts @@ -15,7 +15,7 @@ import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from " import { DescribeTransitGatewayVpcAttachmentsRequest, DescribeTransitGatewayVpcAttachmentsResult, -} from "../models/models_3"; +} from "../models/models_4"; import { deserializeAws_ec2DescribeTransitGatewayVpcAttachmentsCommand, serializeAws_ec2DescribeTransitGatewayVpcAttachmentsCommand, diff --git a/clients/client-ec2/src/commands/DescribeTransitGatewaysCommand.ts b/clients/client-ec2/src/commands/DescribeTransitGatewaysCommand.ts index 94666f602d60..806ed1f10491 100644 --- a/clients/client-ec2/src/commands/DescribeTransitGatewaysCommand.ts +++ b/clients/client-ec2/src/commands/DescribeTransitGatewaysCommand.ts @@ -12,7 +12,7 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeTransitGatewaysRequest, DescribeTransitGatewaysResult } from "../models/models_3"; +import { DescribeTransitGatewaysRequest, DescribeTransitGatewaysResult } from "../models/models_4"; import { deserializeAws_ec2DescribeTransitGatewaysCommand, serializeAws_ec2DescribeTransitGatewaysCommand, diff --git a/clients/client-ec2/src/commands/DescribeTrunkInterfaceAssociationsCommand.ts b/clients/client-ec2/src/commands/DescribeTrunkInterfaceAssociationsCommand.ts index 3a0eba95e960..91f71051791a 100644 --- a/clients/client-ec2/src/commands/DescribeTrunkInterfaceAssociationsCommand.ts +++ b/clients/client-ec2/src/commands/DescribeTrunkInterfaceAssociationsCommand.ts @@ -12,8 +12,10 @@ import { } from "@aws-sdk/types"; import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; -import { DescribeTrunkInterfaceAssociationsRequest } from "../models/models_3"; -import { DescribeTrunkInterfaceAssociationsResult } from "../models/models_4"; +import { + DescribeTrunkInterfaceAssociationsRequest, + DescribeTrunkInterfaceAssociationsResult, +} from "../models/models_4"; import { deserializeAws_ec2DescribeTrunkInterfaceAssociationsCommand, serializeAws_ec2DescribeTrunkInterfaceAssociationsCommand, diff --git a/clients/client-ec2/src/commands/GetInstanceTypesFromInstanceRequirementsCommand.ts b/clients/client-ec2/src/commands/GetInstanceTypesFromInstanceRequirementsCommand.ts new file mode 100644 index 000000000000..32ea38f38a59 --- /dev/null +++ b/clients/client-ec2/src/commands/GetInstanceTypesFromInstanceRequirementsCommand.ts @@ -0,0 +1,119 @@ +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, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client"; +import { + GetInstanceTypesFromInstanceRequirementsRequest, + GetInstanceTypesFromInstanceRequirementsResult, +} from "../models/models_4"; +import { + deserializeAws_ec2GetInstanceTypesFromInstanceRequirementsCommand, + serializeAws_ec2GetInstanceTypesFromInstanceRequirementsCommand, +} from "../protocols/Aws_ec2"; + +export interface GetInstanceTypesFromInstanceRequirementsCommandInput + extends GetInstanceTypesFromInstanceRequirementsRequest {} +export interface GetInstanceTypesFromInstanceRequirementsCommandOutput + extends GetInstanceTypesFromInstanceRequirementsResult, + __MetadataBearer {} + +/** + *Returns a list of instance types with the specified instance attributes. You can + * use the response to preview the instance types without launching instances. Note + * that the response does not consider capacity.
+ *When you specify multiple parameters, you get instance types that satisfy all of the + * specified parameters. If you specify multiple values for a parameter, you get instance + * types that satisfy any of the specified values.
+ *For more information, see Preview instance types with specified attributes, Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot + * placement score in the Amazon EC2 User Guide, and Creating an + * Auto Scaling group using attribute-based instance type selection in the + * Amazon EC2 Auto Scaling User Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetInstanceTypesFromInstanceRequirementsCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetInstanceTypesFromInstanceRequirementsCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetInstanceTypesFromInstanceRequirementsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetInstanceTypesFromInstanceRequirementsCommandInput} for command's `input` shape. + * @see {@link GetInstanceTypesFromInstanceRequirementsCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * + */ +export class GetInstanceTypesFromInstanceRequirementsCommand extends $Command< + GetInstanceTypesFromInstanceRequirementsCommandInput, + GetInstanceTypesFromInstanceRequirementsCommandOutput, + EC2ClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: GetInstanceTypesFromInstanceRequirementsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCalculates the Spot placement score for a Region or Availability Zone based on the + * specified target capacity and compute requirements.
+ *You can specify your compute requirements either by using
+ * InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal
+ * instance types to fulfill your Spot request, or you can specify the instance types by using
+ * InstanceTypes.
For more information, see Spot placement score in + * the Amazon EC2 User Guide.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { EC2Client, GetSpotPlacementScoresCommand } from "@aws-sdk/client-ec2"; // ES Modules import + * // const { EC2Client, GetSpotPlacementScoresCommand } = require("@aws-sdk/client-ec2"); // CommonJS import + * const client = new EC2Client(config); + * const command = new GetSpotPlacementScoresCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetSpotPlacementScoresCommandInput} for command's `input` shape. + * @see {@link GetSpotPlacementScoresCommandOutput} for command's `response` shape. + * @see {@link EC2ClientResolvedConfig | config} for command's `input` shape. + * + */ +export class GetSpotPlacementScoresCommand extends $Command< + GetSpotPlacementScoresCommandInput, + GetSpotPlacementScoresCommandOutput, + EC2ClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + constructor(readonly input: GetSpotPlacementScoresCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) + * on an instance.
+ */ +export interface AcceleratorCount { + /** + *The minimum number of accelerators. If this parameter is not specified, there is no minimum + * limit.
+ */ + Min?: number; + + /** + *The maximum number of accelerators. If this parameter is not specified, there is no + * maximum limit.
+ */ + Max?: number; +} + +export namespace AcceleratorCount { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AcceleratorCount): any => ({ + ...obj, + }); +} + +/** + *The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips)
+ * on an instance. To exclude accelerator-enabled instance types, set Max to
+ * 0.
The minimum number of accelerators. To specify no minimum limit, omit this + * parameter.
+ */ + Min?: number; + + /** + *The maximum number of accelerators. To specify no maximum limit, omit this
+ * parameter. To exclude accelerator-enabled instance types, set Max to
+ * 0.
The minimum and maximum amount of total accelerator memory, in MiB.
+ */ +export interface AcceleratorTotalMemoryMiB { + /** + *The minimum amount of accelerator memory, in MiB. If this parameter is not specified, + * there is no minimum limit.
+ */ + Min?: number; + + /** + *The maximum amount of accelerator memory, in MiB. If this parameter is not specified, + * there is no maximum limit.
+ */ + Max?: number; +} + +export namespace AcceleratorTotalMemoryMiB { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AcceleratorTotalMemoryMiB): any => ({ + ...obj, + }); +} + +/** + *The minimum and maximum amount of total accelerator memory, in MiB.
+ */ +export interface AcceleratorTotalMemoryMiBRequest { + /** + *The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this + * parameter.
+ */ + Min?: number; + + /** + *The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this + * parameter.
+ */ + Max?: number; +} + +export namespace AcceleratorTotalMemoryMiBRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: AcceleratorTotalMemoryMiBRequest): any => ({ + ...obj, + }); +} + +export enum AcceleratorType { + FPGA = "fpga", + GPU = "gpu", + INFERENCE = "inference", +} + /** *Details about the target configuration.
*/ @@ -5664,6 +5795,7 @@ export type _InstanceType = | "d3en.6xlarge" | "d3en.8xlarge" | "d3en.xlarge" + | "dl1.24xlarge" | "f1.16xlarge" | "f1.2xlarge" | "f1.4xlarge" @@ -7504,642 +7636,559 @@ export namespace FleetLaunchTemplateSpecificationRequest { }); } +export enum BareMetal { + EXCLUDED = "excluded", + INCLUDED = "included", + REQUIRED = "required", +} + /** - *Describes the placement of an instance.
+ *The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see + * Amazon + * EBS–optimized instances in the Amazon EC2 User Guide.
*/ -export interface Placement { +export interface BaselineEbsBandwidthMbpsRequest { /** - *The Availability Zone of the instance.
- *If not specified, an Availability Zone will be automatically chosen for you based on - * the load balancing criteria for the Region.
- *This parameter is not supported by CreateFleet.
+ *The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit + * this parameter.
*/ - AvailabilityZone?: string; + Min?: number; /** - *The affinity setting for the instance on the Dedicated Host. This parameter is not - * supported for the ImportInstance command.
- *This parameter is not supported by CreateFleet.
+ *The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit + * this parameter.
*/ - Affinity?: string; + Max?: number; +} +export namespace BaselineEbsBandwidthMbpsRequest { /** - *The name of the placement group the instance is in.
+ * @internal */ - GroupName?: string; + export const filterSensitiveLog = (obj: BaselineEbsBandwidthMbpsRequest): any => ({ + ...obj, + }); +} - /** - *The number of the partition the instance is in. Valid only if the placement group
- * strategy is set to partition.
This parameter is not supported by CreateFleet.
- */ - PartitionNumber?: number; +export enum BurstablePerformance { + EXCLUDED = "excluded", + INCLUDED = "included", + REQUIRED = "required", +} - /** - *The ID of the Dedicated Host on which the instance resides. This parameter is not - * supported for the ImportInstance command.
- *This parameter is not supported by CreateFleet.
- */ - HostId?: string; +export enum CpuManufacturer { + AMAZON_WEB_SERVICES = "amazon-web-services", + AMD = "amd", + INTEL = "intel", +} - /** - *The tenancy of the instance (if the instance is running in a VPC). An instance with a
- * tenancy of dedicated runs on single-tenant hardware. The host
- * tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
- * - *T3 instances that use the unlimited CPU credit option do not support host tenancy.
The minimum and maximum amount of memory per vCPU, in GiB.
+ */ +export interface MemoryGiBPerVCpuRequest { /** - *Reserved for future use.
- *This parameter is not supported by CreateFleet.
+ *The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this + * parameter.
*/ - SpreadDomain?: string; + Min?: number; /** - *The ARN of the host resource group in which to launch the instances. If you specify
- * a host resource group ARN, omit the Tenancy
- * parameter or set it to host.
This parameter is not supported by CreateFleet.
+ *The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this + * parameter.
*/ - HostResourceGroupArn?: string; + Max?: number; } -export namespace Placement { +export namespace MemoryGiBPerVCpuRequest { /** * @internal */ - export const filterSensitiveLog = (obj: Placement): any => ({ + export const filterSensitiveLog = (obj: MemoryGiBPerVCpuRequest): any => ({ ...obj, }); } /** - *Describes overrides for a launch template.
+ *The minimum and maximum amount of memory, in MiB.
*/ -export interface FleetLaunchTemplateOverridesRequest { - /** - *The instance type.
- */ - InstanceType?: _InstanceType | string; - - /** - *The maximum price per unit hour that you are willing to pay for a Spot Instance.
- */ - MaxPrice?: string; - +export interface MemoryMiBRequest { /** - *The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, subnet-1234abcdeexample1, subnet-0987cdef6example2). A request of type instant can have only one subnet ID.
The minimum amount of memory, in MiB. To specify no minimum limit, specify
+ * 0.
The Availability Zone in which to launch the instances.
+ *The maximum amount of memory, in MiB. To specify no maximum limit, omit this + * parameter.
*/ - AvailabilityZone?: string; + Max?: number; +} +export namespace MemoryMiBRequest { /** - *The number of units provided by the specified instance type.
+ * @internal */ - WeightedCapacity?: number; + export const filterSensitiveLog = (obj: MemoryMiBRequest): any => ({ + ...obj, + }); +} +/** + *The minimum and maximum number of network interfaces.
+ */ +export interface NetworkInterfaceCountRequest { /** - *The priority for the launch template override. The highest priority is launched - * first.
- *If the On-Demand AllocationStrategy is set to prioritized,
- * EC2 Fleet uses priority to determine which launch template override to use first in fulfilling
- * On-Demand capacity.
If the Spot AllocationStrategy is set to
- * capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis
- * to determine which launch template override to use in fulfilling Spot capacity, but
- * optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the
- * higher the priority. If no number is set, the launch template override has the lowest
- * priority. You can set the same priority for different launch template overrides.
The minimum number of network interfaces. To specify no minimum limit, omit this + * parameter.
*/ - Priority?: number; + Min?: number; /** - *The location where the instance launched, if applicable.
+ *The maximum number of network interfaces. To specify no maximum limit, omit this + * parameter.
*/ - Placement?: Placement; + Max?: number; } -export namespace FleetLaunchTemplateOverridesRequest { +export namespace NetworkInterfaceCountRequest { /** * @internal */ - export const filterSensitiveLog = (obj: FleetLaunchTemplateOverridesRequest): any => ({ + export const filterSensitiveLog = (obj: NetworkInterfaceCountRequest): any => ({ ...obj, }); } /** - *Describes a launch template and overrides.
+ *The minimum and maximum amount of total local storage, in GB.
*/ -export interface FleetLaunchTemplateConfigRequest { +export interface TotalLocalStorageGBRequest { /** - *The launch template to use. You must specify either the launch template ID or launch - * template name in the request.
+ *The minimum amount of total local storage, in GB. To specify no minimum limit, omit this + * parameter.
*/ - LaunchTemplateSpecification?: FleetLaunchTemplateSpecificationRequest; + Min?: number; /** - *Any parameters that you specify override the same parameters in the launch - * template.
- *For fleets of type request and maintain, a maximum of 300
- * items is allowed across all launch templates.
The maximum amount of total local storage, in GB. To specify no maximum limit, omit this + * parameter.
*/ - Overrides?: FleetLaunchTemplateOverridesRequest[]; + Max?: number; } -export namespace FleetLaunchTemplateConfigRequest { +export namespace TotalLocalStorageGBRequest { /** * @internal */ - export const filterSensitiveLog = (obj: FleetLaunchTemplateConfigRequest): any => ({ + export const filterSensitiveLog = (obj: TotalLocalStorageGBRequest): any => ({ ...obj, }); } -export enum FleetOnDemandAllocationStrategy { - LOWEST_PRICE = "lowest-price", - PRIORITIZED = "prioritized", -} - -export enum FleetCapacityReservationUsageStrategy { - USE_CAPACITY_RESERVATIONS_FIRST = "use-capacity-reservations-first", -} - /** - *Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand - * capacity.
- *This strategy can only be used if the EC2 Fleet is of type instant.
For more information about Capacity Reservations, see On-Demand Capacity - * Reservations in the Amazon EC2 User Guide. For examples of using - * Capacity Reservations in an EC2 Fleet, see EC2 Fleet example - * configurations in the Amazon EC2 User Guide.
+ *The minimum and maximum number of vCPUs.
*/ -export interface CapacityReservationOptionsRequest { +export interface VCpuCountRangeRequest { /** - *Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
- *If you specify use-capacity-reservations-first, the fleet uses unused
- * Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If
- * multiple instance pools have unused Capacity Reservations, the On-Demand allocation
- * strategy (lowest-price or prioritized) is applied. If the number
- * of unused Capacity Reservations is less than the On-Demand target capacity, the remaining
- * On-Demand target capacity is launched according to the On-Demand allocation strategy
- * (lowest-price or prioritized).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the - * chosen On-Demand allocation strategy.
+ *The minimum number of vCPUs. To specify no minimum limit, specify 0.
The maximum number of vCPUs. To specify no maximum limit, omit this parameter.
+ */ + Max?: number; } -export namespace CapacityReservationOptionsRequest { +export namespace VCpuCountRangeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CapacityReservationOptionsRequest): any => ({ + export const filterSensitiveLog = (obj: VCpuCountRangeRequest): any => ({ ...obj, }); } /** - *Describes the configuration of On-Demand Instances in an EC2 Fleet.
+ *The attributes for the instance types. When you specify instance attributes, Amazon EC2 will + * identify instance types with these attributes.
+ *When you specify multiple parameters, you get instance types that satisfy all of the + * specified parameters. If you specify multiple values for a parameter, you get instance + * types that satisfy any of the specified values.
+ *You must specify VCpuCount and MemoryMiB. All other parameters
+ * are optional. Any unspecified optional parameter is set to its default.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot + * placement score in the Amazon EC2 User Guide.
*/ -export interface OnDemandOptionsRequest { +export interface InstanceRequirementsRequest { /** - *The order of the launch template overrides to use in fulfilling On-Demand capacity. If
- * you specify lowest-price, EC2 Fleet uses price to determine the order, launching
- * the lowest price first. If you specify prioritized, EC2 Fleet uses the priority
- * that you assigned to each launch template override, launching the highest priority first.
- * If you do not specify a value, EC2 Fleet defaults to lowest-price.
The minimum and maximum number of vCPUs.
*/ - AllocationStrategy?: FleetOnDemandAllocationStrategy | string; + VCpuCount: VCpuCountRangeRequest | undefined; /** - *The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
- * Supported only for fleets of type instant.
The minimum and maximum amount of memory, in MiB.
*/ - CapacityReservationOptions?: CapacityReservationOptionsRequest; + MemoryMiB: MemoryMiBRequest | undefined; /** - *Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
- * Supported only for fleets of type instant.
The CPU manufacturers to include.
+ *For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
Don't confuse the CPU manufacturer with the CPU architecture. Instances will + * be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you + * specify in your launch template.
+ *Default: Any manufacturer
*/ - SingleInstanceType?: boolean; + CpuManufacturers?: (CpuManufacturer | string)[]; /** - *Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported
- * only for fleets of type instant.
The minimum and maximum amount of memory per vCPU, in GiB.
+ *Default: No minimum or maximum limits
*/ - SingleAvailabilityZone?: boolean; + MemoryGiBPerVCpu?: MemoryGiBPerVCpuRequest; /** - *The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is - * not reached, the fleet launches no instances.
+ *The instance types to exclude. You can use strings with one or more wild cards, represented by
+ * an asterisk (*), to exclude an instance family, type, size, or generation. The
+ * following are examples: m5.8xlarge, c5*.*, m5a.*,
+ * r*, *3*.
For example, if you specify c5*.*, Amazon EC2 will exclude the entire C5
+ * instance family (all C5a and C5n instance types). If you specify c5a.*, Amazon EC2
+ * excludes all the C5a instance types, but does not exclude the C5n instance types.
Default: No excluded instance types
*/ - MinTargetCapacity?: number; + ExcludedInstanceTypes?: string[]; /** - *The maximum amount per hour for On-Demand Instances that you're willing to pay.
+ *Indicates whether current or previous generation instance types are included. The + * current generation instance types are recommended for use. Current generation instance types are + * typically the latest two to three generations in each instance family. For more + * information, see Instance types in the + * Amazon EC2 User Guide.
+ *For current generation instance types, specify current.
For previous generation instance types, specify previous.
Default: Current and previous generation instance types
*/ - MaxTotalPrice?: string; -} + InstanceGenerations?: (InstanceGeneration | string)[]; -export namespace OnDemandOptionsRequest { /** - * @internal - */ - export const filterSensitiveLog = (obj: OnDemandOptionsRequest): any => ({ - ...obj, - }); -} - -export enum SpotAllocationStrategy { - CAPACITY_OPTIMIZED = "capacity-optimized", - CAPACITY_OPTIMIZED_PRIORITIZED = "capacity-optimized-prioritized", - DIVERSIFIED = "diversified", - LOWEST_PRICE = "lowest-price", -} - -export type SpotInstanceInterruptionBehavior = "hibernate" | "stop" | "terminate"; - -export enum FleetReplacementStrategy { - LAUNCH = "launch", -} - -/** - *The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your - * Spot Instance is at an elevated risk of being interrupted. For more information, see - * Capacity rebalancing in the Amazon EC2 User Guide.
- */ -export interface FleetSpotCapacityRebalanceRequest { - /** - *The replacement strategy to use. Only available for fleets of type
- * maintain.
To allow EC2 Fleet to launch a replacement Spot Instance when an instance rebalance
- * notification is emitted for an existing Spot Instance in the fleet, specify
- * launch. You must specify a value, otherwise you get an error.
When a replacement instance is launched, the instance marked for rebalance is not - * automatically terminated. You can terminate it, or you can leave it running. You are charged for all instances while they are running.
- *The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
- */ -export interface FleetSpotMaintenanceStrategiesRequest { - /** - *The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an - * elevated risk of being interrupted.
- */ - CapacityRebalance?: FleetSpotCapacityRebalanceRequest; -} - -export namespace FleetSpotMaintenanceStrategiesRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: FleetSpotMaintenanceStrategiesRequest): any => ({ - ...obj, - }); -} - -/** - *Describes the configuration of Spot Instances in an EC2 Fleet request.
- */ -export interface SpotOptionsRequest { - /** - *Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by - * the EC2 Fleet.
- *If the allocation strategy is lowest-price, EC2 Fleet launches instances from
- * the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified, EC2 Fleet launches instances from all
- * of the Spot Instance pools that you specify.
If the allocation strategy is capacity-optimized (recommended), EC2 Fleet
- * launches instances from Spot Instance pools with optimal capacity for the number of instances that
- * are launching. To give certain instance types a higher chance of launching first, use
- * capacity-optimized-prioritized. Set a priority for each instance type by
- * using the Priority parameter for LaunchTemplateOverrides. You can
- * assign the same priority to different LaunchTemplateOverrides. EC2 implements
- * the priorities on a best-effort basis, but optimizes for capacity first.
- * capacity-optimized-prioritized is supported only if your fleet uses a
- * launch template. Note that if the On-Demand AllocationStrategy is set to
- * prioritized, the same priority is applied when fulfilling On-Demand
- * capacity.
The strategies for managing your Spot Instances that are at an elevated risk of being - * interrupted.
- */ - MaintenanceStrategies?: FleetSpotMaintenanceStrategiesRequest; - - /** - *The behavior when a Spot Instance is interrupted. The default is terminate.
The number of Spot pools across which to allocate your target Spot capacity. Valid only
- * when Spot AllocationStrategy is set to
- * lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates
- * your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a - * best effort basis. If a pool runs out of Spot capacity before fulfilling your target - * capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest - * pool. To ensure that your target capacity is met, you might receive Spot Instances from more than - * the number of pools that you specified. Similarly, if most of the pools have no Spot - * capacity, you might receive your full target capacity from fewer than the number of pools - * that you specified.
- */ - InstancePoolsToUseCount?: number; - - /** - *Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
- * Supported only for fleets of type instant.
Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported
- * only for fleets of type instant.
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is - * not reached, the fleet launches no instances.
- */ - MinTargetCapacity?: number; - - /** - *The maximum amount per hour for Spot Instances that you're willing to pay.
- */ - MaxTotalPrice?: string; -} - -export namespace SpotOptionsRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: SpotOptionsRequest): any => ({ - ...obj, - }); -} - -export enum DefaultTargetCapacityType { - ON_DEMAND = "on-demand", - SPOT = "spot", -} - -/** - *The number of units to request. You can choose to set the target capacity as the number of
- * instances. Or you can set the target capacity to a performance characteristic that is important to your application workload,
- * such as vCPUs, memory, or I/O. If the request type is maintain, you can
- * specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance
- * MaxTotalPrice parameter, or both parameters to ensure that your fleet cost
- * does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances
- * in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're
- * willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops
- * launching instances even if it hasn’t met the target capacity. The
- * MaxTotalPrice parameters are located in OnDemandOptionsRequest
- * and SpotOptionsRequest.
The number of units to request, filled using
- * DefaultTargetCapacityType.
The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance, + * expressed as a percentage above the cheapest M, C, or R instance type with your specified + * attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance + * types priced above your threshold.
+ *The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
+ *To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
+ *Default: 100
+ *
The number of On-Demand units to request.
+ *The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, + * expressed as a percentage above the cheapest M, C, or R instance type with your specified + * attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance + * types priced above your threshold.
+ *The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
+ *To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
+ *Default: 20
+ *
The number of Spot units to request.
+ *Indicates whether bare metal instance types must be included, excluded, or required.
+ *To include bare metal instance types, specify included.
To require only bare metal instance types, specify required.
To exclude bare metal instance types, specify excluded.
Default: excluded
+ *
The default TotalTargetCapacity, which is either Spot or
- * On-Demand.
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see + * Burstable performance instances.
+ *To include burstable performance instance types, specify included.
To require only burstable performance instance types, specify required.
To exclude burstable performance instance types, specify excluded.
Default: excluded
+ *
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Indicates whether instance types must support hibernation for On-Demand Instances.
+ *This parameter is not supported for GetSpotPlacementScores.
+ *Default: false
+ *
Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see Ensuring - * Idempotency.
+ *The minimum and maximum number of network interfaces.
+ *Default: No minimum or maximum limits
*/ - ClientToken?: string; + NetworkInterfaceCount?: NetworkInterfaceCountRequest; /** - *Describes the configuration of Spot Instances in an EC2 Fleet.
+ *Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, + * Amazon + * EC2 instance store in the Amazon EC2 User Guide.
+ *To include instance types with instance store volumes, specify
+ * included.
To require only instance types with instance store volumes, specify
+ * required.
To exclude instance types with instance store volumes, specify
+ * excluded.
Default: included
+ *
Describes the configuration of On-Demand Instances in an EC2 Fleet.
+ *The type of local storage that is required.
+ *For instance types with hard disk drive (HDD) storage, specify hdd.
For instance types with solid state drive (SDD) storage, specify sdd.
Default: hdd and sdd
+ *
Indicates whether running instances should be terminated if the total target capacity of - * the EC2 Fleet is decreased below the current size of the EC2 Fleet.
+ *The minimum and maximum amount of total local storage, in GB.
+ *Default: No minimum or maximum limits
*/ - ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy | string; + TotalLocalStorageGB?: TotalLocalStorageGBRequest; /** - *The configuration for the EC2 Fleet.
+ *The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see + * Amazon + * EBS–optimized instances in the Amazon EC2 User Guide.
+ *Default: No minimum or maximum limits
*/ - LaunchTemplateConfigs: FleetLaunchTemplateConfigRequest[] | undefined; + BaselineEbsBandwidthMbps?: BaselineEbsBandwidthMbpsRequest; /** - *The number of units to request.
+ *The accelerator types that must be on the instance type.
+ *To include instance types with GPU hardware, specify gpu.
To include instance types with FPGA hardware, specify fpga.
To include instance types with inference hardware, specify inference.
Default: Any accelerator type
*/ - TargetCapacitySpecification: TargetCapacitySpecificationRequest | undefined; + AcceleratorTypes?: (AcceleratorType | string)[]; /** - *Indicates whether running instances should be terminated when the EC2 Fleet expires.
+ *The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on + * an instance.
+ *To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
*/ - TerminateInstancesWithExpiration?: boolean; + AcceleratorCount?: AcceleratorCountRequest; /** - *The fleet type. The default value is maintain.
Indicates whether instance types must have accelerators by specific manufacturers.
*
- * maintain - The EC2 Fleet places an asynchronous request for your desired
- * capacity, and continues to maintain your desired Spot capacity by replenishing
- * interrupted Spot Instances.
For instance types with NVIDIA devices, specify nvidia.
- * request - The EC2 Fleet places an asynchronous one-time request for your
- * desired capacity, but does submit Spot requests in alternative capacity pools if Spot
- * capacity is unavailable, and does not maintain Spot capacity if Spot Instances are
- * interrupted.
For instance types with AMD devices, specify amd.
- * instant - The EC2 Fleet places a synchronous one-time request for your
- * desired capacity, and returns errors for any instances that could not be
- * launched.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
For more information, see EC2 Fleet - * request types in the Amazon EC2 User Guide.
+ *Default: Any manufacturer
*/ - Type?: FleetType | string; + AcceleratorManufacturers?: (AcceleratorManufacturer | string)[]; /** - *The start date and time of the request, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ). - * The default is to start fulfilling the request immediately.
+ *The accelerators that must be on the instance type.
+ *For instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA V100 GPUs, specify v100.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
Default: Any accelerator
*/ - ValidFrom?: Date; + AcceleratorNames?: (AcceleratorName | string)[]; /** - *The end date and time of the request, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ). - * At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.
+ *The minimum and maximum amount of total accelerator memory, in MiB.
+ *Default: No minimum or maximum limits
*/ - ValidUntil?: Date; + AcceleratorTotalMemoryMiB?: AcceleratorTotalMemoryMiBRequest; +} +export namespace InstanceRequirementsRequest { /** - *Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for
- * fleets of type maintain. For more information, see EC2 Fleet
- * health checks in the Amazon EC2 User Guide.
Describes the placement of an instance.
+ */ +export interface Placement { /** - *The key-value pair for tagging the EC2 Fleet request on creation. For more information, see - * Tagging your resources.
- *If the fleet type is instant, specify a resource type of fleet
- * to tag the fleet or instance to tag the instances at launch.
If the fleet type is maintain or request, specify a resource
- * type of fleet to tag the fleet. You cannot specify a resource type of
- * instance. To tag instances at launch, specify the tags in a launch template.
The Availability Zone of the instance.
+ *If not specified, an Availability Zone will be automatically chosen for you based on + * the load balancing criteria for the Region.
+ *This parameter is not supported by CreateFleet.
*/ - TagSpecifications?: TagSpecification[]; + AvailabilityZone?: string; /** - *Reserved.
+ *The affinity setting for the instance on the Dedicated Host. This parameter is not + * supported for the ImportInstance command.
+ *This parameter is not supported by CreateFleet.
*/ - Context?: string; -} + Affinity?: string; -export namespace CreateFleetRequest { /** - * @internal + *The name of the placement group the instance is in.
*/ - export const filterSensitiveLog = (obj: CreateFleetRequest): any => ({ - ...obj, - }); -} + GroupName?: string; -/** - *Describes the Amazon EC2 launch template and the launch template version that can be used - * by a Spot Fleet request to configure Amazon EC2 instances. For information about launch templates, - * see Launching an instance from a launch template in the - * Amazon EC2 User Guide for Linux Instances.
- */ -export interface FleetLaunchTemplateSpecification { /** - *The ID of the launch template. If you specify the template ID, you can't specify the - * template name.
+ *The number of the partition the instance is in. Valid only if the placement group
+ * strategy is set to partition.
This parameter is not supported by CreateFleet.
*/ - LaunchTemplateId?: string; + PartitionNumber?: number; /** - *The name of the launch template. If you specify the template name, you can't specify - * the template ID.
+ *The ID of the Dedicated Host on which the instance resides. This parameter is not + * supported for the ImportInstance command.
+ *This parameter is not supported by CreateFleet.
*/ - LaunchTemplateName?: string; + HostId?: string; /** - *The launch template version number, $Latest, or $Default.
- * You must specify a value, otherwise the request fails.
If the value is $Latest, Amazon EC2 uses the latest version of the launch
- * template.
If the value is $Default, Amazon EC2 uses the default version of the launch
- * template.
The tenancy of the instance (if the instance is running in a VPC). An instance with a
+ * tenancy of dedicated runs on single-tenant hardware. The host
+ * tenancy is not supported for the ImportInstance command.
This parameter is not supported by CreateFleet.
+ * + *T3 instances that use the unlimited CPU credit option do not support host tenancy.
Reserved for future use.
+ *This parameter is not supported by CreateFleet.
*/ - export const filterSensitiveLog = (obj: FleetLaunchTemplateSpecification): any => ({ - ...obj, - }); -} + SpreadDomain?: string; -/** - *Describes the placement of an instance.
- */ -export interface PlacementResponse { /** - *The name of the placement group that the instance is in.
+ *The ARN of the host resource group in which to launch the instances. If you specify
+ * a host resource group ARN, omit the Tenancy
+ * parameter or set it to host.
This parameter is not supported by CreateFleet.
*/ - GroupName?: string; + HostResourceGroupArn?: string; } -export namespace PlacementResponse { +export namespace Placement { /** * @internal */ - export const filterSensitiveLog = (obj: PlacementResponse): any => ({ + export const filterSensitiveLog = (obj: Placement): any => ({ ...obj, }); } @@ -8147,9 +8196,13 @@ export namespace PlacementResponse { /** *Describes overrides for a launch template.
*/ -export interface FleetLaunchTemplateOverrides { +export interface FleetLaunchTemplateOverridesRequest { /** *The instance type.
+ *If you specify InstanceTypes, you can't specify
+ * InstanceRequirements.
The ID of the subnet in which to launch the instances.
+ *The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, subnet-1234abcdeexample1, subnet-0987cdef6example2). A request of type instant can have only one subnet ID.
Valid values are whole numbers starting at 0. The lower the number, the
- * higher the priority. If no number is set, the override has the lowest priority. You can set
- * the same priority for different launch template overrides.
The location where the instance launched, if applicable.
*/ - Placement?: PlacementResponse; + Placement?: Placement; + + /** + *The attributes for the instance types. When you specify instance attributes, Amazon EC2 will + * identify instance types with those attributes.
+ *If you specify InstanceRequirements, you can't specify
+ * InstanceTypes.
Describes a launch template and overrides.
*/ -export interface LaunchTemplateAndOverridesResponse { +export interface FleetLaunchTemplateConfigRequest { /** - *The launch template.
+ *The launch template to use. You must specify either the launch template ID or launch + * template name in the request.
*/ - LaunchTemplateSpecification?: FleetLaunchTemplateSpecification; + LaunchTemplateSpecification?: FleetLaunchTemplateSpecificationRequest; /** *Any parameters that you specify override the same parameters in the launch * template.
+ *For fleets of type request and maintain, a maximum of 300
+ * items is allowed across all launch templates.
Describes the instances that could not be launched by the fleet.
+ *Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand + * capacity.
+ *This strategy can only be used if the EC2 Fleet is of type instant.
For more information about Capacity Reservations, see On-Demand Capacity + * Reservations in the Amazon EC2 User Guide. For examples of using + * Capacity Reservations in an EC2 Fleet, see EC2 Fleet example + * configurations in the Amazon EC2 User Guide.
*/ -export interface CreateFleetError { - /** - *The launch templates and overrides that were used for launching the instances. The - * values that you specify in the Overrides replace the values in the launch template.
- */ - LaunchTemplateAndOverrides?: LaunchTemplateAndOverridesResponse; - - /** - *Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
- */ - Lifecycle?: InstanceLifecycle | string; - - /** - *The error code that indicates why the instance could not be launched. For more - * information about error codes, see Error Codes.
- */ - ErrorCode?: string; - +export interface CapacityReservationOptionsRequest { /** - *The error message that describes why the instance could not be launched. For more - * information about error messages, see Error Codes.
+ *Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
+ *If you specify use-capacity-reservations-first, the fleet uses unused
+ * Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If
+ * multiple instance pools have unused Capacity Reservations, the On-Demand allocation
+ * strategy (lowest-price or prioritized) is applied. If the number
+ * of unused Capacity Reservations is less than the On-Demand target capacity, the remaining
+ * On-Demand target capacity is launched according to the On-Demand allocation strategy
+ * (lowest-price or prioritized).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the + * chosen On-Demand allocation strategy.
*/ - ErrorMessage?: string; + UsageStrategy?: FleetCapacityReservationUsageStrategy | string; } -export namespace CreateFleetError { +export namespace CapacityReservationOptionsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateFleetError): any => ({ + export const filterSensitiveLog = (obj: CapacityReservationOptionsRequest): any => ({ ...obj, }); } -export type PlatformValues = "Windows"; - /** - *Describes the instances that were launched by the fleet.
+ *Describes the configuration of On-Demand Instances in an EC2 Fleet.
*/ -export interface CreateFleetInstance { +export interface OnDemandOptionsRequest { /** - *The launch templates and overrides that were used for launching the instances. The - * values that you specify in the Overrides replace the values in the launch template.
+ *The order of the launch template overrides to use in fulfilling On-Demand capacity. If
+ * you specify lowest-price, EC2 Fleet uses price to determine the order, launching
+ * the lowest price first. If you specify prioritized, EC2 Fleet uses the priority
+ * that you assigned to each launch template override, launching the highest priority first.
+ * If you do not specify a value, EC2 Fleet defaults to lowest-price.
Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
+ *The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
+ * Supported only for fleets of type instant.
The IDs of the instances.
+ *Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
+ * Supported only for fleets of type instant.
The instance type.
+ *Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported
+ * only for fleets of type instant.
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is + * not reached, the fleet launches no instances.
+ */ + MinTargetCapacity?: number; /** - *The value is Windows for Windows instances. Otherwise, the value is
- * blank.
The maximum amount per hour for On-Demand Instances that you're willing to pay.
*/ - Platform?: PlatformValues | string; + MaxTotalPrice?: string; } -export namespace CreateFleetInstance { +export namespace OnDemandOptionsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateFleetInstance): any => ({ + export const filterSensitiveLog = (obj: OnDemandOptionsRequest): any => ({ ...obj, }); } -export interface CreateFleetResult { - /** - *The ID of the EC2 Fleet.
- */ - FleetId?: string; +export enum SpotAllocationStrategy { + CAPACITY_OPTIMIZED = "capacity-optimized", + CAPACITY_OPTIMIZED_PRIORITIZED = "capacity-optimized-prioritized", + DIVERSIFIED = "diversified", + LOWEST_PRICE = "lowest-price", +} - /** - *Information about the instances that could not be launched by the fleet. Supported only for
- * fleets of type instant.
The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your + * Spot Instance is at an elevated risk of being interrupted. For more information, see + * Capacity rebalancing in the Amazon EC2 User Guide.
+ */ +export interface FleetSpotCapacityRebalanceRequest { /** - *Information about the instances that were launched by the fleet. Supported only for
- * fleets of type instant.
The replacement strategy to use. Only available for fleets of type
+ * maintain.
To allow EC2 Fleet to launch a replacement Spot Instance when an instance rebalance
+ * notification is emitted for an existing Spot Instance in the fleet, specify
+ * launch. You must specify a value, otherwise you get an error.
When a replacement instance is launched, the instance marked for rebalance is not + * automatically terminated. You can terminate it, or you can leave it running. You are charged for all instances while they are running.
+ *Describes the destination options for a flow log.
+ *The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
*/ -export interface DestinationOptionsRequest { - /** - *The format for the flow log. The default is plain-text.
Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.
- * The default is false.
Indicates whether to partition the flow log per hour. This reduces the cost and response
- * time for queries. The default is false.
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an + * elevated risk of being interrupted.
*/ - PerHourPartition?: boolean; + CapacityRebalance?: FleetSpotCapacityRebalanceRequest; } -export namespace DestinationOptionsRequest { +export namespace FleetSpotMaintenanceStrategiesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DestinationOptionsRequest): any => ({ + export const filterSensitiveLog = (obj: FleetSpotMaintenanceStrategiesRequest): any => ({ ...obj, }); } -export type LogDestinationType = "cloud-watch-logs" | "s3"; - -export type FlowLogsResourceType = "NetworkInterface" | "Subnet" | "VPC"; - -export type TrafficType = "ACCEPT" | "ALL" | "REJECT"; - -export interface CreateFlowLogsRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to ensure - * idempotency.
- */ - ClientToken?: string; - - /** - *The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group - * in your account.
- *If you specify LogDestinationType as s3, do not specify
- * DeliverLogsPermissionArn or LogGroupName.
The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
- *If you specify LogDestinationType as s3, do not specify
- * DeliverLogsPermissionArn or LogGroupName.
The ID of the subnet, network interface, or VPC for which you want to create a flow log.
- *Constraints: Maximum of 1000 resources
- */ - ResourceIds: string[] | undefined; - +/** + *Describes the configuration of Spot Instances in an EC2 Fleet request.
+ */ +export interface SpotOptionsRequest { /** - *The type of resource for which to create the flow log. For example, if you specified a VPC ID for
- * the ResourceId property, specify VPC for this property.
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by + * the EC2 Fleet.
+ *If the allocation strategy is lowest-price, EC2 Fleet launches instances from
+ * the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified, EC2 Fleet launches instances from all
+ * of the Spot Instance pools that you specify.
If the allocation strategy is capacity-optimized (recommended), EC2 Fleet
+ * launches instances from Spot Instance pools with optimal capacity for the number of instances that
+ * are launching. To give certain instance types a higher chance of launching first, use
+ * capacity-optimized-prioritized. Set a priority for each instance type by
+ * using the Priority parameter for LaunchTemplateOverrides. You can
+ * assign the same priority to different LaunchTemplateOverrides. EC2 implements
+ * the priorities on a best-effort basis, but optimizes for capacity first.
+ * capacity-optimized-prioritized is supported only if your fleet uses a
+ * launch template. Note that if the On-Demand AllocationStrategy is set to
+ * prioritized, the same priority is applied when fulfilling On-Demand
+ * capacity.
The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
+ *The strategies for managing your Spot Instances that are at an elevated risk of being + * interrupted.
*/ - TrafficType: TrafficType | string | undefined; + MaintenanceStrategies?: FleetSpotMaintenanceStrategiesRequest; /** - *The type of destination to which the flow log data is to be published. Flow log data can be
- * published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To
- * publish flow log data to Amazon S3, specify s3.
If you specify LogDestinationType as s3, do not specify
- * DeliverLogsPermissionArn or LogGroupName.
Default: cloud-watch-logs
- *
The behavior when a Spot Instance is interrupted. The default is terminate.
The destination to which the flow log data is to be published. Flow log data can be published
- * to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified
- * for LogDestinationType.
If LogDestinationType is not specified or cloud-watch-logs,
- * specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish
- * to a log group called my-logs, specify
- * arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively,
- * use LogGroupName instead.
If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a
- * subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format:
- * bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a
- * bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You
- * cannot use AWSLogs as a subfolder name. This is a reserved term.
The number of Spot pools across which to allocate your target Spot capacity. Valid only
+ * when Spot AllocationStrategy is set to
+ * lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates
+ * your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a + * best effort basis. If a pool runs out of Spot capacity before fulfilling your target + * capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest + * pool. To ensure that your target capacity is met, you might receive Spot Instances from more than + * the number of pools that you specified. Similarly, if most of the pools have no Spot + * capacity, you might receive your full target capacity from fewer than the number of pools + * that you specified.
*/ - LogDestination?: string; + InstancePoolsToUseCount?: number; /** - *The fields to include in the flow log record, in the order in which they should - * appear. For a list of available fields, see Flow log records. If you - * omit this parameter, the flow log is created using the default format. If you specify this parameter, - * you must specify at least one field.
- *Specify the fields using the ${field-id} format, separated by spaces. For
- * the CLI, surround this parameter value with single quotes on Linux or
- * double quotes on Windows.
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
+ * Supported only for fleets of type instant.
The tags to apply to the flow logs.
+ *Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported
+ * only for fleets of type instant.
The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
- *When a network interface is attached to a Nitro-based - * instance, the aggregation interval is always 60 seconds or less, regardless - * of the value that you specify.
- *Default: 600
+ *The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is + * not reached, the fleet launches no instances.
*/ - MaxAggregationInterval?: number; + MinTargetCapacity?: number; /** - *The destination options.
+ *The maximum amount per hour for Spot Instances that you're willing to pay.
*/ - DestinationOptions?: DestinationOptionsRequest; + MaxTotalPrice?: string; } -export namespace CreateFlowLogsRequest { +export namespace SpotOptionsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateFlowLogsRequest): any => ({ + export const filterSensitiveLog = (obj: SpotOptionsRequest): any => ({ ...obj, }); } -export interface CreateFlowLogsResult { - /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request.
- */ - ClientToken?: string; +export enum DefaultTargetCapacityType { + ON_DEMAND = "on-demand", + SPOT = "spot", +} +export enum TargetCapacityUnitType { + MEMORY_MIB = "memory-mib", + UNITS = "units", + VCPU = "vcpu", +} + +/** + *The number of units to request. You can choose to set the target capacity as the number of
+ * instances. Or you can set the target capacity to a performance characteristic that is important to your application workload,
+ * such as vCPUs, memory, or I/O. If the request type is maintain, you can
+ * specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance
+ * MaxTotalPrice parameter, or both parameters to ensure that your fleet cost
+ * does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances
+ * in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're
+ * willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops
+ * launching instances even if it hasn’t met the target capacity. The
+ * MaxTotalPrice parameters are located in OnDemandOptionsRequest
+ * and SpotOptionsRequest.
The IDs of the flow logs.
+ *The number of units to request, filled using
+ * DefaultTargetCapacityType.
Information about the flow logs that could not be created successfully.
+ *The number of On-Demand units to request.
*/ - Unsuccessful?: UnsuccessfulItem[]; -} + OnDemandTargetCapacity?: number; -export namespace CreateFlowLogsResult { /** - * @internal + *The number of Spot units to request.
*/ - export const filterSensitiveLog = (obj: CreateFlowLogsResult): any => ({ - ...obj, - }); -} + SpotTargetCapacity?: number; -/** - *Describes a storage location in Amazon S3.
- */ -export interface StorageLocation { /** - *The name of the S3 bucket.
+ *The default TotalTargetCapacity, which is either Spot or
+ * On-Demand.
The key.
+ *The unit for the target capacity.
+ *Default: units (translates to number of instances)
Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -8559,321 +8617,208 @@ export interface CreateFpgaImageRequest {
DryRun?: boolean;
/**
- *
The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.
- */ - InputStorageLocation: StorageLocation | undefined; - - /** - *The location in Amazon S3 for the output logs.
- */ - LogsStorageLocation?: StorageLocation; - - /** - *A description for the AFI.
- */ - Description?: string; - - /** - *A name for the AFI.
- */ - Name?: string; - - /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. - * For more information, see Ensuring Idempotency.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. For more information, see Ensuring + * Idempotency.
*/ ClientToken?: string; /** - *The tags to apply to the FPGA image during creation.
- */ - TagSpecifications?: TagSpecification[]; -} - -export namespace CreateFpgaImageRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: CreateFpgaImageRequest): any => ({ - ...obj, - }); -} - -export interface CreateFpgaImageResult { - /** - *The FPGA image identifier (AFI ID).
+ *Describes the configuration of Spot Instances in an EC2 Fleet.
*/ - FpgaImageId?: string; + SpotOptions?: SpotOptionsRequest; /** - *The global FPGA image identifier (AGFI ID).
+ *Describes the configuration of On-Demand Instances in an EC2 Fleet.
*/ - FpgaImageGlobalId?: string; -} + OnDemandOptions?: OnDemandOptionsRequest; -export namespace CreateFpgaImageResult { /** - * @internal + *Indicates whether running instances should be terminated if the total target capacity of + * the EC2 Fleet is decreased below the current size of the EC2 Fleet.
*/ - export const filterSensitiveLog = (obj: CreateFpgaImageResult): any => ({ - ...obj, - }); -} - -export type VolumeType = "gp2" | "gp3" | "io1" | "io2" | "sc1" | "st1" | "standard"; + ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy | string; -/** - *Describes a block device for an EBS volume.
- */ -export interface EbsBlockDevice { /** - *Indicates whether the EBS volume is deleted on instance termination. For more - * information, see Preserving Amazon EBS volumes on instance termination in the - * Amazon EC2 User Guide.
+ *The configuration for the EC2 Fleet.
*/ - DeleteOnTermination?: boolean; + LaunchTemplateConfigs: FleetLaunchTemplateConfigRequest[] | undefined; /** - *The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this
- * represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this
- * represents the baseline performance of the volume and the rate at which the volume accumulates
- * I/O credits for bursting.
The following are the supported values for each volume type:
- *
- * gp3: 3,000-16,000 IOPS
- * io1: 100-64,000 IOPS
- * io2: 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS only for
- * Instances built on the Nitro System. Other instance families guarantee performance
- * up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes.
- * The default for gp3 volumes is 3,000 IOPS.
- * This parameter is not supported for gp2, st1, sc1, or standard volumes.
The number of units to request.
*/ - Iops?: number; + TargetCapacitySpecification: TargetCapacitySpecificationRequest | undefined; /** - *The ID of the snapshot.
+ *Indicates whether running instances should be terminated when the EC2 Fleet expires.
*/ - SnapshotId?: string; + TerminateInstancesWithExpiration?: boolean; /** - *The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. - * If you specify a snapshot, the default is the snapshot size. You can specify a volume - * size that is equal to or larger than the snapshot size.
- *The following are the supported volumes sizes for each volume type:
- *
- * gp2 and gp3:1-16,384
The fleet type. The default value is maintain.
- * io1 and io2: 4-16,384
maintain - The EC2 Fleet places an asynchronous request for your desired
+ * capacity, and continues to maintain your desired Spot capacity by replenishing
+ * interrupted Spot Instances.
*
- * st1 and sc1: 125-16,384
request - The EC2 Fleet places an asynchronous one-time request for your
+ * desired capacity, but does submit Spot requests in alternative capacity pools if Spot
+ * capacity is unavailable, and does not maintain Spot capacity if Spot Instances are
+ * interrupted.
*
- * standard: 1-1,024
instant - The EC2 Fleet places a synchronous one-time request for your
+ * desired capacity, and returns errors for any instances that could not be
+ * launched.
* For more information, see EC2 Fleet + * request types in the Amazon EC2 User Guide.
*/ - VolumeSize?: number; + Type?: FleetType | string; /** - *The volume type. For more information, see Amazon EBS volume types in the
- * Amazon EC2 User Guide. If the volume type is io1 or io2,
- * you must specify the IOPS that the volume supports.
The start date and time of the request, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ). + * The default is to start fulfilling the request immediately.
*/ - VolumeType?: VolumeType | string; + ValidFrom?: Date; /** - *Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under - * which the EBS volume is encrypted.
- *This parameter is only supported on BlockDeviceMapping objects called by
- * RunInstances, RequestSpotFleet,
- * and RequestSpotInstances.
The end date and time of the request, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ). + * At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.
*/ - KmsKeyId?: string; + ValidUntil?: Date; /** - *The throughput that the volume supports, in MiB/s.
- *This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
+ *Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for
+ * fleets of type maintain. For more information, see EC2 Fleet
+ * health checks in the Amazon EC2 User Guide.
The ARN of the Outpost on which the snapshot is stored.
+ *The key-value pair for tagging the EC2 Fleet request on creation. For more information, see + * Tagging your resources.
+ *If the fleet type is instant, specify a resource type of fleet
+ * to tag the fleet or instance to tag the instances at launch.
If the fleet type is maintain or request, specify a resource
+ * type of fleet to tag the fleet. You cannot specify a resource type of
+ * instance. To tag instances at launch, specify the tags in a launch template.
Indicates whether the encryption state of an EBS volume is changed while being
- * restored from a backing snapshot.
- * The effect of setting the encryption state to true depends on
- * the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled.
- * For more information, see Amazon EBS encryption
- * in the Amazon EC2 User Guide.
In no case can you remove encryption from an encrypted volume.
- *Encrypted volumes can only be attached to instances that support Amazon EBS - * encryption. For more information, see Supported instance types.
- *This parameter is not returned by .
+ *Reserved.
*/ - Encrypted?: boolean; + Context?: string; } -export namespace EbsBlockDevice { +export namespace CreateFleetRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EbsBlockDevice): any => ({ + export const filterSensitiveLog = (obj: CreateFleetRequest): any => ({ ...obj, }); } /** - *Describes a block device mapping, which defines the EBS volumes and instance store - * volumes to attach to an instance at launch.
+ *Describes the Amazon EC2 launch template and the launch template version that can be used + * by a Spot Fleet request to configure Amazon EC2 instances. For information about launch templates, + * see Launching an instance from a launch template in the + * Amazon EC2 User Guide for Linux Instances.
*/ -export interface BlockDeviceMapping { - /** - *The device name (for example, /dev/sdh or xvdh).
The virtual device name (ephemeralN). Instance store volumes are numbered
- * starting from 0. An instance type with 2 available instance store volumes can specify
- * mappings for ephemeral0 and ephemeral1. The number of
- * available instance store volumes depends on the instance type. After you connect to the
- * instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. - * Including them in your block device mapping has no effect.
- *Constraints: For M3 instances, you must specify instance store volumes in the block - * device mapping for the instance. When you launch an M3 instance, we ignore any instance - * store volumes specified in the block device mapping for the AMI.
+ *The ID of the launch template. If you specify the template ID, you can't specify the + * template name.
*/ - VirtualName?: string; + LaunchTemplateId?: string; /** - *Parameters used to automatically set up EBS volumes when the instance is - * launched.
+ *The name of the launch template. If you specify the template name, you can't specify + * the template ID.
*/ - Ebs?: EbsBlockDevice; + LaunchTemplateName?: string; /** - *To omit the device from the block device mapping, specify an empty string. When this - * property is specified, the device is removed from the block device mapping regardless of - * the assigned value.
+ *The launch template version number, $Latest, or $Default.
+ * You must specify a value, otherwise the request fails.
If the value is $Latest, Amazon EC2 uses the latest version of the launch
+ * template.
If the value is $Default, Amazon EC2 uses the default version of the launch
+ * template.
The block device mappings. This parameter cannot be used to modify the encryption - * status of existing volumes or snapshots. To create an AMI with encrypted snapshots, - * use the CopyImage action.
- */ - BlockDeviceMappings?: BlockDeviceMapping[]; - - /** - *A description for the new image.
- */ - Description?: string; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the instance.
- */ - InstanceId: string | undefined; - - /** - *A name for the new image.
- *Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
- */ - Name: string | undefined; - +/** + *The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see + * Amazon + * EBS–optimized instances in the Amazon EC2 User Guide.
+ */ +export interface BaselineEbsBandwidthMbps { /** - *By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image.
- * If the No Reboot option is set, Amazon EC2 doesn't shut down the instance before creating
- * the image. Without a reboot, the AMI will be crash consistent (all the volumes are snapshotted
- * at the same time), but not application consistent (all the operating system buffers are not flushed
- * to disk before the snapshots are created).
The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no + * minimum limit.
*/ - NoReboot?: boolean; + Min?: number; /** - *The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the - * snapshots, or both.
- *To tag the AMI, the value for ResourceType must be
- * image.
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that
- * are attached to the instance, the value for ResourceType must be
- * snapshot. The same tag is applied to all of the snapshots that are
- * created.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
+ *The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no + * maximum limit.
*/ - TagSpecifications?: TagSpecification[]; + Max?: number; } -export namespace CreateImageRequest { +export namespace BaselineEbsBandwidthMbps { /** * @internal */ - export const filterSensitiveLog = (obj: CreateImageRequest): any => ({ + export const filterSensitiveLog = (obj: BaselineEbsBandwidthMbps): any => ({ ...obj, }); } -export interface CreateImageResult { +/** + *The minimum and maximum amount of memory per vCPU, in GiB.
+ * + */ +export interface MemoryGiBPerVCpu { /** - *The ID of the new AMI.
+ *The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is + * no minimum limit.
*/ - ImageId?: string; + Min?: number; + + /** + *The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is + * no maximum limit.
+ */ + Max?: number; } -export namespace CreateImageResult { +export namespace MemoryGiBPerVCpu { /** * @internal */ - export const filterSensitiveLog = (obj: CreateImageResult): any => ({ + export const filterSensitiveLog = (obj: MemoryGiBPerVCpu): any => ({ ...obj, }); } diff --git a/clients/client-ec2/src/models/models_1.ts b/clients/client-ec2/src/models/models_1.ts index fd5ebbb864f7..a630b5f6938c 100644 --- a/clients/client-ec2/src/models/models_1.ts +++ b/clients/client-ec2/src/models/models_1.ts @@ -2,15 +2,30 @@ import { SENSITIVE_STRING } from "@aws-sdk/smithy-client"; import { _InstanceType, + AcceleratorCount, + AcceleratorManufacturer, + AcceleratorName, + AcceleratorTotalMemoryMiB, + AcceleratorType, AddPrefixListEntry, ApplianceModeSupportValue, AttachmentStatus, + BareMetal, + BaselineEbsBandwidthMbps, + BurstablePerformance, + CpuManufacturer, CurrencyCodeValues, DnsSupportValue, + FleetLaunchTemplateSpecification, InstanceEventWindow, + InstanceGeneration, + InstanceRequirementsRequest, InternetGatewayAttachment, Ipv4PrefixSpecification, Ipv6SupportValue, + LocalStorage, + LocalStorageType, + MemoryGiBPerVCpu, ReservedInstancesListing, ResourceType, RouteTableAssociationState, @@ -22,3662 +37,3993 @@ import { TransitGatewayAttachmentState, TransitGatewayPeeringAttachment, TransitGatewayVpcAttachment, + UnsuccessfulItem, VolumeAttachment, - VolumeType, Vpc, - VpcPeeringConnection, WeekDay, } from "./models_0"; /** - *The start day and time and the end day and time of the time range, in UTC.
+ *The minimum and maximum amount of memory, in MiB.
*/ -export interface InstanceEventWindowTimeRangeRequest { +export interface MemoryMiB { /** - *The day on which the time range begins.
+ *The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum + * limit.
*/ - StartWeekDay?: WeekDay | string; + Min?: number; /** - *The hour when the time range begins.
+ *The maximum amount of memory, in MiB. If this parameter is not specified, there is no + * maximum limit.
*/ - StartHour?: number; + Max?: number; +} +export namespace MemoryMiB { /** - *The day on which the time range ends.
+ * @internal */ - EndWeekDay?: WeekDay | string; + export const filterSensitiveLog = (obj: MemoryMiB): any => ({ + ...obj, + }); +} +/** + *The minimum and maximum number of network interfaces.
+ */ +export interface NetworkInterfaceCount { /** - *The hour when the time range ends.
+ *The minimum number of network interfaces. If this parameter is not specified, there is no + * minimum limit.
*/ - EndHour?: number; + Min?: number; + + /** + *The maximum number of network interfaces. If this parameter is not specified, there is no + * maximum limit.
+ */ + Max?: number; } -export namespace InstanceEventWindowTimeRangeRequest { +export namespace NetworkInterfaceCount { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceEventWindowTimeRangeRequest): any => ({ + export const filterSensitiveLog = (obj: NetworkInterfaceCount): any => ({ ...obj, }); } -export interface CreateInstanceEventWindowRequest { +/** + *The minimum and maximum amount of total local storage, in GB.
+ */ +export interface TotalLocalStorageGB { /** - *Checks whether you have the required permissions for the action, without 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 minimum amount of total local storage, in GB. If this parameter is not specified, there is + * no minimum limit.
*/ - DryRun?: boolean; + Min?: number; /** - *The name of the event window.
+ *The maximum amount of total local storage, in GB. If this parameter is not specified, there is + * no maximum limit.
*/ - Name?: string; + Max?: number; +} +export namespace TotalLocalStorageGB { /** - *The time range for the event window. If you specify a time range, you can't specify a cron - * expression.
+ * @internal */ - TimeRanges?: InstanceEventWindowTimeRangeRequest[]; + export const filterSensitiveLog = (obj: TotalLocalStorageGB): any => ({ + ...obj, + }); +} +/** + *The minimum and maximum number of vCPUs.
+ */ +export interface VCpuCountRange { /** - *The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If
- * you specify a cron expression, you can't specify a time range.
Constraints:
- *Only hour and day of the week values are supported.
- *For day of the week values, you can specify either integers 0 through
- * 6, or alternative single values SUN through
- * SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or
- * 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or
- * 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event - * window must be >= 4 hours.
- *For more information about cron expressions, see cron on the Wikipedia - * website.
+ *The minimum number of vCPUs. If the value is 0, there is no minimum
+ * limit.
The tags to apply to the event window.
+ *The maximum number of vCPUs. If this parameter is not specified, there is no maximum + * limit.
*/ - TagSpecifications?: TagSpecification[]; + Max?: number; } -export namespace CreateInstanceEventWindowRequest { +export namespace VCpuCountRange { /** * @internal */ - export const filterSensitiveLog = (obj: CreateInstanceEventWindowRequest): any => ({ + export const filterSensitiveLog = (obj: VCpuCountRange): any => ({ ...obj, }); } -export interface CreateInstanceEventWindowResult { +/** + *The attributes for the instance types. When you specify instance attributes, Amazon EC2 will + * identify instance types with these attributes.
+ *When you specify multiple parameters, you get instance types that satisfy all of the + * specified parameters. If you specify multiple values for a parameter, you get instance + * types that satisfy any of the specified values.
+ *You must specify VCpuCount and MemoryMiB. All other parameters
+ * are optional. Any unspecified optional parameter is set to its default.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot + * placement score in the Amazon EC2 User Guide.
+ */ +export interface InstanceRequirements { /** - *Information about the event window.
+ *The minimum and maximum number of vCPUs.
*/ - InstanceEventWindow?: InstanceEventWindow; -} + VCpuCount?: VCpuCountRange; -export namespace CreateInstanceEventWindowResult { /** - * @internal + *The minimum and maximum amount of memory, in MiB.
*/ - export const filterSensitiveLog = (obj: CreateInstanceEventWindowResult): any => ({ - ...obj, - }); -} + MemoryMiB?: MemoryMiB; -export type ContainerFormat = "ova"; + /** + *The CPU manufacturers to include.
+ *For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
Don't confuse the CPU manufacturer with the CPU architecture. Instances will + * be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you + * specify in your launch template.
+ *Default: Any manufacturer
+ */ + CpuManufacturers?: (CpuManufacturer | string)[]; -export type DiskImageFormat = "RAW" | "VHD" | "VMDK"; + /** + *The minimum and maximum amount of memory per vCPU, in GiB.
+ *Default: No minimum or maximum limits
+ */ + MemoryGiBPerVCpu?: MemoryGiBPerVCpu; -/** - *Describes an export instance task.
- */ -export interface ExportToS3TaskSpecification { /** - *The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is - * exported.
+ *The instance types to exclude. You can use strings with one or more wild cards, represented by
+ * an asterisk (*), to exclude an instance type, size, or generation. The
+ * following are examples: m5.8xlarge, c5*.*, m5a.*,
+ * r*, *3*.
For example, if you specify c5*.*, Amazon EC2 will exclude the entire C5
+ * instance family (all C5a and C5n instance types). If you specify c5a.*, Amazon EC2
+ * excludes all the C5a instance types, but does not exclude the C5n instance types.
Default: No excluded instance types
*/ - ContainerFormat?: ContainerFormat | string; + ExcludedInstanceTypes?: string[]; /** - *The format for the exported image.
+ *Indicates whether current or previous generation instance types are included. The + * current generation instance types are recommended for use. Current generation instance types are + * typically the latest two to three generations in each instance family. For more + * information, see Instance types in the + * Amazon EC2 User Guide.
+ *For current generation instance types, specify current.
For previous generation instance types, specify previous.
Default: Current and previous generation instance types
*/ - DiskImageFormat?: DiskImageFormat | string; + InstanceGenerations?: (InstanceGeneration | string)[]; /** - *The Amazon S3 bucket for the destination image. The destination bucket must exist and grant
- * WRITE and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.
The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, + * expressed as a percentage above the cheapest M, C, or R instance type with your specified + * attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance + * types priced above your threshold.
+ *The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
+ *To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
+ *Default: 100
+ *
The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + - * exportTaskId + '.' + diskImageFormat.
+ *The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, + * expressed as a percentage above the cheapest M, C, or R instance type with your specified + * attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance + * types priced above your threshold.
+ *The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
+ *To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
+ *Default: 20
+ *
Indicates whether bare metal instance types must be included, excluded, or required.
+ *To include bare metal instance types, specify included.
To require only bare metal instance types, specify required.
To exclude bare metal instance types, specify excluded.
Default: excluded
+ *
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see + * Burstable performance instances.
+ *To include burstable performance instance types, specify included.
To require only burstable performance instance types, specify required.
To exclude burstable performance instance types, specify excluded.
Default: excluded
+ *
A description for the conversion task or the resource being exported. The maximum length is 255 characters.
+ *Indicates whether instance types must support hibernation for On-Demand + * Instances.
+ *This parameter is not supported for GetSpotPlacementScores.
+ *Default: false
+ *
The format and location for an export instance task.
+ *The minimum and maximum number of network interfaces.
+ *Default: No minimum or maximum limits
*/ - ExportToS3Task: ExportToS3TaskSpecification | undefined; + NetworkInterfaceCount?: NetworkInterfaceCount; /** - *The ID of the instance.
+ *Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, + * Amazon + * EC2 instance store in the Amazon EC2 User Guide.
+ *To include instance types with instance store volumes, specify
+ * included.
To require only instance types with instance store volumes, specify
+ * required.
To exclude instance types with instance store volumes, specify
+ * excluded.
Default: included
+ *
The target virtualization environment.
+ *The type of local storage that is required.
+ *For instance types with hard disk drive (HDD) storage, specify hdd.
For instance types with solid state drive (SDD) storage, specify sdd.
Default: hdd and sdd
+ *
The tags to apply to the export instance task during creation.
+ *The minimum and maximum amount of total local storage, in GB.
+ *Default: No minimum or maximum limits
*/ - TagSpecifications?: TagSpecification[]; -} + TotalLocalStorageGB?: TotalLocalStorageGB; -export namespace CreateInstanceExportTaskRequest { /** - * @internal + *The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see + * Amazon + * EBS–optimized instances in the Amazon EC2 User Guide.
+ *Default: No minimum or maximum limits
*/ - export const filterSensitiveLog = (obj: CreateInstanceExportTaskRequest): any => ({ - ...obj, - }); -} + BaselineEbsBandwidthMbps?: BaselineEbsBandwidthMbps; -/** - *Describes the format and location for the export task.
- */ -export interface ExportToS3Task { /** - *The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is - * exported.
+ *The accelerator types that must be on the instance type.
+ *For instance types with GPU accelerators, specify gpu.
For instance types with FPGA accelerators, specify fpga.
For instance types with inference accelerators, specify inference.
Default: Any accelerator type
*/ - ContainerFormat?: ContainerFormat | string; + AcceleratorTypes?: (AcceleratorType | string)[]; /** - *The format for the exported image.
+ *The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on + * an instance.
+ *To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
*/ - DiskImageFormat?: DiskImageFormat | string; + AcceleratorCount?: AcceleratorCount; /** - *The Amazon S3 bucket for the destination image. The destination bucket must exist and grant
- * WRITE and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.
Indicates whether instance types must have accelerators by specific manufacturers.
+ *For instance types with NVIDIA devices, specify nvidia.
For instance types with AMD devices, specify amd.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
*/ - S3Bucket?: string; + AcceleratorManufacturers?: (AcceleratorManufacturer | string)[]; /** - *The encryption key for your S3 bucket.
+ *The accelerators that must be on the instance type.
+ *For instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA V100 GPUs, specify v100.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
Default: Any accelerator
*/ - S3Key?: string; + AcceleratorNames?: (AcceleratorName | string)[]; + + /** + *The minimum and maximum amount of total accelerator memory, in MiB.
+ *Default: No minimum or maximum limits
+ */ + AcceleratorTotalMemoryMiB?: AcceleratorTotalMemoryMiB; } -export namespace ExportToS3Task { +export namespace InstanceRequirements { /** * @internal */ - export const filterSensitiveLog = (obj: ExportToS3Task): any => ({ + export const filterSensitiveLog = (obj: InstanceRequirements): any => ({ ...obj, }); } /** - *Describes an instance to export.
+ *Describes the placement of an instance.
*/ -export interface InstanceExportDetails { - /** - *The ID of the resource being exported.
- */ - InstanceId?: string; - +export interface PlacementResponse { /** - *The target virtualization environment.
+ *The name of the placement group that the instance is in.
*/ - TargetEnvironment?: ExportEnvironment | string; + GroupName?: string; } -export namespace InstanceExportDetails { +export namespace PlacementResponse { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceExportDetails): any => ({ + export const filterSensitiveLog = (obj: PlacementResponse): any => ({ ...obj, }); } -export type ExportTaskState = "active" | "cancelled" | "cancelling" | "completed"; - /** - *Describes an export instance task.
+ *Describes overrides for a launch template.
*/ -export interface ExportTask { +export interface FleetLaunchTemplateOverrides { /** - *A description of the resource being exported.
+ *The instance type.
+ *If you specify InstanceTypes, you can't specify
+ * InstanceRequirements.
The ID of the export task.
+ *The maximum price per unit hour that you are willing to pay for a Spot Instance.
*/ - ExportTaskId?: string; + MaxPrice?: string; /** - *Information about the export task.
+ *The ID of the subnet in which to launch the instances.
*/ - ExportToS3Task?: ExportToS3Task; + SubnetId?: string; /** - *Information about the instance to export.
+ *The Availability Zone in which to launch the instances.
*/ - InstanceExportDetails?: InstanceExportDetails; + AvailabilityZone?: string; /** - *The state of the export task.
+ *The number of units provided by the specified instance type.
*/ - State?: ExportTaskState | string; + WeightedCapacity?: number; /** - *The status message related to the export task.
+ *The priority for the launch template override. The highest priority is launched + * first.
+ *If the On-Demand AllocationStrategy is set to prioritized,
+ * EC2 Fleet uses priority to determine which launch template override to use first in fulfilling
+ * On-Demand capacity.
If the Spot AllocationStrategy is set to
+ * capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis
+ * to determine which launch template override to use in fulfilling Spot capacity, but
+ * optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the
+ * higher the priority. If no number is set, the override has the lowest priority. You can set
+ * the same priority for different launch template overrides.
The tags for the export task.
+ *The location where the instance launched, if applicable.
*/ - Tags?: Tag[]; + Placement?: PlacementResponse; + + /** + *The attributes for the instance types. When you specify instance attributes, Amazon EC2 will + * identify instance types with those attributes.
+ *If you specify InstanceRequirements, you can't specify
+ * InstanceTypes.
Describes a launch template and overrides.
+ */ +export interface LaunchTemplateAndOverridesResponse { /** - *Information about the export instance task.
+ *The launch template.
*/ - ExportTask?: ExportTask; + LaunchTemplateSpecification?: FleetLaunchTemplateSpecification; + + /** + *Any parameters that you specify override the same parameters in the launch + * template.
+ */ + Overrides?: FleetLaunchTemplateOverrides; } -export namespace CreateInstanceExportTaskResult { +export namespace LaunchTemplateAndOverridesResponse { /** * @internal */ - export const filterSensitiveLog = (obj: CreateInstanceExportTaskResult): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateAndOverridesResponse): any => ({ ...obj, }); } -export interface CreateInternetGatewayRequest { +export enum InstanceLifecycle { + ON_DEMAND = "on-demand", + SPOT = "spot", +} + +/** + *Describes the instances that could not be launched by the fleet.
+ */ +export interface CreateFleetError { /** - *The tags to assign to the internet gateway.
+ *The launch templates and overrides that were used for launching the instances. The + * values that you specify in the Overrides replace the values in the launch template.
*/ - TagSpecifications?: TagSpecification[]; + LaunchTemplateAndOverrides?: LaunchTemplateAndOverridesResponse; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
*/ - DryRun?: boolean; + Lifecycle?: InstanceLifecycle | string; + + /** + *The error code that indicates why the instance could not be launched. For more + * information about error codes, see Error Codes.
+ */ + ErrorCode?: string; + + /** + *The error message that describes why the instance could not be launched. For more + * information about error messages, see Error Codes.
+ */ + ErrorMessage?: string; } -export namespace CreateInternetGatewayRequest { +export namespace CreateFleetError { /** * @internal */ - export const filterSensitiveLog = (obj: CreateInternetGatewayRequest): any => ({ + export const filterSensitiveLog = (obj: CreateFleetError): any => ({ ...obj, }); } +export type PlatformValues = "Windows"; + /** - *Describes an internet gateway.
+ *Describes the instances that were launched by the fleet.
*/ -export interface InternetGateway { +export interface CreateFleetInstance { /** - *Any VPCs attached to the internet gateway.
+ *The launch templates and overrides that were used for launching the instances. The + * values that you specify in the Overrides replace the values in the launch template.
*/ - Attachments?: InternetGatewayAttachment[]; + LaunchTemplateAndOverrides?: LaunchTemplateAndOverridesResponse; /** - *The ID of the internet gateway.
+ *Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
*/ - InternetGatewayId?: string; + Lifecycle?: InstanceLifecycle | string; /** - *The ID of the Amazon Web Services account that owns the internet gateway.
+ *The IDs of the instances.
*/ - OwnerId?: string; + InstanceIds?: string[]; /** - *Any tags assigned to the internet gateway.
+ *The instance type.
*/ - Tags?: Tag[]; + InstanceType?: _InstanceType | string; + + /** + *The value is Windows for Windows instances. Otherwise, the value is
+ * blank.
Information about the internet gateway.
+ *The ID of the EC2 Fleet.
*/ - InternetGateway?: InternetGateway; + FleetId?: string; + + /** + *Information about the instances that could not be launched by the fleet. Supported only for
+ * fleets of type instant.
Information about the instances that were launched by the fleet. Supported only for
+ * fleets of type instant.
A unique name for the key pair.
- *Constraints: Up to 255 ASCII characters
- */ - KeyName: string | undefined; - +/** + *Describes the destination options for a flow log.
+ */ +export interface DestinationOptionsRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The format for the flow log. The default is plain-text.
The type of key pair. Note that ED25519 keys are not supported for Windows instances, EC2 Instance Connect, and EC2 Serial Console.
- *Default: rsa
- *
Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.
+ * The default is false.
The tags to apply to the new key pair.
+ *Indicates whether to partition the flow log per hour. This reduces the cost and response
+ * time for queries. The default is false.
Describes a key pair.
- */ -export interface KeyPair { - /** - *The SHA-1 digest of the DER encoded private key.
- */ - KeyFingerprint?: string; +export type LogDestinationType = "cloud-watch-logs" | "s3"; + +export type FlowLogsResourceType = "NetworkInterface" | "Subnet" | "VPC"; +export type TrafficType = "ACCEPT" | "ALL" | "REJECT"; + +export interface CreateFlowLogsRequest { /** - *An unencrypted PEM encoded RSA or ED25519 private key.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The name of the key pair.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. For more information, see How to ensure + * idempotency.
*/ - KeyName?: string; + ClientToken?: string; /** - *The ID of the key pair.
+ *The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group + * in your account.
+ *If you specify LogDestinationType as s3, do not specify
+ * DeliverLogsPermissionArn or LogGroupName.
Any tags applied to the key pair.
+ *The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
+ *If you specify LogDestinationType as s3, do not specify
+ * DeliverLogsPermissionArn or LogGroupName.
The ID of the subnet, network interface, or VPC for which you want to create a flow log.
+ *Constraints: Maximum of 1000 resources
*/ - export const filterSensitiveLog = (obj: KeyPair): any => ({ - ...obj, - ...(obj.KeyMaterial && { KeyMaterial: SENSITIVE_STRING }), - }); -} + ResourceIds: string[] | undefined; -/** - *The parameters for a block device for an EBS volume.
- */ -export interface LaunchTemplateEbsBlockDeviceRequest { /** - *Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. - * If you are creating a volume from a snapshot, you can't specify an encryption value.
+ *The type of resource for which to create the flow log. For example, if you specified a VPC ID for
+ * the ResourceId property, specify VPC for this property.
Indicates whether the EBS volume is deleted on instance termination.
+ *The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
*/ - DeleteOnTermination?: boolean; + TrafficType: TrafficType | string | undefined; /** - *The number of I/O operations per second (IOPS). For gp3, io1, and io2
- * volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes,
- * this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits
- * for bursting.
The following are the supported values for each volume type:
- *
- * gp3: 3,000-16,000 IOPS
- * io1: 100-64,000 IOPS
- * io2: 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS
- * only for Instances built on the Nitro System. Other instance families guarantee performance up
- * to 32,000 IOPS.
This parameter is supported for io1, io2, and gp3 volumes only. This parameter is not supported for
- * gp2, st1, sc1, or standard volumes.
The type of destination to which the flow log data is to be published. Flow log data can be
+ * published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To
+ * publish flow log data to Amazon S3, specify s3.
If you specify LogDestinationType as s3, do not specify
+ * DeliverLogsPermissionArn or LogGroupName.
Default: cloud-watch-logs
+ *
The ARN of the symmetric Key Management Service (KMS) CMK used for - * encryption.
+ *The destination to which the flow log data is to be published. Flow log data can be published
+ * to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified
+ * for LogDestinationType.
If LogDestinationType is not specified or cloud-watch-logs,
+ * specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish
+ * to a log group called my-logs, specify
+ * arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively,
+ * use LogGroupName instead.
If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a
+ * subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format:
+ * bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a
+ * bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You
+ * cannot use AWSLogs as a subfolder name. This is a reserved term.
The ID of the snapshot.
+ *The fields to include in the flow log record, in the order in which they should + * appear. For a list of available fields, see Flow log records. If you + * omit this parameter, the flow log is created using the default format. If you specify this parameter, + * you must specify at least one field.
+ *Specify the fields using the ${field-id} format, separated by spaces. For
+ * the CLI, surround this parameter value with single quotes on Linux or
+ * double quotes on Windows.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following - * are the supported volumes sizes for each volume type:
- *
- * gp2 and gp3: 1-16,384
- * io1 and io2: 4-16,384
- * st1 and sc1: 125-16,384
- * standard: 1-1,024
The tags to apply to the flow logs.
*/ - VolumeSize?: number; + TagSpecifications?: TagSpecification[]; /** - *The volume type. For more information, see Amazon EBS volume types in the - * Amazon Elastic Compute Cloud User Guide.
+ *The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
+ *When a network interface is attached to a Nitro-based + * instance, the aggregation interval is always 60 seconds or less, regardless + * of the value that you specify.
+ *Default: 600
*/ - VolumeType?: VolumeType | string; + MaxAggregationInterval?: number; /** - *The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
+ *The destination options.
*/ - Throughput?: number; + DestinationOptions?: DestinationOptionsRequest; } -export namespace LaunchTemplateEbsBlockDeviceRequest { +export namespace CreateFlowLogsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateEbsBlockDeviceRequest): any => ({ + export const filterSensitiveLog = (obj: CreateFlowLogsRequest): any => ({ ...obj, }); } -/** - *Describes a block device mapping.
- */ -export interface LaunchTemplateBlockDeviceMappingRequest { - /** - *The device name (for example, /dev/sdh or xvdh).
- */ - DeviceName?: string; - +export interface CreateFlowLogsResult { /** - *The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. - * An instance type with 2 available instance store volumes can specify mappings for ephemeral0 - * and ephemeral1. The number of available instance store volumes depends on the instance type. - * After you connect to the instance, you must mount the volume.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request.
*/ - VirtualName?: string; + ClientToken?: string; /** - *Parameters used to automatically set up EBS volumes when the instance is launched.
+ *The IDs of the flow logs.
*/ - Ebs?: LaunchTemplateEbsBlockDeviceRequest; + FlowLogIds?: string[]; /** - *To omit the device from the block device mapping, specify an empty string.
+ *Information about the flow logs that could not be created successfully.
*/ - NoDevice?: string; + Unsuccessful?: UnsuccessfulItem[]; } -export namespace LaunchTemplateBlockDeviceMappingRequest { +export namespace CreateFlowLogsResult { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateBlockDeviceMappingRequest): any => ({ + export const filterSensitiveLog = (obj: CreateFlowLogsResult): any => ({ ...obj, }); } -export type CapacityReservationPreference = "none" | "open"; - /** - *Describes a target Capacity Reservation or Capacity Reservation group.
+ *Describes a storage location in Amazon S3.
*/ -export interface CapacityReservationTarget { +export interface StorageLocation { /** - *The ID of the Capacity Reservation in which to run the instance.
+ *The name of the S3 bucket.
*/ - CapacityReservationId?: string; + Bucket?: string; /** - *The ARN of the Capacity Reservation resource group in which to run the instance.
+ *The key.
*/ - CapacityReservationResourceGroupArn?: string; + Key?: string; } -export namespace CapacityReservationTarget { +export namespace StorageLocation { /** * @internal */ - export const filterSensitiveLog = (obj: CapacityReservationTarget): any => ({ + export const filterSensitiveLog = (obj: StorageLocation): any => ({ ...obj, }); } -/** - *Describes an instance's Capacity Reservation targeting option. You can specify only one option at a time. Use the
- * CapacityReservationPreference parameter to configure the instance to run in On-Demand capacity or
- * to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
- * Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or
- * a Capacity Reservation group.
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
- *
- * open - The instance can run in any open Capacity Reservation that has matching attributes
- * (instance type, platform, Availability Zone).
- * none - The instance avoids running in a Capacity Reservation even if one is available. The instance
- * runs in On-Demand capacity.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the target Capacity Reservation or Capacity Reservation group.
+ *The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.
*/ - CapacityReservationTarget?: CapacityReservationTarget; -} + InputStorageLocation: StorageLocation | undefined; -export namespace LaunchTemplateCapacityReservationSpecificationRequest { /** - * @internal + *The location in Amazon S3 for the output logs.
*/ - export const filterSensitiveLog = (obj: LaunchTemplateCapacityReservationSpecificationRequest): any => ({ - ...obj, - }); -} + LogsStorageLocation?: StorageLocation; -/** - *The CPU options for the instance. Both the core count and threads per core - * must be specified in the request.
- */ -export interface LaunchTemplateCpuOptionsRequest { /** - *The number of CPU cores for the instance.
+ *A description for the AFI.
*/ - CoreCount?: number; + Description?: string; /** - *The number of threads per CPU core. To disable multithreading - * for the instance, specify a value of 1. Otherwise, specify the default value of 2.
+ *A name for the AFI.
*/ - ThreadsPerCore?: number; -} + Name?: string; -export namespace LaunchTemplateCpuOptionsRequest { /** - * @internal + *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + * For more information, see Ensuring Idempotency.
*/ - export const filterSensitiveLog = (obj: LaunchTemplateCpuOptionsRequest): any => ({ - ...obj, - }); -} + ClientToken?: string; -/** - *The credit option for CPU usage of a T2, T3, or T3a instance.
- */ -export interface CreditSpecificationRequest { /** - *The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are
- * standard and unlimited.
The tags to apply to the FPGA image during creation.
*/ - CpuCredits: string | undefined; + TagSpecifications?: TagSpecification[]; } -export namespace CreditSpecificationRequest { +export namespace CreateFpgaImageRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreditSpecificationRequest): any => ({ + export const filterSensitiveLog = (obj: CreateFpgaImageRequest): any => ({ ...obj, }); } -/** - *A specification for an Elastic Graphics accelerator.
- */ -export interface ElasticGpuSpecification { +export interface CreateFpgaImageResult { /** - *The type of Elastic Graphics accelerator. For more information about the values to specify for
- * Type, see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the
- * Amazon Elastic Compute Cloud User Guide for Windows Instances.
The FPGA image identifier (AFI ID).
*/ - Type: string | undefined; + FpgaImageId?: string; + + /** + *The global FPGA image identifier (AGFI ID).
+ */ + FpgaImageGlobalId?: string; } -export namespace ElasticGpuSpecification { +export namespace CreateFpgaImageResult { /** * @internal */ - export const filterSensitiveLog = (obj: ElasticGpuSpecification): any => ({ + export const filterSensitiveLog = (obj: CreateFpgaImageResult): any => ({ ...obj, }); } +export type VolumeType = "gp2" | "gp3" | "io1" | "io2" | "sc1" | "st1" | "standard"; + /** - *- * Describes an elastic inference accelerator. - *
+ *Describes a block device for an EBS volume.
*/ -export interface LaunchTemplateElasticInferenceAccelerator { +export interface EbsBlockDevice { /** - *- * The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. - *
+ *Indicates whether the EBS volume is deleted on instance termination. For more + * information, see Preserving Amazon EBS volumes on instance termination in the + * Amazon EC2 User Guide.
*/ - Type: string | undefined; + DeleteOnTermination?: boolean; /** - *- * The number of elastic inference accelerators to attach to the instance. - *
- *Default: 1
+ *The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this
+ * represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this
+ * represents the baseline performance of the volume and the rate at which the volume accumulates
+ * I/O credits for bursting.
The following are the supported values for each volume type:
+ *
+ * gp3: 3,000-16,000 IOPS
+ * io1: 100-64,000 IOPS
+ * io2: 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS only for
+ * Instances built on the Nitro System. Other instance families guarantee performance
+ * up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes.
+ * The default for gp3 volumes is 3,000 IOPS.
+ * This parameter is not supported for gp2, st1, sc1, or standard volumes.
The ID of the snapshot.
*/ - export const filterSensitiveLog = (obj: LaunchTemplateElasticInferenceAccelerator): any => ({ - ...obj, - }); -} + SnapshotId?: string; -/** - *Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, - * see - * What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
- */ -export interface LaunchTemplateEnclaveOptionsRequest { /** - *To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. + * If you specify a snapshot, the default is the snapshot size. You can specify a volume + * size that is equal to or larger than the snapshot size.
+ *The following are the supported volumes sizes for each volume type:
+ *
+ * gp2 and gp3:1-16,384
+ * io1 and io2: 4-16,384
+ * st1 and sc1: 125-16,384
+ * standard: 1-1,024
The volume type. For more information, see Amazon EBS volume types in the
+ * Amazon EC2 User Guide. If the volume type is io1 or io2,
+ * you must specify the IOPS that the volume supports.
Indicates whether the instance is configured for hibernation. This parameter is valid only - * if the instance meets the hibernation - * prerequisites.
- */ -export interface LaunchTemplateHibernationOptionsRequest { /** - *If you set this parameter to true, the instance is enabled for hibernation.
Default: false
- *
Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under + * which the EBS volume is encrypted.
+ *This parameter is only supported on BlockDeviceMapping objects called by
+ * RunInstances, RequestSpotFleet,
+ * and RequestSpotInstances.
The throughput that the volume supports, in MiB/s.
+ *This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
+ */ + Throughput?: number; + + /** + *The ARN of the Outpost on which the snapshot is stored.
+ */ + OutpostArn?: string; + + /** + *Indicates whether the encryption state of an EBS volume is changed while being
+ * restored from a backing snapshot.
+ * The effect of setting the encryption state to true depends on
+ * the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled.
+ * For more information, see Amazon EBS encryption
+ * in the Amazon EC2 User Guide.
In no case can you remove encryption from an encrypted volume.
+ *Encrypted volumes can only be attached to instances that support Amazon EBS + * encryption. For more information, see Supported instance types.
+ *This parameter is not returned by .
+ */ + Encrypted?: boolean; } -export namespace LaunchTemplateHibernationOptionsRequest { +export namespace EbsBlockDevice { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateHibernationOptionsRequest): any => ({ + export const filterSensitiveLog = (obj: EbsBlockDevice): any => ({ ...obj, }); } /** - *An IAM instance profile.
+ *Describes a block device mapping, which defines the EBS volumes and instance store + * volumes to attach to an instance at launch.
*/ -export interface LaunchTemplateIamInstanceProfileSpecificationRequest { +export interface BlockDeviceMapping { /** - *The Amazon Resource Name (ARN) of the instance profile.
+ *The device name (for example, /dev/sdh or xvdh).
The name of the instance profile.
+ *The virtual device name (ephemeralN). Instance store volumes are numbered
+ * starting from 0. An instance type with 2 available instance store volumes can specify
+ * mappings for ephemeral0 and ephemeral1. The number of
+ * available instance store volumes depends on the instance type. After you connect to the
+ * instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. + * Including them in your block device mapping has no effect.
+ *Constraints: For M3 instances, you must specify instance store volumes in the block + * device mapping for the instance. When you launch an M3 instance, we ignore any instance + * store volumes specified in the block device mapping for the AMI.
*/ - Name?: string; + VirtualName?: string; + + /** + *Parameters used to automatically set up EBS volumes when the instance is + * launched.
+ */ + Ebs?: EbsBlockDevice; + + /** + *To omit the device from the block device mapping, specify an empty string. When this + * property is specified, the device is removed from the block device mapping regardless of + * the assigned value.
+ */ + NoDevice?: string; } -export namespace LaunchTemplateIamInstanceProfileSpecificationRequest { +export namespace BlockDeviceMapping { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateIamInstanceProfileSpecificationRequest): any => ({ + export const filterSensitiveLog = (obj: BlockDeviceMapping): any => ({ ...obj, }); } -export type ShutdownBehavior = "stop" | "terminate"; - -export type MarketType = "spot"; - -export type InstanceInterruptionBehavior = "hibernate" | "stop" | "terminate"; +export interface CreateImageRequest { + /** + *The block device mappings. This parameter cannot be used to modify the encryption + * status of existing volumes or snapshots. To create an AMI with encrypted snapshots, + * use the CopyImage action.
+ */ + BlockDeviceMappings?: BlockDeviceMapping[]; -export type SpotInstanceType = "one-time" | "persistent"; + /** + *A description for the new image.
+ */ + Description?: string; -/** - *The options for Spot Instances.
- */ -export interface LaunchTemplateSpotMarketOptionsRequest { /** - *The maximum hourly price you're willing to pay for the Spot Instances.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The Spot Instance request type.
+ *The ID of the instance.
*/ - SpotInstanceType?: SpotInstanceType | string; + InstanceId: string | undefined; /** - *The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
+ *A name for the new image.
+ *Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
*/ - BlockDurationMinutes?: number; + Name: string | undefined; /** - *The end date of the request. - * For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. - * If the request is persistent, it remains active until it is canceled or this date and time is reached. - * The default end date is 7 days from the current date.
+ *By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image.
+ * If the No Reboot option is set, Amazon EC2 doesn't shut down the instance before creating
+ * the image. Without a reboot, the AMI will be crash consistent (all the volumes are snapshotted
+ * at the same time), but not application consistent (all the operating system buffers are not flushed
+ * to disk before the snapshots are created).
The behavior when a Spot Instance is interrupted. The default is terminate.
The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the + * snapshots, or both.
+ *To tag the AMI, the value for ResourceType must be
+ * image.
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that
+ * are attached to the instance, the value for ResourceType must be
+ * snapshot. The same tag is applied to all of the snapshots that are
+ * created.
If you specify other values for ResourceType, the request fails.
To tag an AMI or snapshot after it has been created, see CreateTags.
*/ - InstanceInterruptionBehavior?: InstanceInterruptionBehavior | string; + TagSpecifications?: TagSpecification[]; } -export namespace LaunchTemplateSpotMarketOptionsRequest { +export namespace CreateImageRequest { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateSpotMarketOptionsRequest): any => ({ + export const filterSensitiveLog = (obj: CreateImageRequest): any => ({ ...obj, }); } -/** - *The market (purchasing) option for the instances.
- */ -export interface LaunchTemplateInstanceMarketOptionsRequest { - /** - *The market type.
- */ - MarketType?: MarketType | string; - +export interface CreateImageResult { /** - *The options for Spot Instances.
+ *The ID of the new AMI.
*/ - SpotOptions?: LaunchTemplateSpotMarketOptionsRequest; + ImageId?: string; } -export namespace LaunchTemplateInstanceMarketOptionsRequest { +export namespace CreateImageResult { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateInstanceMarketOptionsRequest): any => ({ + export const filterSensitiveLog = (obj: CreateImageResult): any => ({ ...obj, }); } /** - *Describes a license configuration.
+ *The start day and time and the end day and time of the time range, in UTC.
*/ -export interface LaunchTemplateLicenseConfigurationRequest { +export interface InstanceEventWindowTimeRangeRequest { /** - *The Amazon Resource Name (ARN) of the license configuration.
+ *The day on which the time range begins.
*/ - LicenseConfigurationArn?: string; -} + StartWeekDay?: WeekDay | string; -export namespace LaunchTemplateLicenseConfigurationRequest { /** - * @internal + *The hour when the time range begins.
*/ - export const filterSensitiveLog = (obj: LaunchTemplateLicenseConfigurationRequest): any => ({ - ...obj, - }); -} + StartHour?: number; -export type LaunchTemplateInstanceMetadataEndpointState = "disabled" | "enabled"; + /** + *The day on which the time range ends.
+ */ + EndWeekDay?: WeekDay | string; -export enum LaunchTemplateInstanceMetadataProtocolIpv6 { - disabled = "disabled", - enabled = "enabled", + /** + *The hour when the time range ends.
+ */ + EndHour?: number; } -export enum LaunchTemplateHttpTokensState { - optional = "optional", - required = "required", +export namespace InstanceEventWindowTimeRangeRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: InstanceEventWindowTimeRangeRequest): any => ({ + ...obj, + }); } -/** - *The metadata options for the instance. For more information, see Instance Metadata and User Data in the - * Amazon Elastic Compute Cloud User Guide.
- */ -export interface LaunchTemplateInstanceMetadataOptionsRequest { +export interface CreateInstanceEventWindowRequest { /** - *The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
Checks whether you have the required permissions for the action, without 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 desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
- *Default: 1
- *Possible values: Integers from 1 to 64
+ *The name of the event window.
*/ - HttpPutResponseHopLimit?: number; + Name?: string; /** - *This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.
- *
The time range for the event window. If you specify a time range, you can't specify a cron + * expression.
*/ - HttpEndpoint?: LaunchTemplateInstanceMetadataEndpointState | string; + TimeRanges?: InstanceEventWindowTimeRangeRequest[]; /** - *Enables or disables the IPv6 endpoint for the instance metadata service.
- *Default: disabled
- *
The cron expression for the event window, for example, * 0-4,20-23 * * 1,5. If
+ * you specify a cron expression, you can't specify a time range.
Constraints:
+ *Only hour and day of the week values are supported.
+ *For day of the week values, you can specify either integers 0 through
+ * 6, or alternative single values SUN through
+ * SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or
+ * 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or
+ * 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event + * window must be >= 4 hours.
+ *For more information about cron expressions, see cron on the Wikipedia + * website.
*/ - HttpProtocolIpv6?: LaunchTemplateInstanceMetadataProtocolIpv6 | string; + CronExpression?: string; + + /** + *The tags to apply to the event window.
+ */ + TagSpecifications?: TagSpecification[]; } -export namespace LaunchTemplateInstanceMetadataOptionsRequest { +export namespace CreateInstanceEventWindowRequest { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateInstanceMetadataOptionsRequest): any => ({ + export const filterSensitiveLog = (obj: CreateInstanceEventWindowRequest): any => ({ ...obj, }); } -/** - *Describes the monitoring for the instance.
- */ -export interface LaunchTemplatesMonitoringRequest { +export interface CreateInstanceEventWindowResult { /** - *Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.
Information about the event window.
*/ - Enabled?: boolean; + InstanceEventWindow?: InstanceEventWindow; } -export namespace LaunchTemplatesMonitoringRequest { +export namespace CreateInstanceEventWindowResult { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplatesMonitoringRequest): any => ({ + export const filterSensitiveLog = (obj: CreateInstanceEventWindowResult): any => ({ ...obj, }); } +export type ContainerFormat = "ova"; + +export type DiskImageFormat = "RAW" | "VHD" | "VMDK"; + /** - *Describes the IPv4 prefix option for a network interface.
+ *Describes an export instance task.
*/ -export interface Ipv4PrefixSpecificationRequest { +export interface ExportToS3TaskSpecification { /** - *The IPv4 prefix. For information, see - * Assigning prefixes to Amazon EC2 network interfaces in the - * Amazon Elastic Compute Cloud User Guide.
+ *The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is + * exported.
*/ - Ipv4Prefix?: string; + ContainerFormat?: ContainerFormat | string; + + /** + *The format for the exported image.
+ */ + DiskImageFormat?: DiskImageFormat | string; + + /** + *The Amazon S3 bucket for the destination image. The destination bucket must exist and grant
+ * WRITE and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.
The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + + * exportTaskId + '.' + diskImageFormat.
+ */ + S3Prefix?: string; } -export namespace Ipv4PrefixSpecificationRequest { +export namespace ExportToS3TaskSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: Ipv4PrefixSpecificationRequest): any => ({ + export const filterSensitiveLog = (obj: ExportToS3TaskSpecification): any => ({ ...obj, }); } -/** - *Describes an IPv6 address.
- */ -export interface InstanceIpv6AddressRequest { +export type ExportEnvironment = "citrix" | "microsoft" | "vmware"; + +export interface CreateInstanceExportTaskRequest { /** - *The IPv6 address.
+ *A description for the conversion task or the resource being exported. The maximum length is 255 characters.
*/ - Ipv6Address?: string; + Description?: string; + + /** + *The format and location for an export instance task.
+ */ + ExportToS3Task: ExportToS3TaskSpecification | undefined; + + /** + *The ID of the instance.
+ */ + InstanceId: string | undefined; + + /** + *The target virtualization environment.
+ */ + TargetEnvironment: ExportEnvironment | string | undefined; + + /** + *The tags to apply to the export instance task during creation.
+ */ + TagSpecifications?: TagSpecification[]; } -export namespace InstanceIpv6AddressRequest { +export namespace CreateInstanceExportTaskRequest { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceIpv6AddressRequest): any => ({ + export const filterSensitiveLog = (obj: CreateInstanceExportTaskRequest): any => ({ ...obj, }); } /** - *Describes the IPv4 prefix option for a network interface.
+ *Describes the format and location for the export task.
*/ -export interface Ipv6PrefixSpecificationRequest { +export interface ExportToS3Task { /** - *The IPv6 prefix.
+ *The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is + * exported.
*/ - Ipv6Prefix?: string; + ContainerFormat?: ContainerFormat | string; + + /** + *The format for the exported image.
+ */ + DiskImageFormat?: DiskImageFormat | string; + + /** + *The Amazon S3 bucket for the destination image. The destination bucket must exist and grant
+ * WRITE and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.
The encryption key for your S3 bucket.
+ */ + S3Key?: string; } -export namespace Ipv6PrefixSpecificationRequest { +export namespace ExportToS3Task { /** * @internal */ - export const filterSensitiveLog = (obj: Ipv6PrefixSpecificationRequest): any => ({ + export const filterSensitiveLog = (obj: ExportToS3Task): any => ({ ...obj, }); } /** - *Describes a secondary private IPv4 address for a network interface.
+ *Describes an instance to export.
*/ -export interface PrivateIpAddressSpecification { +export interface InstanceExportDetails { /** - *Indicates whether the private IPv4 address is the primary private IPv4 address. Only - * one IPv4 address can be designated as primary.
+ *The ID of the resource being exported.
*/ - Primary?: boolean; + InstanceId?: string; /** - *The private IPv4 addresses.
+ *The target virtualization environment.
*/ - PrivateIpAddress?: string; + TargetEnvironment?: ExportEnvironment | string; } -export namespace PrivateIpAddressSpecification { +export namespace InstanceExportDetails { /** * @internal */ - export const filterSensitiveLog = (obj: PrivateIpAddressSpecification): any => ({ + export const filterSensitiveLog = (obj: InstanceExportDetails): any => ({ ...obj, }); } +export type ExportTaskState = "active" | "cancelled" | "cancelling" | "completed"; + /** - *The parameters for a network interface.
+ *Describes an export instance task.
*/ -export interface LaunchTemplateInstanceNetworkInterfaceSpecificationRequest { +export interface ExportTask { /** - *Associates a Carrier IP address with eth0 for a new network interface.
- *Use this option when you launch an instance in a Wavelength Zone and want to associate - * a Carrier IP address with the network interface. For more information about Carrier IP - * addresses, see Carrier IP addresses in the Wavelength Developer - * Guide.
+ *A description of the resource being exported.
*/ - AssociateCarrierIpAddress?: boolean; + Description?: string; /** - *Associates a public IPv4 address with eth0 for a new network interface.
+ *The ID of the export task.
*/ - AssociatePublicIpAddress?: boolean; + ExportTaskId?: string; /** - *Indicates whether the network interface is deleted when the instance is terminated.
+ *Information about the export task.
*/ - DeleteOnTermination?: boolean; + ExportToS3Task?: ExportToS3Task; /** - *A description for the network interface.
+ *Information about the instance to export.
*/ - Description?: string; + InstanceExportDetails?: InstanceExportDetails; /** - *The device index for the network interface attachment.
+ *The state of the export task.
*/ - DeviceIndex?: number; + State?: ExportTaskState | string; /** - *The IDs of one or more security groups.
+ *The status message related to the export task.
*/ - Groups?: string[]; + StatusMessage?: string; /** - *The type of network interface. To create an Elastic Fabric Adapter (EFA), specify
- * efa. For more information, see Elastic Fabric Adapter in the
- * Amazon Elastic Compute Cloud User Guide.
If you are not creating an EFA, specify interface or omit this parameter.
Valid values: interface | efa
- *
The tags for the export task.
*/ - InterfaceType?: string; + Tags?: Tag[]; +} +export namespace ExportTask { /** - *The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
+ * @internal */ - Ipv6AddressCount?: number; + export const filterSensitiveLog = (obj: ExportTask): any => ({ + ...obj, + }); +} +export interface CreateInstanceExportTaskResult { /** - *One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
+ *Information about the export instance task.
*/ - Ipv6Addresses?: InstanceIpv6AddressRequest[]; + ExportTask?: ExportTask; +} +export namespace CreateInstanceExportTaskResult { /** - *The ID of the network interface.
+ * @internal */ - NetworkInterfaceId?: string; + export const filterSensitiveLog = (obj: CreateInstanceExportTaskResult): any => ({ + ...obj, + }); +} +export interface CreateInternetGatewayRequest { /** - *The primary private IPv4 address of the network interface.
+ *The tags to assign to the internet gateway.
*/ - PrivateIpAddress?: string; + TagSpecifications?: TagSpecification[]; /** - *One or more private IPv4 addresses.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The number of secondary private IPv4 addresses to assign to a network interface.
+ * @internal */ - SecondaryPrivateIpAddressCount?: number; + export const filterSensitiveLog = (obj: CreateInternetGatewayRequest): any => ({ + ...obj, + }); +} +/** + *Describes an internet gateway.
+ */ +export interface InternetGateway { /** - *The ID of the subnet for the network interface.
+ *Any VPCs attached to the internet gateway.
*/ - SubnetId?: string; + Attachments?: InternetGatewayAttachment[]; /** - *The index of the network card. Some instance types support multiple network cards. - * The primary network interface must be assigned to network card index 0. - * The default is network card index 0.
+ *The ID of the internet gateway.
*/ - NetworkCardIndex?: number; + InternetGatewayId?: string; /** - *One or more IPv4 prefixes to be assigned to the network interface. You cannot use
- * this option if you use the Ipv4PrefixCount option.
The ID of the Amazon Web Services account that owns the internet gateway.
*/ - Ipv4Prefixes?: Ipv4PrefixSpecificationRequest[]; + OwnerId?: string; /** - *The number of IPv4 prefixes to be automatically assigned to the
- * network interface. You cannot use this option if you use the Ipv4Prefix option.
Any tags assigned to the internet gateway.
*/ - Ipv4PrefixCount?: number; + Tags?: Tag[]; +} +export namespace InternetGateway { /** - *One or more IPv6 prefixes to be assigned to the network interface. You cannot
- * use this option if you use the Ipv6PrefixCount option.
The number of IPv6 prefixes to be automatically assigned to the network
- * interface. You cannot use this option if you use the Ipv6Prefix option.
Information about the internet gateway.
*/ - Ipv6PrefixCount?: number; + InternetGateway?: InternetGateway; } -export namespace LaunchTemplateInstanceNetworkInterfaceSpecificationRequest { +export namespace CreateInternetGatewayResult { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateInstanceNetworkInterfaceSpecificationRequest): any => ({ + export const filterSensitiveLog = (obj: CreateInternetGatewayResult): any => ({ ...obj, }); } -/** - *Describes the placement of an instance.
- */ -export interface LaunchTemplatePlacementRequest { - /** - *The Availability Zone for the instance.
- */ - AvailabilityZone?: string; +export enum KeyType { + ed25519 = "ed25519", + rsa = "rsa", +} +export interface CreateKeyPairRequest { /** - *The affinity setting for an instance on a Dedicated Host.
+ *A unique name for the key pair.
+ *Constraints: Up to 255 ASCII characters
*/ - Affinity?: string; + KeyName: string | undefined; /** - *The name of the placement group for the instance.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the Dedicated Host for the instance.
+ *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 tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy - * of dedicated runs on single-tenant hardware.
+ *The tags to apply to the new key pair.
*/ - Tenancy?: Tenancy | string; + TagSpecifications?: TagSpecification[]; +} +export namespace CreateKeyPairRequest { /** - *Reserved for future use.
+ * @internal */ - SpreadDomain?: string; + export const filterSensitiveLog = (obj: CreateKeyPairRequest): any => ({ + ...obj, + }); +} +/** + *Describes a key pair.
+ */ +export interface KeyPair { /** - *The ARN of the host resource group in which to launch the instances. If you specify a host
- * resource group ARN, omit the Tenancy parameter
- * or set it to host.
The SHA-1 digest of the DER encoded private key.
*/ - HostResourceGroupArn?: string; + KeyFingerprint?: string; /** - *The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
An unencrypted PEM encoded RSA or ED25519 private key.
*/ - PartitionNumber?: number; -} + KeyMaterial?: string; -export namespace LaunchTemplatePlacementRequest { /** - * @internal + *The name of the key pair.
*/ - export const filterSensitiveLog = (obj: LaunchTemplatePlacementRequest): any => ({ - ...obj, - }); -} + KeyName?: string; -/** - *The tags specification for the launch template.
- */ -export interface LaunchTemplateTagSpecificationRequest { /** - *The type of resource to tag. Currently, the resource types that support tagging on
- * creation are instance and volume. To tag a resource after it
- * has been created, see CreateTags.
The ID of the key pair.
*/ - ResourceType?: ResourceType | string; + KeyPairId?: string; /** - *The tags to apply to the resource.
+ *Any tags applied to the key pair.
*/ Tags?: Tag[]; } -export namespace LaunchTemplateTagSpecificationRequest { +export namespace KeyPair { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateTagSpecificationRequest): any => ({ + export const filterSensitiveLog = (obj: KeyPair): any => ({ ...obj, + ...(obj.KeyMaterial && { KeyMaterial: SENSITIVE_STRING }), }); } /** - *The information to include in the launch template.
+ *The parameters for a block device for an EBS volume.
*/ -export interface RequestLaunchTemplateData { +export interface LaunchTemplateEbsBlockDeviceRequest { /** - *The ID of the kernel.
- *We recommend that you use PV-GRUB instead of kernels and RAM disks. For more - * information, see User Provided - * Kernels in the Amazon Elastic Compute Cloud User - * Guide.
- *Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. + * If you are creating a volume from a snapshot, you can't specify an encryption value.
*/ - KernelId?: string; + Encrypted?: boolean; /** - *Indicates whether the instance is optimized for Amazon EBS I/O. This optimization - * provides dedicated throughput to Amazon EBS and an optimized configuration stack to - * provide optimal Amazon EBS I/O performance. This optimization isn't available with all - * instance types. Additional usage charges apply when using an EBS-optimized - * instance.
+ *Indicates whether the EBS volume is deleted on instance termination.
*/ - EbsOptimized?: boolean; + DeleteOnTermination?: boolean; /** - *The name or Amazon Resource Name (ARN) of an IAM instance profile.
+ *The number of I/O operations per second (IOPS). For gp3, io1, and io2
+ * volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes,
+ * this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits
+ * for bursting.
The following are the supported values for each volume type:
+ *
+ * gp3: 3,000-16,000 IOPS
+ * io1: 100-64,000 IOPS
+ * io2: 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS
+ * only for Instances built on the Nitro System. Other instance families guarantee performance up
+ * to 32,000 IOPS.
This parameter is supported for io1, io2, and gp3 volumes only. This parameter is not supported for
+ * gp2, st1, sc1, or standard volumes.
The block device mapping.
+ *The ARN of the symmetric Key Management Service (KMS) CMK used for + * encryption.
*/ - BlockDeviceMappings?: LaunchTemplateBlockDeviceMappingRequest[]; + KmsKeyId?: string; /** - *One or more network interfaces. If you specify a network interface, you must specify - * any security groups and subnets as part of the network interface.
+ *The ID of the snapshot.
*/ - NetworkInterfaces?: LaunchTemplateInstanceNetworkInterfaceSpecificationRequest[]; + SnapshotId?: string; /** - *The ID of the AMI.
- */ - ImageId?: string; - - /** - *The instance type. For more information, see Instance Types in the - * Amazon Elastic Compute Cloud User Guide.
- */ - InstanceType?: _InstanceType | string; - - /** - *The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
- *If you do not specify a key pair, you can't connect to the instance unless you - * choose an AMI that is configured to allow users another way to log in.
- *The monitoring for the instance.
- */ - Monitoring?: LaunchTemplatesMonitoringRequest; - - /** - *The placement for the instance.
- */ - Placement?: LaunchTemplatePlacementRequest; - - /** - *The ID of the RAM disk.
- *We recommend that you use PV-GRUB instead of kernels and RAM disks. For more - * information, see User Provided - * Kernels in the Amazon Elastic Compute Cloud User - * Guide.
- *If you set this parameter to true, you can't terminate the instance using
- * the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch,
- * use ModifyInstanceAttribute.
- * Alternatively, if you set InstanceInitiatedShutdownBehavior to
- * terminate, you can terminate the instance by running the shutdown
- * command from the instance.
Indicates whether an instance stops or terminates when you initiate shutdown from - * the instance (using the operating system command for system shutdown).
- *Default: stop
- *
The user data to make available to the instance. You must provide base64-encoded text. - * User data is limited to 16 KB. For more information, see Running Commands on Your Linux Instance - * at Launch (Linux) or Adding User Data (Windows).
- * - *If you are creating the launch template for use with Batch, the user data - * must be provided in the - * MIME multi-part archive format. For more information, see Amazon EC2 user data in - * launch templates in the Batch User Guide.
- */ - UserData?: string; - - /** - *The tags to apply to the resources during launch. You can only tag instances and - * volumes on launch. The specified tags are applied to all instances or volumes that are - * created during launch. To tag a resource after it has been created, see CreateTags.
- */ - TagSpecifications?: LaunchTemplateTagSpecificationRequest[]; - - /** - *An elastic GPU to associate with the instance.
- */ - ElasticGpuSpecifications?: ElasticGpuSpecification[]; - - /** - *- * The elastic inference accelerator for the instance. - *
- */ - ElasticInferenceAccelerators?: LaunchTemplateElasticInferenceAccelerator[]; - - /** - *One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and - * security name in the same request.
- */ - SecurityGroupIds?: string[]; - - /** - *[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, - * you must use security group IDs instead. You cannot specify both a security group ID and - * security name in the same request.
- */ - SecurityGroups?: string[]; - - /** - *The market (purchasing) option for the instances.
+ *The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following + * are the supported volumes sizes for each volume type:
+ *
+ * gp2 and gp3: 1-16,384
+ * io1 and io2: 4-16,384
+ * st1 and sc1: 125-16,384
+ * standard: 1-1,024
The credit option for CPU usage of the instance. Valid for T2, T3, or T3a instances - * only.
+ *The volume type. For more information, see Amazon EBS volume types in the + * Amazon Elastic Compute Cloud User Guide.
*/ - CreditSpecification?: CreditSpecificationRequest; + VolumeType?: VolumeType | string; /** - *The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User - * Guide.
+ *The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
*/ - CpuOptions?: LaunchTemplateCpuOptionsRequest; + Throughput?: number; +} +export namespace LaunchTemplateEbsBlockDeviceRequest { /** - *The Capacity Reservation targeting option. If you do not specify this parameter, the
- * instance's Capacity Reservation preference defaults to open, which enables it
- * to run in any open Capacity Reservation that has matching attributes (instance type,
- * platform, Availability Zone).
Describes a block device mapping.
+ */ +export interface LaunchTemplateBlockDeviceMappingRequest { /** - *The license configurations.
+ *The device name (for example, /dev/sdh or xvdh).
*/ - LicenseSpecifications?: LaunchTemplateLicenseConfigurationRequest[]; + DeviceName?: string; /** - *Indicates whether an instance is enabled for hibernation. This parameter is valid only - * if the instance meets the hibernation - * prerequisites. For - * more information, see Hibernate your instance in the - * Amazon Elastic Compute Cloud User Guide.
+ *The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. + * An instance type with 2 available instance store volumes can specify mappings for ephemeral0 + * and ephemeral1. The number of available instance store volumes depends on the instance type. + * After you connect to the instance, you must mount the volume.
*/ - HibernationOptions?: LaunchTemplateHibernationOptionsRequest; + VirtualName?: string; /** - *The metadata options for the instance. For more information, see Instance metadata and user data in the - * Amazon Elastic Compute Cloud User Guide.
+ *Parameters used to automatically set up EBS volumes when the instance is launched.
*/ - MetadataOptions?: LaunchTemplateInstanceMetadataOptionsRequest; + Ebs?: LaunchTemplateEbsBlockDeviceRequest; /** - *Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, - * see - * What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
- *You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
+ *To omit the device from the block device mapping, specify an empty string.
*/ - EnclaveOptions?: LaunchTemplateEnclaveOptionsRequest; + NoDevice?: string; } -export namespace RequestLaunchTemplateData { +export namespace LaunchTemplateBlockDeviceMappingRequest { /** * @internal */ - export const filterSensitiveLog = (obj: RequestLaunchTemplateData): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateBlockDeviceMappingRequest): any => ({ ...obj, }); } -export interface CreateLaunchTemplateRequest { - /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
Describes a target Capacity Reservation or Capacity Reservation group.
+ */ +export interface CapacityReservationTarget { /** - *Unique, case-sensitive identifier you provide to ensure the idempotency of the - * request. For more information, see Ensuring - * Idempotency.
- *Constraint: Maximum 128 ASCII characters.
+ *The ID of the Capacity Reservation in which to run the instance.
*/ - ClientToken?: string; + CapacityReservationId?: string; /** - *A name for the launch template.
+ *The ARN of the Capacity Reservation resource group in which to run the instance.
*/ - LaunchTemplateName: string | undefined; + CapacityReservationResourceGroupArn?: string; +} +export namespace CapacityReservationTarget { /** - *A description for the first version of the launch template.
+ * @internal */ - VersionDescription?: string; + export const filterSensitiveLog = (obj: CapacityReservationTarget): any => ({ + ...obj, + }); +} +/** + *Describes an instance's Capacity Reservation targeting option. You can specify only one option at a time. Use the
+ * CapacityReservationPreference parameter to configure the instance to run in On-Demand capacity or
+ * to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
+ * Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or
+ * a Capacity Reservation group.
The information for the launch template.
+ *Indicates the instance's Capacity Reservation preferences. Possible preferences include:
+ *
+ * open - The instance can run in any open Capacity Reservation that has matching attributes
+ * (instance type, platform, Availability Zone).
+ * none - The instance avoids running in a Capacity Reservation even if one is available. The instance
+ * runs in On-Demand capacity.
The tags to apply to the launch template during creation.
+ *Information about the target Capacity Reservation or Capacity Reservation group.
*/ - TagSpecifications?: TagSpecification[]; + CapacityReservationTarget?: CapacityReservationTarget; } -export namespace CreateLaunchTemplateRequest { +export namespace LaunchTemplateCapacityReservationSpecificationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateLaunchTemplateRequest): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateCapacityReservationSpecificationRequest): any => ({ ...obj, }); } /** - *Describes a launch template.
+ *The CPU options for the instance. Both the core count and threads per core + * must be specified in the request.
*/ -export interface LaunchTemplate { - /** - *The ID of the launch template.
- */ - LaunchTemplateId?: string; - +export interface LaunchTemplateCpuOptionsRequest { /** - *The name of the launch template.
+ *The number of CPU cores for the instance.
*/ - LaunchTemplateName?: string; + CoreCount?: number; /** - *The time launch template was created.
+ *The number of threads per CPU core. To disable multithreading + * for the instance, specify a value of 1. Otherwise, specify the default value of 2.
*/ - CreateTime?: Date; + ThreadsPerCore?: number; +} +export namespace LaunchTemplateCpuOptionsRequest { /** - *The principal that created the launch template.
+ * @internal */ - CreatedBy?: string; + export const filterSensitiveLog = (obj: LaunchTemplateCpuOptionsRequest): any => ({ + ...obj, + }); +} +/** + *The credit option for CPU usage of a T2, T3, or T3a instance.
+ */ +export interface CreditSpecificationRequest { /** - *The version number of the default version of the launch template.
+ *The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are
+ * standard and unlimited.
The version number of the latest version of the launch template.
+ * @internal */ - LatestVersionNumber?: number; + export const filterSensitiveLog = (obj: CreditSpecificationRequest): any => ({ + ...obj, + }); +} +/** + *A specification for an Elastic Graphics accelerator.
+ */ +export interface ElasticGpuSpecification { /** - *The tags for the launch template.
+ *The type of Elastic Graphics accelerator. For more information about the values to specify for
+ * Type, see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the
+ * Amazon Elastic Compute Cloud User Guide for Windows Instances.
The error code and error message that is returned for a parameter or parameter combination that is not valid when a new launch template or new version of a launch template is created.
+ *+ * Describes an elastic inference accelerator. + *
*/ -export interface ValidationError { +export interface LaunchTemplateElasticInferenceAccelerator { /** - *The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error Codes.
+ *+ * The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. + *
*/ - Code?: string; + Type: string | undefined; /** - *The error message that describes why the parameter or parameter combination is not valid. For more - * information about error messages, see Error Codes.
+ *+ * The number of elastic inference accelerators to attach to the instance. + *
+ *Default: 1
*/ - Message?: string; + Count?: number; } -export namespace ValidationError { +export namespace LaunchTemplateElasticInferenceAccelerator { /** * @internal */ - export const filterSensitiveLog = (obj: ValidationError): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateElasticInferenceAccelerator): any => ({ ...obj, }); } /** - *The error codes and error messages that are returned for the parameters or parameter combinations that are not valid when a new launch template or new version of a launch template is created.
+ *Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, + * see + * What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
*/ -export interface ValidationWarning { +export interface LaunchTemplateEnclaveOptionsRequest { /** - *The error codes and error messages.
+ *To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true.
Information about the launch template.
- */ - LaunchTemplate?: LaunchTemplate; - +/** + *Indicates whether the instance is configured for hibernation. This parameter is valid only + * if the instance meets the hibernation + * prerequisites.
+ */ +export interface LaunchTemplateHibernationOptionsRequest { /** - *If the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.
+ *If you set this parameter to true, the instance is enabled for hibernation.
Default: false
+ *
Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
Unique, case-sensitive identifier you provide to ensure the idempotency of the - * request. For more information, see Ensuring - * Idempotency.
- *Constraint: Maximum 128 ASCII characters.
- */ - ClientToken?: string; - - /** - *The ID of the launch template. You must specify either the launch template ID or - * launch template name in the request.
- */ - LaunchTemplateId?: string; - - /** - *The name of the launch template. You must specify either the launch template ID or - * launch template name in the request.
- */ - LaunchTemplateName?: string; - - /** - *The version number of the launch template version on which to base the new version.
- * The new version inherits the same launch parameters as the source version, except for
- * parameters that you specify in LaunchTemplateData. Snapshots applied
- * to the block device mapping are ignored when creating a new version unless they
- * are explicitly included.
An IAM instance profile.
+ */ +export interface LaunchTemplateIamInstanceProfileSpecificationRequest { /** - *A description for the version of the launch template.
+ *The Amazon Resource Name (ARN) of the instance profile.
*/ - VersionDescription?: string; + Arn?: string; /** - *The information for the launch template.
+ *The name of the instance profile.
*/ - LaunchTemplateData: RequestLaunchTemplateData | undefined; + Name?: string; } -export namespace CreateLaunchTemplateVersionRequest { +export namespace LaunchTemplateIamInstanceProfileSpecificationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateLaunchTemplateVersionRequest): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateIamInstanceProfileSpecificationRequest): any => ({ ...obj, }); } -/** - *Describes a block device for an EBS volume.
- */ -export interface LaunchTemplateEbsBlockDevice { - /** - *Indicates whether the EBS volume is encrypted.
- */ - Encrypted?: boolean; +export type ShutdownBehavior = "stop" | "terminate"; - /** - *Indicates whether the EBS volume is deleted on instance termination.
- */ - DeleteOnTermination?: boolean; +export type MarketType = "spot"; - /** - *The number of I/O operations per second (IOPS) that the volume supports.
- */ - Iops?: number; +export type InstanceInterruptionBehavior = "hibernate" | "stop" | "terminate"; +export type SpotInstanceType = "one-time" | "persistent"; + +/** + *The options for Spot Instances.
+ */ +export interface LaunchTemplateSpotMarketOptionsRequest { /** - *The ARN of the Key Management Service (KMS) CMK used for encryption.
+ *The maximum hourly price you're willing to pay for the Spot Instances.
*/ - KmsKeyId?: string; + MaxPrice?: string; /** - *The ID of the snapshot.
+ *The Spot Instance request type.
*/ - SnapshotId?: string; + SpotInstanceType?: SpotInstanceType | string; /** - *The size of the volume, in GiB.
+ *The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
*/ - VolumeSize?: number; + BlockDurationMinutes?: number; /** - *The volume type.
+ *The end date of the request. + * For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. + * If the request is persistent, it remains active until it is canceled or this date and time is reached. + * The default end date is 7 days from the current date.
*/ - VolumeType?: VolumeType | string; + ValidUntil?: Date; /** - *The throughput that the volume supports, in MiB/s.
+ *The behavior when a Spot Instance is interrupted. The default is terminate.
Describes a block device mapping.
+ *The market (purchasing) option for the instances.
*/ -export interface LaunchTemplateBlockDeviceMapping { +export interface LaunchTemplateInstanceMarketOptionsRequest { /** - *The device name.
+ *The market type.
*/ - DeviceName?: string; + MarketType?: MarketType | string; /** - *The virtual device name (ephemeralN).
+ *The options for Spot Instances.
*/ - VirtualName?: string; + SpotOptions?: LaunchTemplateSpotMarketOptionsRequest; +} +export namespace LaunchTemplateInstanceMarketOptionsRequest { /** - *Information about the block device for an EBS volume.
+ * @internal */ - Ebs?: LaunchTemplateEbsBlockDevice; + export const filterSensitiveLog = (obj: LaunchTemplateInstanceMarketOptionsRequest): any => ({ + ...obj, + }); +} +/** + *Describes a license configuration.
+ */ +export interface LaunchTemplateLicenseConfigurationRequest { /** - *To omit the device from the block device mapping, specify an empty string.
+ *The Amazon Resource Name (ARN) of the license configuration.
*/ - NoDevice?: string; + LicenseConfigurationArn?: string; } -export namespace LaunchTemplateBlockDeviceMapping { +export namespace LaunchTemplateLicenseConfigurationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateBlockDeviceMapping): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateLicenseConfigurationRequest): any => ({ ...obj, }); } +export type LaunchTemplateInstanceMetadataEndpointState = "disabled" | "enabled"; + +export enum LaunchTemplateInstanceMetadataProtocolIpv6 { + disabled = "disabled", + enabled = "enabled", +} + +export enum LaunchTemplateHttpTokensState { + optional = "optional", + required = "required", +} + /** - *Describes a target Capacity Reservation or Capacity Reservation group.
+ *The metadata options for the instance. For more information, see Instance Metadata and User Data in the + * Amazon Elastic Compute Cloud User Guide.
*/ -export interface CapacityReservationTargetResponse { +export interface LaunchTemplateInstanceMetadataOptionsRequest { /** - *The ID of the targeted Capacity Reservation.
+ *The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
The ARN of the targeted Capacity Reservation group.
+ *The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
+ *Default: 1
+ *Possible values: Integers from 1 to 64
*/ - CapacityReservationResourceGroupArn?: string; + HttpPutResponseHopLimit?: number; + + /** + *This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.
+ *
Enables or disables the IPv6 endpoint for the instance metadata service.
+ *Default: disabled
+ *
Information about the Capacity Reservation targeting option.
+ *Describes the monitoring for the instance.
*/ -export interface LaunchTemplateCapacityReservationSpecificationResponse { - /** - *Indicates the instance's Capacity Reservation preferences. Possible preferences include:
- *
- * open - The instance can run in any open Capacity Reservation that has matching attributes
- * (instance type, platform, Availability Zone).
- * none - The instance avoids running in a Capacity Reservation even if one is available. The instance
- * runs in On-Demand capacity.
Information about the target Capacity Reservation or Capacity Reservation group.
+ *Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.
The CPU options for the instance.
+ *Describes the IPv4 prefix option for a network interface.
*/ -export interface LaunchTemplateCpuOptions { - /** - *The number of CPU cores for the instance.
- */ - CoreCount?: number; - +export interface Ipv4PrefixSpecificationRequest { /** - *The number of threads per CPU core.
+ *The IPv4 prefix. For information, see + * Assigning prefixes to Amazon EC2 network interfaces in the + * Amazon Elastic Compute Cloud User Guide.
*/ - ThreadsPerCore?: number; + Ipv4Prefix?: string; } -export namespace LaunchTemplateCpuOptions { +export namespace Ipv4PrefixSpecificationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateCpuOptions): any => ({ + export const filterSensitiveLog = (obj: Ipv4PrefixSpecificationRequest): any => ({ ...obj, }); } /** - *Describes the credit option for CPU usage of a T2, T3, or T3a instance.
+ *Describes an IPv6 address.
*/ -export interface CreditSpecification { +export interface InstanceIpv6AddressRequest { /** - *The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are
- * standard and unlimited.
The IPv6 address.
*/ - CpuCredits?: string; + Ipv6Address?: string; } -export namespace CreditSpecification { +export namespace InstanceIpv6AddressRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreditSpecification): any => ({ + export const filterSensitiveLog = (obj: InstanceIpv6AddressRequest): any => ({ ...obj, }); } /** - *Describes an elastic GPU.
+ *Describes the IPv4 prefix option for a network interface.
*/ -export interface ElasticGpuSpecificationResponse { +export interface Ipv6PrefixSpecificationRequest { /** - *The elastic GPU type.
+ *The IPv6 prefix.
*/ - Type?: string; + Ipv6Prefix?: string; } -export namespace ElasticGpuSpecificationResponse { +export namespace Ipv6PrefixSpecificationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ElasticGpuSpecificationResponse): any => ({ + export const filterSensitiveLog = (obj: Ipv6PrefixSpecificationRequest): any => ({ ...obj, }); } /** - *- * Describes an elastic inference accelerator. - *
+ *Describes a secondary private IPv4 address for a network interface.
*/ -export interface LaunchTemplateElasticInferenceAcceleratorResponse { +export interface PrivateIpAddressSpecification { /** - *- * The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. - *
+ *Indicates whether the private IPv4 address is the primary private IPv4 address. Only + * one IPv4 address can be designated as primary.
*/ - Type?: string; + Primary?: boolean; /** - *- * The number of elastic inference accelerators to attach to the instance. - *
- *Default: 1
+ *The private IPv4 addresses.
*/ - Count?: number; + PrivateIpAddress?: string; } -export namespace LaunchTemplateElasticInferenceAcceleratorResponse { +export namespace PrivateIpAddressSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateElasticInferenceAcceleratorResponse): any => ({ + export const filterSensitiveLog = (obj: PrivateIpAddressSpecification): any => ({ ...obj, }); } /** - *Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
+ *The parameters for a network interface.
*/ -export interface LaunchTemplateEnclaveOptions { +export interface LaunchTemplateInstanceNetworkInterfaceSpecificationRequest { /** - *If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves;
- * otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.
Associates a Carrier IP address with eth0 for a new network interface.
+ *Use this option when you launch an instance in a Wavelength Zone and want to associate + * a Carrier IP address with the network interface. For more information about Carrier IP + * addresses, see Carrier IP addresses in the Wavelength Developer + * Guide.
*/ - Enabled?: boolean; -} + AssociateCarrierIpAddress?: boolean; -export namespace LaunchTemplateEnclaveOptions { /** - * @internal + *Associates a public IPv4 address with eth0 for a new network interface.
*/ - export const filterSensitiveLog = (obj: LaunchTemplateEnclaveOptions): any => ({ - ...obj, - }); -} + AssociatePublicIpAddress?: boolean; -/** - *Indicates whether an instance is configured for hibernation.
- */ -export interface LaunchTemplateHibernationOptions { /** - *If this parameter is set to true, the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.
Indicates whether the network interface is deleted when the instance is terminated.
*/ - Configured?: boolean; -} + DeleteOnTermination?: boolean; -export namespace LaunchTemplateHibernationOptions { /** - * @internal + *A description for the network interface.
*/ - export const filterSensitiveLog = (obj: LaunchTemplateHibernationOptions): any => ({ - ...obj, - }); -} + Description?: string; -/** - *Describes an IAM instance profile.
- */ -export interface LaunchTemplateIamInstanceProfileSpecification { /** - *The Amazon Resource Name (ARN) of the instance profile.
+ *The device index for the network interface attachment.
*/ - Arn?: string; + DeviceIndex?: number; /** - *The name of the instance profile.
+ *The IDs of one or more security groups.
*/ - Name?: string; + Groups?: string[]; + + /** + *The type of network interface. To create an Elastic Fabric Adapter (EFA), specify
+ * efa. For more information, see Elastic Fabric Adapter in the
+ * Amazon Elastic Compute Cloud User Guide.
If you are not creating an EFA, specify interface or omit this parameter.
Valid values: interface | efa
+ *
The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
+ */ + Ipv6AddressCount?: number; + + /** + *One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
+ */ + Ipv6Addresses?: InstanceIpv6AddressRequest[]; + + /** + *The ID of the network interface.
+ */ + NetworkInterfaceId?: string; + + /** + *The primary private IPv4 address of the network interface.
+ */ + PrivateIpAddress?: string; + + /** + *One or more private IPv4 addresses.
+ */ + PrivateIpAddresses?: PrivateIpAddressSpecification[]; + + /** + *The number of secondary private IPv4 addresses to assign to a network interface.
+ */ + SecondaryPrivateIpAddressCount?: number; + + /** + *The ID of the subnet for the network interface.
+ */ + SubnetId?: string; + + /** + *The index of the network card. Some instance types support multiple network cards. + * The primary network interface must be assigned to network card index 0. + * The default is network card index 0.
+ */ + NetworkCardIndex?: number; + + /** + *One or more IPv4 prefixes to be assigned to the network interface. You cannot use
+ * this option if you use the Ipv4PrefixCount option.
The number of IPv4 prefixes to be automatically assigned to the
+ * network interface. You cannot use this option if you use the Ipv4Prefix option.
One or more IPv6 prefixes to be assigned to the network interface. You cannot
+ * use this option if you use the Ipv6PrefixCount option.
The number of IPv6 prefixes to be automatically assigned to the network
+ * interface. You cannot use this option if you use the Ipv6Prefix option.
The options for Spot Instances.
+ *Describes the placement of an instance.
*/ -export interface LaunchTemplateSpotMarketOptions { +export interface LaunchTemplatePlacementRequest { /** - *The maximum hourly price you're willing to pay for the Spot Instances.
+ *The Availability Zone for the instance.
*/ - MaxPrice?: string; + AvailabilityZone?: string; /** - *The Spot Instance request type.
+ *The affinity setting for an instance on a Dedicated Host.
*/ - SpotInstanceType?: SpotInstanceType | string; + Affinity?: string; /** - *The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
+ *The name of the placement group for the instance.
*/ - BlockDurationMinutes?: number; + GroupName?: string; /** - *The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
+ *The ID of the Dedicated Host for the instance.
*/ - ValidUntil?: Date; + HostId?: string; /** - *The behavior when a Spot Instance is interrupted.
+ *The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy + * of dedicated runs on single-tenant hardware.
*/ - InstanceInterruptionBehavior?: InstanceInterruptionBehavior | string; + Tenancy?: Tenancy | string; + + /** + *Reserved for future use.
+ */ + SpreadDomain?: string; + + /** + *The ARN of the host resource group in which to launch the instances. If you specify a host
+ * resource group ARN, omit the Tenancy parameter
+ * or set it to host.
The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
The market (purchasing) option for the instances.
+ *The tags specification for the launch template.
*/ -export interface LaunchTemplateInstanceMarketOptions { +export interface LaunchTemplateTagSpecificationRequest { /** - *The market type.
+ *The type of resource to tag. Currently, the resource types that support tagging on
+ * creation are instance and volume. To tag a resource after it
+ * has been created, see CreateTags.
The options for Spot Instances.
+ *The tags to apply to the resource.
*/ - SpotOptions?: LaunchTemplateSpotMarketOptions; + Tags?: Tag[]; } -export namespace LaunchTemplateInstanceMarketOptions { +export namespace LaunchTemplateTagSpecificationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateInstanceMarketOptions): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateTagSpecificationRequest): any => ({ ...obj, }); } /** - *Describes a license configuration.
+ *The information to include in the launch template.
*/ -export interface LaunchTemplateLicenseConfiguration { +export interface RequestLaunchTemplateData { /** - *The Amazon Resource Name (ARN) of the license configuration.
+ *The ID of the kernel.
+ *We recommend that you use PV-GRUB instead of kernels and RAM disks. For more + * information, see User Provided + * Kernels in the Amazon Elastic Compute Cloud User + * Guide.
+ *Indicates whether the instance is optimized for Amazon EBS I/O. This optimization + * provides dedicated throughput to Amazon EBS and an optimized configuration stack to + * provide optimal Amazon EBS I/O performance. This optimization isn't available with all + * instance types. Additional usage charges apply when using an EBS-optimized + * instance.
*/ - export const filterSensitiveLog = (obj: LaunchTemplateLicenseConfiguration): any => ({ - ...obj, - }); -} - -export type LaunchTemplateInstanceMetadataOptionsState = "applied" | "pending"; + EbsOptimized?: boolean; -/** - *The metadata options for the instance. For more information, see Instance Metadata and User Data in the - * Amazon Elastic Compute Cloud User Guide.
- */ -export interface LaunchTemplateInstanceMetadataOptions { /** - *The state of the metadata option changes.
- *
- * pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
- * applied - The metadata options have been successfully applied on the instance.
The name or Amazon Resource Name (ARN) of an IAM instance profile.
*/ - State?: LaunchTemplateInstanceMetadataOptionsState | string; + IamInstanceProfile?: LaunchTemplateIamInstanceProfileSpecificationRequest; /** - *The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
The block device mapping.
*/ - HttpTokens?: LaunchTemplateHttpTokensState | string; + BlockDeviceMappings?: LaunchTemplateBlockDeviceMappingRequest[]; /** - *The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
- *Default: 1
- *Possible values: Integers from 1 to 64
+ *One or more network interfaces. If you specify a network interface, you must specify + * any security groups and subnets as part of the network interface.
*/ - HttpPutResponseHopLimit?: number; + NetworkInterfaces?: LaunchTemplateInstanceNetworkInterfaceSpecificationRequest[]; /** - *This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.
- *
The ID of the AMI.
*/ - HttpEndpoint?: LaunchTemplateInstanceMetadataEndpointState | string; + ImageId?: string; /** - *Enables or disables the IPv6 endpoint for the instance metadata service.
- *Default: disabled
- *
The instance type. For more information, see Instance Types in the + * Amazon Elastic Compute Cloud User Guide.
+ *If you specify InstanceTypes, you can't specify
+ * InstanceRequirements.
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
+ *If you do not specify a key pair, you can't connect to the instance unless you + * choose an AMI that is configured to allow users another way to log in.
+ *Describes the monitoring for the instance.
- */ -export interface LaunchTemplatesMonitoring { /** - *Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is - * enabled.
+ *The monitoring for the instance.
*/ - Enabled?: boolean; -} + Monitoring?: LaunchTemplatesMonitoringRequest; -export namespace LaunchTemplatesMonitoring { /** - * @internal + *The placement for the instance.
*/ - export const filterSensitiveLog = (obj: LaunchTemplatesMonitoring): any => ({ - ...obj, - }); -} + Placement?: LaunchTemplatePlacementRequest; -/** - *Information about the IPv4 delegated prefixes assigned - * to a network interface.
- */ -export interface Ipv4PrefixSpecificationResponse { /** - *One or more IPv4 delegated prefixes assigned to the network interface.
+ *The ID of the RAM disk.
+ *We recommend that you use PV-GRUB instead of kernels and RAM disks. For more + * information, see User Provided + * Kernels in the Amazon Elastic Compute Cloud User + * Guide.
+ *If you set this parameter to true, you can't terminate the instance using
+ * the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch,
+ * use ModifyInstanceAttribute.
+ * Alternatively, if you set InstanceInitiatedShutdownBehavior to
+ * terminate, you can terminate the instance by running the shutdown
+ * command from the instance.
Describes an IPv6 address.
- */ -export interface InstanceIpv6Address { /** - *The IPv6 address.
+ *Indicates whether an instance stops or terminates when you initiate shutdown from + * the instance (using the operating system command for system shutdown).
+ *Default: stop
+ *
The user data to make available to the instance. You must provide base64-encoded text. + * User data is limited to 16 KB. For more information, see Running Commands on Your Linux Instance + * at Launch (Linux) or Adding User Data (Windows).
+ * + *If you are creating the launch template for use with Batch, the user data + * must be provided in the + * MIME multi-part archive format. For more information, see Amazon EC2 user data in + * launch templates in the Batch User Guide.
*/ - export const filterSensitiveLog = (obj: InstanceIpv6Address): any => ({ - ...obj, - }); -} + UserData?: string; -/** - *Information about the IPv6 delegated prefixes assigned - * to a network interface.
- */ -export interface Ipv6PrefixSpecificationResponse { /** - *One or more IPv6 delegated prefixes assigned to the network interface.
+ *The tags to apply to the resources during launch. You can only tag instances and + * volumes on launch. The specified tags are applied to all instances or volumes that are + * created during launch. To tag a resource after it has been created, see CreateTags.
*/ - Ipv6Prefix?: string; -} + TagSpecifications?: LaunchTemplateTagSpecificationRequest[]; -export namespace Ipv6PrefixSpecificationResponse { /** - * @internal + *An elastic GPU to associate with the instance.
*/ - export const filterSensitiveLog = (obj: Ipv6PrefixSpecificationResponse): any => ({ - ...obj, - }); -} + ElasticGpuSpecifications?: ElasticGpuSpecification[]; -/** - *Describes a network interface.
- */ -export interface LaunchTemplateInstanceNetworkInterfaceSpecification { /** - *Indicates whether to associate a Carrier IP address with eth0 for a new network interface.
- *Use this option when you launch an instance in a Wavelength Zone and want to associate - * a Carrier IP address with the network interface. For more information about Carrier IP - * addresses, see Carrier IP addresses in the Wavelength Developer - * Guide.
+ *+ * The elastic inference accelerator for the instance. + *
*/ - AssociateCarrierIpAddress?: boolean; + ElasticInferenceAccelerators?: LaunchTemplateElasticInferenceAccelerator[]; /** - *Indicates whether to associate a public IPv4 address with eth0 for a new network interface.
+ *One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and + * security name in the same request.
*/ - AssociatePublicIpAddress?: boolean; + SecurityGroupIds?: string[]; /** - *Indicates whether the network interface is deleted when the instance is terminated.
+ *[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, + * you must use security group IDs instead. You cannot specify both a security group ID and + * security name in the same request.
*/ - DeleteOnTermination?: boolean; + SecurityGroups?: string[]; /** - *A description for the network interface.
+ *The market (purchasing) option for the instances.
*/ - Description?: string; + InstanceMarketOptions?: LaunchTemplateInstanceMarketOptionsRequest; /** - *The device index for the network interface attachment.
+ *The credit option for CPU usage of the instance. Valid for T2, T3, or T3a instances + * only.
*/ - DeviceIndex?: number; + CreditSpecification?: CreditSpecificationRequest; /** - *The IDs of one or more security groups.
+ *The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User + * Guide.
*/ - Groups?: string[]; + CpuOptions?: LaunchTemplateCpuOptionsRequest; /** - *The type of network interface.
+ *The Capacity Reservation targeting option. If you do not specify this parameter, the
+ * instance's Capacity Reservation preference defaults to open, which enables it
+ * to run in any open Capacity Reservation that has matching attributes (instance type,
+ * platform, Availability Zone).
The number of IPv6 addresses for the network interface.
+ *The license configurations.
*/ - Ipv6AddressCount?: number; + LicenseSpecifications?: LaunchTemplateLicenseConfigurationRequest[]; /** - *The IPv6 addresses for the network interface.
+ *Indicates whether an instance is enabled for hibernation. This parameter is valid only + * if the instance meets the hibernation + * prerequisites. For + * more information, see Hibernate your instance in the + * Amazon Elastic Compute Cloud User Guide.
*/ - Ipv6Addresses?: InstanceIpv6Address[]; + HibernationOptions?: LaunchTemplateHibernationOptionsRequest; /** - *The ID of the network interface.
+ *The metadata options for the instance. For more information, see Instance metadata and user data in the + * Amazon Elastic Compute Cloud User Guide.
*/ - NetworkInterfaceId?: string; + MetadataOptions?: LaunchTemplateInstanceMetadataOptionsRequest; /** - *The primary private IPv4 address of the network interface.
+ *Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, + * see + * What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
+ *You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
*/ - PrivateIpAddress?: string; + EnclaveOptions?: LaunchTemplateEnclaveOptionsRequest; /** - *One or more private IPv4 addresses.
+ *The attributes for the instance types. When you specify instance attributes, Amazon EC2 will + * identify instance types with these attributes.
+ *If you specify InstanceRequirements, you can't specify
+ * InstanceTypes.
The number of secondary private IPv4 addresses for the network interface.
+ * @internal */ - SecondaryPrivateIpAddressCount?: number; + export const filterSensitiveLog = (obj: RequestLaunchTemplateData): any => ({ + ...obj, + }); +} +export interface CreateLaunchTemplateRequest { /** - *The ID of the subnet for the network interface.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The index of the network card.
+ *Unique, case-sensitive identifier you provide to ensure the idempotency of the + * request. For more information, see Ensuring + * Idempotency.
+ *Constraint: Maximum 128 ASCII characters.
*/ - NetworkCardIndex?: number; + ClientToken?: string; /** - *One or more IPv4 prefixes assigned to the network interface.
+ *A name for the launch template.
*/ - Ipv4Prefixes?: Ipv4PrefixSpecificationResponse[]; + LaunchTemplateName: string | undefined; /** - *The number of IPv4 prefixes that Amazon Web Services automatically assigned to the - * network interface.
+ *A description for the first version of the launch template.
*/ - Ipv4PrefixCount?: number; + VersionDescription?: string; /** - *One or more IPv6 prefixes assigned to the network interface.
+ *The information for the launch template.
*/ - Ipv6Prefixes?: Ipv6PrefixSpecificationResponse[]; + LaunchTemplateData: RequestLaunchTemplateData | undefined; /** - *The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network - * interface.
+ *The tags to apply to the launch template during creation.
*/ - Ipv6PrefixCount?: number; + TagSpecifications?: TagSpecification[]; } -export namespace LaunchTemplateInstanceNetworkInterfaceSpecification { +export namespace CreateLaunchTemplateRequest { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateInstanceNetworkInterfaceSpecification): any => ({ + export const filterSensitiveLog = (obj: CreateLaunchTemplateRequest): any => ({ ...obj, }); } /** - *Describes the placement of an instance.
+ *Describes a launch template.
*/ -export interface LaunchTemplatePlacement { - /** - *The Availability Zone of the instance.
- */ - AvailabilityZone?: string; - +export interface LaunchTemplate { /** - *The affinity setting for the instance on the Dedicated Host.
+ *The ID of the launch template.
*/ - Affinity?: string; + LaunchTemplateId?: string; /** - *The name of the placement group for the instance.
+ *The name of the launch template.
*/ - GroupName?: string; + LaunchTemplateName?: string; /** - *The ID of the Dedicated Host for the instance.
+ *The time launch template was created.
*/ - HostId?: string; + CreateTime?: Date; /** - *The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
The principal that created the launch template.
*/ - Tenancy?: Tenancy | string; + CreatedBy?: string; /** - *Reserved for future use.
+ *The version number of the default version of the launch template.
*/ - SpreadDomain?: string; + DefaultVersionNumber?: number; /** - *The ARN of the host resource group in which to launch the instances. - *
+ *The version number of the latest version of the launch template.
*/ - HostResourceGroupArn?: string; + LatestVersionNumber?: number; /** - *The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
The tags for the launch template.
*/ - PartitionNumber?: number; + Tags?: Tag[]; } -export namespace LaunchTemplatePlacement { +export namespace LaunchTemplate { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplatePlacement): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplate): any => ({ ...obj, }); } /** - *The tag specification for the launch template.
+ *The error code and error message that is returned for a parameter or parameter combination that is not valid when a new launch template or new version of a launch template is created.
*/ -export interface LaunchTemplateTagSpecification { +export interface ValidationError { /** - *The type of resource.
+ *The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error Codes.
*/ - ResourceType?: ResourceType | string; + Code?: string; /** - *The tags for the resource.
+ *The error message that describes why the parameter or parameter combination is not valid. For more + * information about error messages, see Error Codes.
*/ - Tags?: Tag[]; + Message?: string; } -export namespace LaunchTemplateTagSpecification { +export namespace ValidationError { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateTagSpecification): any => ({ + export const filterSensitiveLog = (obj: ValidationError): any => ({ ...obj, }); } /** - *The information for a launch template.
+ *The error codes and error messages that are returned for the parameters or parameter combinations that are not valid when a new launch template or new version of a launch template is created.
*/ -export interface ResponseLaunchTemplateData { - /** - *The ID of the kernel, if applicable.
- */ - KernelId?: string; - - /** - *Indicates whether the instance is optimized for Amazon EBS I/O.
- */ - EbsOptimized?: boolean; - - /** - *The IAM instance profile.
- */ - IamInstanceProfile?: LaunchTemplateIamInstanceProfileSpecification; - - /** - *The block device mappings.
- */ - BlockDeviceMappings?: LaunchTemplateBlockDeviceMapping[]; - - /** - *The network interfaces.
- */ - NetworkInterfaces?: LaunchTemplateInstanceNetworkInterfaceSpecification[]; - - /** - *The ID of the AMI that was used to launch the instance.
- */ - ImageId?: string; - +export interface ValidationWarning { /** - *The instance type.
+ *The error codes and error messages.
*/ - InstanceType?: _InstanceType | string; + Errors?: ValidationError[]; +} +export namespace ValidationWarning { /** - *The name of the key pair.
+ * @internal */ - KeyName?: string; + export const filterSensitiveLog = (obj: ValidationWarning): any => ({ + ...obj, + }); +} +export interface CreateLaunchTemplateResult { /** - *The monitoring for the instance.
+ *Information about the launch template.
*/ - Monitoring?: LaunchTemplatesMonitoring; + LaunchTemplate?: LaunchTemplate; /** - *The placement of the instance.
+ *If the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.
*/ - Placement?: LaunchTemplatePlacement; + Warning?: ValidationWarning; +} +export namespace CreateLaunchTemplateResult { /** - *The ID of the RAM disk, if applicable.
+ * @internal */ - RamDiskId?: string; + export const filterSensitiveLog = (obj: CreateLaunchTemplateResult): any => ({ + ...obj, + }); +} +export interface CreateLaunchTemplateVersionRequest { /** - *If set to true, indicates that the instance cannot be terminated using
- * the Amazon EC2 console, command line tool, or API.
Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Indicates whether an instance stops or terminates when you initiate shutdown from - * the instance (using the operating system command for system shutdown).
+ *Unique, case-sensitive identifier you provide to ensure the idempotency of the + * request. For more information, see Ensuring + * Idempotency.
+ *Constraint: Maximum 128 ASCII characters.
*/ - InstanceInitiatedShutdownBehavior?: ShutdownBehavior | string; + ClientToken?: string; /** - *The user data for the instance.
+ *The ID of the launch template. You must specify either the launch template ID or + * launch template name in the request.
*/ - UserData?: string; + LaunchTemplateId?: string; /** - *The tags.
+ *The name of the launch template. You must specify either the launch template ID or + * launch template name in the request.
*/ - TagSpecifications?: LaunchTemplateTagSpecification[]; + LaunchTemplateName?: string; /** - *The elastic GPU specification.
+ *The version number of the launch template version on which to base the new version.
+ * The new version inherits the same launch parameters as the source version, except for
+ * parameters that you specify in LaunchTemplateData. Snapshots applied
+ * to the block device mapping are ignored when creating a new version unless they
+ * are explicitly included.
- * The elastic inference accelerator for the instance. - *
+ *A description for the version of the launch template.
*/ - ElasticInferenceAccelerators?: LaunchTemplateElasticInferenceAcceleratorResponse[]; + VersionDescription?: string; /** - *The security group IDs.
+ *The information for the launch template.
*/ - SecurityGroupIds?: string[]; + LaunchTemplateData: RequestLaunchTemplateData | undefined; +} +export namespace CreateLaunchTemplateVersionRequest { /** - *The security group names.
+ * @internal */ - SecurityGroups?: string[]; + export const filterSensitiveLog = (obj: CreateLaunchTemplateVersionRequest): any => ({ + ...obj, + }); +} +/** + *Describes a block device for an EBS volume.
+ */ +export interface LaunchTemplateEbsBlockDevice { /** - *The market (purchasing) option for the instances.
+ *Indicates whether the EBS volume is encrypted.
*/ - InstanceMarketOptions?: LaunchTemplateInstanceMarketOptions; + Encrypted?: boolean; /** - *The credit option for CPU usage of the instance.
+ *Indicates whether the EBS volume is deleted on instance termination.
*/ - CreditSpecification?: CreditSpecification; + DeleteOnTermination?: boolean; /** - *The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User - * Guide.
+ *The number of I/O operations per second (IOPS) that the volume supports.
*/ - CpuOptions?: LaunchTemplateCpuOptions; + Iops?: number; /** - *Information about the Capacity Reservation targeting option.
+ *The ARN of the Key Management Service (KMS) CMK used for encryption.
*/ - CapacityReservationSpecification?: LaunchTemplateCapacityReservationSpecificationResponse; + KmsKeyId?: string; /** - *The license configurations.
+ *The ID of the snapshot.
*/ - LicenseSpecifications?: LaunchTemplateLicenseConfiguration[]; + SnapshotId?: string; /** - *Indicates whether an instance is configured for hibernation. For more information, see - * Hibernate - * your instance in the Amazon Elastic Compute Cloud User Guide.
+ *The size of the volume, in GiB.
*/ - HibernationOptions?: LaunchTemplateHibernationOptions; + VolumeSize?: number; /** - *The metadata options for the instance. For more information, see Instance metadata and user data in the - * Amazon Elastic Compute Cloud User Guide.
+ *The volume type.
*/ - MetadataOptions?: LaunchTemplateInstanceMetadataOptions; + VolumeType?: VolumeType | string; /** - *Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
+ *The throughput that the volume supports, in MiB/s.
*/ - EnclaveOptions?: LaunchTemplateEnclaveOptions; + Throughput?: number; } -export namespace ResponseLaunchTemplateData { +export namespace LaunchTemplateEbsBlockDevice { /** * @internal */ - export const filterSensitiveLog = (obj: ResponseLaunchTemplateData): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateEbsBlockDevice): any => ({ ...obj, }); } /** - *Describes a launch template version.
+ *Describes a block device mapping.
*/ -export interface LaunchTemplateVersion { - /** - *The ID of the launch template.
- */ - LaunchTemplateId?: string; - +export interface LaunchTemplateBlockDeviceMapping { /** - *The name of the launch template.
+ *The device name.
*/ - LaunchTemplateName?: string; + DeviceName?: string; /** - *The version number.
+ *The virtual device name (ephemeralN).
*/ - VersionNumber?: number; + VirtualName?: string; /** - *The description for the version.
+ *Information about the block device for an EBS volume.
*/ - VersionDescription?: string; + Ebs?: LaunchTemplateEbsBlockDevice; /** - *The time the version was created.
+ *To omit the device from the block device mapping, specify an empty string.
*/ - CreateTime?: Date; + NoDevice?: string; +} +export namespace LaunchTemplateBlockDeviceMapping { /** - *The principal that created the version.
+ * @internal */ - CreatedBy?: string; + export const filterSensitiveLog = (obj: LaunchTemplateBlockDeviceMapping): any => ({ + ...obj, + }); +} +/** + *Describes a target Capacity Reservation or Capacity Reservation group.
+ */ +export interface CapacityReservationTargetResponse { /** - *Indicates whether the version is the default version.
+ *The ID of the targeted Capacity Reservation.
*/ - DefaultVersion?: boolean; + CapacityReservationId?: string; /** - *Information about the launch template.
+ *The ARN of the targeted Capacity Reservation group.
*/ - LaunchTemplateData?: ResponseLaunchTemplateData; + CapacityReservationResourceGroupArn?: string; } -export namespace LaunchTemplateVersion { +export namespace CapacityReservationTargetResponse { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchTemplateVersion): any => ({ + export const filterSensitiveLog = (obj: CapacityReservationTargetResponse): any => ({ ...obj, }); } -export interface CreateLaunchTemplateVersionResult { +/** + *Information about the Capacity Reservation targeting option.
+ */ +export interface LaunchTemplateCapacityReservationSpecificationResponse { /** - *Information about the launch template version.
+ *Indicates the instance's Capacity Reservation preferences. Possible preferences include:
+ *
+ * open - The instance can run in any open Capacity Reservation that has matching attributes
+ * (instance type, platform, Availability Zone).
+ * none - The instance avoids running in a Capacity Reservation even if one is available. The instance
+ * runs in On-Demand capacity.
If the new version of the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.
+ *Information about the target Capacity Reservation or Capacity Reservation group.
*/ - Warning?: ValidationWarning; + CapacityReservationTarget?: CapacityReservationTargetResponse; } -export namespace CreateLaunchTemplateVersionResult { +export namespace LaunchTemplateCapacityReservationSpecificationResponse { /** * @internal */ - export const filterSensitiveLog = (obj: CreateLaunchTemplateVersionResult): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateCapacityReservationSpecificationResponse): any => ({ ...obj, }); } -export interface CreateLocalGatewayRouteRequest { - /** - *The CIDR range used for destination matches. Routing decisions are based on - * the most specific match.
- */ - DestinationCidrBlock: string | undefined; - - /** - *The ID of the local gateway route table.
- */ - LocalGatewayRouteTableId: string | undefined; - +/** + *The CPU options for the instance.
+ */ +export interface LaunchTemplateCpuOptions { /** - *The ID of the virtual interface group.
+ *The number of CPU cores for the instance.
*/ - LocalGatewayVirtualInterfaceGroupId: string | undefined; + CoreCount?: number; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The number of threads per CPU core.
*/ - DryRun?: boolean; + ThreadsPerCore?: number; } -export namespace CreateLocalGatewayRouteRequest { +export namespace LaunchTemplateCpuOptions { /** * @internal */ - export const filterSensitiveLog = (obj: CreateLocalGatewayRouteRequest): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateCpuOptions): any => ({ ...obj, }); } -export type LocalGatewayRouteState = "active" | "blackhole" | "deleted" | "deleting" | "pending"; - -export type LocalGatewayRouteType = "propagated" | "static"; - /** - *Describes a route for a local gateway route table.
+ *Describes the credit option for CPU usage of a T2, T3, or T3a instance.
*/ -export interface LocalGatewayRoute { - /** - *The CIDR block used for destination matches.
- */ - DestinationCidrBlock?: string; - +export interface CreditSpecification { /** - *The ID of the virtual interface group.
+ *The credit option for CPU usage of a T2, T3, or T3a instance. Valid values are
+ * standard and unlimited.
The route type.
+ * @internal */ - Type?: LocalGatewayRouteType | string; + export const filterSensitiveLog = (obj: CreditSpecification): any => ({ + ...obj, + }); +} +/** + *Describes an elastic GPU.
+ */ +export interface ElasticGpuSpecificationResponse { /** - *The state of the route.
+ *The elastic GPU type.
*/ - State?: LocalGatewayRouteState | string; + Type?: string; +} +export namespace ElasticGpuSpecificationResponse { /** - *The ID of the local gateway route table.
+ * @internal */ - LocalGatewayRouteTableId?: string; + export const filterSensitiveLog = (obj: ElasticGpuSpecificationResponse): any => ({ + ...obj, + }); +} +/** + *+ * Describes an elastic inference accelerator. + *
+ */ +export interface LaunchTemplateElasticInferenceAcceleratorResponse { /** - *The Amazon Resource Name (ARN) of the local gateway route table.
+ *+ * The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. + *
*/ - LocalGatewayRouteTableArn?: string; + Type?: string; /** - *The ID of the Amazon Web Services account that owns the local gateway route.
+ *+ * The number of elastic inference accelerators to attach to the instance. + *
+ *Default: 1
*/ - OwnerId?: string; + Count?: number; } -export namespace LocalGatewayRoute { +export namespace LaunchTemplateElasticInferenceAcceleratorResponse { /** * @internal */ - export const filterSensitiveLog = (obj: LocalGatewayRoute): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateElasticInferenceAcceleratorResponse): any => ({ ...obj, }); } -export interface CreateLocalGatewayRouteResult { +/** + *Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
+ */ +export interface LaunchTemplateEnclaveOptions { /** - *Information about the route.
+ *If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves;
+ * otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.
Indicates whether an instance is configured for hibernation.
+ */ +export interface LaunchTemplateHibernationOptions { /** - *The ID of the local gateway route table.
+ *If this parameter is set to true, the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.
The ID of the VPC.
+ * @internal */ - VpcId: string | undefined; + export const filterSensitiveLog = (obj: LaunchTemplateHibernationOptions): any => ({ + ...obj, + }); +} +/** + *Describes an IAM instance profile.
+ */ +export interface LaunchTemplateIamInstanceProfileSpecification { /** - *The tags to assign to the local gateway route table VPC association.
+ *The Amazon Resource Name (ARN) of the instance profile.
*/ - TagSpecifications?: TagSpecification[]; + Arn?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The name of the instance profile.
*/ - DryRun?: boolean; + Name?: string; } -export namespace CreateLocalGatewayRouteTableVpcAssociationRequest { +export namespace LaunchTemplateIamInstanceProfileSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: CreateLocalGatewayRouteTableVpcAssociationRequest): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateIamInstanceProfileSpecification): any => ({ ...obj, }); } /** - *Describes an association between a local gateway route table and a VPC.
+ *The options for Spot Instances.
*/ -export interface LocalGatewayRouteTableVpcAssociation { +export interface LaunchTemplateSpotMarketOptions { /** - *The ID of the association.
+ *The maximum hourly price you're willing to pay for the Spot Instances.
*/ - LocalGatewayRouteTableVpcAssociationId?: string; + MaxPrice?: string; /** - *The ID of the local gateway route table.
+ *The Spot Instance request type.
*/ - LocalGatewayRouteTableId?: string; + SpotInstanceType?: SpotInstanceType | string; /** - *The Amazon Resource Name (ARN) of the local gateway route table for the association.
+ *The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
*/ - LocalGatewayRouteTableArn?: string; + BlockDurationMinutes?: number; /** - *The ID of the local gateway.
+ *The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
*/ - LocalGatewayId?: string; + ValidUntil?: Date; /** - *The ID of the VPC.
+ *The behavior when a Spot Instance is interrupted.
*/ - VpcId?: string; + InstanceInterruptionBehavior?: InstanceInterruptionBehavior | string; +} +export namespace LaunchTemplateSpotMarketOptions { /** - *The ID of the Amazon Web Services account that owns the local gateway route table for the association.
+ * @internal */ - OwnerId?: string; + export const filterSensitiveLog = (obj: LaunchTemplateSpotMarketOptions): any => ({ + ...obj, + }); +} +/** + *The market (purchasing) option for the instances.
+ */ +export interface LaunchTemplateInstanceMarketOptions { /** - *The state of the association.
+ *The market type.
*/ - State?: string; + MarketType?: MarketType | string; /** - *The tags assigned to the association.
+ *The options for Spot Instances.
*/ - Tags?: Tag[]; + SpotOptions?: LaunchTemplateSpotMarketOptions; } -export namespace LocalGatewayRouteTableVpcAssociation { +export namespace LaunchTemplateInstanceMarketOptions { /** * @internal */ - export const filterSensitiveLog = (obj: LocalGatewayRouteTableVpcAssociation): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateInstanceMarketOptions): any => ({ ...obj, }); } -export interface CreateLocalGatewayRouteTableVpcAssociationResult { +/** + *Describes a license configuration.
+ */ +export interface LaunchTemplateLicenseConfiguration { /** - *Information about the association.
+ *The Amazon Resource Name (ARN) of the license configuration.
*/ - LocalGatewayRouteTableVpcAssociation?: LocalGatewayRouteTableVpcAssociation; + LicenseConfigurationArn?: string; } -export namespace CreateLocalGatewayRouteTableVpcAssociationResult { +export namespace LaunchTemplateLicenseConfiguration { /** * @internal */ - export const filterSensitiveLog = (obj: CreateLocalGatewayRouteTableVpcAssociationResult): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateLicenseConfiguration): any => ({ ...obj, }); } -export interface CreateManagedPrefixListRequest { - /** - *Checks whether you have the required permissions for the action, without 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 metadata options for the instance. For more information, see Instance Metadata and User Data in the + * Amazon Elastic Compute Cloud User Guide.
+ */ +export interface LaunchTemplateInstanceMetadataOptions { /** - *A name for the prefix list.
- *Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.
The state of the metadata option changes.
+ *
+ * pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
+ * applied - The metadata options have been successfully applied on the instance.
One or more entries for the prefix list.
+ *The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.
If the state is required, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
The maximum number of entries for the prefix list.
+ *The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
+ *Default: 1
+ *Possible values: Integers from 1 to 64
*/ - MaxEntries: number | undefined; + HttpPutResponseHopLimit?: number; /** - *The tags to apply to the prefix list during creation.
+ *This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.
+ *
The IP address type.
- *Valid Values: IPv4 | IPv6
+ *
Enables or disables the IPv6 endpoint for the instance metadata service.
+ *Default: disabled
*
Unique, case-sensitive identifier you provide to ensure the idempotency of the - * request. For more information, see Ensuring - * Idempotency.
- *Constraints: Up to 255 UTF-8 characters in length.
- */ - ClientToken?: string; + HttpProtocolIpv6?: LaunchTemplateInstanceMetadataProtocolIpv6 | string; } -export namespace CreateManagedPrefixListRequest { +export namespace LaunchTemplateInstanceMetadataOptions { /** * @internal */ - export const filterSensitiveLog = (obj: CreateManagedPrefixListRequest): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateInstanceMetadataOptions): any => ({ ...obj, }); } -export type PrefixListState = - | "create-complete" - | "create-failed" - | "create-in-progress" - | "delete-complete" - | "delete-failed" - | "delete-in-progress" - | "modify-complete" - | "modify-failed" - | "modify-in-progress" - | "restore-complete" - | "restore-failed" - | "restore-in-progress"; - /** - *Describes a managed prefix list.
+ *Describes the monitoring for the instance.
*/ -export interface ManagedPrefixList { - /** - *The ID of the prefix list.
- */ - PrefixListId?: string; - - /** - *The IP address version.
- */ - AddressFamily?: string; - - /** - *The current state of the prefix list.
- */ - State?: PrefixListState | string; - - /** - *The state message.
- */ - StateMessage?: string; - - /** - *The Amazon Resource Name (ARN) for the prefix list.
- */ - PrefixListArn?: string; - +export interface LaunchTemplatesMonitoring { /** - *The name of the prefix list.
+ *Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is + * enabled.
*/ - PrefixListName?: string; + Enabled?: boolean; +} +export namespace LaunchTemplatesMonitoring { /** - *The maximum number of entries for the prefix list.
+ * @internal */ - MaxEntries?: number; + export const filterSensitiveLog = (obj: LaunchTemplatesMonitoring): any => ({ + ...obj, + }); +} +/** + *Information about the IPv4 delegated prefixes assigned + * to a network interface.
+ */ +export interface Ipv4PrefixSpecificationResponse { /** - *The version of the prefix list.
+ *One or more IPv4 delegated prefixes assigned to the network interface.
*/ - Version?: number; + Ipv4Prefix?: string; +} +export namespace Ipv4PrefixSpecificationResponse { /** - *The tags for the prefix list.
+ * @internal */ - Tags?: Tag[]; + export const filterSensitiveLog = (obj: Ipv4PrefixSpecificationResponse): any => ({ + ...obj, + }); +} +/** + *Describes an IPv6 address.
+ */ +export interface InstanceIpv6Address { /** - *The ID of the owner of the prefix list.
+ *The IPv6 address.
*/ - OwnerId?: string; + Ipv6Address?: string; } -export namespace ManagedPrefixList { +export namespace InstanceIpv6Address { /** * @internal */ - export const filterSensitiveLog = (obj: ManagedPrefixList): any => ({ + export const filterSensitiveLog = (obj: InstanceIpv6Address): any => ({ ...obj, }); } -export interface CreateManagedPrefixListResult { +/** + *Information about the IPv6 delegated prefixes assigned + * to a network interface.
+ */ +export interface Ipv6PrefixSpecificationResponse { /** - *Information about the prefix list.
+ *One or more IPv6 delegated prefixes assigned to the network interface.
*/ - PrefixList?: ManagedPrefixList; + Ipv6Prefix?: string; } -export namespace CreateManagedPrefixListResult { +export namespace Ipv6PrefixSpecificationResponse { /** * @internal */ - export const filterSensitiveLog = (obj: CreateManagedPrefixListResult): any => ({ + export const filterSensitiveLog = (obj: Ipv6PrefixSpecificationResponse): any => ({ ...obj, }); } -export enum ConnectivityType { - PRIVATE = "private", - PUBLIC = "public", -} +/** + *Describes a network interface.
+ */ +export interface LaunchTemplateInstanceNetworkInterfaceSpecification { + /** + *Indicates whether to associate a Carrier IP address with eth0 for a new network interface.
+ *Use this option when you launch an instance in a Wavelength Zone and want to associate + * a Carrier IP address with the network interface. For more information about Carrier IP + * addresses, see Carrier IP addresses in the Wavelength Developer + * Guide.
+ */ + AssociateCarrierIpAddress?: boolean; -export interface CreateNatGatewayRequest { /** - *[Public NAT gateways only] The allocation ID of an Elastic IP address to associate - * with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. - * If the Elastic IP address is associated with another resource, you must first disassociate it.
+ *Indicates whether to associate a public IPv4 address with eth0 for a new network interface.
*/ - AllocationId?: string; + AssociatePublicIpAddress?: boolean; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to ensure - * idempotency.
- *Constraint: Maximum 64 ASCII characters.
+ *Indicates whether the network interface is deleted when the instance is terminated.
*/ - ClientToken?: string; + DeleteOnTermination?: boolean; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
A description for the network interface.
*/ - DryRun?: boolean; + Description?: string; /** - *The subnet in which to create the NAT gateway.
+ *The device index for the network interface attachment.
*/ - SubnetId: string | undefined; + DeviceIndex?: number; /** - *The tags to assign to the NAT gateway.
+ *The IDs of one or more security groups.
+ */ + Groups?: string[]; + + /** + *The type of network interface.
*/ - TagSpecifications?: TagSpecification[]; + InterfaceType?: string; /** - *Indicates whether the NAT gateway supports public or private connectivity. - * The default is public connectivity.
+ *The number of IPv6 addresses for the network interface.
*/ - ConnectivityType?: ConnectivityType | string; -} + Ipv6AddressCount?: number; -export namespace CreateNatGatewayRequest { /** - * @internal + *The IPv6 addresses for the network interface.
*/ - export const filterSensitiveLog = (obj: CreateNatGatewayRequest): any => ({ - ...obj, - }); -} + Ipv6Addresses?: InstanceIpv6Address[]; -/** - *Describes the IP addresses and network interface associated with a NAT gateway.
- */ -export interface NatGatewayAddress { /** - *[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
+ *The ID of the network interface.
*/ - AllocationId?: string; + NetworkInterfaceId?: string; /** - *The ID of the network interface associated with the NAT gateway.
+ *The primary private IPv4 address of the network interface.
*/ - NetworkInterfaceId?: string; + PrivateIpAddress?: string; /** - *The private IP address associated with the NAT gateway.
+ *One or more private IPv4 addresses.
*/ - PrivateIp?: string; + PrivateIpAddresses?: PrivateIpAddressSpecification[]; /** - *[Public NAT gateway only] The Elastic IP address associated with the NAT gateway.
+ *The number of secondary private IPv4 addresses for the network interface.
*/ - PublicIp?: string; -} + SecondaryPrivateIpAddressCount?: number; -export namespace NatGatewayAddress { /** - * @internal + *The ID of the subnet for the network interface.
*/ - export const filterSensitiveLog = (obj: NatGatewayAddress): any => ({ - ...obj, - }); -} + SubnetId?: string; -/** - *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
- */ -export interface ProvisionedBandwidth { /** - *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
+ *The index of the network card.
*/ - ProvisionTime?: Date; + NetworkCardIndex?: number; /** - *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
+ *One or more IPv4 prefixes assigned to the network interface.
*/ - Provisioned?: string; + Ipv4Prefixes?: Ipv4PrefixSpecificationResponse[]; /** - *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
+ *The number of IPv4 prefixes that Amazon Web Services automatically assigned to the + * network interface.
*/ - RequestTime?: Date; + Ipv4PrefixCount?: number; /** - *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
+ *One or more IPv6 prefixes assigned to the network interface.
*/ - Requested?: string; + Ipv6Prefixes?: Ipv6PrefixSpecificationResponse[]; /** - *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
+ *The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network + * interface.
*/ - Status?: string; + Ipv6PrefixCount?: number; } -export namespace ProvisionedBandwidth { +export namespace LaunchTemplateInstanceNetworkInterfaceSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: ProvisionedBandwidth): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateInstanceNetworkInterfaceSpecification): any => ({ ...obj, }); } -export enum NatGatewayState { - AVAILABLE = "available", - DELETED = "deleted", - DELETING = "deleting", - FAILED = "failed", - PENDING = "pending", -} - /** - *Describes a NAT gateway.
+ *Describes the placement of an instance.
*/ -export interface NatGateway { +export interface LaunchTemplatePlacement { /** - *The date and time the NAT gateway was created.
+ *The Availability Zone of the instance.
*/ - CreateTime?: Date; + AvailabilityZone?: string; /** - *The date and time the NAT gateway was deleted, if applicable.
+ *The affinity setting for the instance on the Dedicated Host.
*/ - DeleteTime?: Date; + Affinity?: string; /** - *If the NAT gateway could not be created, specifies the error code for the failure.
- * (InsufficientFreeAddressesInSubnet | Gateway.NotAttached |
- * InvalidAllocationID.NotFound | Resource.AlreadyAssociated |
- * InternalError | InvalidSubnetID.NotFound)
The name of the placement group for the instance.
*/ - FailureCode?: string; + GroupName?: string; /** - *If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
- *For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
- *For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
- *For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
- *For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
- *For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
- *For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."
- *The ID of the Dedicated Host for the instance.
*/ - FailureMessage?: string; + HostId?: string; /** - *Information about the IP addresses and network interface associated with the NAT gateway.
+ *The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
The ID of the NAT gateway.
+ *Reserved for future use.
*/ - NatGatewayId?: string; + SpreadDomain?: string; /** - *Reserved. If you need to sustain traffic greater than the documented limits, contact us through - * the Support Center.
+ *The ARN of the host resource group in which to launch the instances. + *
*/ - ProvisionedBandwidth?: ProvisionedBandwidth; + HostResourceGroupArn?: string; /** - *The state of the NAT gateway.
- *
- * pending: The NAT gateway is being created and is not ready to process
- * traffic.
- * failed: The NAT gateway could not be created. Check the
- * failureCode and failureMessage fields for the reason.
- * available: The NAT gateway is able to process traffic. This status remains
- * until you delete the NAT gateway, and does not indicate the health of the NAT gateway.
- * deleting: The NAT gateway is in the process of being terminated and may
- * still be processing traffic.
- * deleted: The NAT gateway has been terminated and is no longer processing
- * traffic.
The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
The ID of the subnet in which the NAT gateway is located.
+ * @internal */ - SubnetId?: string; + export const filterSensitiveLog = (obj: LaunchTemplatePlacement): any => ({ + ...obj, + }); +} +/** + *The tag specification for the launch template.
+ */ +export interface LaunchTemplateTagSpecification { /** - *The ID of the VPC in which the NAT gateway is located.
+ *The type of resource.
*/ - VpcId?: string; + ResourceType?: ResourceType | string; /** - *The tags for the NAT gateway.
+ *The tags for the resource.
*/ Tags?: Tag[]; - - /** - *Indicates whether the NAT gateway supports public or private connectivity.
- */ - ConnectivityType?: ConnectivityType | string; } -export namespace NatGateway { +export namespace LaunchTemplateTagSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: NatGateway): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateTagSpecification): any => ({ ...obj, }); } -export interface CreateNatGatewayResult { +/** + *The information for a launch template.
+ */ +export interface ResponseLaunchTemplateData { /** - *Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
+ *The ID of the kernel, if applicable.
*/ - ClientToken?: string; + KernelId?: string; /** - *Information about the NAT gateway.
+ *Indicates whether the instance is optimized for Amazon EBS I/O.
*/ - NatGateway?: NatGateway; -} + EbsOptimized?: boolean; -export namespace CreateNatGatewayResult { /** - * @internal + *The IAM instance profile.
*/ - export const filterSensitiveLog = (obj: CreateNatGatewayResult): any => ({ - ...obj, - }); -} + IamInstanceProfile?: LaunchTemplateIamInstanceProfileSpecification; -export interface CreateNetworkAclRequest { /** - *Checks whether you have the required permissions for the action, without 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 block device mappings.
*/ - DryRun?: boolean; + BlockDeviceMappings?: LaunchTemplateBlockDeviceMapping[]; /** - *The ID of the VPC.
+ *The network interfaces.
*/ - VpcId: string | undefined; + NetworkInterfaces?: LaunchTemplateInstanceNetworkInterfaceSpecification[]; /** - *The tags to assign to the network ACL.
+ *The ID of the AMI that was used to launch the instance.
*/ - TagSpecifications?: TagSpecification[]; -} + ImageId?: string; -export namespace CreateNetworkAclRequest { /** - * @internal + *The instance type.
*/ - export const filterSensitiveLog = (obj: CreateNetworkAclRequest): any => ({ - ...obj, - }); -} + InstanceType?: _InstanceType | string; + + /** + *The name of the key pair.
+ */ + KeyName?: string; + + /** + *The monitoring for the instance.
+ */ + Monitoring?: LaunchTemplatesMonitoring; -/** - *Describes an association between a network ACL and a subnet.
- */ -export interface NetworkAclAssociation { /** - *The ID of the association between a network ACL and a subnet.
+ *The placement of the instance.
*/ - NetworkAclAssociationId?: string; + Placement?: LaunchTemplatePlacement; /** - *The ID of the network ACL.
+ *The ID of the RAM disk, if applicable.
*/ - NetworkAclId?: string; + RamDiskId?: string; /** - *The ID of the subnet.
+ *If set to true, indicates that the instance cannot be terminated using
+ * the Amazon EC2 console, command line tool, or API.
Indicates whether an instance stops or terminates when you initiate shutdown from + * the instance (using the operating system command for system shutdown).
*/ - export const filterSensitiveLog = (obj: NetworkAclAssociation): any => ({ - ...obj, - }); -} + InstanceInitiatedShutdownBehavior?: ShutdownBehavior | string; -/** - *Describes the ICMP type and code.
- */ -export interface IcmpTypeCode { /** - *The ICMP code. A value of -1 means all codes for the specified ICMP type.
+ *The user data for the instance.
*/ - Code?: number; + UserData?: string; /** - *The ICMP type. A value of -1 means all types.
+ *The tags.
*/ - Type?: number; -} + TagSpecifications?: LaunchTemplateTagSpecification[]; -export namespace IcmpTypeCode { /** - * @internal + *The elastic GPU specification.
*/ - export const filterSensitiveLog = (obj: IcmpTypeCode): any => ({ - ...obj, - }); -} + ElasticGpuSpecifications?: ElasticGpuSpecificationResponse[]; -/** - *Describes a range of ports.
- */ -export interface PortRange { /** - *The first port in the range.
+ *+ * The elastic inference accelerator for the instance. + *
*/ - From?: number; + ElasticInferenceAccelerators?: LaunchTemplateElasticInferenceAcceleratorResponse[]; /** - *The last port in the range.
+ *The security group IDs.
*/ - To?: number; -} + SecurityGroupIds?: string[]; -export namespace PortRange { /** - * @internal + *The security group names.
*/ - export const filterSensitiveLog = (obj: PortRange): any => ({ - ...obj, - }); -} + SecurityGroups?: string[]; -export type RuleAction = "allow" | "deny"; + /** + *The market (purchasing) option for the instances.
+ */ + InstanceMarketOptions?: LaunchTemplateInstanceMarketOptions; -/** - *Describes an entry in a network ACL.
- */ -export interface NetworkAclEntry { /** - *The IPv4 network range to allow or deny, in CIDR notation.
+ *The credit option for CPU usage of the instance.
*/ - CidrBlock?: string; + CreditSpecification?: CreditSpecification; /** - *Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
+ *The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User + * Guide.
*/ - Egress?: boolean; + CpuOptions?: LaunchTemplateCpuOptions; /** - *ICMP protocol: The ICMP type and code.
+ *Information about the Capacity Reservation targeting option.
*/ - IcmpTypeCode?: IcmpTypeCode; + CapacityReservationSpecification?: LaunchTemplateCapacityReservationSpecificationResponse; /** - *The IPv6 network range to allow or deny, in CIDR notation.
+ *The license configurations.
*/ - Ipv6CidrBlock?: string; + LicenseSpecifications?: LaunchTemplateLicenseConfiguration[]; /** - *TCP or UDP protocols: The range of ports the rule applies to.
+ *Indicates whether an instance is configured for hibernation. For more information, see + * Hibernate + * your instance in the Amazon Elastic Compute Cloud User Guide.
*/ - PortRange?: PortRange; + HibernationOptions?: LaunchTemplateHibernationOptions; /** - *The protocol number. A value of "-1" means all protocols.
+ *The metadata options for the instance. For more information, see Instance metadata and user data in the + * Amazon Elastic Compute Cloud User Guide.
*/ - Protocol?: string; + MetadataOptions?: LaunchTemplateInstanceMetadataOptions; /** - *Indicates whether to allow or deny the traffic that matches the rule.
+ *Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
*/ - RuleAction?: RuleAction | string; + EnclaveOptions?: LaunchTemplateEnclaveOptions; /** - *The rule number for the entry. ACL entries are processed in ascending order by rule number.
+ *The attributes for the instance types. When you specify instance attributes, Amazon EC2 will + * identify instance types with these attributes.
+ *If you specify InstanceRequirements, you can't specify
+ * InstanceTypes.
Describes a network ACL.
+ *Describes a launch template version.
*/ -export interface NetworkAcl { +export interface LaunchTemplateVersion { /** - *Any associations between the network ACL and one or more subnets
+ *The ID of the launch template.
*/ - Associations?: NetworkAclAssociation[]; + LaunchTemplateId?: string; /** - *One or more entries (rules) in the network ACL.
+ *The name of the launch template.
*/ - Entries?: NetworkAclEntry[]; + LaunchTemplateName?: string; /** - *Indicates whether this is the default network ACL for the VPC.
+ *The version number.
*/ - IsDefault?: boolean; + VersionNumber?: number; /** - *The ID of the network ACL.
+ *The description for the version.
*/ - NetworkAclId?: string; + VersionDescription?: string; /** - *Any tags assigned to the network ACL.
+ *The time the version was created.
*/ - Tags?: Tag[]; + CreateTime?: Date; /** - *The ID of the VPC for the network ACL.
+ *The principal that created the version.
*/ - VpcId?: string; + CreatedBy?: string; /** - *The ID of the Amazon Web Services account that owns the network ACL.
+ *Indicates whether the version is the default version.
*/ - OwnerId?: string; + DefaultVersion?: boolean; + + /** + *Information about the launch template.
+ */ + LaunchTemplateData?: ResponseLaunchTemplateData; } -export namespace NetworkAcl { +export namespace LaunchTemplateVersion { /** * @internal */ - export const filterSensitiveLog = (obj: NetworkAcl): any => ({ + export const filterSensitiveLog = (obj: LaunchTemplateVersion): any => ({ ...obj, }); } -export interface CreateNetworkAclResult { +export interface CreateLaunchTemplateVersionResult { /** - *Information about the network ACL.
+ *Information about the launch template version.
*/ - NetworkAcl?: NetworkAcl; + LaunchTemplateVersion?: LaunchTemplateVersion; + + /** + *If the new version of the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found.
+ */ + Warning?: ValidationWarning; } -export namespace CreateNetworkAclResult { +export namespace CreateLaunchTemplateVersionResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateNetworkAclResult): any => ({ + export const filterSensitiveLog = (obj: CreateLaunchTemplateVersionResult): any => ({ ...obj, }); } -export interface CreateNetworkAclEntryRequest { +export interface CreateLocalGatewayRouteRequest { /** - *The IPv4 network range to allow or deny, in CIDR notation (for example
- * 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The CIDR range used for destination matches. Routing decisions are based on + * the most specific match.
*/ - CidrBlock?: string; + DestinationCidrBlock: 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 local gateway route table.
*/ - DryRun?: boolean; + LocalGatewayRouteTableId: string | undefined; /** - *Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
+ *The ID of the virtual interface group.
*/ - Egress: boolean | undefined; + LocalGatewayVirtualInterfaceGroupId: string | undefined; /** - *ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol - * 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
+ *Checks whether you have the required permissions for the action, without 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 IPv6 network range to allow or deny, in CIDR notation (for example
- * 2001:db8:1234:1a00::/64).
Describes a route for a local gateway route table.
+ */ +export interface LocalGatewayRoute { /** - *The ID of the network ACL.
+ *The CIDR block used for destination matches.
*/ - NetworkAclId: string | undefined; + DestinationCidrBlock?: string; /** - *TCP or UDP protocols: The range of ports the rule applies to. - * Required if specifying protocol 6 (TCP) or 17 (UDP).
+ *The ID of the virtual interface group.
*/ - PortRange?: PortRange; + LocalGatewayVirtualInterfaceGroupId?: string; /** - *The protocol number. A value of "-1" means all protocols. If you specify "-1" or a - * protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is - * allowed, regardless of any ports or ICMP types or codes that you specify. If you specify - * protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and - * codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) - * and specify an IPv6 CIDR block, you must specify an ICMP type and code.
+ *The route type.
*/ - Protocol: string | undefined; + Type?: LocalGatewayRouteType | string; /** - *Indicates whether to allow or deny the traffic that matches the rule.
+ *The state of the route.
*/ - RuleAction: RuleAction | string | undefined; + State?: LocalGatewayRouteState | string; /** - *The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
- *Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
+ *The ID of the local gateway route table.
*/ - RuleNumber: number | undefined; -} + LocalGatewayRouteTableId?: string; -export namespace CreateNetworkAclEntryRequest { /** - * @internal + *The Amazon Resource Name (ARN) of the local gateway route table.
*/ - export const filterSensitiveLog = (obj: CreateNetworkAclEntryRequest): any => ({ - ...obj, - }); -} - -export type Protocol = "tcp" | "udp"; + LocalGatewayRouteTableArn?: string; -export interface CreateNetworkInsightsPathRequest { /** - *The IP address of the Amazon Web Services resource that is the source of the path.
+ *The ID of the Amazon Web Services account that owns the local gateway route.
*/ - SourceIp?: string; + OwnerId?: string; +} +export namespace LocalGatewayRoute { /** - *The IP address of the Amazon Web Services resource that is the destination of the path.
+ * @internal */ - DestinationIp?: string; + export const filterSensitiveLog = (obj: LocalGatewayRoute): any => ({ + ...obj, + }); +} +export interface CreateLocalGatewayRouteResult { /** - *The Amazon Web Services resource that is the source of the path.
+ *Information about the route.
*/ - Source: string | undefined; + Route?: LocalGatewayRoute; +} +export namespace CreateLocalGatewayRouteResult { /** - *The Amazon Web Services resource that is the destination of the path.
+ * @internal */ - Destination: string | undefined; + export const filterSensitiveLog = (obj: CreateLocalGatewayRouteResult): any => ({ + ...obj, + }); +} +export interface CreateLocalGatewayRouteTableVpcAssociationRequest { /** - *The protocol.
+ *The ID of the local gateway route table.
*/ - Protocol: Protocol | string | undefined; + LocalGatewayRouteTableId: string | undefined; /** - *The destination port.
+ *The ID of the VPC.
*/ - DestinationPort?: number; + VpcId: string | undefined; /** - *The tags to add to the path.
+ *The tags to assign to the local gateway route table VPC association.
*/ TagSpecifications?: TagSpecification[]; @@ -3687,714 +4033,749 @@ export interface CreateNetworkInsightsPathRequest { * Otherwise, it isUnauthorizedOperation.
*/
DryRun?: boolean;
-
- /**
- * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, - * see How to ensure idempotency.
- */ - ClientToken?: string; } -export namespace CreateNetworkInsightsPathRequest { +export namespace CreateLocalGatewayRouteTableVpcAssociationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateNetworkInsightsPathRequest): any => ({ + export const filterSensitiveLog = (obj: CreateLocalGatewayRouteTableVpcAssociationRequest): any => ({ ...obj, }); } /** - *Describes a path.
+ *Describes an association between a local gateway route table and a VPC.
*/ -export interface NetworkInsightsPath { - /** - *The ID of the path.
- */ - NetworkInsightsPathId?: string; - - /** - *The Amazon Resource Name (ARN) of the path.
- */ - NetworkInsightsPathArn?: string; - +export interface LocalGatewayRouteTableVpcAssociation { /** - *The time stamp when the path was created.
+ *The ID of the association.
*/ - CreatedDate?: Date; + LocalGatewayRouteTableVpcAssociationId?: string; /** - *The Amazon Web Services resource that is the source of the path.
+ *The ID of the local gateway route table.
*/ - Source?: string; + LocalGatewayRouteTableId?: string; /** - *The Amazon Web Services resource that is the destination of the path.
+ *The Amazon Resource Name (ARN) of the local gateway route table for the association.
*/ - Destination?: string; + LocalGatewayRouteTableArn?: string; /** - *The IP address of the Amazon Web Services resource that is the source of the path.
+ *The ID of the local gateway.
*/ - SourceIp?: string; + LocalGatewayId?: string; /** - *The IP address of the Amazon Web Services resource that is the destination of the path.
+ *The ID of the VPC.
*/ - DestinationIp?: string; + VpcId?: string; /** - *The protocol.
+ *The ID of the Amazon Web Services account that owns the local gateway route table for the association.
*/ - Protocol?: Protocol | string; + OwnerId?: string; /** - *The destination port.
+ *The state of the association.
*/ - DestinationPort?: number; + State?: string; /** - *The tags associated with the path.
+ *The tags assigned to the association.
*/ Tags?: Tag[]; } -export namespace NetworkInsightsPath { +export namespace LocalGatewayRouteTableVpcAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: NetworkInsightsPath): any => ({ + export const filterSensitiveLog = (obj: LocalGatewayRouteTableVpcAssociation): any => ({ ...obj, }); } -export interface CreateNetworkInsightsPathResult { +export interface CreateLocalGatewayRouteTableVpcAssociationResult { /** - *Information about the path.
+ *Information about the association.
*/ - NetworkInsightsPath?: NetworkInsightsPath; + LocalGatewayRouteTableVpcAssociation?: LocalGatewayRouteTableVpcAssociation; } -export namespace CreateNetworkInsightsPathResult { +export namespace CreateLocalGatewayRouteTableVpcAssociationResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateNetworkInsightsPathResult): any => ({ + export const filterSensitiveLog = (obj: CreateLocalGatewayRouteTableVpcAssociationResult): any => ({ ...obj, }); } -export type NetworkInterfaceCreationType = "branch" | "efa" | "trunk"; - -/** - *Contains the parameters for CreateNetworkInterface.
- */ -export interface CreateNetworkInterfaceRequest { - /** - *A description for the network interface.
- */ - Description?: string; - +export interface CreateManagedPrefixListRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
/**
- * The IDs of one or more security groups.
- */ - Groups?: string[]; - - /** - *The number of IPv6 addresses to assign to a network interface. Amazon EC2
- * automatically selects the IPv6 addresses from the subnet range. You can't use this
- * option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set
- * to true, you can specify 0 to override this setting.
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. - * You can't use this option if you're specifying a number of IPv6 addresses.
- */ - Ipv6Addresses?: InstanceIpv6Address[]; - - /** - *The primary private IPv4 address of the network interface. If you don't specify an
- * IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you
- * specify an IP address, you cannot indicate any IP addresses specified in
- * privateIpAddresses as primary (only one IP address can be designated as
- * primary).
One or more private IPv4 addresses.
+ *A name for the prefix list.
+ *Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.
The number of secondary private IPv4 addresses to assign to a network interface. When
- * you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses
- * within the subnet's IPv4 CIDR range. You can't specify this option and specify more than
- * one private IP address using privateIpAddresses.
The number of IP addresses you can assign to a network interface varies by instance - * type. For more information, see IP Addresses Per ENI Per - * Instance Type in the Amazon Virtual Private Cloud User Guide.
+ *One or more entries for the prefix list.
*/ - SecondaryPrivateIpAddressCount?: number; + Entries?: AddPrefixListEntry[]; /** - *One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.
The maximum number of entries for the prefix list.
*/ - Ipv4Prefixes?: Ipv4PrefixSpecificationRequest[]; + MaxEntries: number | undefined; /** - *The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.
The tags to apply to the prefix list during creation.
*/ - Ipv4PrefixCount?: number; + TagSpecifications?: TagSpecification[]; /** - *One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
The IP address type.
+ *Valid Values: IPv4 | IPv6
+ *
The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.
Unique, case-sensitive identifier you provide to ensure the idempotency of the + * request. For more information, see Ensuring + * Idempotency.
+ *Constraints: Up to 255 UTF-8 characters in length.
*/ - Ipv6PrefixCount?: number; + ClientToken?: string; +} +export namespace CreateManagedPrefixListRequest { /** - *Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify
- * efa. For more information, see
- * Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide. To create a trunk network interface, specify
- * efa. For more information, see
- * Network interface trunking in the Amazon Elastic Compute Cloud User Guide.
The ID of the subnet to associate with the network interface.
- */ - SubnetId: string | undefined; +export type PrefixListState = + | "create-complete" + | "create-failed" + | "create-in-progress" + | "delete-complete" + | "delete-failed" + | "delete-in-progress" + | "modify-complete" + | "modify-failed" + | "modify-in-progress" + | "restore-complete" + | "restore-failed" + | "restore-in-progress"; +/** + *Describes a managed prefix list.
+ */ +export interface ManagedPrefixList { /** - *The tags to apply to the new network interface.
+ *The ID of the prefix list.
*/ - TagSpecifications?: TagSpecification[]; + PrefixListId?: string; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
+ *The IP address version.
*/ - ClientToken?: string; -} + AddressFamily?: string; -export namespace CreateNetworkInterfaceRequest { /** - * @internal + *The current state of the prefix list.
*/ - export const filterSensitiveLog = (obj: CreateNetworkInterfaceRequest): any => ({ - ...obj, - }); -} + State?: PrefixListState | string; -/** - *Describes association information for an Elastic IP address (IPv4 only), or a Carrier - * IP address (for a network interface which resides in a subnet in a Wavelength - * Zone).
- */ -export interface NetworkInterfaceAssociation { /** - *The allocation ID.
+ *The state message.
*/ - AllocationId?: string; + StateMessage?: string; /** - *The association ID.
+ *The Amazon Resource Name (ARN) for the prefix list.
*/ - AssociationId?: string; + PrefixListArn?: string; /** - *The ID of the Elastic IP address owner.
+ *The name of the prefix list.
*/ - IpOwnerId?: string; + PrefixListName?: string; /** - *The public DNS name.
+ *The maximum number of entries for the prefix list.
*/ - PublicDnsName?: string; + MaxEntries?: number; /** - *The address of the Elastic IP address bound to the network - * interface.
+ *The version of the prefix list.
*/ - PublicIp?: string; + Version?: number; /** - *The customer-owned IP address associated with the network interface.
+ *The tags for the prefix list.
*/ - CustomerOwnedIp?: string; + Tags?: Tag[]; /** - *The carrier IP address associated with the network interface.
- *This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
+ *The ID of the owner of the prefix list.
*/ - CarrierIp?: string; + OwnerId?: string; } -export namespace NetworkInterfaceAssociation { +export namespace ManagedPrefixList { /** * @internal */ - export const filterSensitiveLog = (obj: NetworkInterfaceAssociation): any => ({ + export const filterSensitiveLog = (obj: ManagedPrefixList): any => ({ ...obj, }); } -/** - *Describes a network interface attachment.
- */ -export interface NetworkInterfaceAttachment { +export interface CreateManagedPrefixListResult { /** - *The timestamp indicating when the attachment initiated.
+ *Information about the prefix list.
*/ - AttachTime?: Date; + PrefixList?: ManagedPrefixList; +} +export namespace CreateManagedPrefixListResult { /** - *The ID of the network interface attachment.
+ * @internal */ - AttachmentId?: string; + export const filterSensitiveLog = (obj: CreateManagedPrefixListResult): any => ({ + ...obj, + }); +} + +export enum ConnectivityType { + PRIVATE = "private", + PUBLIC = "public", +} +export interface CreateNatGatewayRequest { /** - *Indicates whether the network interface is deleted when the instance is terminated.
+ *[Public NAT gateways only] The allocation ID of an Elastic IP address to associate + * with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. + * If the Elastic IP address is associated with another resource, you must first disassociate it.
*/ - DeleteOnTermination?: boolean; + AllocationId?: string; /** - *The device index of the network interface attachment on the instance.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. For more information, see How to ensure + * idempotency.
+ *Constraint: Maximum 64 ASCII characters.
*/ - DeviceIndex?: number; + ClientToken?: string; /** - *The index of the network card.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the instance.
+ *The subnet in which to create the NAT gateway.
*/ - InstanceId?: string; + SubnetId: string | undefined; /** - *The Amazon Web Services account ID of the owner of the instance.
+ *The tags to assign to the NAT gateway.
*/ - InstanceOwnerId?: string; + TagSpecifications?: TagSpecification[]; /** - *The attachment state.
+ *Indicates whether the NAT gateway supports public or private connectivity. + * The default is public connectivity.
*/ - Status?: AttachmentStatus | string; + ConnectivityType?: ConnectivityType | string; } -export namespace NetworkInterfaceAttachment { +export namespace CreateNatGatewayRequest { /** * @internal */ - export const filterSensitiveLog = (obj: NetworkInterfaceAttachment): any => ({ + export const filterSensitiveLog = (obj: CreateNatGatewayRequest): any => ({ ...obj, }); } /** - *Describes a security group.
+ *Describes the IP addresses and network interface associated with a NAT gateway.
*/ -export interface GroupIdentifier { +export interface NatGatewayAddress { /** - *The name of the security group.
+ *[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.
*/ - GroupName?: string; + AllocationId?: string; /** - *The ID of the security group.
+ *The ID of the network interface associated with the NAT gateway.
*/ - GroupId?: string; -} + NetworkInterfaceId?: string; -export namespace GroupIdentifier { /** - * @internal + *The private IP address associated with the NAT gateway.
*/ - export const filterSensitiveLog = (obj: GroupIdentifier): any => ({ - ...obj, - }); -} - -export type NetworkInterfaceType = "efa" | "interface" | "natGateway" | "trunk"; + PrivateIp?: string; -/** - *Describes an IPv6 address associated with a network interface.
- */ -export interface NetworkInterfaceIpv6Address { /** - *The IPv6 address.
+ *[Public NAT gateway only] The Elastic IP address associated with the NAT gateway.
*/ - Ipv6Address?: string; + PublicIp?: string; } -export namespace NetworkInterfaceIpv6Address { +export namespace NatGatewayAddress { /** * @internal */ - export const filterSensitiveLog = (obj: NetworkInterfaceIpv6Address): any => ({ + export const filterSensitiveLog = (obj: NatGatewayAddress): any => ({ ...obj, }); } /** - *Describes the IPv6 prefix.
+ *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
*/ -export interface Ipv6PrefixSpecification { - /** - *The IPv6 prefix.
- */ - Ipv6Prefix?: string; -} - -export namespace Ipv6PrefixSpecification { +export interface ProvisionedBandwidth { /** - * @internal + *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
*/ - export const filterSensitiveLog = (obj: Ipv6PrefixSpecification): any => ({ - ...obj, - }); -} + ProvisionTime?: Date; -/** - *Describes the private IPv4 address of a network interface.
- */ -export interface NetworkInterfacePrivateIpAddress { /** - *The association information for an Elastic IP address (IPv4) associated with the network interface.
+ *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
*/ - Association?: NetworkInterfaceAssociation; + Provisioned?: string; /** - *Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.
+ *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
*/ - Primary?: boolean; + RequestTime?: Date; /** - *The private DNS name.
+ *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
*/ - PrivateDnsName?: string; + Requested?: string; /** - *The private IPv4 address.
+ *Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
*/ - PrivateIpAddress?: string; + Status?: string; } -export namespace NetworkInterfacePrivateIpAddress { +export namespace ProvisionedBandwidth { /** * @internal */ - export const filterSensitiveLog = (obj: NetworkInterfacePrivateIpAddress): any => ({ + export const filterSensitiveLog = (obj: ProvisionedBandwidth): any => ({ ...obj, }); } -export type NetworkInterfaceStatus = "associated" | "attaching" | "available" | "detaching" | "in-use"; +export enum NatGatewayState { + AVAILABLE = "available", + DELETED = "deleted", + DELETING = "deleting", + FAILED = "failed", + PENDING = "pending", +} /** - *Describes a network interface.
+ *Describes a NAT gateway.
*/ -export interface NetworkInterface { +export interface NatGateway { /** - *The association information for an Elastic IP address (IPv4) associated with the network interface.
+ *The date and time the NAT gateway was created.
*/ - Association?: NetworkInterfaceAssociation; + CreateTime?: Date; /** - *The network interface attachment.
+ *The date and time the NAT gateway was deleted, if applicable.
*/ - Attachment?: NetworkInterfaceAttachment; + DeleteTime?: Date; /** - *The Availability Zone.
+ *If the NAT gateway could not be created, specifies the error code for the failure.
+ * (InsufficientFreeAddressesInSubnet | Gateway.NotAttached |
+ * InvalidAllocationID.NotFound | Resource.AlreadyAssociated |
+ * InternalError | InvalidSubnetID.NotFound)
A description.
+ *If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
+ *For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
+ *For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
+ *For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
+ *For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
+ *For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
+ *For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."
+ *Any security groups for the network interface.
+ *Information about the IP addresses and network interface associated with the NAT gateway.
*/ - Groups?: GroupIdentifier[]; + NatGatewayAddresses?: NatGatewayAddress[]; /** - *The type of network interface.
+ *The ID of the NAT gateway.
*/ - InterfaceType?: NetworkInterfaceType | string; + NatGatewayId?: string; /** - *The IPv6 addresses associated with the network interface.
+ *Reserved. If you need to sustain traffic greater than the documented limits, contact us through + * the Support Center.
+ */ + ProvisionedBandwidth?: ProvisionedBandwidth; + + /** + *The state of the NAT gateway.
+ *
+ * pending: The NAT gateway is being created and is not ready to process
+ * traffic.
+ * failed: The NAT gateway could not be created. Check the
+ * failureCode and failureMessage fields for the reason.
+ * available: The NAT gateway is able to process traffic. This status remains
+ * until you delete the NAT gateway, and does not indicate the health of the NAT gateway.
+ * deleting: The NAT gateway is in the process of being terminated and may
+ * still be processing traffic.
+ * deleted: The NAT gateway has been terminated and is no longer processing
+ * traffic.
The ID of the subnet in which the NAT gateway is located.
*/ - Ipv6Addresses?: NetworkInterfaceIpv6Address[]; + SubnetId?: string; /** - *The MAC address.
+ *The ID of the VPC in which the NAT gateway is located.
*/ - MacAddress?: string; + VpcId?: string; /** - *The ID of the network interface.
+ *The tags for the NAT gateway.
*/ - NetworkInterfaceId?: string; + Tags?: Tag[]; /** - *The Amazon Resource Name (ARN) of the Outpost.
+ *Indicates whether the NAT gateway supports public or private connectivity.
*/ - OutpostArn?: string; + ConnectivityType?: ConnectivityType | string; +} +export namespace NatGateway { /** - *The Amazon Web Services account ID of the owner of the network interface.
+ * @internal */ - OwnerId?: string; + export const filterSensitiveLog = (obj: NatGateway): any => ({ + ...obj, + }); +} +export interface CreateNatGatewayResult { /** - *The private DNS name.
+ *Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
*/ - PrivateDnsName?: string; + ClientToken?: string; /** - *The IPv4 address of the network interface within the subnet.
+ *Information about the NAT gateway.
*/ - PrivateIpAddress?: string; + NatGateway?: NatGateway; +} +export namespace CreateNatGatewayResult { /** - *The private IPv4 addresses associated with the network interface.
+ * @internal */ - PrivateIpAddresses?: NetworkInterfacePrivateIpAddress[]; + export const filterSensitiveLog = (obj: CreateNatGatewayResult): any => ({ + ...obj, + }); +} +export interface CreateNetworkAclRequest { /** - *The IPv4 prefixes that are assigned to the network interface.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The IPv6 prefixes that are assigned to the network interface.
+ *The ID of the VPC.
*/ - Ipv6Prefixes?: Ipv6PrefixSpecification[]; + VpcId: string | undefined; /** - *The alias or Amazon Web Services account ID of the principal or service that created the network interface.
+ *The tags to assign to the network ACL.
*/ - RequesterId?: string; + TagSpecifications?: TagSpecification[]; +} +export namespace CreateNetworkAclRequest { /** - *Indicates whether the network interface is being managed by Amazon Web Services.
+ * @internal */ - RequesterManaged?: boolean; + export const filterSensitiveLog = (obj: CreateNetworkAclRequest): any => ({ + ...obj, + }); +} +/** + *Describes an association between a network ACL and a subnet.
+ */ +export interface NetworkAclAssociation { /** - *Indicates whether source/destination checking is enabled.
+ *The ID of the association between a network ACL and a subnet.
*/ - SourceDestCheck?: boolean; + NetworkAclAssociationId?: string; /** - *The status of the network interface.
+ *The ID of the network ACL.
*/ - Status?: NetworkInterfaceStatus | string; + NetworkAclId?: string; /** *The ID of the subnet.
*/ SubnetId?: string; +} +export namespace NetworkAclAssociation { /** - *Any tags assigned to the network interface.
+ * @internal */ - TagSet?: Tag[]; + export const filterSensitiveLog = (obj: NetworkAclAssociation): any => ({ + ...obj, + }); +} +/** + *Describes the ICMP type and code.
+ */ +export interface IcmpTypeCode { /** - *The ID of the VPC.
+ *The ICMP code. A value of -1 means all codes for the specified ICMP type.
*/ - VpcId?: string; + Code?: number; + + /** + *The ICMP type. A value of -1 means all types.
+ */ + Type?: number; } -export namespace NetworkInterface { +export namespace IcmpTypeCode { /** * @internal */ - export const filterSensitiveLog = (obj: NetworkInterface): any => ({ + export const filterSensitiveLog = (obj: IcmpTypeCode): any => ({ ...obj, }); } /** - *Contains the output of CreateNetworkInterface.
+ *Describes a range of ports.
*/ -export interface CreateNetworkInterfaceResult { +export interface PortRange { /** - *Information about the network interface.
+ *The first port in the range.
*/ - NetworkInterface?: NetworkInterface; + From?: number; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The last port in the range.
*/ - ClientToken?: string; + To?: number; } -export namespace CreateNetworkInterfaceResult { +export namespace PortRange { /** * @internal */ - export const filterSensitiveLog = (obj: CreateNetworkInterfaceResult): any => ({ + export const filterSensitiveLog = (obj: PortRange): any => ({ ...obj, }); } -export type InterfacePermissionType = "EIP-ASSOCIATE" | "INSTANCE-ATTACH"; +export type RuleAction = "allow" | "deny"; /** - *Contains the parameters for CreateNetworkInterfacePermission.
+ *Describes an entry in a network ACL.
*/ -export interface CreateNetworkInterfacePermissionRequest { +export interface NetworkAclEntry { /** - *The ID of the network interface.
+ *The IPv4 network range to allow or deny, in CIDR notation.
*/ - NetworkInterfaceId: string | undefined; + CidrBlock?: string; /** - *The Amazon Web Services account ID.
+ *Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
*/ - AwsAccountId?: string; + Egress?: boolean; /** - *The Amazon Web Service. Currently not supported.
+ *ICMP protocol: The ICMP type and code.
*/ - AwsService?: string; + IcmpTypeCode?: IcmpTypeCode; /** - *The type of permission to grant.
+ *The IPv6 network range to allow or deny, in CIDR notation.
*/ - Permission: InterfacePermissionType | string | undefined; + Ipv6CidrBlock?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
TCP or UDP protocols: The range of ports the rule applies to.
*/ - DryRun?: boolean; -} + PortRange?: PortRange; -export namespace CreateNetworkInterfacePermissionRequest { /** - * @internal + *The protocol number. A value of "-1" means all protocols.
*/ - export const filterSensitiveLog = (obj: CreateNetworkInterfacePermissionRequest): any => ({ - ...obj, - }); -} - -export type NetworkInterfacePermissionStateCode = "granted" | "pending" | "revoked" | "revoking"; + Protocol?: string; -/** - *Describes the state of a network interface permission.
- */ -export interface NetworkInterfacePermissionState { /** - *The state of the permission.
+ *Indicates whether to allow or deny the traffic that matches the rule.
*/ - State?: NetworkInterfacePermissionStateCode | string; + RuleAction?: RuleAction | string; /** - *A status message, if applicable.
+ *The rule number for the entry. ACL entries are processed in ascending order by rule number.
*/ - StatusMessage?: string; + RuleNumber?: number; } -export namespace NetworkInterfacePermissionState { +export namespace NetworkAclEntry { /** * @internal */ - export const filterSensitiveLog = (obj: NetworkInterfacePermissionState): any => ({ + export const filterSensitiveLog = (obj: NetworkAclEntry): any => ({ ...obj, }); } /** - *Describes a permission for a network interface.
+ *Describes a network ACL.
*/ -export interface NetworkInterfacePermission { +export interface NetworkAcl { /** - *The ID of the network interface permission.
+ *Any associations between the network ACL and one or more subnets
*/ - NetworkInterfacePermissionId?: string; + Associations?: NetworkAclAssociation[]; /** - *The ID of the network interface.
+ *One or more entries (rules) in the network ACL.
*/ - NetworkInterfaceId?: string; + Entries?: NetworkAclEntry[]; /** - *The Amazon Web Services account ID.
+ *Indicates whether this is the default network ACL for the VPC.
*/ - AwsAccountId?: string; + IsDefault?: boolean; /** - *The Amazon Web Service.
+ *The ID of the network ACL.
*/ - AwsService?: string; + NetworkAclId?: string; /** - *The type of permission.
+ *Any tags assigned to the network ACL.
*/ - Permission?: InterfacePermissionType | string; + Tags?: Tag[]; /** - *Information about the state of the permission.
+ *The ID of the VPC for the network ACL.
*/ - PermissionState?: NetworkInterfacePermissionState; + VpcId?: string; + + /** + *The ID of the Amazon Web Services account that owns the network ACL.
+ */ + OwnerId?: string; } -export namespace NetworkInterfacePermission { +export namespace NetworkAcl { /** * @internal */ - export const filterSensitiveLog = (obj: NetworkInterfacePermission): any => ({ + export const filterSensitiveLog = (obj: NetworkAcl): any => ({ ...obj, }); } -/** - *Contains the output of CreateNetworkInterfacePermission.
- */ -export interface CreateNetworkInterfacePermissionResult { +export interface CreateNetworkAclResult { /** - *Information about the permission for the network interface.
+ *Information about the network ACL.
*/ - InterfacePermission?: NetworkInterfacePermission; + NetworkAcl?: NetworkAcl; } -export namespace CreateNetworkInterfacePermissionResult { +export namespace CreateNetworkAclResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateNetworkInterfacePermissionResult): any => ({ + export const filterSensitiveLog = (obj: CreateNetworkAclResult): any => ({ ...obj, }); } -export type PlacementStrategy = "cluster" | "partition" | "spread"; +export interface CreateNetworkAclEntryRequest { + /** + *The IPv4 network range to allow or deny, in CIDR notation (for example
+ * 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -4403,119 +4784,101 @@ export interface CreatePlacementGroupRequest {
DryRun?: boolean;
/**
- *
A name for the placement group. Must be unique within the scope of your account for - * the Region.
- *Constraints: Up to 255 ASCII characters
- */ - GroupName?: string; - - /** - *The placement strategy.
- */ - Strategy?: PlacementStrategy | string; - - /** - *The number of partitions. Valid only when Strategy is
- * set to partition.
The tags to apply to the new placement group.
+ *Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
*/ - TagSpecifications?: TagSpecification[]; -} + Egress: boolean | undefined; -export namespace CreatePlacementGroupRequest { /** - * @internal + *ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol + * 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.
*/ - export const filterSensitiveLog = (obj: CreatePlacementGroupRequest): any => ({ - ...obj, - }); -} - -export type PlacementGroupState = "available" | "deleted" | "deleting" | "pending"; + IcmpTypeCode?: IcmpTypeCode; -/** - *Describes a placement group.
- */ -export interface PlacementGroup { /** - *The name of the placement group.
+ *The IPv6 network range to allow or deny, in CIDR notation (for example
+ * 2001:db8:1234:1a00::/64).
The state of the placement group.
+ *The ID of the network ACL.
*/ - State?: PlacementGroupState | string; + NetworkAclId: string | undefined; /** - *The placement strategy.
+ *TCP or UDP protocols: The range of ports the rule applies to. + * Required if specifying protocol 6 (TCP) or 17 (UDP).
*/ - Strategy?: PlacementStrategy | string; + PortRange?: PortRange; /** - *The number of partitions. Valid only if strategy is
- * set to partition.
The protocol number. A value of "-1" means all protocols. If you specify "-1" or a + * protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is + * allowed, regardless of any ports or ICMP types or codes that you specify. If you specify + * protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and + * codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) + * and specify an IPv6 CIDR block, you must specify an ICMP type and code.
*/ - PartitionCount?: number; + Protocol: string | undefined; /** - *The ID of the placement group.
+ *Indicates whether to allow or deny the traffic that matches the rule.
*/ - GroupId?: string; + RuleAction: RuleAction | string | undefined; /** - *Any tags applied to the placement group.
+ *The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
+ *Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.
*/ - Tags?: Tag[]; + RuleNumber: number | undefined; } -export namespace PlacementGroup { +export namespace CreateNetworkAclEntryRequest { /** * @internal */ - export const filterSensitiveLog = (obj: PlacementGroup): any => ({ + export const filterSensitiveLog = (obj: CreateNetworkAclEntryRequest): any => ({ ...obj, }); } -export interface CreatePlacementGroupResult { +export type Protocol = "tcp" | "udp"; + +export interface CreateNetworkInsightsPathRequest { /** - *Describes a placement group.
+ *The IP address of the Amazon Web Services resource that is the source of the path.
*/ - PlacementGroup?: PlacementGroup; -} + SourceIp?: string; -export namespace CreatePlacementGroupResult { /** - * @internal + *The IP address of the Amazon Web Services resource that is the destination of the path.
*/ - export const filterSensitiveLog = (obj: CreatePlacementGroupResult): any => ({ - ...obj, - }); -} + DestinationIp?: string; -export interface CreateReplaceRootVolumeTaskRequest { /** - *The ID of the instance for which to replace the root volume.
+ *The Amazon Web Services resource that is the source of the path.
*/ - InstanceId: string | undefined; + Source: string | undefined; /** - *The ID of the snapshot from which to restore the replacement root volume. If you want to - * restore the volume to the initial launch state, omit this parameter.
+ *The Amazon Web Services resource that is the destination of the path.
*/ - SnapshotId?: string; + Destination: string | undefined; /** - *Unique, case-sensitive identifier you provide to ensure the idempotency of the request. - * If you do not specify a client token, a randomly generated token is used for the request - * to ensure idempotency. For more information, see Ensuring idempotency.
+ *The protocol.
*/ - ClientToken?: string; + Protocol: Protocol | string | undefined; + + /** + *The destination port.
+ */ + DestinationPort?: number; + + /** + *The tags to add to the path.
+ */ + TagSpecifications?: TagSpecification[]; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -4525,1501 +4888,1594 @@ export interface CreateReplaceRootVolumeTaskRequest { DryRun?: boolean; /** - *
The tags to apply to the root volume replacement task.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, + * see How to ensure idempotency.
*/ - TagSpecifications?: TagSpecification[]; + ClientToken?: string; } -export namespace CreateReplaceRootVolumeTaskRequest { +export namespace CreateNetworkInsightsPathRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateReplaceRootVolumeTaskRequest): any => ({ + export const filterSensitiveLog = (obj: CreateNetworkInsightsPathRequest): any => ({ ...obj, }); } -export enum ReplaceRootVolumeTaskState { - failed = "failed", - failed_detached = "failed-detached", - failing = "failing", - in_progress = "in-progress", - pending = "pending", - succeeded = "succeeded", -} - /** - *Information about a root volume replacement task.
+ *Describes a path.
*/ -export interface ReplaceRootVolumeTask { +export interface NetworkInsightsPath { /** - *The ID of the root volume replacement task.
+ *The ID of the path.
*/ - ReplaceRootVolumeTaskId?: string; + NetworkInsightsPathId?: string; /** - *The ID of the instance for which the root volume replacement task was created.
+ *The Amazon Resource Name (ARN) of the path.
*/ - InstanceId?: string; + NetworkInsightsPathArn?: string; /** - *The state of the task. The task can be in one of the following states:
- *
- * pending - the replacement volume is being created.
- * in-progress - the original volume is being detached and the
- * replacement volume is being attached.
- * succeeded - the replacement volume has been successfully attached
- * to the instance and the instance is available.
- * failing - the replacement task is in the process of failing.
- * failed - the replacement task has failed but the original root
- * volume is still attached.
- * failing-detached - the replacement task is in the process of failing.
- * The instance might have no root volume attached.
- * failed-detached - the replacement task has failed and the instance
- * has no root volume attached.
The time stamp when the path was created.
*/ - TaskState?: ReplaceRootVolumeTaskState | string; + CreatedDate?: Date; /** - *The time the task was started.
+ *The Amazon Web Services resource that is the source of the path.
*/ - StartTime?: string; + Source?: string; /** - *The time the task completed.
+ *The Amazon Web Services resource that is the destination of the path.
*/ - CompleteTime?: string; + Destination?: string; /** - *The tags assigned to the task.
+ *The IP address of the Amazon Web Services resource that is the source of the path.
+ */ + SourceIp?: string; + + /** + *The IP address of the Amazon Web Services resource that is the destination of the path.
+ */ + DestinationIp?: string; + + /** + *The protocol.
+ */ + Protocol?: Protocol | string; + + /** + *The destination port.
+ */ + DestinationPort?: number; + + /** + *The tags associated with the path.
*/ Tags?: Tag[]; } -export namespace ReplaceRootVolumeTask { +export namespace NetworkInsightsPath { /** * @internal */ - export const filterSensitiveLog = (obj: ReplaceRootVolumeTask): any => ({ + export const filterSensitiveLog = (obj: NetworkInsightsPath): any => ({ ...obj, }); } -export interface CreateReplaceRootVolumeTaskResult { +export interface CreateNetworkInsightsPathResult { /** - *Information about the root volume replacement task.
+ *Information about the path.
*/ - ReplaceRootVolumeTask?: ReplaceRootVolumeTask; + NetworkInsightsPath?: NetworkInsightsPath; } -export namespace CreateReplaceRootVolumeTaskResult { +export namespace CreateNetworkInsightsPathResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateReplaceRootVolumeTaskResult): any => ({ + export const filterSensitiveLog = (obj: CreateNetworkInsightsPathResult): any => ({ ...obj, }); } +export type NetworkInterfaceCreationType = "branch" | "efa" | "trunk"; + /** - *Describes the price for a Reserved Instance.
+ *Contains the parameters for CreateNetworkInterface.
*/ -export interface PriceScheduleSpecification { +export interface CreateNetworkInterfaceRequest { /** - *The currency for transacting the Reserved Instance resale.
- * At this time, the only supported currency is USD.
A description for the network interface.
+ */ + Description?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The IDs of one or more security groups.
+ */ + Groups?: string[]; + + /** + *The number of IPv6 addresses to assign to a network interface. Amazon EC2
+ * automatically selects the IPv6 addresses from the subnet range. You can't use this
+ * option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set
+ * to true, you can specify 0 to override this setting.
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. + * You can't use this option if you're specifying a number of IPv6 addresses.
+ */ + Ipv6Addresses?: InstanceIpv6Address[]; + + /** + *The primary private IPv4 address of the network interface. If you don't specify an
+ * IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you
+ * specify an IP address, you cannot indicate any IP addresses specified in
+ * privateIpAddresses as primary (only one IP address can be designated as
+ * primary).
One or more private IPv4 addresses.
*/ - CurrencyCode?: CurrencyCodeValues | string; + PrivateIpAddresses?: PrivateIpAddressSpecification[]; /** - *The fixed price for the term.
+ *The number of secondary private IPv4 addresses to assign to a network interface. When
+ * you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses
+ * within the subnet's IPv4 CIDR range. You can't specify this option and specify more than
+ * one private IP address using privateIpAddresses.
The number of IP addresses you can assign to a network interface varies by instance + * type. For more information, see IP Addresses Per ENI Per + * Instance Type in the Amazon Virtual Private Cloud User Guide.
*/ - Price?: number; + SecondaryPrivateIpAddressCount?: number; /** - *The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
+ *One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.
The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.
Contains the parameters for CreateReservedInstancesListing.
- */ -export interface CreateReservedInstancesListingRequest { /** - *Unique, case-sensitive identifier you provide to ensure idempotency of your - * listings. This helps avoid duplicate listings. For more information, see - * Ensuring Idempotency.
+ *One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.
+ *The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.
A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.
+ *Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify
+ * efa. For more information, see
+ * Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide. To create a trunk network interface, specify
+ * efa. For more information, see
+ * Network interface trunking in the Amazon Elastic Compute Cloud User Guide.
The ID of the active Standard Reserved Instance.
+ *The ID of the subnet to associate with the network interface.
*/ - ReservedInstancesId: string | undefined; -} + SubnetId: string | undefined; -export namespace CreateReservedInstancesListingRequest { /** - * @internal + *The tags to apply to the new network interface.
*/ - export const filterSensitiveLog = (obj: CreateReservedInstancesListingRequest): any => ({ - ...obj, - }); -} + TagSpecifications?: TagSpecification[]; -/** - *Contains the output of CreateReservedInstancesListing.
- */ -export interface CreateReservedInstancesListingResult { /** - *Information about the Standard Reserved Instance listing.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
*/ - ReservedInstancesListings?: ReservedInstancesListing[]; + ClientToken?: string; } -export namespace CreateReservedInstancesListingResult { +export namespace CreateNetworkInterfaceRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateReservedInstancesListingResult): any => ({ + export const filterSensitiveLog = (obj: CreateNetworkInterfaceRequest): any => ({ ...obj, }); } -export interface CreateRestoreImageTaskRequest { +/** + *Describes association information for an Elastic IP address (IPv4 only), or a Carrier + * IP address (for a network interface which resides in a subnet in a Wavelength + * Zone).
+ */ +export interface NetworkInterfaceAssociation { /** - *The name of the Amazon S3 bucket that contains the stored AMI object.
+ *The allocation ID.
*/ - Bucket: string | undefined; + AllocationId?: string; /** - *The name of the stored AMI object in the bucket.
+ *The association ID.
*/ - ObjectKey: string | undefined; + AssociationId?: string; /** - *The name for the restored AMI. The name must be unique for AMIs in the Region for this - * account. If you do not provide a name, the new AMI gets the same name as the original - * AMI.
+ *The ID of the Elastic IP address owner.
*/ - Name?: string; + IpOwnerId?: string; /** - *The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the - * snapshots, or both.
- *To tag the AMI, the value for ResourceType must be image.
To
- * tag the snapshots, the value for ResourceType must be snapshot. The
- * same tag is applied to all of the snapshots that are created.
The public DNS name.
*/ - TagSpecifications?: TagSpecification[]; + PublicDnsName?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The address of the Elastic IP address bound to the network + * interface.
*/ - DryRun?: boolean; -} + PublicIp?: string; -export namespace CreateRestoreImageTaskRequest { /** - * @internal + *The customer-owned IP address associated with the network interface.
*/ - export const filterSensitiveLog = (obj: CreateRestoreImageTaskRequest): any => ({ - ...obj, - }); -} + CustomerOwnedIp?: string; -export interface CreateRestoreImageTaskResult { /** - *The AMI ID.
+ *The carrier IP address associated with the network interface.
+ *This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
*/ - ImageId?: string; + CarrierIp?: string; } -export namespace CreateRestoreImageTaskResult { +export namespace NetworkInterfaceAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: CreateRestoreImageTaskResult): any => ({ + export const filterSensitiveLog = (obj: NetworkInterfaceAssociation): any => ({ ...obj, }); } -export interface CreateRouteRequest { - /** - *The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
- */ - DestinationIpv6CidrBlock?: string; - +/** + *Describes a network interface attachment.
+ */ +export interface NetworkInterfaceAttachment { /** - *The ID of a prefix list used for the destination match.
+ *The timestamp indicating when the attachment initiated.
*/ - DestinationPrefixListId?: string; + AttachTime?: Date; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the network interface attachment.
*/ - DryRun?: boolean; + AttachmentId?: string; /** - *The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
+ *Indicates whether the network interface is deleted when the instance is terminated.
*/ - VpcEndpointId?: string; + DeleteOnTermination?: boolean; /** - *[IPv6 traffic only] The ID of an egress-only internet gateway.
+ *The device index of the network interface attachment on the instance.
*/ - EgressOnlyInternetGatewayId?: string; + DeviceIndex?: number; /** - *The ID of an internet gateway or virtual private gateway attached to your - * VPC.
+ *The index of the network card.
*/ - GatewayId?: string; + NetworkCardIndex?: number; /** - *The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
+ *The ID of the instance.
*/ InstanceId?: string; /** - *[IPv4 traffic only] The ID of a NAT gateway.
+ *The Amazon Web Services account ID of the owner of the instance.
*/ - NatGatewayId?: string; + InstanceOwnerId?: string; /** - *The ID of a transit gateway.
+ *The attachment state.
*/ - TransitGatewayId?: string; + Status?: AttachmentStatus | string; +} +export namespace NetworkInterfaceAttachment { /** - *The ID of the local gateway.
+ * @internal */ - LocalGatewayId?: string; + export const filterSensitiveLog = (obj: NetworkInterfaceAttachment): any => ({ + ...obj, + }); +} +/** + *Describes a security group.
+ */ +export interface GroupIdentifier { /** - *The ID of the carrier gateway.
- *You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
+ *The name of the security group.
*/ - CarrierGatewayId?: string; + GroupName?: string; /** - *The ID of a network interface.
+ *The ID of the security group.
*/ - NetworkInterfaceId?: string; + GroupId?: string; +} +export namespace GroupIdentifier { /** - *The ID of the route table for the route.
+ * @internal */ - RouteTableId: string | undefined; + export const filterSensitiveLog = (obj: GroupIdentifier): any => ({ + ...obj, + }); +} + +export type NetworkInterfaceType = "efa" | "interface" | "natGateway" | "trunk"; +/** + *Describes an IPv6 address associated with a network interface.
+ */ +export interface NetworkInterfaceIpv6Address { /** - *The ID of a VPC peering connection.
+ *The IPv6 address.
*/ - VpcPeeringConnectionId?: string; + Ipv6Address?: string; } -export namespace CreateRouteRequest { +export namespace NetworkInterfaceIpv6Address { /** * @internal */ - export const filterSensitiveLog = (obj: CreateRouteRequest): any => ({ + export const filterSensitiveLog = (obj: NetworkInterfaceIpv6Address): any => ({ ...obj, }); } -export interface CreateRouteResult { +/** + *Describes the IPv6 prefix.
+ */ +export interface Ipv6PrefixSpecification { /** - *Returns true if the request succeeds; otherwise, it returns an error.
The IPv6 prefix.
*/ - Return?: boolean; + Ipv6Prefix?: string; } -export namespace CreateRouteResult { +export namespace Ipv6PrefixSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: CreateRouteResult): any => ({ + export const filterSensitiveLog = (obj: Ipv6PrefixSpecification): any => ({ ...obj, }); } -export interface CreateRouteTableRequest { +/** + *Describes the private IPv4 address of a network interface.
+ */ +export interface NetworkInterfacePrivateIpAddress { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The association information for an Elastic IP address (IPv4) associated with the network interface.
*/ - DryRun?: boolean; + Association?: NetworkInterfaceAssociation; + + /** + *Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.
+ */ + Primary?: boolean; /** - *The ID of the VPC.
+ *The private DNS name.
*/ - VpcId: string | undefined; + PrivateDnsName?: string; /** - *The tags to assign to the route table.
+ *The private IPv4 address.
*/ - TagSpecifications?: TagSpecification[]; + PrivateIpAddress?: string; } -export namespace CreateRouteTableRequest { +export namespace NetworkInterfacePrivateIpAddress { /** * @internal */ - export const filterSensitiveLog = (obj: CreateRouteTableRequest): any => ({ + export const filterSensitiveLog = (obj: NetworkInterfacePrivateIpAddress): any => ({ ...obj, }); } +export type NetworkInterfaceStatus = "associated" | "attaching" | "available" | "detaching" | "in-use"; + /** - *Describes an association between a route table and a subnet or gateway.
+ *Describes a network interface.
*/ -export interface RouteTableAssociation { +export interface NetworkInterface { /** - *Indicates whether this is the main route table.
+ *The association information for an Elastic IP address (IPv4) associated with the network interface.
*/ - Main?: boolean; + Association?: NetworkInterfaceAssociation; /** - *The ID of the association.
+ *The network interface attachment.
*/ - RouteTableAssociationId?: string; + Attachment?: NetworkInterfaceAttachment; /** - *The ID of the route table.
+ *The Availability Zone.
*/ - RouteTableId?: string; + AvailabilityZone?: string; /** - *The ID of the subnet. A subnet ID is not returned for an implicit association.
+ *A description.
*/ - SubnetId?: string; + Description?: string; /** - *The ID of the internet gateway or virtual private gateway.
+ *Any security groups for the network interface.
*/ - GatewayId?: string; + Groups?: GroupIdentifier[]; /** - *The state of the association.
+ *The type of network interface.
*/ - AssociationState?: RouteTableAssociationState; -} + InterfaceType?: NetworkInterfaceType | string; -export namespace RouteTableAssociation { /** - * @internal + *The IPv6 addresses associated with the network interface.
*/ - export const filterSensitiveLog = (obj: RouteTableAssociation): any => ({ - ...obj, - }); -} + Ipv6Addresses?: NetworkInterfaceIpv6Address[]; -/** - *Describes a virtual private gateway propagating route.
- */ -export interface PropagatingVgw { /** - *The ID of the virtual private gateway.
+ *The MAC address.
*/ - GatewayId?: string; -} + MacAddress?: string; -export namespace PropagatingVgw { /** - * @internal + *The ID of the network interface.
*/ - export const filterSensitiveLog = (obj: PropagatingVgw): any => ({ - ...obj, - }); -} - -export type RouteOrigin = "CreateRoute" | "CreateRouteTable" | "EnableVgwRoutePropagation"; - -export type RouteState = "active" | "blackhole"; + NetworkInterfaceId?: string; -/** - *Describes a route in a route table.
- */ -export interface Route { /** - *The IPv4 CIDR block used for the destination match.
+ *The Amazon Resource Name (ARN) of the Outpost.
*/ - DestinationCidrBlock?: string; + OutpostArn?: string; /** - *The IPv6 CIDR block used for the destination match.
+ *The Amazon Web Services account ID of the owner of the network interface.
*/ - DestinationIpv6CidrBlock?: string; + OwnerId?: string; /** - *The prefix of the Amazon Web Service.
+ *The private DNS name.
*/ - DestinationPrefixListId?: string; + PrivateDnsName?: string; /** - *The ID of the egress-only internet gateway.
+ *The IPv4 address of the network interface within the subnet.
*/ - EgressOnlyInternetGatewayId?: string; + PrivateIpAddress?: string; /** - *The ID of a gateway attached to your VPC.
+ *The private IPv4 addresses associated with the network interface.
*/ - GatewayId?: string; + PrivateIpAddresses?: NetworkInterfacePrivateIpAddress[]; /** - *The ID of a NAT instance in your VPC.
+ *The IPv4 prefixes that are assigned to the network interface.
*/ - InstanceId?: string; + Ipv4Prefixes?: Ipv4PrefixSpecification[]; /** - *The ID of Amazon Web Services account that owns the instance.
+ *The IPv6 prefixes that are assigned to the network interface.
*/ - InstanceOwnerId?: string; + Ipv6Prefixes?: Ipv6PrefixSpecification[]; /** - *The ID of a NAT gateway.
+ *The alias or Amazon Web Services account ID of the principal or service that created the network interface.
*/ - NatGatewayId?: string; + RequesterId?: string; /** - *The ID of a transit gateway.
+ *Indicates whether the network interface is being managed by Amazon Web Services.
*/ - TransitGatewayId?: string; + RequesterManaged?: boolean; /** - *The ID of the local gateway.
+ *Indicates whether source/destination checking is enabled.
*/ - LocalGatewayId?: string; + SourceDestCheck?: boolean; /** - *The ID of the carrier gateway.
+ *The status of the network interface.
*/ - CarrierGatewayId?: string; + Status?: NetworkInterfaceStatus | string; /** - *The ID of the network interface.
+ *The ID of the subnet.
*/ - NetworkInterfaceId?: string; + SubnetId?: string; /** - *Describes how the route was created.
- *
- * CreateRouteTable - The route was automatically created when the route table was created.
- * CreateRoute - The route was manually added to the route table.
- * EnableVgwRoutePropagation - The route was propagated by route propagation.
Any tags assigned to the network interface.
*/ - Origin?: RouteOrigin | string; + TagSet?: Tag[]; /** - *The state of the route. The blackhole state indicates that the
- * route's target isn't available (for example, the specified gateway isn't attached to the
- * VPC, or the specified NAT instance has been terminated).
The ID of the VPC.
*/ - State?: RouteState | string; + VpcId?: string; /** - *The ID of a VPC peering connection.
+ *Indicates whether a network interface with an IPv6 address is unreachable from the
+ * public internet. If the value is true, inbound traffic from the internet
+ * is dropped and you cannot assign an elastic IP address to the network interface. The
+ * network interface is reachable from peered VPCs and resources connected through a
+ * transit gateway, including on-premises networks.
Describes a route table.
+ *Contains the output of CreateNetworkInterface.
*/ -export interface RouteTable { +export interface CreateNetworkInterfaceResult { /** - *The associations between the route table and one or more subnets or a gateway.
+ *Information about the network interface.
*/ - Associations?: RouteTableAssociation[]; + NetworkInterface?: NetworkInterface; /** - *Any virtual private gateway (VGW) propagating routes.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the route table.
+ * @internal */ - RouteTableId?: string; + export const filterSensitiveLog = (obj: CreateNetworkInterfaceResult): any => ({ + ...obj, + }); +} + +export type InterfacePermissionType = "EIP-ASSOCIATE" | "INSTANCE-ATTACH"; +/** + *Contains the parameters for CreateNetworkInterfacePermission.
+ */ +export interface CreateNetworkInterfacePermissionRequest { /** - *The routes in the route table.
+ *The ID of the network interface.
*/ - Routes?: Route[]; + NetworkInterfaceId: string | undefined; /** - *Any tags assigned to the route table.
+ *The Amazon Web Services account ID.
*/ - Tags?: Tag[]; + AwsAccountId?: string; /** - *The ID of the VPC.
+ *The Amazon Web Service. Currently not supported.
*/ - VpcId?: string; + AwsService?: string; /** - *The ID of the Amazon Web Services account that owns the route table.
+ *The type of permission to grant.
*/ - OwnerId?: string; + Permission: InterfacePermissionType | string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the state of a network interface permission.
+ */ +export interface NetworkInterfacePermissionState { /** - *Information about the route table.
+ *The state of the permission.
*/ - RouteTable?: RouteTable; + State?: NetworkInterfacePermissionStateCode | string; + + /** + *A status message, if applicable.
+ */ + StatusMessage?: string; } -export namespace CreateRouteTableResult { +export namespace NetworkInterfacePermissionState { /** * @internal */ - export const filterSensitiveLog = (obj: CreateRouteTableResult): any => ({ + export const filterSensitiveLog = (obj: NetworkInterfacePermissionState): any => ({ ...obj, }); } -export interface CreateSecurityGroupRequest { +/** + *Describes a permission for a network interface.
+ */ +export interface NetworkInterfacePermission { /** - *A description for the security group. This is informational only.
- *Constraints: Up to 255 characters in length
- *Constraints for EC2-Classic: ASCII characters
- *Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
+ *The ID of the network interface permission.
*/ - Description: string | undefined; + NetworkInterfacePermissionId?: string; /** - *The name of the security group.
- *Constraints: Up to 255 characters in length. Cannot start with
- * sg-.
Constraints for EC2-Classic: ASCII characters
- *Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
+ *The ID of the network interface.
*/ - GroupName: string | undefined; + NetworkInterfaceId?: string; /** - *[EC2-VPC] The ID of the VPC. Required for EC2-VPC.
+ *The Amazon Web Services account ID.
*/ - VpcId?: string; + AwsAccountId?: string; + + /** + *The Amazon Web Service.
+ */ + AwsService?: string; /** - *The tags to assign to the security group.
+ *The type of permission.
*/ - TagSpecifications?: TagSpecification[]; + Permission?: InterfacePermissionType | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the state of the permission.
*/ - DryRun?: boolean; + PermissionState?: NetworkInterfacePermissionState; } -export namespace CreateSecurityGroupRequest { +export namespace NetworkInterfacePermission { /** * @internal */ - export const filterSensitiveLog = (obj: CreateSecurityGroupRequest): any => ({ + export const filterSensitiveLog = (obj: NetworkInterfacePermission): any => ({ ...obj, }); } -export interface CreateSecurityGroupResult { - /** - *The ID of the security group.
- */ - GroupId?: string; - +/** + *Contains the output of CreateNetworkInterfacePermission.
+ */ +export interface CreateNetworkInterfacePermissionResult { /** - *The tags assigned to the security group.
+ *Information about the permission for the network interface.
*/ - Tags?: Tag[]; + InterfacePermission?: NetworkInterfacePermission; } -export namespace CreateSecurityGroupResult { +export namespace CreateNetworkInterfacePermissionResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateSecurityGroupResult): any => ({ + export const filterSensitiveLog = (obj: CreateNetworkInterfacePermissionResult): any => ({ ...obj, }); } -export interface CreateSnapshotRequest { +export type PlacementStrategy = "cluster" | "partition" | "spread"; + +export interface CreatePlacementGroupRequest { /** - *A description for the snapshot.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The Amazon Resource Name (ARN) of the Outpost on which to create a local - * snapshot.
- *To create a snapshot of a volume in a Region, omit this parameter. The snapshot - * is created in the same Region as the volume.
- *To create a snapshot of a volume on an Outpost and store the snapshot in the - * Region, omit this parameter. The snapshot is created in the Region for the - * Outpost.
- *To create a snapshot of a volume on an Outpost and store the snapshot on an - * Outpost, specify the ARN of the destination Outpost. The snapshot must be created on - * the same Outpost as the volume.
- *For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.
+ *A name for the placement group. Must be unique within the scope of your account for + * the Region.
+ *Constraints: Up to 255 ASCII characters
*/ - OutpostArn?: string; + GroupName?: string; /** - *The ID of the Amazon EBS volume.
+ *The placement strategy.
*/ - VolumeId: string | undefined; + Strategy?: PlacementStrategy | string; /** - *The tags to apply to the snapshot during creation.
+ *The number of partitions. Valid only when Strategy is
+ * set to partition.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The tags to apply to the new placement group.
*/ - DryRun?: boolean; + TagSpecifications?: TagSpecification[]; } -export namespace CreateSnapshotRequest { +export namespace CreatePlacementGroupRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateSnapshotRequest): any => ({ + export const filterSensitiveLog = (obj: CreatePlacementGroupRequest): any => ({ ...obj, }); } -export type SnapshotState = "completed" | "error" | "pending"; +export type PlacementGroupState = "available" | "deleted" | "deleting" | "pending"; /** - *Describes a snapshot.
+ *Describes a placement group.
*/ -export interface Snapshot { - /** - *The data encryption key identifier for the snapshot. This value is a unique identifier - * that corresponds to the data encryption key that was used to encrypt the original volume or - * snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, - * and vice versa, if snapshots share the same data encryption key identifier, then they belong - * to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.
- */ - DataEncryptionKeyId?: string; - +export interface PlacementGroup { /** - *The description for the snapshot.
+ *The name of the placement group.
*/ - Description?: string; + GroupName?: string; /** - *Indicates whether the snapshot is encrypted.
+ *The state of the placement group.
*/ - Encrypted?: boolean; + State?: PlacementGroupState | string; /** - *The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the - * volume encryption key for the parent volume.
+ *The placement strategy.
*/ - KmsKeyId?: string; + Strategy?: PlacementStrategy | string; /** - *The ID of the Amazon Web Services account that owns the EBS snapshot.
+ *The number of partitions. Valid only if strategy is
+ * set to partition.
The progress of the snapshot, as a percentage.
+ *The ID of the placement group.
*/ - Progress?: string; + GroupId?: string; /** - *The ID of the snapshot. Each snapshot receives a unique identifier when it is - * created.
+ *Any tags applied to the placement group.
*/ - SnapshotId?: string; + Tags?: Tag[]; +} +export namespace PlacementGroup { /** - *The time stamp when the snapshot was initiated.
+ * @internal */ - StartTime?: Date; + export const filterSensitiveLog = (obj: PlacementGroup): any => ({ + ...obj, + }); +} +export interface CreatePlacementGroupResult { /** - *The snapshot state.
+ *Describes a placement group.
*/ - State?: SnapshotState | string; + PlacementGroup?: PlacementGroup; +} +export namespace CreatePlacementGroupResult { /** - *Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails - * (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error - * state details to help you diagnose why the error occurred. This parameter is only returned by - * DescribeSnapshots.
+ * @internal */ - StateMessage?: string; + export const filterSensitiveLog = (obj: CreatePlacementGroupResult): any => ({ + ...obj, + }); +} +export interface CreateReplaceRootVolumeTaskRequest { /** - *The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any - * purpose.
+ *The ID of the instance for which to replace the root volume.
*/ - VolumeId?: string; + InstanceId: string | undefined; /** - *The size of the volume, in GiB.
+ *The ID of the snapshot from which to restore the replacement root volume. If you want to + * restore the volume to the initial launch state, omit this parameter.
*/ - VolumeSize?: number; + SnapshotId?: string; /** - *The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not
- * the user-configured Amazon Web Services account alias set using the IAM console.
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. + * If you do not specify a client token, a randomly generated token is used for the request + * to ensure idempotency. For more information, see Ensuring idempotency.
*/ - OwnerAlias?: string; + ClientToken?: string; /** - *The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the - * Amazon Elastic Compute Cloud User Guide.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Any tags assigned to the snapshot.
+ *The tags to apply to the root volume replacement task.
*/ - Tags?: Tag[]; + TagSpecifications?: TagSpecification[]; } -export namespace Snapshot { +export namespace CreateReplaceRootVolumeTaskRequest { /** * @internal */ - export const filterSensitiveLog = (obj: Snapshot): any => ({ + export const filterSensitiveLog = (obj: CreateReplaceRootVolumeTaskRequest): any => ({ ...obj, }); } -export type CopyTagsFromSource = "volume"; +export enum ReplaceRootVolumeTaskState { + failed = "failed", + failed_detached = "failed-detached", + failing = "failing", + in_progress = "in-progress", + pending = "pending", + succeeded = "succeeded", +} /** - *The instance details to specify which volumes should be snapshotted.
+ *Information about a root volume replacement task.
*/ -export interface InstanceSpecification { +export interface ReplaceRootVolumeTask { /** - *The instance to specify which volumes should be snapshotted.
+ *The ID of the root volume replacement task.
+ */ + ReplaceRootVolumeTaskId?: string; + + /** + *The ID of the instance for which the root volume replacement task was created.
*/ InstanceId?: string; /** - *Excludes the root volume from being snapshotted.
+ *The state of the task. The task can be in one of the following states:
+ *
+ * pending - the replacement volume is being created.
+ * in-progress - the original volume is being detached and the
+ * replacement volume is being attached.
+ * succeeded - the replacement volume has been successfully attached
+ * to the instance and the instance is available.
+ * failing - the replacement task is in the process of failing.
+ * failed - the replacement task has failed but the original root
+ * volume is still attached.
+ * failing-detached - the replacement task is in the process of failing.
+ * The instance might have no root volume attached.
+ * failed-detached - the replacement task has failed and the instance
+ * has no root volume attached.
The time the task was started.
+ */ + StartTime?: string; + + /** + *The time the task completed.
+ */ + CompleteTime?: string; + + /** + *The tags assigned to the task.
*/ - ExcludeBootVolume?: boolean; + Tags?: Tag[]; } -export namespace InstanceSpecification { +export namespace ReplaceRootVolumeTask { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceSpecification): any => ({ + export const filterSensitiveLog = (obj: ReplaceRootVolumeTask): any => ({ ...obj, }); } -export interface CreateSnapshotsRequest { - /** - *A description propagated to every snapshot specified by the instance.
- */ - Description?: string; - +export interface CreateReplaceRootVolumeTaskResult { /** - *The instance to specify which volumes should be included in the snapshots.
+ *Information about the root volume replacement task.
*/ - InstanceSpecification: InstanceSpecification | undefined; + ReplaceRootVolumeTask?: ReplaceRootVolumeTask; +} +export namespace CreateReplaceRootVolumeTaskResult { /** - *The Amazon Resource Name (ARN) of the Outpost on which to create the local - * snapshots.
- *To create snapshots from an instance in a Region, omit this parameter. The - * snapshots are created in the same Region as the instance.
- *To create snapshots from an instance on an Outpost and store the snapshots - * in the Region, omit this parameter. The snapshots are created in the Region - * for the Outpost.
- *To create snapshots from an instance on an Outpost and store the snapshots - * on an Outpost, specify the ARN of the destination Outpost. The snapshots must - * be created on the same Outpost as the instance.
- *For more information, see - * Create multi-volume local snapshots from instances on an Outpost in the - * Amazon Elastic Compute Cloud User Guide.
+ * @internal */ - OutpostArn?: string; + export const filterSensitiveLog = (obj: CreateReplaceRootVolumeTaskResult): any => ({ + ...obj, + }); +} +/** + *Describes the price for a Reserved Instance.
+ */ +export interface PriceScheduleSpecification { /** - *Tags to apply to every snapshot specified by the instance.
+ *The currency for transacting the Reserved Instance resale.
+ * At this time, the only supported currency is USD.
Checks whether you have the required permissions for the action, without 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 fixed price for the term.
*/ - DryRun?: boolean; + Price?: number; /** - *Copies the tags from the specified volume to corresponding snapshot.
+ *The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
*/ - CopyTagsFromSource?: CopyTagsFromSource | string; + Term?: number; } -export namespace CreateSnapshotsRequest { +export namespace PriceScheduleSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: CreateSnapshotsRequest): any => ({ + export const filterSensitiveLog = (obj: PriceScheduleSpecification): any => ({ ...obj, }); } /** - *Information about a snapshot.
+ *Contains the parameters for CreateReservedInstancesListing.
*/ -export interface SnapshotInfo { +export interface CreateReservedInstancesListingRequest { /** - *Description specified by the CreateSnapshotRequest that has been applied to all - * snapshots.
+ *Unique, case-sensitive identifier you provide to ensure idempotency of your + * listings. This helps avoid duplicate listings. For more information, see + * Ensuring Idempotency.
*/ - Description?: string; + ClientToken: string | undefined; /** - *Tags associated with this snapshot.
+ *The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.
*/ - Tags?: Tag[]; + InstanceCount: number | undefined; /** - *Indicates whether the snapshot is encrypted.
+ *A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.
*/ - Encrypted?: boolean; + PriceSchedules: PriceScheduleSpecification[] | undefined; /** - *Source volume from which this snapshot was created.
+ *The ID of the active Standard Reserved Instance.
*/ - VolumeId?: string; + ReservedInstancesId: string | undefined; +} +export namespace CreateReservedInstancesListingRequest { /** - *Current state of the snapshot.
+ * @internal */ - State?: SnapshotState | string; + export const filterSensitiveLog = (obj: CreateReservedInstancesListingRequest): any => ({ + ...obj, + }); +} +/** + *Contains the output of CreateReservedInstancesListing.
+ */ +export interface CreateReservedInstancesListingResult { /** - *Size of the volume from which this snapshot was created.
+ *Information about the Standard Reserved Instance listing.
*/ - VolumeSize?: number; + ReservedInstancesListings?: ReservedInstancesListing[]; +} +export namespace CreateReservedInstancesListingResult { /** - *Time this snapshot was started. This is the same for all snapshots initiated by the - * same request.
+ * @internal */ - StartTime?: Date; + export const filterSensitiveLog = (obj: CreateReservedInstancesListingResult): any => ({ + ...obj, + }); +} +export interface CreateRestoreImageTaskRequest { /** - *Progress this snapshot has made towards completing.
+ *The name of the Amazon S3 bucket that contains the stored AMI object.
*/ - Progress?: string; + Bucket: string | undefined; /** - *Account id used when creating this snapshot.
+ *The name of the stored AMI object in the bucket.
*/ - OwnerId?: string; + ObjectKey: string | undefined; /** - *Snapshot id that can be used to describe this snapshot.
+ *The name for the restored AMI. The name must be unique for AMIs in the Region for this + * account. If you do not provide a name, the new AMI gets the same name as the original + * AMI.
*/ - SnapshotId?: string; + Name?: string; /** - *The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the - * Amazon Elastic Compute Cloud User Guide.
+ *The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the + * snapshots, or both.
+ *To tag the AMI, the value for ResourceType must be image.
To
+ * tag the snapshots, the value for ResourceType must be snapshot. The
+ * same tag is applied to all of the snapshots that are created.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
List of snapshots.
+ *The AMI ID.
*/ - Snapshots?: SnapshotInfo[]; + ImageId?: string; } -export namespace CreateSnapshotsResult { +export namespace CreateRestoreImageTaskResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateSnapshotsResult): any => ({ + export const filterSensitiveLog = (obj: CreateRestoreImageTaskResult): any => ({ ...obj, }); } -/** - *Contains the parameters for CreateSpotDatafeedSubscription.
- */ -export interface CreateSpotDatafeedSubscriptionRequest { +export interface CreateRouteRequest { /** - *The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For - * more information about bucket names, see Rules for bucket - * naming in the Amazon S3 Developer Guide.
+ *The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
Checks whether you have the required permissions for the action, without 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 IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
+ */ + DestinationIpv6CidrBlock?: string; + + /** + *The ID of a prefix list used for the destination match.
+ */ + DestinationPrefixListId?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The prefix for the data feed file names.
+ *The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
*/ - Prefix?: string; -} + VpcEndpointId?: string; -export namespace CreateSpotDatafeedSubscriptionRequest { /** - * @internal + *[IPv6 traffic only] The ID of an egress-only internet gateway.
*/ - export const filterSensitiveLog = (obj: CreateSpotDatafeedSubscriptionRequest): any => ({ - ...obj, - }); -} + EgressOnlyInternetGatewayId?: string; -/** - *Describes a Spot Instance state change.
- */ -export interface SpotInstanceStateFault { /** - *The reason code for the Spot Instance state change.
+ *The ID of an internet gateway or virtual private gateway attached to your + * VPC.
*/ - Code?: string; + GatewayId?: string; /** - *The message for the Spot Instance state change.
+ *The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
*/ - Message?: string; -} + InstanceId?: string; -export namespace SpotInstanceStateFault { /** - * @internal + *[IPv4 traffic only] The ID of a NAT gateway.
*/ - export const filterSensitiveLog = (obj: SpotInstanceStateFault): any => ({ - ...obj, - }); -} + NatGatewayId?: string; -export type DatafeedSubscriptionState = "Active" | "Inactive"; + /** + *The ID of a transit gateway.
+ */ + TransitGatewayId?: string; -/** - *Describes the data feed for a Spot Instance.
- */ -export interface SpotDatafeedSubscription { /** - *The name of the Amazon S3 bucket where the Spot Instance data feed is located.
+ *The ID of the local gateway.
*/ - Bucket?: string; + LocalGatewayId?: string; /** - *The fault codes for the Spot Instance request, if any.
+ *The ID of the carrier gateway.
+ *You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.
*/ - Fault?: SpotInstanceStateFault; + CarrierGatewayId?: string; /** - *The Amazon Web Services account ID of the account.
+ *The ID of a network interface.
*/ - OwnerId?: string; + NetworkInterfaceId?: string; /** - *The prefix for the data feed files.
+ *The ID of the route table for the route.
*/ - Prefix?: string; + RouteTableId: string | undefined; /** - *The state of the Spot Instance data feed subscription.
+ *The ID of a VPC peering connection.
*/ - State?: DatafeedSubscriptionState | string; + VpcPeeringConnectionId?: string; } -export namespace SpotDatafeedSubscription { +export namespace CreateRouteRequest { /** * @internal */ - export const filterSensitiveLog = (obj: SpotDatafeedSubscription): any => ({ + export const filterSensitiveLog = (obj: CreateRouteRequest): any => ({ ...obj, }); } -/** - *Contains the output of CreateSpotDatafeedSubscription.
- */ -export interface CreateSpotDatafeedSubscriptionResult { +export interface CreateRouteResult { /** - *The Spot Instance data feed subscription.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. For more - * information, see Categorizing your storage using - * tags in the Amazon Simple Storage Service User Guide.
- */ -export interface S3ObjectTag { +export interface CreateRouteTableRequest { /** - *The key of the tag.
- *Constraints: Tag keys are case-sensitive and can be up to 128 Unicode characters in
- * length. May not begin with aws:.
Checks whether you have the required permissions for the action, without 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 value of the tag.
- *Constraints: Tag values are case-sensitive and can be up to 256 Unicode characters in - * length.
+ *The ID of the VPC.
*/ - Value?: string; + VpcId: string | undefined; + + /** + *The tags to assign to the route table.
+ */ + TagSpecifications?: TagSpecification[]; } -export namespace S3ObjectTag { +export namespace CreateRouteTableRequest { /** * @internal */ - export const filterSensitiveLog = (obj: S3ObjectTag): any => ({ + export const filterSensitiveLog = (obj: CreateRouteTableRequest): any => ({ ...obj, }); } -export interface CreateStoreImageTaskRequest { +/** + *Describes an association between a route table and a subnet or gateway.
+ */ +export interface RouteTableAssociation { /** - *The ID of the AMI.
+ *Indicates whether this is the main route table.
*/ - ImageId: string | undefined; + Main?: boolean; /** - *The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in - * the Region in which the request is being made. The AMI object appears in the bucket only after - * the upload task has completed.
+ *The ID of the association.
*/ - Bucket: string | undefined; + RouteTableAssociationId?: string; /** - *The tags to apply to the AMI object that will be stored in the Amazon S3 bucket.
+ *The ID of the route table.
*/ - S3ObjectTags?: S3ObjectTag[]; + RouteTableId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the subnet. A subnet ID is not returned for an implicit association.
*/ - DryRun?: boolean; + SubnetId?: string; + + /** + *The ID of the internet gateway or virtual private gateway.
+ */ + GatewayId?: string; + + /** + *The state of the association.
+ */ + AssociationState?: RouteTableAssociationState; } -export namespace CreateStoreImageTaskRequest { +export namespace RouteTableAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: CreateStoreImageTaskRequest): any => ({ + export const filterSensitiveLog = (obj: RouteTableAssociation): any => ({ ...obj, }); } -export interface CreateStoreImageTaskResult { +/** + *Describes a virtual private gateway propagating route.
+ */ +export interface PropagatingVgw { /** - *The name of the stored AMI object in the S3 bucket.
+ *The ID of the virtual private gateway.
*/ - ObjectKey?: string; + GatewayId?: string; } -export namespace CreateStoreImageTaskResult { +export namespace PropagatingVgw { /** * @internal */ - export const filterSensitiveLog = (obj: CreateStoreImageTaskResult): any => ({ + export const filterSensitiveLog = (obj: PropagatingVgw): any => ({ ...obj, }); } -export interface CreateSubnetRequest { - /** - *The tags to assign to the subnet.
- */ - TagSpecifications?: TagSpecification[]; +export type RouteOrigin = "CreateRoute" | "CreateRouteTable" | "EnableVgwRoutePropagation"; - /** - *The Availability Zone or Local Zone for the subnet.
- *Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we - * do not necessarily select a different zone for each subnet.
- *To create a subnet in a Local Zone, set this value to the Local Zone ID, for example
- * us-west-2-lax-1a. For information about the Regions that support Local Zones,
- * see Available Regions in the Amazon Elastic Compute Cloud User Guide.
To create a subnet in an Outpost, set this value to the Availability Zone for the - * Outpost and specify the Outpost ARN.
- */ - AvailabilityZone?: string; +export type RouteState = "active" | "blackhole"; +/** + *Describes a route in a route table.
+ */ +export interface Route { /** - *The AZ ID or the Local Zone ID of the subnet.
+ *The IPv4 CIDR block used for the destination match.
*/ - AvailabilityZoneId?: string; + DestinationCidrBlock?: string; /** - *The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The IPv6 CIDR block used for the destination match.
*/ - CidrBlock: string | undefined; + DestinationIpv6CidrBlock?: string; /** - *The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a - * /64 prefix length.
+ *The prefix of the Amazon Web Service.
*/ - Ipv6CidrBlock?: string; + DestinationPrefixListId?: string; /** - *The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also - * specify the Availability Zone of the Outpost subnet.
+ *The ID of the egress-only internet gateway.
*/ - OutpostArn?: string; + EgressOnlyInternetGatewayId?: string; /** - *The ID of the VPC.
+ *The ID of a gateway attached to your VPC.
*/ - VpcId: string | undefined; + GatewayId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of a NAT instance in your VPC.
*/ - DryRun?: boolean; -} + InstanceId?: string; -export namespace CreateSubnetRequest { /** - * @internal + *The ID of Amazon Web Services account that owns the instance.
*/ - export const filterSensitiveLog = (obj: CreateSubnetRequest): any => ({ - ...obj, - }); -} + InstanceOwnerId?: string; -export interface CreateSubnetResult { /** - *Information about the subnet.
+ *The ID of a NAT gateway.
*/ - Subnet?: Subnet; -} + NatGatewayId?: string; -export namespace CreateSubnetResult { /** - * @internal + *The ID of a transit gateway.
*/ - export const filterSensitiveLog = (obj: CreateSubnetResult): any => ({ - ...obj, - }); -} - -export enum SubnetCidrReservationType { - explicit = "explicit", - prefix = "prefix", -} + TransitGatewayId?: string; -export interface CreateSubnetCidrReservationRequest { /** - *The tags to assign to the subnet CIDR reservation.
+ *The ID of the local gateway.
*/ - TagSpecifications?: TagSpecification[]; + LocalGatewayId?: string; /** - *The ID of the subnet.
+ *The ID of the carrier gateway.
*/ - SubnetId: string | undefined; + CarrierGatewayId?: string; /** - *The IPv4 or IPV6 CIDR range to reserve.
+ *The ID of the network interface.
*/ - Cidr: string | undefined; + NetworkInterfaceId?: string; /** - *The type of reservation.
- *The following are valid values:
- *Describes how the route was created.
+ *
- * prefix: The Amazon EC2
- * Prefix
- * Delegation feature assigns the IP addresses to network interfaces that are
- * associated with an instance. For information about Prefix
- * Delegation,
- * see Prefix Delegation
- * for Amazon EC2 network interfaces in the
- * Amazon Elastic Compute Cloud User Guide.
+ * CreateRouteTable - The route was automatically created when the route table was created.
- * explicit: You manually assign the IP addresses to resources that
- * reside in your subnet.
+ * CreateRoute - The route was manually added to the route table.
+ * EnableVgwRoutePropagation - The route was propagated by route propagation.
The - * description - * to assign to the subnet CIDR reservation.
+ *The state of the route. The blackhole state indicates that the
+ * route's target isn't available (for example, the specified gateway isn't attached to the
+ * VPC, or the specified NAT instance has been terminated).
Checks whether you have the required permissions for the action, without 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 a VPC peering connection.
*/ - DryRun?: boolean; + VpcPeeringConnectionId?: string; } -export namespace CreateSubnetCidrReservationRequest { +export namespace Route { /** * @internal */ - export const filterSensitiveLog = (obj: CreateSubnetCidrReservationRequest): any => ({ + export const filterSensitiveLog = (obj: Route): any => ({ ...obj, }); } /** - *Describes a subnet CIDR reservation.
+ *Describes a route table.
*/ -export interface SubnetCidrReservation { +export interface RouteTable { /** - *The ID of the subnet CIDR reservation.
+ *The associations between the route table and one or more subnets or a gateway.
*/ - SubnetCidrReservationId?: string; + Associations?: RouteTableAssociation[]; /** - *The ID of the subnet.
+ *Any virtual private gateway (VGW) propagating routes.
*/ - SubnetId?: string; + PropagatingVgws?: PropagatingVgw[]; /** - *The CIDR that has been reserved.
+ *The ID of the route table.
*/ - Cidr?: string; + RouteTableId?: string; /** - *The type of reservation.
+ *The routes in the route table.
*/ - ReservationType?: SubnetCidrReservationType | string; + Routes?: Route[]; /** - *The ID of the account that owns the subnet CIDR reservation.
+ *Any tags assigned to the route table.
*/ - OwnerId?: string; + Tags?: Tag[]; /** - *The - * description - * assigned to the subnet CIDR - * reservation.
+ *The ID of the VPC.
*/ - Description?: string; + VpcId?: string; /** - *The tags assigned to the subnet CIDR reservation.
+ *The ID of the Amazon Web Services account that owns the route table.
*/ - Tags?: Tag[]; + OwnerId?: string; } -export namespace SubnetCidrReservation { +export namespace RouteTable { /** * @internal */ - export const filterSensitiveLog = (obj: SubnetCidrReservation): any => ({ + export const filterSensitiveLog = (obj: RouteTable): any => ({ ...obj, }); } -export interface CreateSubnetCidrReservationResult { +export interface CreateRouteTableResult { /** - *Information about the created subnet CIDR reservation.
+ *Information about the route table.
*/ - SubnetCidrReservation?: SubnetCidrReservation; + RouteTable?: RouteTable; } -export namespace CreateSubnetCidrReservationResult { +export namespace CreateRouteTableResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateSubnetCidrReservationResult): any => ({ + export const filterSensitiveLog = (obj: CreateRouteTableResult): any => ({ ...obj, }); } -export interface CreateTagsRequest { +export interface CreateSecurityGroupRequest { + /** + *A description for the security group. This is informational only.
+ *Constraints: Up to 255 characters in length
+ *Constraints for EC2-Classic: ASCII characters
+ *Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
+ */ + Description: string | undefined; + + /** + *The name of the security group.
+ *Constraints: Up to 255 characters in length. Cannot start with
+ * sg-.
Constraints for EC2-Classic: ASCII characters
+ *Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
+ */ + GroupName: string | undefined; + + /** + *[EC2-VPC] The ID of the VPC. Required for EC2-VPC.
+ */ + VpcId?: string; + + /** + *The tags to assign to the security group.
+ */ + TagSpecifications?: TagSpecification[]; + /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The IDs of the resources, separated by spaces.
- *Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
+ * @internal */ - Resources: string[] | undefined; + export const filterSensitiveLog = (obj: CreateSecurityGroupRequest): any => ({ + ...obj, + }); +} +export interface CreateSecurityGroupResult { /** - *The tags. The value parameter is required, but if you don't want the tag to have a value,
- * specify the parameter with no value, and we set the value to an empty string.
The ID of the security group.
*/ - Tags: Tag[] | undefined; + GroupId?: string; + + /** + *The tags assigned to the security group.
+ */ + Tags?: Tag[]; } -export namespace CreateTagsRequest { +export namespace CreateSecurityGroupResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTagsRequest): any => ({ + export const filterSensitiveLog = (obj: CreateSecurityGroupResult): any => ({ ...obj, }); } -export interface CreateTrafficMirrorFilterRequest { +export interface CreateSnapshotRequest { /** - *The description of the Traffic Mirror filter.
+ *A description for the snapshot.
*/ Description?: string; /** - *The tags to assign to a Traffic Mirror filter.
+ *The Amazon Resource Name (ARN) of the Outpost on which to create a local + * snapshot.
+ *To create a snapshot of a volume in a Region, omit this parameter. The snapshot + * is created in the same Region as the volume.
+ *To create a snapshot of a volume on an Outpost and store the snapshot in the + * Region, omit this parameter. The snapshot is created in the Region for the + * Outpost.
+ *To create a snapshot of a volume on an Outpost and store the snapshot on an + * Outpost, specify the ARN of the destination Outpost. The snapshot must be created on + * the same Outpost as the volume.
+ *For more information, see Create local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.
+ */ + OutpostArn?: string; + + /** + *The ID of the Amazon EBS volume.
+ */ + VolumeId: string | undefined; + + /** + *The tags to apply to the snapshot during creation.
*/ TagSpecifications?: TagSpecification[]; @@ -6029,484 +6485,540 @@ export interface CreateTrafficMirrorFilterRequest { * Otherwise, it isUnauthorizedOperation.
*/
DryRun?: boolean;
-
- /**
- * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
- */ - ClientToken?: string; } -export namespace CreateTrafficMirrorFilterRequest { +export namespace CreateSnapshotRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTrafficMirrorFilterRequest): any => ({ + export const filterSensitiveLog = (obj: CreateSnapshotRequest): any => ({ ...obj, }); } +export type SnapshotState = "completed" | "error" | "pending"; + /** - *Describes the Traffic Mirror port range.
+ *Describes a snapshot.
*/ -export interface TrafficMirrorPortRange { +export interface Snapshot { /** - *The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
+ *The data encryption key identifier for the snapshot. This value is a unique identifier + * that corresponds to the data encryption key that was used to encrypt the original volume or + * snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, + * and vice versa, if snapshots share the same data encryption key identifier, then they belong + * to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.
*/ - FromPort?: number; + DataEncryptionKeyId?: string; /** - *The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
+ *The description for the snapshot.
*/ - ToPort?: number; -} + Description?: string; -export namespace TrafficMirrorPortRange { /** - * @internal + *Indicates whether the snapshot is encrypted.
*/ - export const filterSensitiveLog = (obj: TrafficMirrorPortRange): any => ({ - ...obj, - }); -} - -export type TrafficMirrorRuleAction = "accept" | "reject"; + Encrypted?: boolean; -export type TrafficDirection = "egress" | "ingress"; + /** + *The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the + * volume encryption key for the parent volume.
+ */ + KmsKeyId?: string; -/** - *Describes the Traffic Mirror rule.
- */ -export interface TrafficMirrorFilterRule { /** - *The ID of the Traffic Mirror rule.
+ *The ID of the Amazon Web Services account that owns the EBS snapshot.
*/ - TrafficMirrorFilterRuleId?: string; + OwnerId?: string; /** - *The ID of the Traffic Mirror filter that the rule is associated with.
+ *The progress of the snapshot, as a percentage.
*/ - TrafficMirrorFilterId?: string; + Progress?: string; /** - *The traffic direction assigned to the Traffic Mirror rule.
+ *The ID of the snapshot. Each snapshot receives a unique identifier when it is + * created.
*/ - TrafficDirection?: TrafficDirection | string; + SnapshotId?: string; /** - *The rule number of the Traffic Mirror rule.
+ *The time stamp when the snapshot was initiated.
*/ - RuleNumber?: number; + StartTime?: Date; /** - *The action assigned to the Traffic Mirror rule.
+ *The snapshot state.
*/ - RuleAction?: TrafficMirrorRuleAction | string; + State?: SnapshotState | string; /** - *The protocol assigned to the Traffic Mirror rule.
+ *Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails + * (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error + * state details to help you diagnose why the error occurred. This parameter is only returned by + * DescribeSnapshots.
*/ - Protocol?: number; + StateMessage?: string; /** - *The destination port range assigned to the Traffic Mirror rule.
+ *The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any + * purpose.
*/ - DestinationPortRange?: TrafficMirrorPortRange; + VolumeId?: string; /** - *The source port range assigned to the Traffic Mirror rule.
+ *The size of the volume, in GiB.
*/ - SourcePortRange?: TrafficMirrorPortRange; + VolumeSize?: number; /** - *The destination CIDR block assigned to the Traffic Mirror rule.
+ *The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not
+ * the user-configured Amazon Web Services account alias set using the IAM console.
The source CIDR block assigned to the Traffic Mirror rule.
+ *The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the + * Amazon Elastic Compute Cloud User Guide.
*/ - SourceCidrBlock?: string; + OutpostArn?: string; /** - *The description of the Traffic Mirror rule.
+ *Any tags assigned to the snapshot.
*/ - Description?: string; + Tags?: Tag[]; } -export namespace TrafficMirrorFilterRule { +export namespace Snapshot { /** * @internal */ - export const filterSensitiveLog = (obj: TrafficMirrorFilterRule): any => ({ + export const filterSensitiveLog = (obj: Snapshot): any => ({ ...obj, }); } -export type TrafficMirrorNetworkService = "amazon-dns"; +export type CopyTagsFromSource = "volume"; /** - *Describes the Traffic Mirror filter.
- */ -export interface TrafficMirrorFilter { - /** - *The ID of the Traffic Mirror filter.
- */ - TrafficMirrorFilterId?: string; - - /** - *Information about the ingress rules that are associated with the Traffic Mirror filter.
- */ - IngressFilterRules?: TrafficMirrorFilterRule[]; - - /** - *Information about the egress rules that are associated with the Traffic Mirror filter.
- */ - EgressFilterRules?: TrafficMirrorFilterRule[]; - - /** - *The network service traffic that is associated with the Traffic Mirror filter.
- */ - NetworkServices?: (TrafficMirrorNetworkService | string)[]; - + *The instance details to specify which volumes should be snapshotted.
+ */ +export interface InstanceSpecification { /** - *The description of the Traffic Mirror filter.
+ *The instance to specify which volumes should be snapshotted.
*/ - Description?: string; + InstanceId?: string; /** - *The tags assigned to the Traffic Mirror filter.
+ *Excludes the root volume from being snapshotted.
*/ - Tags?: Tag[]; + ExcludeBootVolume?: boolean; } -export namespace TrafficMirrorFilter { +export namespace InstanceSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: TrafficMirrorFilter): any => ({ + export const filterSensitiveLog = (obj: InstanceSpecification): any => ({ ...obj, }); } -export interface CreateTrafficMirrorFilterResult { +export interface CreateSnapshotsRequest { /** - *Information about the Traffic Mirror filter.
+ *A description propagated to every snapshot specified by the instance.
*/ - TrafficMirrorFilter?: TrafficMirrorFilter; + Description?: string; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
+ *The instance to specify which volumes should be included in the snapshots.
*/ - ClientToken?: string; -} + InstanceSpecification: InstanceSpecification | undefined; -export namespace CreateTrafficMirrorFilterResult { /** - * @internal + *The Amazon Resource Name (ARN) of the Outpost on which to create the local + * snapshots.
+ *To create snapshots from an instance in a Region, omit this parameter. The + * snapshots are created in the same Region as the instance.
+ *To create snapshots from an instance on an Outpost and store the snapshots + * in the Region, omit this parameter. The snapshots are created in the Region + * for the Outpost.
+ *To create snapshots from an instance on an Outpost and store the snapshots + * on an Outpost, specify the ARN of the destination Outpost. The snapshots must + * be created on the same Outpost as the instance.
+ *For more information, see + * Create multi-volume local snapshots from instances on an Outpost in the + * Amazon Elastic Compute Cloud User Guide.
*/ - export const filterSensitiveLog = (obj: CreateTrafficMirrorFilterResult): any => ({ - ...obj, - }); -} + OutpostArn?: string; -/** - *Information about the Traffic Mirror filter rule port range.
- */ -export interface TrafficMirrorPortRangeRequest { /** - *The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
+ *Tags to apply to every snapshot specified by the instance.
*/ - FromPort?: number; + TagSpecifications?: TagSpecification[]; /** - *The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Copies the tags from the specified volume to corresponding snapshot.
+ */ + CopyTagsFromSource?: CopyTagsFromSource | string; } -export namespace TrafficMirrorPortRangeRequest { +export namespace CreateSnapshotsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: TrafficMirrorPortRangeRequest): any => ({ + export const filterSensitiveLog = (obj: CreateSnapshotsRequest): any => ({ ...obj, }); } -export interface CreateTrafficMirrorFilterRuleRequest { +/** + *Information about a snapshot.
+ */ +export interface SnapshotInfo { /** - *The ID of the filter that this rule is associated with.
+ *Description specified by the CreateSnapshotRequest that has been applied to all + * snapshots.
*/ - TrafficMirrorFilterId: string | undefined; + Description?: string; /** - *The type of traffic.
+ *Tags associated with this snapshot.
*/ - TrafficDirection: TrafficDirection | string | undefined; + Tags?: Tag[]; /** - *The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given - * direction. The rules are processed in ascending order by rule number.
+ *Indicates whether the snapshot is encrypted.
*/ - RuleNumber: number | undefined; + Encrypted?: boolean; /** - *The action to take on the filtered traffic.
+ *Source volume from which this snapshot was created.
*/ - RuleAction: TrafficMirrorRuleAction | string | undefined; + VolumeId?: string; /** - *The destination port range.
+ *Current state of the snapshot.
*/ - DestinationPortRange?: TrafficMirrorPortRangeRequest; + State?: SnapshotState | string; /** - *The source port range.
+ *Size of the volume from which this snapshot was created.
*/ - SourcePortRange?: TrafficMirrorPortRangeRequest; + VolumeSize?: number; /** - *The protocol, for example UDP, to assign to the Traffic Mirror rule.
- *For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.
+ *Time this snapshot was started. This is the same for all snapshots initiated by the + * same request.
*/ - Protocol?: number; + StartTime?: Date; /** - *The destination CIDR block to assign to the Traffic Mirror rule.
+ *Progress this snapshot has made towards completing.
*/ - DestinationCidrBlock: string | undefined; + Progress?: string; /** - *The source CIDR block to assign to the Traffic Mirror rule.
+ *Account id used when creating this snapshot.
*/ - SourceCidrBlock: string | undefined; + OwnerId?: string; /** - *The description of the Traffic Mirror rule.
+ *Snapshot id that can be used to describe this snapshot.
*/ - Description?: string; + SnapshotId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the + * Amazon Elastic Compute Cloud User Guide.
*/ - DryRun?: boolean; + OutpostArn?: string; +} +export namespace SnapshotInfo { /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
+ * @internal */ - ClientToken?: string; + export const filterSensitiveLog = (obj: SnapshotInfo): any => ({ + ...obj, + }); } -export namespace CreateTrafficMirrorFilterRuleRequest { +export interface CreateSnapshotsResult { + /** + *List of snapshots.
+ */ + Snapshots?: SnapshotInfo[]; +} + +export namespace CreateSnapshotsResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTrafficMirrorFilterRuleRequest): any => ({ + export const filterSensitiveLog = (obj: CreateSnapshotsResult): any => ({ ...obj, }); } -export interface CreateTrafficMirrorFilterRuleResult { +/** + *Contains the parameters for CreateSpotDatafeedSubscription.
+ */ +export interface CreateSpotDatafeedSubscriptionRequest { /** - *The Traffic Mirror rule.
+ *The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For + * more information about bucket names, see Rules for bucket + * naming in the Amazon S3 Developer Guide.
*/ - TrafficMirrorFilterRule?: TrafficMirrorFilterRule; + Bucket: string | undefined; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The prefix for the data feed file names.
+ */ + Prefix?: string; } -export namespace CreateTrafficMirrorFilterRuleResult { +export namespace CreateSpotDatafeedSubscriptionRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTrafficMirrorFilterRuleResult): any => ({ + export const filterSensitiveLog = (obj: CreateSpotDatafeedSubscriptionRequest): any => ({ ...obj, }); } -export interface CreateTrafficMirrorSessionRequest { +/** + *Describes a Spot Instance state change.
+ */ +export interface SpotInstanceStateFault { /** - *The ID of the source network interface.
+ *The reason code for the Spot Instance state change.
*/ - NetworkInterfaceId: string | undefined; + Code?: string; /** - *The ID of the Traffic Mirror target.
+ *The message for the Spot Instance state change.
*/ - TrafficMirrorTargetId: string | undefined; + Message?: string; +} +export namespace SpotInstanceStateFault { /** - *The ID of the Traffic Mirror filter.
+ * @internal */ - TrafficMirrorFilterId: string | undefined; + export const filterSensitiveLog = (obj: SpotInstanceStateFault): any => ({ + ...obj, + }); +} +export type DatafeedSubscriptionState = "Active" | "Inactive"; + +/** + *Describes the data feed for a Spot Instance.
+ */ +export interface SpotDatafeedSubscription { /** - *The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do - * not specify this parameter when you want to mirror the entire packet. To mirror a subset of - * the packet, set this to the length (in bytes) that you want to mirror. For example, if you - * set this value to 100, then the first 100 bytes that meet the filter criteria are copied to - * the target.
- *If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.
The name of the Amazon S3 bucket where the Spot Instance data feed is located.
*/ - PacketLength?: number; + Bucket?: string; /** - *The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
- *Valid values are 1-32766.
+ *The fault codes for the Spot Instance request, if any.
*/ - SessionNumber: number | undefined; + Fault?: SpotInstanceStateFault; /** - *The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN
- * protocol, see RFC 7348. If you do
- * not specify a VirtualNetworkId, an account-wide unique id is chosen at
- * random.
The Amazon Web Services account ID of the account.
*/ - VirtualNetworkId?: number; + OwnerId?: string; /** - *The description of the Traffic Mirror session.
+ *The prefix for the data feed files.
*/ - Description?: string; + Prefix?: string; /** - *The tags to assign to a Traffic Mirror session.
+ *The state of the Spot Instance data feed subscription.
*/ - TagSpecifications?: TagSpecification[]; + State?: DatafeedSubscriptionState | string; +} +export namespace SpotDatafeedSubscription { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Contains the output of CreateSpotDatafeedSubscription.
+ */ +export interface CreateSpotDatafeedSubscriptionResult { /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
+ *The Spot Instance data feed subscription.
*/ - ClientToken?: string; + SpotDatafeedSubscription?: SpotDatafeedSubscription; } -export namespace CreateTrafficMirrorSessionRequest { +export namespace CreateSpotDatafeedSubscriptionResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTrafficMirrorSessionRequest): any => ({ + export const filterSensitiveLog = (obj: CreateSpotDatafeedSubscriptionResult): any => ({ ...obj, }); } /** - *Describes a Traffic Mirror session.
+ *The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. For more + * information, see Categorizing your storage using + * tags in the Amazon Simple Storage Service User Guide.
*/ -export interface TrafficMirrorSession { - /** - *The ID for the Traffic Mirror session.
- */ - TrafficMirrorSessionId?: string; - +export interface S3ObjectTag { /** - *The ID of the Traffic Mirror target.
+ *The key of the tag.
+ *Constraints: Tag keys are case-sensitive and can be up to 128 Unicode characters in
+ * length. May not begin with aws:.
The ID of the Traffic Mirror filter.
+ *The value of the tag.
+ *Constraints: Tag values are case-sensitive and can be up to 256 Unicode characters in + * length.
*/ - TrafficMirrorFilterId?: string; + Value?: string; +} +export namespace S3ObjectTag { /** - *The ID of the Traffic Mirror session's network interface.
+ * @internal */ - NetworkInterfaceId?: string; + export const filterSensitiveLog = (obj: S3ObjectTag): any => ({ + ...obj, + }); +} +export interface CreateStoreImageTaskRequest { /** - *The ID of the account that owns the Traffic Mirror session.
+ *The ID of the AMI.
*/ - OwnerId?: string; + ImageId: string | undefined; /** - *The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet
+ *The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in + * the Region in which the request is being made. The AMI object appears in the bucket only after + * the upload task has completed.
*/ - PacketLength?: number; + Bucket: string | undefined; /** - *The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
- *Valid values are 1-32766.
+ *The tags to apply to the AMI object that will be stored in the Amazon S3 bucket.
*/ - SessionNumber?: number; + S3ObjectTags?: S3ObjectTag[]; /** - *The virtual network ID associated with the Traffic Mirror session.
+ *Checks whether you have the required permissions for the action, without 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 description of the Traffic Mirror session.
+ * @internal */ - Description?: string; + export const filterSensitiveLog = (obj: CreateStoreImageTaskRequest): any => ({ + ...obj, + }); +} +export interface CreateStoreImageTaskResult { /** - *The tags assigned to the Traffic Mirror session.
+ *The name of the stored AMI object in the S3 bucket.
*/ - Tags?: Tag[]; + ObjectKey?: string; } -export namespace TrafficMirrorSession { +export namespace CreateStoreImageTaskResult { /** * @internal */ - export const filterSensitiveLog = (obj: TrafficMirrorSession): any => ({ + export const filterSensitiveLog = (obj: CreateStoreImageTaskResult): any => ({ ...obj, }); } -export interface CreateTrafficMirrorSessionResult { +export interface CreateSubnetRequest { /** - *Information about the Traffic Mirror session.
+ *The tags to assign to the subnet.
*/ - TrafficMirrorSession?: TrafficMirrorSession; + TagSpecifications?: TagSpecification[]; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
+ *The Availability Zone or Local Zone for the subnet.
+ *Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we + * do not necessarily select a different zone for each subnet.
+ *To create a subnet in a Local Zone, set this value to the Local Zone ID, for example
+ * us-west-2-lax-1a. For information about the Regions that support Local Zones,
+ * see Available Regions in the Amazon Elastic Compute Cloud User Guide.
To create a subnet in an Outpost, set this value to the Availability Zone for the + * Outpost and specify the Outpost ARN.
*/ - ClientToken?: string; -} + AvailabilityZone?: string; -export namespace CreateTrafficMirrorSessionResult { /** - * @internal + *The AZ ID or the Local Zone ID of the subnet.
*/ - export const filterSensitiveLog = (obj: CreateTrafficMirrorSessionResult): any => ({ - ...obj, - }); -} + AvailabilityZoneId?: string; -export interface CreateTrafficMirrorTargetRequest { /** - *The network interface ID that is associated with the target.
+ *The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.
+ *The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a + * /64 prefix length.
*/ - NetworkLoadBalancerArn?: string; + Ipv6CidrBlock?: string; /** - *The description of the Traffic Mirror target.
+ *The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also + * specify the Availability Zone of the Outpost subnet.
*/ - Description?: string; + OutpostArn?: string; /** - *The tags to assign to the Traffic Mirror target.
+ *The ID of the VPC.
*/ - TagSpecifications?: TagSpecification[]; + VpcId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request,
@@ -6514,172 +7026,208 @@ export interface CreateTrafficMirrorTargetRequest {
* Otherwise, it is UnauthorizedOperation.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
+ * @internal */ - ClientToken?: string; + export const filterSensitiveLog = (obj: CreateSubnetRequest): any => ({ + ...obj, + }); } -export namespace CreateTrafficMirrorTargetRequest { +export interface CreateSubnetResult { + /** + *Information about the subnet.
+ */ + Subnet?: Subnet; +} + +export namespace CreateSubnetResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTrafficMirrorTargetRequest): any => ({ + export const filterSensitiveLog = (obj: CreateSubnetResult): any => ({ ...obj, }); } -export type TrafficMirrorTargetType = "network-interface" | "network-load-balancer"; +export enum SubnetCidrReservationType { + explicit = "explicit", + prefix = "prefix", +} -/** - *Describes a Traffic Mirror target.
- */ -export interface TrafficMirrorTarget { +export interface CreateSubnetCidrReservationRequest { /** - *The ID of the Traffic Mirror target.
+ *The tags to assign to the subnet CIDR reservation.
*/ - TrafficMirrorTargetId?: string; + TagSpecifications?: TagSpecification[]; /** - *The network interface ID that is attached to the target.
+ *The ID of the subnet.
*/ - NetworkInterfaceId?: string; + SubnetId: string | undefined; /** - *The Amazon Resource Name (ARN) of the Network Load Balancer.
+ *The IPv4 or IPV6 CIDR range to reserve.
*/ - NetworkLoadBalancerArn?: string; + Cidr: string | undefined; /** - *The type of Traffic Mirror target.
+ *The type of reservation.
+ *The following are valid values:
+ *
+ * prefix: The Amazon EC2
+ * Prefix
+ * Delegation feature assigns the IP addresses to network interfaces that are
+ * associated with an instance. For information about Prefix
+ * Delegation,
+ * see Prefix Delegation
+ * for Amazon EC2 network interfaces in the
+ * Amazon Elastic Compute Cloud User Guide.
+ * explicit: You manually assign the IP addresses to resources that
+ * reside in your subnet.
Information about the Traffic Mirror target.
+ *The + * description + * to assign to the subnet CIDR reservation.
*/ Description?: string; /** - *The ID of the account that owns the Traffic Mirror target.
- */ - OwnerId?: string; - - /** - *The tags assigned to the Traffic Mirror target.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a subnet CIDR reservation.
+ */ +export interface SubnetCidrReservation { /** - *Information about the Traffic Mirror target.
+ *The ID of the subnet CIDR reservation.
*/ - TrafficMirrorTarget?: TrafficMirrorTarget; + SubnetCidrReservationId?: string; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
+ *The ID of the subnet.
*/ - ClientToken?: string; -} + SubnetId?: string; -export namespace CreateTrafficMirrorTargetResult { /** - * @internal + *The CIDR that has been reserved.
*/ - export const filterSensitiveLog = (obj: CreateTrafficMirrorTargetResult): any => ({ - ...obj, - }); -} - -export type AutoAcceptSharedAttachmentsValue = "disable" | "enable"; - -export type DefaultRouteTableAssociationValue = "disable" | "enable"; - -export type DefaultRouteTablePropagationValue = "disable" | "enable"; + Cidr?: string; -export type MulticastSupportValue = "disable" | "enable"; + /** + *The type of reservation.
+ */ + ReservationType?: SubnetCidrReservationType | string; -export type VpnEcmpSupportValue = "disable" | "enable"; + /** + *The ID of the account that owns the subnet CIDR reservation.
+ */ + OwnerId?: string; -/** - *Describes the options for a transit gateway.
- */ -export interface TransitGatewayRequestOptions { /** - *A private Autonomous System Number (ASN) for the Amazon side of a BGP session.
- * The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The default is 64512.
The + * description + * assigned to the subnet CIDR + * reservation.
*/ - AmazonSideAsn?: number; + Description?: string; /** - *Enable or disable automatic acceptance of attachment requests. Disabled by default.
+ *The tags assigned to the subnet CIDR reservation.
*/ - AutoAcceptSharedAttachments?: AutoAcceptSharedAttachmentsValue | string; + Tags?: Tag[]; +} +export namespace SubnetCidrReservation { /** - *Enable or disable automatic association with the default association route table. Enabled by default.
+ * @internal */ - DefaultRouteTableAssociation?: DefaultRouteTableAssociationValue | string; + export const filterSensitiveLog = (obj: SubnetCidrReservation): any => ({ + ...obj, + }); +} +export interface CreateSubnetCidrReservationResult { /** - *Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
+ *Information about the created subnet CIDR reservation.
*/ - DefaultRouteTablePropagation?: DefaultRouteTablePropagationValue | string; + SubnetCidrReservation?: SubnetCidrReservation; +} +export namespace CreateSubnetCidrReservationResult { /** - *Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
+ * @internal */ - VpnEcmpSupport?: VpnEcmpSupportValue | string; + export const filterSensitiveLog = (obj: CreateSubnetCidrReservationResult): any => ({ + ...obj, + }); +} +export interface CreateTagsRequest { /** - *Enable or disable DNS support. Enabled by default.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Indicates whether multicast is enabled on the transit gateway
+ *The IDs of the resources, separated by spaces.
+ *Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
*/ - MulticastSupport?: MulticastSupportValue | string; + Resources: string[] | undefined; /** - *One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
+ *The tags. The value parameter is required, but if you don't want the tag to have a value,
+ * specify the parameter with no value, and we set the value to an empty string.
A description of the transit gateway.
+ *The description of the Traffic Mirror filter.
*/ Description?: string; /** - *The transit gateway options.
- */ - Options?: TransitGatewayRequestOptions; - - /** - *The tags to apply to the transit gateway.
+ *The tags to assign to a Traffic Mirror filter.
*/ TagSpecifications?: TagSpecification[]; @@ -6689,345 +7237,353 @@ export interface CreateTransitGatewayRequest { * Otherwise, it isUnauthorizedOperation.
*/
DryRun?: boolean;
+
+ /**
+ * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
+ */ + ClientToken?: string; } -export namespace CreateTransitGatewayRequest { +export namespace CreateTrafficMirrorFilterRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayRequest): any => ({ + export const filterSensitiveLog = (obj: CreateTrafficMirrorFilterRequest): any => ({ ...obj, }); } /** - *Describes the options for a transit gateway.
+ *Describes the Traffic Mirror port range.
*/ -export interface TransitGatewayOptions { +export interface TrafficMirrorPortRange { /** - *A private Autonomous System Number (ASN) for the Amazon side of a BGP session. - * The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
+ *The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
*/ - AmazonSideAsn?: number; + FromPort?: number; /** - *The transit gateway CIDR blocks.
+ *The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
*/ - TransitGatewayCidrBlocks?: string[]; + ToPort?: number; +} +export namespace TrafficMirrorPortRange { /** - *Indicates whether attachment requests are automatically accepted.
+ * @internal */ - AutoAcceptSharedAttachments?: AutoAcceptSharedAttachmentsValue | string; + export const filterSensitiveLog = (obj: TrafficMirrorPortRange): any => ({ + ...obj, + }); +} + +export type TrafficMirrorRuleAction = "accept" | "reject"; +export type TrafficDirection = "egress" | "ingress"; + +/** + *Describes the Traffic Mirror rule.
+ */ +export interface TrafficMirrorFilterRule { /** - *Indicates whether resource attachments are automatically associated with the default association route table.
+ *The ID of the Traffic Mirror rule.
*/ - DefaultRouteTableAssociation?: DefaultRouteTableAssociationValue | string; + TrafficMirrorFilterRuleId?: string; /** - *The ID of the default association route table.
+ *The ID of the Traffic Mirror filter that the rule is associated with.
*/ - AssociationDefaultRouteTableId?: string; + TrafficMirrorFilterId?: string; /** - *Indicates whether resource attachments automatically propagate routes to the default propagation route table.
+ *The traffic direction assigned to the Traffic Mirror rule.
*/ - DefaultRouteTablePropagation?: DefaultRouteTablePropagationValue | string; + TrafficDirection?: TrafficDirection | string; /** - *The ID of the default propagation route table.
+ *The rule number of the Traffic Mirror rule.
*/ - PropagationDefaultRouteTableId?: string; + RuleNumber?: number; /** - *Indicates whether Equal Cost Multipath Protocol support is enabled.
+ *The action assigned to the Traffic Mirror rule.
*/ - VpnEcmpSupport?: VpnEcmpSupportValue | string; + RuleAction?: TrafficMirrorRuleAction | string; /** - *Indicates whether DNS support is enabled.
+ *The protocol assigned to the Traffic Mirror rule.
*/ - DnsSupport?: DnsSupportValue | string; + Protocol?: number; /** - *Indicates whether multicast is enabled on the transit gateway
+ *The destination port range assigned to the Traffic Mirror rule.
*/ - MulticastSupport?: MulticastSupportValue | string; + DestinationPortRange?: TrafficMirrorPortRange; + + /** + *The source port range assigned to the Traffic Mirror rule.
+ */ + SourcePortRange?: TrafficMirrorPortRange; + + /** + *The destination CIDR block assigned to the Traffic Mirror rule.
+ */ + DestinationCidrBlock?: string; + + /** + *The source CIDR block assigned to the Traffic Mirror rule.
+ */ + SourceCidrBlock?: string; + + /** + *The description of the Traffic Mirror rule.
+ */ + Description?: string; } -export namespace TransitGatewayOptions { +export namespace TrafficMirrorFilterRule { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayOptions): any => ({ + export const filterSensitiveLog = (obj: TrafficMirrorFilterRule): any => ({ ...obj, }); } -export type TransitGatewayState = "available" | "deleted" | "deleting" | "modifying" | "pending"; +export type TrafficMirrorNetworkService = "amazon-dns"; /** - *Describes a transit gateway.
+ *Describes the Traffic Mirror filter.
*/ -export interface TransitGateway { +export interface TrafficMirrorFilter { /** - *The ID of the transit gateway.
+ *The ID of the Traffic Mirror filter.
*/ - TransitGatewayId?: string; + TrafficMirrorFilterId?: string; /** - *The Amazon Resource Name (ARN) of the transit gateway.
+ *Information about the ingress rules that are associated with the Traffic Mirror filter.
*/ - TransitGatewayArn?: string; + IngressFilterRules?: TrafficMirrorFilterRule[]; /** - *The state of the transit gateway.
+ *Information about the egress rules that are associated with the Traffic Mirror filter.
*/ - State?: TransitGatewayState | string; + EgressFilterRules?: TrafficMirrorFilterRule[]; /** - *The ID of the Amazon Web Services account that owns the transit gateway.
+ *The network service traffic that is associated with the Traffic Mirror filter.
*/ - OwnerId?: string; + NetworkServices?: (TrafficMirrorNetworkService | string)[]; /** - *The description of the transit gateway.
+ *The description of the Traffic Mirror filter.
*/ Description?: string; /** - *The creation time.
- */ - CreationTime?: Date; - - /** - *The transit gateway options.
- */ - Options?: TransitGatewayOptions; - - /** - *The tags for the transit gateway.
+ *The tags assigned to the Traffic Mirror filter.
*/ Tags?: Tag[]; } -export namespace TransitGateway { +export namespace TrafficMirrorFilter { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGateway): any => ({ + export const filterSensitiveLog = (obj: TrafficMirrorFilter): any => ({ ...obj, }); } -export interface CreateTransitGatewayResult { +export interface CreateTrafficMirrorFilterResult { /** - *Information about the transit gateway.
+ *Information about the Traffic Mirror filter.
*/ - TransitGateway?: TransitGateway; + TrafficMirrorFilter?: TrafficMirrorFilter; + + /** + *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
+ */ + ClientToken?: string; } -export namespace CreateTransitGatewayResult { +export namespace CreateTrafficMirrorFilterResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayResult): any => ({ + export const filterSensitiveLog = (obj: CreateTrafficMirrorFilterResult): any => ({ ...obj, }); } -export type ProtocolValue = "gre"; - /** - *The options for a Connect attachment.
+ *Information about the Traffic Mirror filter rule port range.
*/ -export interface CreateTransitGatewayConnectRequestOptions { +export interface TrafficMirrorPortRangeRequest { /** - *The tunnel protocol.
+ *The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
*/ - Protocol: ProtocolValue | string | undefined; + FromPort?: number; + + /** + *The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
+ */ + ToPort?: number; } -export namespace CreateTransitGatewayConnectRequestOptions { +export namespace TrafficMirrorPortRangeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayConnectRequestOptions): any => ({ + export const filterSensitiveLog = (obj: TrafficMirrorPortRangeRequest): any => ({ ...obj, }); } -export interface CreateTransitGatewayConnectRequest { - /** - *The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment.
- */ - TransportTransitGatewayAttachmentId: string | undefined; - - /** - *The Connect attachment options.
- */ - Options: CreateTransitGatewayConnectRequestOptions | undefined; - +export interface CreateTrafficMirrorFilterRuleRequest { /** - *The tags to apply to the Connect attachment.
+ *The ID of the filter that this rule is associated with.
*/ - TagSpecifications?: TagSpecification[]; + TrafficMirrorFilterId: 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 type of traffic.
*/ - DryRun?: boolean; -} + TrafficDirection: TrafficDirection | string | undefined; -export namespace CreateTransitGatewayConnectRequest { /** - * @internal + *The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given + * direction. The rules are processed in ascending order by rule number.
*/ - export const filterSensitiveLog = (obj: CreateTransitGatewayConnectRequest): any => ({ - ...obj, - }); -} + RuleNumber: number | undefined; -/** - *Describes the Connect attachment options.
- */ -export interface TransitGatewayConnectOptions { /** - *The tunnel protocol.
+ *The action to take on the filtered traffic.
*/ - Protocol?: ProtocolValue | string; -} + RuleAction: TrafficMirrorRuleAction | string | undefined; -export namespace TransitGatewayConnectOptions { /** - * @internal + *The destination port range.
*/ - export const filterSensitiveLog = (obj: TransitGatewayConnectOptions): any => ({ - ...obj, - }); -} + DestinationPortRange?: TrafficMirrorPortRangeRequest; -/** - *Describes a transit gateway Connect attachment.
- */ -export interface TransitGatewayConnect { /** - *The ID of the Connect attachment.
+ *The source port range.
*/ - TransitGatewayAttachmentId?: string; + SourcePortRange?: TrafficMirrorPortRangeRequest; /** - *The ID of the attachment from which the Connect attachment was created.
+ *The protocol, for example UDP, to assign to the Traffic Mirror rule.
+ *For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.
*/ - TransportTransitGatewayAttachmentId?: string; + Protocol?: number; /** - *The ID of the transit gateway.
+ *The destination CIDR block to assign to the Traffic Mirror rule.
*/ - TransitGatewayId?: string; + DestinationCidrBlock: string | undefined; /** - *The state of the attachment.
+ *The source CIDR block to assign to the Traffic Mirror rule.
*/ - State?: TransitGatewayAttachmentState | string; + SourceCidrBlock: string | undefined; /** - *The creation time.
+ *The description of the Traffic Mirror rule.
*/ - CreationTime?: Date; + Description?: string; /** - *The Connect attachment options.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The tags for the attachment.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
*/ - Tags?: Tag[]; + ClientToken?: string; } -export namespace TransitGatewayConnect { +export namespace CreateTrafficMirrorFilterRuleRequest { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayConnect): any => ({ + export const filterSensitiveLog = (obj: CreateTrafficMirrorFilterRuleRequest): any => ({ ...obj, }); } -export interface CreateTransitGatewayConnectResult { +export interface CreateTrafficMirrorFilterRuleResult { /** - *Information about the Connect attachment.
+ *The Traffic Mirror rule.
*/ - TransitGatewayConnect?: TransitGatewayConnect; + TrafficMirrorFilterRule?: TrafficMirrorFilterRule; + + /** + *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
+ */ + ClientToken?: string; } -export namespace CreateTransitGatewayConnectResult { +export namespace CreateTrafficMirrorFilterRuleResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayConnectResult): any => ({ + export const filterSensitiveLog = (obj: CreateTrafficMirrorFilterRuleResult): any => ({ ...obj, }); } -/** - *The BGP options for the Connect attachment.
- */ -export interface TransitGatewayConnectRequestBgpOptions { +export interface CreateTrafficMirrorSessionRequest { /** - *The peer Autonomous System Number (ASN).
+ *The ID of the source network interface.
*/ - PeerAsn?: number; -} + NetworkInterfaceId: string | undefined; -export namespace TransitGatewayConnectRequestBgpOptions { /** - * @internal + *The ID of the Traffic Mirror target.
*/ - export const filterSensitiveLog = (obj: TransitGatewayConnectRequestBgpOptions): any => ({ - ...obj, - }); -} + TrafficMirrorTargetId: string | undefined; -export interface CreateTransitGatewayConnectPeerRequest { /** - *The ID of the Connect attachment.
+ *The ID of the Traffic Mirror filter.
*/ - TransitGatewayAttachmentId: string | undefined; + TrafficMirrorFilterId: string | undefined; /** - *The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be - * specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns - * the first available IP address from the transit gateway CIDR block.
+ *The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do + * not specify this parameter when you want to mirror the entire packet. To mirror a subset of + * the packet, set this to the length (in bytes) that you want to mirror. For example, if you + * set this value to 100, then the first 100 bytes that meet the filter criteria are copied to + * the target.
+ *If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.
The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.
+ *The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
+ *Valid values are 1-32766.
*/ - PeerAddress: string | undefined; + SessionNumber: number | undefined; /** - *The BGP options for the Connect peer.
+ *The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN
+ * protocol, see RFC 7348. If you do
+ * not specify a VirtualNetworkId, an account-wide unique id is chosen at
+ * random.
The range of inside IP addresses that are used for BGP peering. You must specify a
- * size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address
- * from the range must be configured on the appliance as the BGP IP address. You can also
- * optionally specify a size /125 IPv6 CIDR block from the fd00::/8
- * range.
The description of the Traffic Mirror session.
*/ - InsideCidrBlocks: string[] | undefined; + Description?: string; /** - *The tags to apply to the Connect peer.
+ *The tags to assign to a Traffic Mirror session.
*/ TagSpecifications?: TagSpecification[]; @@ -7037,351 +7593,301 @@ export interface CreateTransitGatewayConnectPeerRequest { * Otherwise, it isUnauthorizedOperation.
*/
DryRun?: boolean;
+
+ /**
+ * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
+ */ + ClientToken?: string; } -export namespace CreateTransitGatewayConnectPeerRequest { +export namespace CreateTrafficMirrorSessionRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayConnectPeerRequest): any => ({ + export const filterSensitiveLog = (obj: CreateTrafficMirrorSessionRequest): any => ({ ...obj, }); } -export type BgpStatus = "down" | "up"; - /** - *The BGP configuration information.
+ *Describes a Traffic Mirror session.
*/ -export interface TransitGatewayAttachmentBgpConfiguration { - /** - *The transit gateway Autonomous System Number (ASN).
- */ - TransitGatewayAsn?: number; - +export interface TrafficMirrorSession { /** - *The peer Autonomous System Number (ASN).
+ *The ID for the Traffic Mirror session.
*/ - PeerAsn?: number; + TrafficMirrorSessionId?: string; /** - *The interior BGP peer IP address for the transit gateway.
+ *The ID of the Traffic Mirror target.
*/ - TransitGatewayAddress?: string; + TrafficMirrorTargetId?: string; /** - *The interior BGP peer IP address for the appliance.
+ *The ID of the Traffic Mirror filter.
*/ - PeerAddress?: string; + TrafficMirrorFilterId?: string; /** - *The BGP status.
+ *The ID of the Traffic Mirror session's network interface.
*/ - BgpStatus?: BgpStatus | string; -} + NetworkInterfaceId?: string; -export namespace TransitGatewayAttachmentBgpConfiguration { /** - * @internal + *The ID of the account that owns the Traffic Mirror session.
*/ - export const filterSensitiveLog = (obj: TransitGatewayAttachmentBgpConfiguration): any => ({ - ...obj, - }); -} + OwnerId?: string; -/** - *Describes the Connect peer details.
- */ -export interface TransitGatewayConnectPeerConfiguration { /** - *The Connect peer IP address on the transit gateway side of the tunnel.
+ *The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet
*/ - TransitGatewayAddress?: string; + PacketLength?: number; /** - *The Connect peer IP address on the appliance side of the tunnel.
+ *The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.
+ *Valid values are 1-32766.
*/ - PeerAddress?: string; + SessionNumber?: number; /** - *The range of interior BGP peer IP addresses.
+ *The virtual network ID associated with the Traffic Mirror session.
*/ - InsideCidrBlocks?: string[]; + VirtualNetworkId?: number; /** - *The tunnel protocol.
+ *The description of the Traffic Mirror session.
*/ - Protocol?: ProtocolValue | string; + Description?: string; /** - *The BGP configuration details.
+ *The tags assigned to the Traffic Mirror session.
*/ - BgpConfigurations?: TransitGatewayAttachmentBgpConfiguration[]; + Tags?: Tag[]; } -export namespace TransitGatewayConnectPeerConfiguration { +export namespace TrafficMirrorSession { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayConnectPeerConfiguration): any => ({ + export const filterSensitiveLog = (obj: TrafficMirrorSession): any => ({ ...obj, }); } -export type TransitGatewayConnectPeerState = "available" | "deleted" | "deleting" | "pending"; +export interface CreateTrafficMirrorSessionResult { + /** + *Information about the Traffic Mirror session.
+ */ + TrafficMirrorSession?: TrafficMirrorSession; -/** - *Describes a transit gateway Connect peer.
- */ -export interface TransitGatewayConnectPeer { /** - *The ID of the Connect attachment.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
*/ - TransitGatewayAttachmentId?: string; + ClientToken?: string; +} +export namespace CreateTrafficMirrorSessionResult { /** - *The ID of the Connect peer.
+ * @internal */ - TransitGatewayConnectPeerId?: string; + export const filterSensitiveLog = (obj: CreateTrafficMirrorSessionResult): any => ({ + ...obj, + }); +} +export interface CreateTrafficMirrorTargetRequest { /** - *The state of the Connect peer.
+ *The network interface ID that is associated with the target.
*/ - State?: TransitGatewayConnectPeerState | string; + NetworkInterfaceId?: string; /** - *The creation time.
+ *The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.
*/ - CreationTime?: Date; + NetworkLoadBalancerArn?: string; /** - *The Connect peer details.
+ *The description of the Traffic Mirror target.
*/ - ConnectPeerConfiguration?: TransitGatewayConnectPeerConfiguration; + Description?: string; /** - *The tags for the Connect peer.
+ *The tags to assign to the Traffic Mirror target.
*/ - Tags?: Tag[]; -} + TagSpecifications?: TagSpecification[]; -export namespace TransitGatewayConnectPeer { /** - * @internal + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the Connect peer.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
*/ - TransitGatewayConnectPeer?: TransitGatewayConnectPeer; + ClientToken?: string; } -export namespace CreateTransitGatewayConnectPeerResult { +export namespace CreateTrafficMirrorTargetRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayConnectPeerResult): any => ({ + export const filterSensitiveLog = (obj: CreateTrafficMirrorTargetRequest): any => ({ ...obj, }); } -export type AutoAcceptSharedAssociationsValue = "disable" | "enable"; - -export type Igmpv2SupportValue = "disable" | "enable"; - -export type StaticSourcesSupportValue = "disable" | "enable"; +export type TrafficMirrorTargetType = "network-interface" | "network-load-balancer"; /** - *The options for the transit gateway multicast domain.
+ *Describes a Traffic Mirror target.
*/ -export interface CreateTransitGatewayMulticastDomainRequestOptions { - /** - *Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.
- */ - Igmpv2Support?: Igmpv2SupportValue | string; - +export interface TrafficMirrorTarget { /** - *Specify whether to enable support for statically configuring multicast group sources for a domain.
+ *The ID of the Traffic Mirror target.
*/ - StaticSourcesSupport?: StaticSourcesSupportValue | string; + TrafficMirrorTargetId?: string; /** - *Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.
+ *The network interface ID that is attached to the target.
*/ - AutoAcceptSharedAssociations?: AutoAcceptSharedAssociationsValue | string; -} + NetworkInterfaceId?: string; -export namespace CreateTransitGatewayMulticastDomainRequestOptions { /** - * @internal + *The Amazon Resource Name (ARN) of the Network Load Balancer.
*/ - export const filterSensitiveLog = (obj: CreateTransitGatewayMulticastDomainRequestOptions): any => ({ - ...obj, - }); -} + NetworkLoadBalancerArn?: string; -export interface CreateTransitGatewayMulticastDomainRequest { /** - *The ID of the transit gateway.
+ *The type of Traffic Mirror target.
*/ - TransitGatewayId: string | undefined; + Type?: TrafficMirrorTargetType | string; /** - *The options for the transit gateway multicast domain.
+ *Information about the Traffic Mirror target.
*/ - Options?: CreateTransitGatewayMulticastDomainRequestOptions; + Description?: string; /** - *The tags for the transit gateway multicast domain.
+ *The ID of the account that owns the Traffic Mirror target.
*/ - TagSpecifications?: TagSpecification[]; + OwnerId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The tags assigned to the Traffic Mirror target.
*/ - DryRun?: boolean; + Tags?: Tag[]; } -export namespace CreateTransitGatewayMulticastDomainRequest { +export namespace TrafficMirrorTarget { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayMulticastDomainRequest): any => ({ + export const filterSensitiveLog = (obj: TrafficMirrorTarget): any => ({ ...obj, }); } -/** - *Describes the options for a transit gateway multicast domain.
- */ -export interface TransitGatewayMulticastDomainOptions { - /** - *Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.
- */ - Igmpv2Support?: Igmpv2SupportValue | string; - +export interface CreateTrafficMirrorTargetResult { /** - *Indicates whether support for statically configuring transit gateway multicast group sources is turned on.
+ *Information about the Traffic Mirror target.
*/ - StaticSourcesSupport?: StaticSourcesSupportValue | string; + TrafficMirrorTarget?: TrafficMirrorTarget; /** - *Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
*/ - AutoAcceptSharedAssociations?: AutoAcceptSharedAssociationsValue | string; + ClientToken?: string; } -export namespace TransitGatewayMulticastDomainOptions { +export namespace CreateTrafficMirrorTargetResult { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayMulticastDomainOptions): any => ({ + export const filterSensitiveLog = (obj: CreateTrafficMirrorTargetResult): any => ({ ...obj, }); } -export type TransitGatewayMulticastDomainState = "available" | "deleted" | "deleting" | "pending"; +export type AutoAcceptSharedAttachmentsValue = "disable" | "enable"; -/** - *Describes the transit gateway multicast domain.
- */ -export interface TransitGatewayMulticastDomain { - /** - *The ID of the transit gateway multicast domain.
- */ - TransitGatewayMulticastDomainId?: string; +export type DefaultRouteTableAssociationValue = "disable" | "enable"; - /** - *The ID of the transit gateway.
- */ - TransitGatewayId?: string; +export type DefaultRouteTablePropagationValue = "disable" | "enable"; + +export type MulticastSupportValue = "disable" | "enable"; +export type VpnEcmpSupportValue = "disable" | "enable"; + +/** + *Describes the options for a transit gateway.
+ */ +export interface TransitGatewayRequestOptions { /** - *The Amazon Resource Name (ARN) of the transit gateway multicast domain.
+ *A private Autonomous System Number (ASN) for the Amazon side of a BGP session.
+ * The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The default is 64512.
The ID of the Amazon Web Services account that owns the transit gateway multicast domain.
+ *Enable or disable automatic acceptance of attachment requests. Disabled by default.
*/ - OwnerId?: string; + AutoAcceptSharedAttachments?: AutoAcceptSharedAttachmentsValue | string; /** - *The options for the transit gateway multicast domain.
+ *Enable or disable automatic association with the default association route table. Enabled by default.
*/ - Options?: TransitGatewayMulticastDomainOptions; + DefaultRouteTableAssociation?: DefaultRouteTableAssociationValue | string; /** - *The state of the transit gateway multicast domain.
+ *Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
*/ - State?: TransitGatewayMulticastDomainState | string; + DefaultRouteTablePropagation?: DefaultRouteTablePropagationValue | string; /** - *The time the transit gateway multicast domain was created.
+ *Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
*/ - CreationTime?: Date; + VpnEcmpSupport?: VpnEcmpSupportValue | string; /** - *The tags for the transit gateway multicast domain.
+ *Enable or disable DNS support. Enabled by default.
*/ - Tags?: Tag[]; -} + DnsSupport?: DnsSupportValue | string; -export namespace TransitGatewayMulticastDomain { /** - * @internal + *Indicates whether multicast is enabled on the transit gateway
*/ - export const filterSensitiveLog = (obj: TransitGatewayMulticastDomain): any => ({ - ...obj, - }); -} + MulticastSupport?: MulticastSupportValue | string; -export interface CreateTransitGatewayMulticastDomainResult { /** - *Information about the transit gateway multicast domain.
+ *One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.
*/ - TransitGatewayMulticastDomain?: TransitGatewayMulticastDomain; + TransitGatewayCidrBlocks?: string[]; } -export namespace CreateTransitGatewayMulticastDomainResult { +export namespace TransitGatewayRequestOptions { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayMulticastDomainResult): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayRequestOptions): any => ({ ...obj, }); } -export interface CreateTransitGatewayPeeringAttachmentRequest { - /** - *The ID of the transit gateway.
- */ - TransitGatewayId: string | undefined; - - /** - *The ID of the peer transit gateway with which to create the peering attachment.
- */ - PeerTransitGatewayId: string | undefined; - +export interface CreateTransitGatewayRequest { /** - *The ID of the Amazon Web Services account that owns the peer transit gateway.
+ *A description of the transit gateway.
*/ - PeerAccountId: string | undefined; + Description?: string; /** - *The Region where the peer transit gateway is located.
+ *The transit gateway options.
*/ - PeerRegion: string | undefined; + Options?: TransitGatewayRequestOptions; /** - *The tags to apply to the transit gateway peering attachment.
+ *The tags to apply to the transit gateway.
*/ TagSpecifications?: TagSpecification[]; @@ -7393,181 +7899,188 @@ export interface CreateTransitGatewayPeeringAttachmentRequest { DryRun?: boolean; } -export namespace CreateTransitGatewayPeeringAttachmentRequest { +export namespace CreateTransitGatewayRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayPeeringAttachmentRequest): any => ({ + export const filterSensitiveLog = (obj: CreateTransitGatewayRequest): any => ({ ...obj, }); } -export interface CreateTransitGatewayPeeringAttachmentResult { +/** + *Describes the options for a transit gateway.
+ */ +export interface TransitGatewayOptions { /** - *The transit gateway peering attachment.
+ *A private Autonomous System Number (ASN) for the Amazon side of a BGP session. + * The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
*/ - TransitGatewayPeeringAttachment?: TransitGatewayPeeringAttachment; -} + AmazonSideAsn?: number; -export namespace CreateTransitGatewayPeeringAttachmentResult { /** - * @internal + *The transit gateway CIDR blocks.
*/ - export const filterSensitiveLog = (obj: CreateTransitGatewayPeeringAttachmentResult): any => ({ - ...obj, - }); -} + TransitGatewayCidrBlocks?: string[]; -export interface CreateTransitGatewayPrefixListReferenceRequest { /** - *The ID of the transit gateway route table.
+ *Indicates whether attachment requests are automatically accepted.
*/ - TransitGatewayRouteTableId: string | undefined; + AutoAcceptSharedAttachments?: AutoAcceptSharedAttachmentsValue | string; /** - *The ID of the prefix list that is used for destination matches.
+ *Indicates whether resource attachments are automatically associated with the default association route table.
*/ - PrefixListId: string | undefined; + DefaultRouteTableAssociation?: DefaultRouteTableAssociationValue | string; /** - *The ID of the attachment to which traffic is routed.
+ *The ID of the default association route table.
*/ - TransitGatewayAttachmentId?: string; + AssociationDefaultRouteTableId?: string; /** - *Indicates whether to drop traffic that matches this route.
+ *Indicates whether resource attachments automatically propagate routes to the default propagation route table.
*/ - Blackhole?: boolean; + DefaultRouteTablePropagation?: DefaultRouteTablePropagationValue | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the default propagation route table.
*/ - DryRun?: boolean; + PropagationDefaultRouteTableId?: string; + + /** + *Indicates whether Equal Cost Multipath Protocol support is enabled.
+ */ + VpnEcmpSupport?: VpnEcmpSupportValue | string; + + /** + *Indicates whether DNS support is enabled.
+ */ + DnsSupport?: DnsSupportValue | string; + + /** + *Indicates whether multicast is enabled on the transit gateway
+ */ + MulticastSupport?: MulticastSupportValue | string; } -export namespace CreateTransitGatewayPrefixListReferenceRequest { +export namespace TransitGatewayOptions { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayPrefixListReferenceRequest): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayOptions): any => ({ ...obj, }); } -export type TransitGatewayPrefixListReferenceState = "available" | "deleting" | "modifying" | "pending"; +export type TransitGatewayState = "available" | "deleted" | "deleting" | "modifying" | "pending"; /** - *Describes a transit gateway prefix list attachment.
+ *Describes a transit gateway.
*/ -export interface TransitGatewayPrefixListAttachment { - /** - *The ID of the attachment.
- */ - TransitGatewayAttachmentId?: string; - - /** - *The resource type. Note that the tgw-peering resource type has been deprecated.
The ID of the resource.
+ *The ID of the transit gateway.
*/ - ResourceId?: string; -} + TransitGatewayId?: string; -export namespace TransitGatewayPrefixListAttachment { /** - * @internal + *The Amazon Resource Name (ARN) of the transit gateway.
*/ - export const filterSensitiveLog = (obj: TransitGatewayPrefixListAttachment): any => ({ - ...obj, - }); -} + TransitGatewayArn?: string; -/** - *Describes a prefix list reference.
- */ -export interface TransitGatewayPrefixListReference { /** - *The ID of the transit gateway route table.
+ *The state of the transit gateway.
*/ - TransitGatewayRouteTableId?: string; + State?: TransitGatewayState | string; /** - *The ID of the prefix list.
+ *The ID of the Amazon Web Services account that owns the transit gateway.
*/ - PrefixListId?: string; + OwnerId?: string; /** - *The ID of the prefix list owner.
+ *The description of the transit gateway.
*/ - PrefixListOwnerId?: string; + Description?: string; /** - *The state of the prefix list reference.
+ *The creation time.
*/ - State?: TransitGatewayPrefixListReferenceState | string; + CreationTime?: Date; /** - *Indicates whether traffic that matches this route is dropped.
+ *The transit gateway options.
*/ - Blackhole?: boolean; + Options?: TransitGatewayOptions; /** - *Information about the transit gateway attachment.
+ *The tags for the transit gateway.
*/ - TransitGatewayAttachment?: TransitGatewayPrefixListAttachment; + Tags?: Tag[]; } -export namespace TransitGatewayPrefixListReference { +export namespace TransitGateway { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayPrefixListReference): any => ({ + export const filterSensitiveLog = (obj: TransitGateway): any => ({ ...obj, }); } -export interface CreateTransitGatewayPrefixListReferenceResult { +export interface CreateTransitGatewayResult { /** - *Information about the prefix list reference.
+ *Information about the transit gateway.
*/ - TransitGatewayPrefixListReference?: TransitGatewayPrefixListReference; + TransitGateway?: TransitGateway; } -export namespace CreateTransitGatewayPrefixListReferenceResult { +export namespace CreateTransitGatewayResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayPrefixListReferenceResult): any => ({ + export const filterSensitiveLog = (obj: CreateTransitGatewayResult): any => ({ ...obj, }); } -export interface CreateTransitGatewayRouteRequest { +export type ProtocolValue = "gre"; + +/** + *The options for a Connect attachment.
+ */ +export interface CreateTransitGatewayConnectRequestOptions { /** - *The CIDR range used for destination matches. Routing decisions are based on the - * most specific match.
+ *The tunnel protocol.
*/ - DestinationCidrBlock: string | undefined; + Protocol: ProtocolValue | string | undefined; +} +export namespace CreateTransitGatewayConnectRequestOptions { /** - *The ID of the transit gateway route table.
+ * @internal */ - TransitGatewayRouteTableId: string | undefined; + export const filterSensitiveLog = (obj: CreateTransitGatewayConnectRequestOptions): any => ({ + ...obj, + }); +} +export interface CreateTransitGatewayConnectRequest { /** - *The ID of the attachment.
+ *The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment.
*/ - TransitGatewayAttachmentId?: string; + TransportTransitGatewayAttachmentId: string | undefined; /** - *Indicates whether to drop traffic that matches this route.
+ *The Connect attachment options.
*/ - Blackhole?: boolean; + Options: CreateTransitGatewayConnectRequestOptions | undefined; + + /** + *The tags to apply to the Connect attachment.
+ */ + TagSpecifications?: TagSpecification[]; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -7577,593 +8090,508 @@ export interface CreateTransitGatewayRouteRequest { DryRun?: boolean; } -export namespace CreateTransitGatewayRouteRequest { +export namespace CreateTransitGatewayConnectRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayRouteRequest): any => ({ + export const filterSensitiveLog = (obj: CreateTransitGatewayConnectRequest): any => ({ ...obj, }); } -export type TransitGatewayRouteState = "active" | "blackhole" | "deleted" | "deleting" | "pending"; - /** - *
Describes a route attachment.
+ *Describes the Connect attachment options.
*/ -export interface TransitGatewayRouteAttachment { - /** - *The ID of the resource.
- */ - ResourceId?: string; - - /** - *The ID of the attachment.
- */ - TransitGatewayAttachmentId?: string; - +export interface TransitGatewayConnectOptions { /** - *The resource type. Note that the tgw-peering resource type has been deprecated.
The tunnel protocol.
*/ - ResourceType?: TransitGatewayAttachmentResourceType | string; + Protocol?: ProtocolValue | string; } -export namespace TransitGatewayRouteAttachment { +export namespace TransitGatewayConnectOptions { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayRouteAttachment): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayConnectOptions): any => ({ ...obj, }); } -export type TransitGatewayRouteType = "propagated" | "static"; - /** - *Describes a route for a transit gateway route table.
+ *Describes a transit gateway Connect attachment.
*/ -export interface TransitGatewayRoute { +export interface TransitGatewayConnect { /** - *The CIDR block used for destination matches.
+ *The ID of the Connect attachment.
*/ - DestinationCidrBlock?: string; + TransitGatewayAttachmentId?: string; /** - *The ID of the prefix list used for destination matches.
+ *The ID of the attachment from which the Connect attachment was created.
*/ - PrefixListId?: string; + TransportTransitGatewayAttachmentId?: string; /** - *The attachments.
+ *The ID of the transit gateway.
*/ - TransitGatewayAttachments?: TransitGatewayRouteAttachment[]; + TransitGatewayId?: string; /** - *The route type.
+ *The state of the attachment.
*/ - Type?: TransitGatewayRouteType | string; + State?: TransitGatewayAttachmentState | string; /** - *The state of the route.
+ *The creation time.
*/ - State?: TransitGatewayRouteState | string; -} + CreationTime?: Date; -export namespace TransitGatewayRoute { /** - * @internal + *The Connect attachment options.
*/ - export const filterSensitiveLog = (obj: TransitGatewayRoute): any => ({ - ...obj, - }); -} + Options?: TransitGatewayConnectOptions; -export interface CreateTransitGatewayRouteResult { /** - *Information about the route.
+ *The tags for the attachment.
*/ - Route?: TransitGatewayRoute; + Tags?: Tag[]; } -export namespace CreateTransitGatewayRouteResult { +export namespace TransitGatewayConnect { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayRouteResult): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayConnect): any => ({ ...obj, }); } -export interface CreateTransitGatewayRouteTableRequest { +export interface CreateTransitGatewayConnectResult { /** - *The ID of the transit gateway.
+ *Information about the Connect attachment.
*/ - TransitGatewayId: string | undefined; + TransitGatewayConnect?: TransitGatewayConnect; +} +export namespace CreateTransitGatewayConnectResult { /** - *The tags to apply to the transit gateway route table.
+ * @internal */ - TagSpecifications?: TagSpecification[]; + export const filterSensitiveLog = (obj: CreateTransitGatewayConnectResult): any => ({ + ...obj, + }); +} +/** + *The BGP options for the Connect attachment.
+ */ +export interface TransitGatewayConnectRequestBgpOptions { /** - *Checks whether you have the required permissions for the action, without 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 peer Autonomous System Number (ASN).
*/ - DryRun?: boolean; + PeerAsn?: number; } -export namespace CreateTransitGatewayRouteTableRequest { +export namespace TransitGatewayConnectRequestBgpOptions { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayRouteTableRequest): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayConnectRequestBgpOptions): any => ({ ...obj, }); } -export type TransitGatewayRouteTableState = "available" | "deleted" | "deleting" | "pending"; - -/** - *Describes a transit gateway route table.
- */ -export interface TransitGatewayRouteTable { +export interface CreateTransitGatewayConnectPeerRequest { /** - *The ID of the transit gateway route table.
+ *The ID of the Connect attachment.
*/ - TransitGatewayRouteTableId?: string; + TransitGatewayAttachmentId: string | undefined; /** - *The ID of the transit gateway.
+ *The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be + * specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns + * the first available IP address from the transit gateway CIDR block.
*/ - TransitGatewayId?: string; + TransitGatewayAddress?: string; /** - *The state of the transit gateway route table.
+ *The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.
*/ - State?: TransitGatewayRouteTableState | string; + PeerAddress: string | undefined; /** - *Indicates whether this is the default association route table for the transit gateway.
+ *The BGP options for the Connect peer.
*/ - DefaultAssociationRouteTable?: boolean; + BgpOptions?: TransitGatewayConnectRequestBgpOptions; /** - *Indicates whether this is the default propagation route table for the transit gateway.
+ *The range of inside IP addresses that are used for BGP peering. You must specify a
+ * size /29 IPv4 CIDR block from the 169.254.0.0/16 range. The first address
+ * from the range must be configured on the appliance as the BGP IP address. You can also
+ * optionally specify a size /125 IPv6 CIDR block from the fd00::/8
+ * range.
The creation time.
+ *The tags to apply to the Connect peer.
*/ - CreationTime?: Date; + TagSpecifications?: TagSpecification[]; /** - *Any tags assigned to the route table.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The BGP configuration information.
+ */ +export interface TransitGatewayAttachmentBgpConfiguration { + /** + *The transit gateway Autonomous System Number (ASN).
+ */ + TransitGatewayAsn?: number; + + /** + *The peer Autonomous System Number (ASN).
+ */ + PeerAsn?: number; + + /** + *The interior BGP peer IP address for the transit gateway.
+ */ + TransitGatewayAddress?: string; + + /** + *The interior BGP peer IP address for the appliance.
+ */ + PeerAddress?: string; + /** - *Information about the transit gateway route table.
+ *The BGP status.
*/ - TransitGatewayRouteTable?: TransitGatewayRouteTable; + BgpStatus?: BgpStatus | string; } -export namespace CreateTransitGatewayRouteTableResult { +export namespace TransitGatewayAttachmentBgpConfiguration { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayRouteTableResult): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayAttachmentBgpConfiguration): any => ({ ...obj, }); } /** - *Describes the options for a VPC attachment.
+ *Describes the Connect peer details.
*/ -export interface CreateTransitGatewayVpcAttachmentRequestOptions { +export interface TransitGatewayConnectPeerConfiguration { /** - *Enable or disable DNS support. The default is enable.
The Connect peer IP address on the transit gateway side of the tunnel.
*/ - DnsSupport?: DnsSupportValue | string; + TransitGatewayAddress?: string; /** - *Enable or disable IPv6 support. The default is disable.
The Connect peer IP address on the appliance side of the tunnel.
*/ - Ipv6Support?: Ipv6SupportValue | string; + PeerAddress?: string; /** - *Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.
The range of interior BGP peer IP addresses.
*/ - ApplianceModeSupport?: ApplianceModeSupportValue | string; + InsideCidrBlocks?: string[]; + + /** + *The tunnel protocol.
+ */ + Protocol?: ProtocolValue | string; + + /** + *The BGP configuration details.
+ */ + BgpConfigurations?: TransitGatewayAttachmentBgpConfiguration[]; } -export namespace CreateTransitGatewayVpcAttachmentRequestOptions { +export namespace TransitGatewayConnectPeerConfiguration { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayVpcAttachmentRequestOptions): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayConnectPeerConfiguration): any => ({ ...obj, }); } -export interface CreateTransitGatewayVpcAttachmentRequest { +export type TransitGatewayConnectPeerState = "available" | "deleted" | "deleting" | "pending"; + +/** + *Describes a transit gateway Connect peer.
+ */ +export interface TransitGatewayConnectPeer { /** - *The ID of the transit gateway.
+ *The ID of the Connect attachment.
*/ - TransitGatewayId: string | undefined; + TransitGatewayAttachmentId?: string; /** - *The ID of the VPC.
+ *The ID of the Connect peer.
*/ - VpcId: string | undefined; + TransitGatewayConnectPeerId?: string; /** - *The IDs of one or more subnets. You can specify only one subnet per Availability Zone. - * You must specify at least one subnet, but we recommend that you specify two subnets for better availability. - * The transit gateway uses one IP address from each specified subnet.
+ *The state of the Connect peer.
*/ - SubnetIds: string[] | undefined; + State?: TransitGatewayConnectPeerState | string; /** - *The VPC attachment options.
+ *The creation time.
*/ - Options?: CreateTransitGatewayVpcAttachmentRequestOptions; + CreationTime?: Date; /** - *The tags to apply to the VPC attachment.
+ *The Connect peer details.
*/ - TagSpecifications?: TagSpecification[]; + ConnectPeerConfiguration?: TransitGatewayConnectPeerConfiguration; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The tags for the Connect peer.
*/ - DryRun?: boolean; + Tags?: Tag[]; } -export namespace CreateTransitGatewayVpcAttachmentRequest { +export namespace TransitGatewayConnectPeer { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayVpcAttachmentRequest): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayConnectPeer): any => ({ ...obj, }); } -export interface CreateTransitGatewayVpcAttachmentResult { +export interface CreateTransitGatewayConnectPeerResult { /** - *Information about the VPC attachment.
+ *Information about the Connect peer.
*/ - TransitGatewayVpcAttachment?: TransitGatewayVpcAttachment; + TransitGatewayConnectPeer?: TransitGatewayConnectPeer; } -export namespace CreateTransitGatewayVpcAttachmentResult { +export namespace CreateTransitGatewayConnectPeerResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateTransitGatewayVpcAttachmentResult): any => ({ + export const filterSensitiveLog = (obj: CreateTransitGatewayConnectPeerResult): any => ({ ...obj, }); } -export interface CreateVolumeRequest { - /** - *The Availability Zone in which to create the volume.
- */ - AvailabilityZone: string | undefined; - - /** - *Indicates whether the volume should be encrypted.
- * The effect of setting the encryption state to true depends on
- * the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled.
- * For more information, see Encryption by default
- * in the Amazon Elastic Compute Cloud User Guide.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. - * For more information, see Supported - * instance types.
- */ - Encrypted?: boolean; - - /** - *The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents
- * the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline
- * performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
- *
- * gp3: 3,000-16,000 IOPS
- * io1: 100-64,000 IOPS
- * io2: 100-64,000 IOPS
- * io1 and io2 volumes support up to 64,000 IOPS only on
- * Instances built on the Nitro System. Other instance families support performance
- * up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes.
- * The default for gp3 volumes is 3,000 IOPS.
- * This parameter is not supported for gp2, st1, sc1, or standard volumes.
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.
- * If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is
- * specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
- *Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
- *Key alias. For example, alias/ExampleAlias.
- *Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
- *Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
- *Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, - * the action can appear to complete, but eventually fails.
- */ - KmsKeyId?: string; +export type Igmpv2SupportValue = "disable" | "enable"; - /** - *The Amazon Resource Name (ARN) of the Outpost.
- */ - OutpostArn?: string; +export type StaticSourcesSupportValue = "disable" | "enable"; +/** + *The options for the transit gateway multicast domain.
+ */ +export interface CreateTransitGatewayMulticastDomainRequestOptions { /** - *The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. - * If you specify a snapshot, the default is the snapshot size. You can specify a volume - * size that is equal to or larger than the snapshot size.
- *The following are the supported volumes sizes for each volume type:
- *
- * gp2 and gp3: 1-16,384
- * io1 and io2: 4-16,384
- * st1 and sc1: 125-16,384
- * standard: 1-1,024
Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.
*/ - Size?: number; + Igmpv2Support?: Igmpv2SupportValue | string; /** - *The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
+ *Specify whether to enable support for statically configuring multicast group sources for a domain.
*/ - SnapshotId?: string; + StaticSourcesSupport?: StaticSourcesSupportValue | string; /** - *The volume type. This parameter can be one of the following values:
- *General Purpose SSD: gp2 | gp3
- *
Provisioned IOPS SSD: io1 | io2
- *
Throughput Optimized HDD: st1
- *
Cold HDD: sc1
- *
Magnetic: standard
- *
For more information, see Amazon EBS volume types in the - * Amazon Elastic Compute Cloud User Guide.
- *Default: gp2
- *
Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.
*/ - VolumeType?: VolumeType | string; + AutoAcceptSharedAssociations?: AutoAcceptSharedAssociationsValue | string; +} +export namespace CreateTransitGatewayMulticastDomainRequestOptions { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The tags to apply to the volume during creation.
+ *The ID of the transit gateway.
*/ - TagSpecifications?: TagSpecification[]; + TransitGatewayId: string | undefined; /** - *Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the
- * volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is
- * supported with io1 and io2 volumes only. For more information,
- * see
- * Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.
The options for the transit gateway multicast domain.
*/ - MultiAttachEnabled?: boolean; + Options?: CreateTransitGatewayMulticastDomainRequestOptions; /** - *The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
- *This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
+ *The tags for the transit gateway multicast domain.
*/ - Throughput?: number; + TagSpecifications?: TagSpecification[]; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency - * of the request. For more information, see Ensure - * Idempotency.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a volume.
+ *Describes the options for a transit gateway multicast domain.
*/ -export interface Volume { - /** - *Information about the volume attachments.
- */ - Attachments?: VolumeAttachment[]; - +export interface TransitGatewayMulticastDomainOptions { /** - *The Availability Zone for the volume.
+ *Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.
*/ - AvailabilityZone?: string; + Igmpv2Support?: Igmpv2SupportValue | string; /** - *The time stamp when volume creation was initiated.
+ *Indicates whether support for statically configuring transit gateway multicast group sources is turned on.
*/ - CreateTime?: Date; + StaticSourcesSupport?: StaticSourcesSupportValue | string; /** - *Indicates whether the volume is encrypted.
+ *Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.
*/ - Encrypted?: boolean; + AutoAcceptSharedAssociations?: AutoAcceptSharedAssociationsValue | string; +} +export namespace TransitGatewayMulticastDomainOptions { /** - *The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the - * volume encryption key for the volume.
+ * @internal */ - KmsKeyId?: string; + export const filterSensitiveLog = (obj: TransitGatewayMulticastDomainOptions): any => ({ + ...obj, + }); +} - /** - *The Amazon Resource Name (ARN) of the Outpost.
- */ - OutpostArn?: string; +export type TransitGatewayMulticastDomainState = "available" | "deleted" | "deleting" | "pending"; +/** + *Describes the transit gateway multicast domain.
+ */ +export interface TransitGatewayMulticastDomain { /** - *The size of the volume, in GiBs.
+ *The ID of the transit gateway multicast domain.
*/ - Size?: number; + TransitGatewayMulticastDomainId?: string; /** - *The snapshot from which the volume was created, if applicable.
+ *The ID of the transit gateway.
*/ - SnapshotId?: string; + TransitGatewayId?: string; /** - *The volume state.
+ *The Amazon Resource Name (ARN) of the transit gateway multicast domain.
*/ - State?: VolumeState | string; + TransitGatewayMulticastDomainArn?: string; /** - *The ID of the volume.
+ *The ID of the Amazon Web Services account that owns the transit gateway multicast domain.
*/ - VolumeId?: string; + OwnerId?: string; /** - *The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents
- * the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline
- * performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The options for the transit gateway multicast domain.
*/ - Iops?: number; + Options?: TransitGatewayMulticastDomainOptions; /** - *Any tags assigned to the volume.
+ *The state of the transit gateway multicast domain.
*/ - Tags?: Tag[]; + State?: TransitGatewayMulticastDomainState | string; /** - *The volume type.
+ *The time the transit gateway multicast domain was created.
*/ - VolumeType?: VolumeType | string; + CreationTime?: Date; /** - *Indicates whether the volume was created using fast snapshot restore.
+ *The tags for the transit gateway multicast domain.
*/ - FastRestored?: boolean; + Tags?: Tag[]; +} +export namespace TransitGatewayMulticastDomain { /** - *Indicates whether Amazon EBS Multi-Attach is enabled.
+ * @internal */ - MultiAttachEnabled?: boolean; + export const filterSensitiveLog = (obj: TransitGatewayMulticastDomain): any => ({ + ...obj, + }); +} +export interface CreateTransitGatewayMulticastDomainResult { /** - *The throughput that the volume supports, in MiB/s.
+ *Information about the transit gateway multicast domain.
*/ - Throughput?: number; + TransitGatewayMulticastDomain?: TransitGatewayMulticastDomain; } -export namespace Volume { +export namespace CreateTransitGatewayMulticastDomainResult { /** * @internal */ - export const filterSensitiveLog = (obj: Volume): any => ({ + export const filterSensitiveLog = (obj: CreateTransitGatewayMulticastDomainResult): any => ({ ...obj, }); } -export interface CreateVpcRequest { +export interface CreateTransitGatewayPeeringAttachmentRequest { /** - *The IPv4 network range for the VPC, in CIDR notation. For example,
- * 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The ID of the transit gateway.
*/ - CidrBlock: string | undefined; + TransitGatewayId: string | undefined; /** - *Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. - * You cannot specify the range of IP addresses, or the size of the CIDR block.
+ *The ID of the peer transit gateway with which to create the peering attachment.
*/ - AmazonProvidedIpv6CidrBlock?: boolean; + PeerTransitGatewayId: string | undefined; /** - *The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
+ *The ID of the Amazon Web Services account that owns the peer transit gateway.
*/ - Ipv6Pool?: string; + PeerAccountId: string | undefined; /** - *The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
+ *The Region where the peer transit gateway is located.
*/ - Ipv6CidrBlock?: string; + PeerRegion: string | undefined; + + /** + *The tags to apply to the transit gateway peering attachment.
+ */ + TagSpecifications?: TagSpecification[]; /** *Checks whether you have the required permissions for the action, without actually making the request,
@@ -8171,1396 +8599,1267 @@ export interface CreateVpcRequest {
* Otherwise, it is UnauthorizedOperation.
The tenancy options for instances launched into the VPC. For default, instances
- * are launched with shared tenancy by default. You can launch instances with any tenancy into a
- * shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy
- * instances by default. You can only launch instances with a tenancy of dedicated
- * or host into a dedicated tenancy VPC.
- * Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
- *
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
- * You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
The tags to assign to the VPC.
- */ - TagSpecifications?: TagSpecification[]; } -export namespace CreateVpcRequest { +export namespace CreateTransitGatewayPeeringAttachmentRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateVpcRequest): any => ({ + export const filterSensitiveLog = (obj: CreateTransitGatewayPeeringAttachmentRequest): any => ({ ...obj, }); } -export interface CreateVpcResult { +export interface CreateTransitGatewayPeeringAttachmentResult { /** - *Information about the VPC.
+ *The transit gateway peering attachment.
*/ - Vpc?: Vpc; + TransitGatewayPeeringAttachment?: TransitGatewayPeeringAttachment; } -export namespace CreateVpcResult { +export namespace CreateTransitGatewayPeeringAttachmentResult { /** * @internal */ - export const filterSensitiveLog = (obj: CreateVpcResult): any => ({ + export const filterSensitiveLog = (obj: CreateTransitGatewayPeeringAttachmentResult): any => ({ ...obj, }); } -export enum VpcEndpointType { - Gateway = "Gateway", - GatewayLoadBalancer = "GatewayLoadBalancer", - Interface = "Interface", -} - -/** - *Contains the parameters for CreateVpcEndpoint.
- */ -export interface CreateVpcEndpointRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The type of endpoint.
- *Default: Gateway
+ *The ID of the transit gateway route table.
*/ - VpcEndpointType?: VpcEndpointType | string; + TransitGatewayRouteTableId: string | undefined; /** - *The ID of the VPC in which the endpoint will be used.
+ *The ID of the prefix list that is used for destination matches.
*/ - VpcId: string | undefined; + PrefixListId: string | undefined; /** - *The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service - * provider.
+ *The ID of the attachment to which traffic is routed.
*/ - ServiceName: string | undefined; + TransitGatewayAttachmentId?: string; /** - *(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the - * service. The policy must be in valid JSON format. If this parameter is not specified, we - * attach a default policy that allows full access to the service.
+ *Indicates whether to drop traffic that matches this route.
*/ - PolicyDocument?: string; + Blackhole?: boolean; /** - *(Gateway endpoint) One or more route table IDs.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint - * network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.
+ * @internal */ - SubnetIds?: string[]; + export const filterSensitiveLog = (obj: CreateTransitGatewayPrefixListReferenceRequest): any => ({ + ...obj, + }); +} - /** - *(Interface endpoint) The ID of one or more security groups to associate with the - * endpoint network interface.
- */ - SecurityGroupIds?: string[]; +export type TransitGatewayPrefixListReferenceState = "available" | "deleting" | "modifying" | "pending"; +/** + *Describes a transit gateway prefix list attachment.
+ */ +export interface TransitGatewayPrefixListAttachment { /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to ensure - * idempotency.
+ *The ID of the attachment.
*/ - ClientToken?: string; + TransitGatewayAttachmentId?: string; /** - *(Interface endpoint) Indicates whether to associate a private hosted zone with the
- * specified VPC. The private hosted zone contains a record set for the default public DNS
- * name for the service for the Region (for example,
- * kinesis.us-east-1.amazonaws.com), which resolves to the private IP
- * addresses of the endpoint network interfaces in the VPC. This enables you to make
- * requests to the default public DNS name for the service instead of the public DNS names
- * that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to
- * true: enableDnsHostnames and
- * enableDnsSupport. Use ModifyVpcAttribute to set the VPC
- * attributes.
Default: true
- *
The resource type. Note that the tgw-peering resource type has been deprecated.
The tags to associate with the endpoint.
+ *The ID of the resource.
*/ - TagSpecifications?: TagSpecification[]; + ResourceId?: string; } -export namespace CreateVpcEndpointRequest { +export namespace TransitGatewayPrefixListAttachment { /** * @internal */ - export const filterSensitiveLog = (obj: CreateVpcEndpointRequest): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayPrefixListAttachment): any => ({ ...obj, }); } /** - *Describes a DNS entry.
+ *Describes a prefix list reference.
*/ -export interface DnsEntry { +export interface TransitGatewayPrefixListReference { /** - *The DNS name.
+ *The ID of the transit gateway route table.
*/ - DnsName?: string; + TransitGatewayRouteTableId?: string; /** - *The ID of the private hosted zone.
+ *The ID of the prefix list.
*/ - HostedZoneId?: string; -} + PrefixListId?: string; -export namespace DnsEntry { /** - * @internal + *The ID of the prefix list owner.
*/ - export const filterSensitiveLog = (obj: DnsEntry): any => ({ - ...obj, - }); -} + PrefixListOwnerId?: string; -/** - *Describes a security group.
- */ -export interface SecurityGroupIdentifier { /** - *The ID of the security group.
+ *The state of the prefix list reference.
*/ - GroupId?: string; + State?: TransitGatewayPrefixListReferenceState | string; /** - *The name of the security group.
+ *Indicates whether traffic that matches this route is dropped.
*/ - GroupName?: string; + Blackhole?: boolean; + + /** + *Information about the transit gateway attachment.
+ */ + TransitGatewayAttachment?: TransitGatewayPrefixListAttachment; } -export namespace SecurityGroupIdentifier { +export namespace TransitGatewayPrefixListReference { /** * @internal */ - export const filterSensitiveLog = (obj: SecurityGroupIdentifier): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayPrefixListReference): any => ({ ...obj, }); } -/** - *The last error that occurred for a VPC endpoint.
- */ -export interface LastError { - /** - *The error message for the VPC endpoint error.
- */ - Message?: string; - +export interface CreateTransitGatewayPrefixListReferenceResult { /** - *The error code for the VPC endpoint error.
+ *Information about the prefix list reference.
*/ - Code?: string; + TransitGatewayPrefixListReference?: TransitGatewayPrefixListReference; } -export namespace LastError { +export namespace CreateTransitGatewayPrefixListReferenceResult { /** * @internal */ - export const filterSensitiveLog = (obj: LastError): any => ({ + export const filterSensitiveLog = (obj: CreateTransitGatewayPrefixListReferenceResult): any => ({ ...obj, }); } -export enum State { - Available = "Available", - Deleted = "Deleted", - Deleting = "Deleting", - Expired = "Expired", - Failed = "Failed", - Pending = "Pending", - PendingAcceptance = "PendingAcceptance", - Rejected = "Rejected", -} - -/** - *Describes a VPC endpoint.
- */ -export interface VpcEndpoint { +export interface CreateTransitGatewayRouteRequest { /** - *The ID of the VPC endpoint.
+ *The CIDR range used for destination matches. Routing decisions are based on the + * most specific match.
*/ - VpcEndpointId?: string; + DestinationCidrBlock: string | undefined; /** - *The type of endpoint.
+ *The ID of the transit gateway route table.
*/ - VpcEndpointType?: VpcEndpointType | string; + TransitGatewayRouteTableId: string | undefined; /** - *The ID of the VPC to which the endpoint is associated.
+ *The ID of the attachment.
*/ - VpcId?: string; + TransitGatewayAttachmentId?: string; /** - *The name of the service to which the endpoint is associated.
+ *Indicates whether to drop traffic that matches this route.
*/ - ServiceName?: string; + Blackhole?: boolean; /** - *The state of the VPC endpoint.
+ *Checks whether you have the required permissions for the action, without 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 policy document associated with the endpoint, if applicable.
+ * @internal */ - PolicyDocument?: string; + export const filterSensitiveLog = (obj: CreateTransitGatewayRouteRequest): any => ({ + ...obj, + }); +} + +export type TransitGatewayRouteState = "active" | "blackhole" | "deleted" | "deleting" | "pending"; +/** + *Describes a route attachment.
+ */ +export interface TransitGatewayRouteAttachment { /** - *(Gateway endpoint) One or more route tables associated with the endpoint.
+ *The ID of the resource.
*/ - RouteTableIds?: string[]; + ResourceId?: string; /** - *(Interface endpoint) One or more subnets in which the endpoint is located.
+ *The ID of the attachment.
*/ - SubnetIds?: string[]; + TransitGatewayAttachmentId?: string; /** - *(Interface endpoint) Information about the security groups that are associated with - * the network interface.
+ *The resource type. Note that the tgw-peering resource type has been deprecated.
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
+ * @internal */ - PrivateDnsEnabled?: boolean; + export const filterSensitiveLog = (obj: TransitGatewayRouteAttachment): any => ({ + ...obj, + }); +} + +export type TransitGatewayRouteType = "propagated" | "static"; +/** + *Describes a route for a transit gateway route table.
+ */ +export interface TransitGatewayRoute { /** - *Indicates whether the VPC endpoint is being managed by its service.
+ *The CIDR block used for destination matches.
*/ - RequesterManaged?: boolean; + DestinationCidrBlock?: string; /** - *(Interface endpoint) One or more network interfaces for the endpoint.
+ *The ID of the prefix list used for destination matches.
*/ - NetworkInterfaceIds?: string[]; + PrefixListId?: string; /** - *(Interface endpoint) The DNS entries for the endpoint.
+ *The attachments.
*/ - DnsEntries?: DnsEntry[]; + TransitGatewayAttachments?: TransitGatewayRouteAttachment[]; /** - *The date and time that the VPC endpoint was created.
+ *The route type.
*/ - CreationTimestamp?: Date; + Type?: TransitGatewayRouteType | string; /** - *Any tags assigned to the VPC endpoint.
+ *The state of the route.
*/ - Tags?: Tag[]; + State?: TransitGatewayRouteState | string; +} +export namespace TransitGatewayRoute { /** - *The ID of the Amazon Web Services account that owns the VPC endpoint.
+ * @internal */ - OwnerId?: string; + export const filterSensitiveLog = (obj: TransitGatewayRoute): any => ({ + ...obj, + }); +} +export interface CreateTransitGatewayRouteResult { /** - *The last error that occurred for VPC endpoint.
+ *Information about the route.
*/ - LastError?: LastError; + Route?: TransitGatewayRoute; } -export namespace VpcEndpoint { +export namespace CreateTransitGatewayRouteResult { /** * @internal */ - export const filterSensitiveLog = (obj: VpcEndpoint): any => ({ + export const filterSensitiveLog = (obj: CreateTransitGatewayRouteResult): any => ({ ...obj, }); } -/** - *Contains the output of CreateVpcEndpoint.
- */ -export interface CreateVpcEndpointResult { +export interface CreateTransitGatewayRouteTableRequest { /** - *Information about the endpoint.
+ *The ID of the transit gateway.
*/ - VpcEndpoint?: VpcEndpoint; + TransitGatewayId: string | undefined; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request.
+ *The tags to apply to the transit gateway route table.
*/ - ClientToken?: string; + TagSpecifications?: TagSpecification[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a transit gateway route table.
+ */ +export interface TransitGatewayRouteTable { /** - *Checks whether you have the required permissions for the action, without 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 transit gateway route table.
*/ - DryRun?: boolean; + TransitGatewayRouteTableId?: string; /** - *The ID of the endpoint service.
+ *The ID of the transit gateway.
*/ - ServiceId?: string; + TransitGatewayId?: string; /** - *The ID of the endpoint.
+ *The state of the transit gateway route table.
*/ - VpcEndpointId?: string; + State?: TransitGatewayRouteTableState | string; /** - *The ARN of the SNS topic for the notifications.
+ *Indicates whether this is the default association route table for the transit gateway.
*/ - ConnectionNotificationArn: string | undefined; + DefaultAssociationRouteTable?: boolean; /** - *One or more endpoint events for which to receive notifications. Valid values are
- * Accept, Connect, Delete, and
- * Reject.
Indicates whether this is the default propagation route table for the transit gateway.
*/ - ConnectionEvents: string[] | undefined; + DefaultPropagationRouteTable?: boolean; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to ensure - * idempotency.
+ *The creation time.
*/ - ClientToken?: string; + CreationTime?: Date; + + /** + *Any tags assigned to the route table.
+ */ + Tags?: Tag[]; } -export namespace CreateVpcEndpointConnectionNotificationRequest { +export namespace TransitGatewayRouteTable { /** * @internal */ - export const filterSensitiveLog = (obj: CreateVpcEndpointConnectionNotificationRequest): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayRouteTable): any => ({ ...obj, }); } -export enum ConnectionNotificationState { - Disabled = "Disabled", - Enabled = "Enabled", +export interface CreateTransitGatewayRouteTableResult { + /** + *Information about the transit gateway route table.
+ */ + TransitGatewayRouteTable?: TransitGatewayRouteTable; } -export enum ConnectionNotificationType { - Topic = "Topic", +export namespace CreateTransitGatewayRouteTableResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateTransitGatewayRouteTableResult): any => ({ + ...obj, + }); } /** - *Describes a connection notification for a VPC endpoint or VPC endpoint - * service.
+ *Describes the options for a VPC attachment.
*/ -export interface ConnectionNotification { +export interface CreateTransitGatewayVpcAttachmentRequestOptions { /** - *The ID of the notification.
+ *Enable or disable DNS support. The default is enable.
The ID of the endpoint service.
+ *Enable or disable IPv6 support. The default is disable.
The ID of the VPC endpoint.
+ *Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is disable.
The type of notification.
+ * @internal */ - ConnectionNotificationType?: ConnectionNotificationType | string; + export const filterSensitiveLog = (obj: CreateTransitGatewayVpcAttachmentRequestOptions): any => ({ + ...obj, + }); +} +export interface CreateTransitGatewayVpcAttachmentRequest { /** - *The ARN of the SNS topic for the notification.
+ *The ID of the transit gateway.
*/ - ConnectionNotificationArn?: string; + TransitGatewayId: string | undefined; /** - *The events for the notification. Valid values are Accept,
- * Connect, Delete, and Reject.
The ID of the VPC.
*/ - ConnectionEvents?: string[]; + VpcId: string | undefined; /** - *The state of the notification.
+ *The IDs of one or more subnets. You can specify only one subnet per Availability Zone. + * You must specify at least one subnet, but we recommend that you specify two subnets for better availability. + * The transit gateway uses one IP address from each specified subnet.
*/ - ConnectionNotificationState?: ConnectionNotificationState | string; -} + SubnetIds: string[] | undefined; -export namespace ConnectionNotification { /** - * @internal + *The VPC attachment options.
*/ - export const filterSensitiveLog = (obj: ConnectionNotification): any => ({ - ...obj, - }); -} + Options?: CreateTransitGatewayVpcAttachmentRequestOptions; -export interface CreateVpcEndpointConnectionNotificationResult { /** - *Information about the notification.
+ *The tags to apply to the VPC attachment.
*/ - ConnectionNotification?: ConnectionNotification; + TagSpecifications?: TagSpecification[]; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the VPC attachment.
*/ - DryRun?: boolean; + TransitGatewayVpcAttachment?: TransitGatewayVpcAttachment; +} +export namespace CreateTransitGatewayVpcAttachmentResult { /** - *Indicates whether requests from service consumers to create an endpoint to your service must - * be accepted. To accept a request, use AcceptVpcEndpointConnections.
+ * @internal */ - AcceptanceRequired?: boolean; + export const filterSensitiveLog = (obj: CreateTransitGatewayVpcAttachmentResult): any => ({ + ...obj, + }); +} +export interface CreateVolumeRequest { /** - *(Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.
+ *The Availability Zone in which to create the volume.
*/ - PrivateDnsName?: string; + AvailabilityZone: string | undefined; /** - *The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your - * service.
+ *Indicates whether the volume should be encrypted.
+ * The effect of setting the encryption state to true depends on
+ * the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled.
+ * For more information, see Encryption by default
+ * in the Amazon Elastic Compute Cloud User Guide.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. + * For more information, see Supported + * instance types.
*/ - NetworkLoadBalancerArns?: string[]; + Encrypted?: boolean; /** - *The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.
+ *The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents
+ * the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline
+ * performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
+ *
+ * gp3: 3,000-16,000 IOPS
+ * io1: 100-64,000 IOPS
+ * io2: 100-64,000 IOPS
+ * io1 and io2 volumes support up to 64,000 IOPS only on
+ * Instances built on the Nitro System. Other instance families support performance
+ * up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes.
+ * The default for gp3 volumes is 3,000 IOPS.
+ * This parameter is not supported for gp2, st1, sc1, or standard volumes.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. - * For more information, see How to ensure - * idempotency.
+ *The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.
+ * If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is
+ * specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
+ *Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
+ *Key alias. For example, alias/ExampleAlias.
+ *Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
+ *Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
+ *Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, + * the action can appear to complete, but eventually fails.
*/ - ClientToken?: string; + KmsKeyId?: string; /** - *The tags to associate with the service.
+ *The Amazon Resource Name (ARN) of the Outpost.
*/ - TagSpecifications?: TagSpecification[]; -} + OutpostArn?: string; -export namespace CreateVpcEndpointServiceConfigurationRequest { /** - * @internal + *The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. + * If you specify a snapshot, the default is the snapshot size. You can specify a volume + * size that is equal to or larger than the snapshot size.
+ *The following are the supported volumes sizes for each volume type:
+ *
+ * gp2 and gp3: 1-16,384
+ * io1 and io2: 4-16,384
+ * st1 and sc1: 125-16,384
+ * standard: 1-1,024
Information about the private DNS name for the service endpoint. For more information - * about these parameters, see VPC Endpoint Service - * Private DNS Name Verification in the - * Amazon Virtual Private Cloud User Guide.
- */ -export interface PrivateDnsNameConfiguration { /** - *The verification state of the VPC endpoint service.
- *>Consumers
- * of the endpoint service can use the private name only when the state is
- * verified.
The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
*/ - State?: DnsNameState | string; + SnapshotId?: string; /** - *The endpoint service verification type, for example TXT.
+ *The volume type. This parameter can be one of the following values:
+ *General Purpose SSD: gp2 | gp3
+ *
Provisioned IOPS SSD: io1 | io2
+ *
Throughput Optimized HDD: st1
+ *
Cold HDD: sc1
+ *
Magnetic: standard
+ *
For more information, see Amazon EBS volume types in the + * Amazon Elastic Compute Cloud User Guide.
+ *Default: gp2
+ *
The value the service provider adds to the private DNS name domain record before verification.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name.
The tags to apply to the volume during creation.
*/ - Name?: string; -} + TagSpecifications?: TagSpecification[]; -export namespace PrivateDnsNameConfiguration { /** - * @internal + *Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the
+ * volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is
+ * supported with io1 and io2 volumes only. For more information,
+ * see
+ * Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.
The throughput to provision for a volume, with a maximum of 1,000 MiB/s.
+ *This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
+ */ + Throughput?: number; -/** - *Describes the type of service for a VPC endpoint.
- */ -export interface ServiceTypeDetail { /** - *The type of service.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency + * of the request. For more information, see Ensure + * Idempotency.
*/ - ServiceType?: ServiceType | string; + ClientToken?: string; } -export namespace ServiceTypeDetail { +export namespace CreateVolumeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ServiceTypeDetail): any => ({ + export const filterSensitiveLog = (obj: CreateVolumeRequest): any => ({ ...obj, }); } +export type VolumeState = "available" | "creating" | "deleted" | "deleting" | "error" | "in-use"; + /** - *Describes a service configuration for a VPC endpoint service.
+ *Describes a volume.
*/ -export interface ServiceConfiguration { +export interface Volume { /** - *The type of service.
+ *Information about the volume attachments.
*/ - ServiceType?: ServiceTypeDetail[]; + Attachments?: VolumeAttachment[]; /** - *The ID of the service.
+ *The Availability Zone for the volume.
*/ - ServiceId?: string; + AvailabilityZone?: string; /** - *The name of the service.
+ *The time stamp when volume creation was initiated.
*/ - ServiceName?: string; + CreateTime?: Date; /** - *The service state.
+ *Indicates whether the volume is encrypted.
*/ - ServiceState?: ServiceState | string; + Encrypted?: boolean; /** - *The Availability Zones in which the service is available.
+ *The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the + * volume encryption key for the volume.
*/ - AvailabilityZones?: string[]; + KmsKeyId?: string; /** - *Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.
+ *The Amazon Resource Name (ARN) of the Outpost.
*/ - AcceptanceRequired?: boolean; + OutpostArn?: string; /** - *Indicates whether the service manages its VPC endpoints. Management of the service VPC - * endpoints using the VPC endpoint API is restricted.
+ *The size of the volume, in GiBs.
*/ - ManagesVpcEndpoints?: boolean; + Size?: number; /** - *The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
+ *The snapshot from which the volume was created, if applicable.
*/ - NetworkLoadBalancerArns?: string[]; + SnapshotId?: string; /** - *The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
+ *The volume state.
*/ - GatewayLoadBalancerArns?: string[]; + State?: VolumeState | string; /** - *The DNS names for the service.
+ *The ID of the volume.
*/ - BaseEndpointDnsNames?: string[]; + VolumeId?: string; /** - *The private DNS name for the service.
+ *The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents
+ * the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline
+ * performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
Information about the endpoint service private DNS name configuration.
+ *Any tags assigned to the volume.
*/ - PrivateDnsNameConfiguration?: PrivateDnsNameConfiguration; + Tags?: Tag[]; /** - *Any tags assigned to the service.
+ *The volume type.
*/ - Tags?: Tag[]; -} + VolumeType?: VolumeType | string; -export namespace ServiceConfiguration { /** - * @internal + *Indicates whether the volume was created using fast snapshot restore.
*/ - export const filterSensitiveLog = (obj: ServiceConfiguration): any => ({ - ...obj, - }); -} + FastRestored?: boolean; -export interface CreateVpcEndpointServiceConfigurationResult { /** - *Information about the service configuration.
+ *Indicates whether Amazon EBS Multi-Attach is enabled.
*/ - ServiceConfiguration?: ServiceConfiguration; + MultiAttachEnabled?: boolean; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request.
+ *The throughput that the volume supports, in MiB/s.
*/ - ClientToken?: string; + Throughput?: number; } -export namespace CreateVpcEndpointServiceConfigurationResult { +export namespace Volume { /** * @internal */ - export const filterSensitiveLog = (obj: CreateVpcEndpointServiceConfigurationResult): any => ({ + export const filterSensitiveLog = (obj: Volume): any => ({ ...obj, }); } -export interface CreateVpcPeeringConnectionRequest { +export interface CreateVpcRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The IPv4 network range for the VPC, in CIDR notation. For example,
+ * 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.
The Amazon Web Services account ID of the owner of the accepter VPC.
- *Default: Your Amazon Web Services account ID
+ *Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. + * You cannot specify the range of IP addresses, or the size of the CIDR block.
*/ - PeerOwnerId?: string; + AmazonProvidedIpv6CidrBlock?: boolean; /** - *The ID of the VPC with which you are creating the VPC peering connection. You must - * specify this parameter in the request.
+ *The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
*/ - PeerVpcId?: string; + Ipv6Pool?: string; /** - *The ID of the requester VPC. You must specify this parameter in the - * request.
+ *The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
*/ - VpcId?: string; + Ipv6CidrBlock?: string; /** - *The Region code for the accepter VPC, if the accepter VPC is located in a Region - * other than the Region in which you make the request.
- *Default: The Region in which you make the request.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The tags to assign to the peering connection.
+ *The tenancy options for instances launched into the VPC. For default, instances
+ * are launched with shared tenancy by default. You can launch instances with any tenancy into a
+ * shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy
+ * instances by default. You can only launch instances with a tenancy of dedicated
+ * or host into a dedicated tenancy VPC.
+ * Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
+ *
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
+ * You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
Information about the VPC peering connection.
+ *The tags to assign to the VPC.
*/ - VpcPeeringConnection?: VpcPeeringConnection; + TagSpecifications?: TagSpecification[]; } -export namespace CreateVpcPeeringConnectionResult { +export namespace CreateVpcRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateVpcPeeringConnectionResult): any => ({ + export const filterSensitiveLog = (obj: CreateVpcRequest): any => ({ ...obj, }); } -export type TunnelInsideIpVersion = "ipv4" | "ipv6"; - -/** - *The IKE version that is permitted for the VPN tunnel.
- */ -export interface IKEVersionsRequestListValue { +export interface CreateVpcResult { /** - *The IKE version.
+ *Information about the VPC.
*/ - Value?: string; + Vpc?: Vpc; } -export namespace IKEVersionsRequestListValue { +export namespace CreateVpcResult { /** * @internal */ - export const filterSensitiveLog = (obj: IKEVersionsRequestListValue): any => ({ + export const filterSensitiveLog = (obj: CreateVpcResult): any => ({ ...obj, }); } -/** - *Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE - * negotiations.
- */ -export interface Phase1DHGroupNumbersRequestListValue { - /** - *The Diffie-Hellmann group number.
- */ - Value?: number; +export enum VpcEndpointType { + Gateway = "Gateway", + GatewayLoadBalancer = "GatewayLoadBalancer", + Interface = "Interface", } -export namespace Phase1DHGroupNumbersRequestListValue { +/** + *Contains the parameters for CreateVpcEndpoint.
+ */ +export interface CreateVpcEndpointRequest { /** - * @internal + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE - * negotiations.
- */ -export interface Phase1EncryptionAlgorithmsRequestListValue { /** - *The value for the encryption algorithm.
+ *The type of endpoint.
+ *Default: Gateway
*/ - Value?: string; -} + VpcEndpointType?: VpcEndpointType | string; -export namespace Phase1EncryptionAlgorithmsRequestListValue { /** - * @internal + *The ID of the VPC in which the endpoint will be used.
*/ - export const filterSensitiveLog = (obj: Phase1EncryptionAlgorithmsRequestListValue): any => ({ - ...obj, - }); -} + VpcId: string | undefined; -/** - *Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE - * negotiations.
- */ -export interface Phase1IntegrityAlgorithmsRequestListValue { /** - *The value for the integrity algorithm.
+ *The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service + * provider.
*/ - Value?: string; -} + ServiceName: string | undefined; -export namespace Phase1IntegrityAlgorithmsRequestListValue { /** - * @internal + *(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the + * service. The policy must be in valid JSON format. If this parameter is not specified, we + * attach a default policy that allows full access to the service.
*/ - export const filterSensitiveLog = (obj: Phase1IntegrityAlgorithmsRequestListValue): any => ({ - ...obj, - }); -} + PolicyDocument?: string; -/** - *Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE - * negotiations.
- */ -export interface Phase2DHGroupNumbersRequestListValue { /** - *The Diffie-Hellmann group number.
+ *(Gateway endpoint) One or more route table IDs.
*/ - Value?: number; -} + RouteTableIds?: string[]; -export namespace Phase2DHGroupNumbersRequestListValue { /** - * @internal + *(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint + * network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.
*/ - export const filterSensitiveLog = (obj: Phase2DHGroupNumbersRequestListValue): any => ({ - ...obj, - }); -} + SubnetIds?: string[]; -/** - *Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE - * negotiations.
- */ -export interface Phase2EncryptionAlgorithmsRequestListValue { /** - *The encryption algorithm.
+ *(Interface endpoint) The ID of one or more security groups to associate with the + * endpoint network interface.
*/ - Value?: string; -} + SecurityGroupIds?: string[]; -export namespace Phase2EncryptionAlgorithmsRequestListValue { /** - * @internal + *Unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. For more information, see How to ensure + * idempotency.
*/ - export const filterSensitiveLog = (obj: Phase2EncryptionAlgorithmsRequestListValue): any => ({ - ...obj, - }); -} + ClientToken?: string; -/** - *Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE - * negotiations.
- */ -export interface Phase2IntegrityAlgorithmsRequestListValue { /** - *The integrity algorithm.
+ *(Interface endpoint) Indicates whether to associate a private hosted zone with the
+ * specified VPC. The private hosted zone contains a record set for the default public DNS
+ * name for the service for the Region (for example,
+ * kinesis.us-east-1.amazonaws.com), which resolves to the private IP
+ * addresses of the endpoint network interfaces in the VPC. This enables you to make
+ * requests to the default public DNS name for the service instead of the public DNS names
+ * that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to
+ * true: enableDnsHostnames and
+ * enableDnsSupport. Use ModifyVpcAttribute to set the VPC
+ * attributes.
Default: true
+ *
The tags to associate with the endpoint.
*/ - export const filterSensitiveLog = (obj: Phase2IntegrityAlgorithmsRequestListValue): any => ({ - ...obj, - }); + TagSpecifications?: TagSpecification[]; } -/** - *The tunnel options for a single VPN tunnel.
- */ -export interface VpnTunnelOptionsSpecification { +export namespace CreateVpcEndpointRequest { /** - *The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be - * unique across all VPN connections that use the same virtual private gateway.
- *Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The
- * following CIDR blocks are reserved and cannot be used:
- * 169.254.0.0/30
- *
- * 169.254.1.0/30
- *
- * 169.254.2.0/30
- *
- * 169.254.3.0/30
- *
- * 169.254.4.0/30
- *
- * 169.254.5.0/30
- *
- * 169.254.169.252/30
- *
Describes a DNS entry.
+ */ +export interface DnsEntry { /** - *The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be - * unique across all VPN connections that use the same transit gateway.
- *Constraints: A size /126 CIDR block from the local fd00::/8 range.
The DNS name.
*/ - TunnelInsideIpv6Cidr?: string; + DnsName?: string; /** - *The pre-shared key (PSK) to establish initial authentication between the virtual - * private gateway and customer gateway.
- *Constraints: Allowed characters are alphanumeric characters, periods (.), and - * underscores (_). Must be between 8 and 64 characters in length and cannot start with - * zero (0).
+ *The ID of the private hosted zone.
*/ - PreSharedKey?: string; + HostedZoneId?: string; +} +export namespace DnsEntry { /** - *The lifetime for phase 1 of the IKE negotiation, in seconds.
- *Constraints: A value between 900 and 28,800.
- *Default: 28800
- *
Describes a security group.
+ */ +export interface SecurityGroupIdentifier { /** - *The lifetime for phase 2 of the IKE negotiation, in seconds.
- *Constraints: A value between 900 and 3,600. The value must be less than the value for
- * Phase1LifetimeSeconds.
Default: 3600
- *
The ID of the security group.
*/ - Phase2LifetimeSeconds?: number; + GroupId?: string; /** - *The margin time, in seconds, before the phase 2 lifetime expires, during which the
- * Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time
- * of the rekey is randomly selected based on the value for
- * RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 540
- *
The name of the security group.
*/ - RekeyMarginTimeSeconds?: number; + GroupName?: string; +} +export namespace SecurityGroupIdentifier { /** - *The percentage of the rekey window (determined by RekeyMarginTimeSeconds)
- * during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
- *Default: 100
- *
The last error that occurred for a VPC endpoint.
+ */ +export interface LastError { /** - *The number of packets in an IKE replay window.
- *Constraints: A value between 64 and 2048.
- *Default: 1024
- *
The error message for the VPC endpoint error.
*/ - ReplayWindowSize?: number; + Message?: string; /** - *The number of seconds after which a DPD timeout occurs.
- *Constraints: A value between 0 and 30.
- *Default: 30
- *
The error code for the VPC endpoint error.
*/ - DPDTimeoutSeconds?: number; + Code?: string; +} +export namespace LastError { /** - *The action to take after DPD timeout occurs. Specify restart to restart
- * the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
- *
Default: clear
- *
Describes a VPC endpoint.
+ */ +export interface VpcEndpoint { /** - *One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 - * IKE negotiations.
- *Valid values: AES128 | AES256 | AES128-GCM-16 |
- * AES256-GCM-16
- *
The ID of the VPC endpoint.
*/ - Phase1EncryptionAlgorithms?: Phase1EncryptionAlgorithmsRequestListValue[]; + VpcEndpointId?: string; /** - *One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 - * IKE negotiations.
- *Valid values: AES128 | AES256 | AES128-GCM-16 |
- * AES256-GCM-16
- *
The type of endpoint.
*/ - Phase2EncryptionAlgorithms?: Phase2EncryptionAlgorithmsRequestListValue[]; + VpcEndpointType?: VpcEndpointType | string; /** - *One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE - * negotiations.
- *Valid values: SHA1 | SHA2-256 | SHA2-384 |
- * SHA2-512
- *
The ID of the VPC to which the endpoint is associated.
*/ - Phase1IntegrityAlgorithms?: Phase1IntegrityAlgorithmsRequestListValue[]; + VpcId?: string; /** - *One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE - * negotiations.
- *Valid values: SHA1 | SHA2-256 | SHA2-384 |
- * SHA2-512
- *
The name of the service to which the endpoint is associated.
*/ - Phase2IntegrityAlgorithms?: Phase2IntegrityAlgorithmsRequestListValue[]; + ServiceName?: string; /** - *One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for - * phase 1 IKE negotiations.
- *Valid values: 2 | 14 | 15 | 16 |
- * 17 | 18 | 19 | 20 |
- * 21 | 22 | 23 | 24
- *
The state of the VPC endpoint.
*/ - Phase1DHGroupNumbers?: Phase1DHGroupNumbersRequestListValue[]; + State?: State | string; /** - *One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for - * phase 2 IKE negotiations.
- *Valid values: 2 | 5 | 14 | 15 |
- * 16 | 17 | 18 | 19 |
- * 20 | 21 | 22 | 23 |
- * 24
- *
The policy document associated with the endpoint, if applicable.
*/ - Phase2DHGroupNumbers?: Phase2DHGroupNumbersRequestListValue[]; + PolicyDocument?: string; /** - *The IKE versions that are permitted for the VPN tunnel.
- *Valid values: ikev1 | ikev2
- *
(Gateway endpoint) One or more route tables associated with the endpoint.
*/ - IKEVersions?: IKEVersionsRequestListValue[]; + RouteTableIds?: string[]; /** - *The action to take when the establishing the tunnel for the VPN connection. By
- * default, your customer gateway device must initiate the IKE negotiation and bring up the
- * tunnel. Specify start for Amazon Web Services to initiate the IKE
- * negotiation.
Valid Values: add | start
- *
Default: add
- *
(Interface endpoint) One or more subnets in which the endpoint is located.
*/ - StartupAction?: string; -} + SubnetIds?: string[]; -export namespace VpnTunnelOptionsSpecification { /** - * @internal + *(Interface endpoint) Information about the security groups that are associated with + * the network interface.
*/ - export const filterSensitiveLog = (obj: VpnTunnelOptionsSpecification): any => ({ - ...obj, - }); -} + Groups?: SecurityGroupIdentifier[]; -/** - *Describes VPN connection options.
- */ -export interface VpnConnectionOptionsSpecification { /** - *Indicate whether to enable acceleration for the VPN connection.
- *Default: false
- *
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
*/ - EnableAcceleration?: boolean; + PrivateDnsEnabled?: boolean; /** - *Indicate whether the VPN connection uses static routes only. If you are creating a VPN
- * connection for a device that does not support BGP, you must specify true.
- * Use CreateVpnConnectionRoute to create a static route.
Default: false
- *
Indicates whether the VPC endpoint is being managed by its service.
*/ - StaticRoutesOnly?: boolean; + RequesterManaged?: boolean; /** - *Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
- *Default: ipv4
- *
(Interface endpoint) One or more network interfaces for the endpoint.
*/ - TunnelInsideIpVersion?: TunnelInsideIpVersion | string; + NetworkInterfaceIds?: string[]; /** - *The tunnel options for the VPN connection.
+ *(Interface endpoint) The DNS entries for the endpoint.
*/ - TunnelOptions?: VpnTunnelOptionsSpecification[]; + DnsEntries?: DnsEntry[]; /** - *The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
- *Default: 0.0.0.0/0
- *
The date and time that the VPC endpoint was created.
*/ - LocalIpv4NetworkCidr?: string; + CreationTimestamp?: Date; /** - *The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
- *Default: 0.0.0.0/0
- *
Any tags assigned to the VPC endpoint.
*/ - RemoteIpv4NetworkCidr?: string; + Tags?: Tag[]; /** - *The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
- *Default: ::/0
- *
The ID of the Amazon Web Services account that owns the VPC endpoint.
*/ - LocalIpv6NetworkCidr?: string; + OwnerId?: string; /** - *The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
- *Default: ::/0
- *
The last error that occurred for VPC endpoint.
*/ - RemoteIpv6NetworkCidr?: string; + LastError?: LastError; } -export namespace VpnConnectionOptionsSpecification { +export namespace VpcEndpoint { /** * @internal */ - export const filterSensitiveLog = (obj: VpnConnectionOptionsSpecification): any => ({ + export const filterSensitiveLog = (obj: VpcEndpoint): any => ({ ...obj, }); } /** - *Contains the parameters for CreateVpnConnection.
+ *Contains the output of CreateVpcEndpoint.
*/ -export interface CreateVpnConnectionRequest { +export interface CreateVpcEndpointResult { /** - *The ID of the customer gateway.
+ *Information about the endpoint.
*/ - CustomerGatewayId: string | undefined; + VpcEndpoint?: VpcEndpoint; /** - *The type of VPN connection (ipsec.1).
Unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request.
*/ - Type: string | undefined; + ClientToken?: string; +} +export namespace CreateVpcEndpointResult { /** - *The ID of the virtual private gateway. If you specify a virtual private gateway, you - * cannot specify a transit gateway.
+ * @internal */ - VpnGatewayId?: string; + export const filterSensitiveLog = (obj: CreateVpcEndpointResult): any => ({ + ...obj, + }); +} +export interface CreateVpcEndpointConnectionNotificationRequest { /** - *The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private - * gateway.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without 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 endpoint service.
*/ - DryRun?: boolean; + ServiceId?: string; /** - *The options for the VPN connection.
+ *The ID of the endpoint.
*/ - Options?: VpnConnectionOptionsSpecification; + VpcEndpointId?: string; /** - *The tags to apply to the VPN connection.
+ *The ARN of the SNS topic for the notifications.
*/ - TagSpecifications?: TagSpecification[]; -} + ConnectionNotificationArn: string | undefined; -export namespace CreateVpnConnectionRequest { /** - * @internal + *One or more endpoint events for which to receive notifications. Valid values are
+ * Accept, Connect, Delete, and
+ * Reject.
The internet key exchange (IKE) version permitted for the VPN tunnel.
- */ -export interface IKEVersionsListValue { /** - *The IKE version.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. For more information, see How to ensure + * idempotency.
*/ - Value?: string; + ClientToken?: string; } -export namespace IKEVersionsListValue { +export namespace CreateVpcEndpointConnectionNotificationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: IKEVersionsListValue): any => ({ + export const filterSensitiveLog = (obj: CreateVpcEndpointConnectionNotificationRequest): any => ({ ...obj, }); } -/** - *The Diffie-Hellmann group number for phase 1 IKE negotiations.
- */ -export interface Phase1DHGroupNumbersListValue { - /** - *The Diffie-Hellmann group number.
- */ - Value?: number; +export enum ConnectionNotificationState { + Disabled = "Disabled", + Enabled = "Enabled", } -export namespace Phase1DHGroupNumbersListValue { - /** - * @internal - */ - export const filterSensitiveLog = (obj: Phase1DHGroupNumbersListValue): any => ({ - ...obj, - }); +export enum ConnectionNotificationType { + Topic = "Topic", } /** - *The encryption algorithm for phase 1 IKE negotiations.
+ *Describes a connection notification for a VPC endpoint or VPC endpoint + * service.
*/ -export interface Phase1EncryptionAlgorithmsListValue { +export interface ConnectionNotification { /** - *The value for the encryption algorithm.
+ *The ID of the notification.
*/ - Value?: string; -} + ConnectionNotificationId?: string; -export namespace Phase1EncryptionAlgorithmsListValue { /** - * @internal + *The ID of the endpoint service.
*/ - export const filterSensitiveLog = (obj: Phase1EncryptionAlgorithmsListValue): any => ({ - ...obj, - }); -} + ServiceId?: string; -/** - *The integrity algorithm for phase 1 IKE negotiations.
- */ -export interface Phase1IntegrityAlgorithmsListValue { /** - *The value for the integrity algorithm.
+ *The ID of the VPC endpoint.
*/ - Value?: string; -} + VpcEndpointId?: string; -export namespace Phase1IntegrityAlgorithmsListValue { /** - * @internal + *The type of notification.
*/ - export const filterSensitiveLog = (obj: Phase1IntegrityAlgorithmsListValue): any => ({ - ...obj, - }); -} + ConnectionNotificationType?: ConnectionNotificationType | string; -/** - *The Diffie-Hellmann group number for phase 2 IKE negotiations.
- */ -export interface Phase2DHGroupNumbersListValue { /** - *The Diffie-Hellmann group number.
+ *The ARN of the SNS topic for the notification.
*/ - Value?: number; -} + ConnectionNotificationArn?: string; -export namespace Phase2DHGroupNumbersListValue { /** - * @internal + *The events for the notification. Valid values are Accept,
+ * Connect, Delete, and Reject.
The encryption algorithm for phase 2 IKE negotiations.
- */ -export interface Phase2EncryptionAlgorithmsListValue { /** - *The encryption algorithm.
+ *The state of the notification.
*/ - Value?: string; + ConnectionNotificationState?: ConnectionNotificationState | string; } -export namespace Phase2EncryptionAlgorithmsListValue { +export namespace ConnectionNotification { /** * @internal */ - export const filterSensitiveLog = (obj: Phase2EncryptionAlgorithmsListValue): any => ({ + export const filterSensitiveLog = (obj: ConnectionNotification): any => ({ ...obj, }); } -/** - *The integrity algorithm for phase 2 IKE negotiations.
- */ -export interface Phase2IntegrityAlgorithmsListValue { +export interface CreateVpcEndpointConnectionNotificationResult { /** - *The integrity algorithm.
+ *Information about the notification.
*/ - Value?: string; + ConnectionNotification?: ConnectionNotification; + + /** + *Unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request.
+ */ + ClientToken?: string; } -export namespace Phase2IntegrityAlgorithmsListValue { +export namespace CreateVpcEndpointConnectionNotificationResult { /** * @internal */ - export const filterSensitiveLog = (obj: Phase2IntegrityAlgorithmsListValue): any => ({ + export const filterSensitiveLog = (obj: CreateVpcEndpointConnectionNotificationResult): any => ({ ...obj, }); } diff --git a/clients/client-ec2/src/models/models_2.ts b/clients/client-ec2/src/models/models_2.ts index c126b4b7e417..3ad6b698adc9 100644 --- a/clients/client-ec2/src/models/models_2.ts +++ b/clients/client-ec2/src/models/models_2.ts @@ -6,12 +6,7 @@ import { Address, AddressAttribute, AddressAttributeName, - AllocationState, - AllowsMultipleInstanceTypes, AssociationStatus, - AttributeValue, - AutoPlacement, - BlockDeviceMapping, BundleTask, ByoipCidr, CapacityReservation, @@ -24,7 +19,6 @@ import { CurrencyCodeValues, CustomerGateway, DefaultTargetCapacityType, - DestinationFileFormat, DhcpOptions, EgressOnlyInternetGateway, FleetCapacityReservation, @@ -32,46 +26,40 @@ import { FleetCapacityReservationUsageStrategy, FleetExcessCapacityTerminationPolicy, FleetInstanceMatchCriteria, - FleetLaunchTemplateOverrides, FleetLaunchTemplateSpecification, FleetOnDemandAllocationStrategy, FleetReplacementStrategy, FleetType, GatewayType, - HostRecovery, - IamInstanceProfileAssociation, InstanceEventWindowState, - InstanceLifecycle, - LaunchTemplateAndOverridesResponse, - LogDestinationType, - PlatformValues, SpotAllocationStrategy, SpotInstanceInterruptionBehavior, Tag, TagSpecification, - TrafficType, + TargetCapacityUnitType, TransitGatewayPeeringAttachment, TransitGatewayVpcAttachment, TransportProtocol, UnsuccessfulItem, VpcAttachment, + VpcPeeringConnection, } from "./models_0"; import { + DestinationFileFormat, DiskImageFormat, ExportTask, + FleetLaunchTemplateOverrides, GroupIdentifier, - IKEVersionsListValue, + InstanceLifecycle, LaunchTemplate, + LaunchTemplateAndOverridesResponse, LocalGatewayRoute, LocalGatewayRouteTableVpcAssociation, + LogDestinationType, ManagedPrefixList, - Phase1DHGroupNumbersListValue, - Phase1EncryptionAlgorithmsListValue, - Phase1IntegrityAlgorithmsListValue, - Phase2DHGroupNumbersListValue, - Phase2EncryptionAlgorithmsListValue, - Phase2IntegrityAlgorithmsListValue, + PlatformValues, SubnetCidrReservation, + TrafficType, TransitGateway, TransitGatewayConnect, TransitGatewayConnectPeer, @@ -79,1310 +67,1427 @@ import { TransitGatewayPrefixListReference, TransitGatewayRoute, TransitGatewayRouteTable, - TunnelInsideIpVersion, } from "./models_1"; -/** - *The VPN tunnel options.
- */ -export interface TunnelOption { +export interface CreateVpcEndpointServiceConfigurationRequest { /** - *The external IP address of the VPN tunnel.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The range of inside IPv4 addresses for the tunnel.
+ *Indicates whether requests from service consumers to create an endpoint to your service must + * be accepted. To accept a request, use AcceptVpcEndpointConnections.
*/ - TunnelInsideCidr?: string; + AcceptanceRequired?: boolean; /** - *The range of inside IPv6 addresses for the tunnel.
+ *(Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.
*/ - TunnelInsideIpv6Cidr?: string; + PrivateDnsName?: string; /** - *The pre-shared key (PSK) to establish initial authentication between the virtual - * private gateway and the customer gateway.
+ *The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your + * service.
*/ - PreSharedKey?: string; + NetworkLoadBalancerArns?: string[]; /** - *The lifetime for phase 1 of the IKE negotiation, in seconds.
+ *The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.
*/ - Phase1LifetimeSeconds?: number; + GatewayLoadBalancerArns?: string[]; /** - *The lifetime for phase 2 of the IKE negotiation, in seconds.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. + * For more information, see How to ensure + * idempotency.
*/ - Phase2LifetimeSeconds?: number; + ClientToken?: string; /** - *The margin time, in seconds, before the phase 2 lifetime expires, during which the - * Amazon Web Services side of the VPN connection performs an IKE rekey.
+ *The tags to associate with the service.
*/ - RekeyMarginTimeSeconds?: number; + TagSpecifications?: TagSpecification[]; +} +export namespace CreateVpcEndpointServiceConfigurationRequest { /** - *The percentage of the rekey window determined by RekeyMarginTimeSeconds
- * during which the rekey time is randomly selected.
Information about the private DNS name for the service endpoint. For more information + * about these parameters, see VPC Endpoint Service + * Private DNS Name Verification in the + * Amazon Virtual Private Cloud User Guide.
+ */ +export interface PrivateDnsNameConfiguration { /** - *The number of packets in an IKE replay window.
+ *The verification state of the VPC endpoint service.
+ *>Consumers
+ * of the endpoint service can use the private name only when the state is
+ * verified.
The number of seconds after which a DPD timeout occurs.
+ *The endpoint service verification type, for example TXT.
*/ - DpdTimeoutSeconds?: number; + Type?: string; /** - *The action to take after a DPD timeout occurs.
+ *The value the service provider adds to the private DNS name domain record before verification.
*/ - DpdTimeoutAction?: string; + Value?: string; /** - *The permitted encryption algorithms for the VPN tunnel for phase 1 IKE - * negotiations.
+ *The name of the record subdomain the service provider needs to create. The service provider adds the value text to the name.
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE - * negotiations.
+ * @internal */ - Phase2EncryptionAlgorithms?: Phase2EncryptionAlgorithmsListValue[]; + export const filterSensitiveLog = (obj: PrivateDnsNameConfiguration): any => ({ + ...obj, + }); +} + +export enum ServiceState { + Available = "Available", + Deleted = "Deleted", + Deleting = "Deleting", + Failed = "Failed", + Pending = "Pending", +} + +export enum ServiceType { + Gateway = "Gateway", + GatewayLoadBalancer = "GatewayLoadBalancer", + Interface = "Interface", +} +/** + *Describes the type of service for a VPC endpoint.
+ */ +export interface ServiceTypeDetail { /** - *The permitted integrity algorithms for the VPN tunnel for phase 1 IKE - * negotiations.
+ *The type of service.
*/ - Phase1IntegrityAlgorithms?: Phase1IntegrityAlgorithmsListValue[]; + ServiceType?: ServiceType | string; +} +export namespace ServiceTypeDetail { /** - *The permitted integrity algorithms for the VPN tunnel for phase 2 IKE - * negotiations.
+ * @internal */ - Phase2IntegrityAlgorithms?: Phase2IntegrityAlgorithmsListValue[]; + export const filterSensitiveLog = (obj: ServiceTypeDetail): any => ({ + ...obj, + }); +} +/** + *Describes a service configuration for a VPC endpoint service.
+ */ +export interface ServiceConfiguration { /** - *The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE - * negotiations.
+ *The type of service.
*/ - Phase1DHGroupNumbers?: Phase1DHGroupNumbersListValue[]; + ServiceType?: ServiceTypeDetail[]; /** - *The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE - * negotiations.
+ *The ID of the service.
*/ - Phase2DHGroupNumbers?: Phase2DHGroupNumbersListValue[]; + ServiceId?: string; /** - *The IKE versions that are permitted for the VPN tunnel.
+ *The name of the service.
*/ - IkeVersions?: IKEVersionsListValue[]; + ServiceName?: string; /** - *The action to take when the establishing the VPN tunnels for a VPN connection.
+ *The service state.
*/ - StartupAction?: string; -} + ServiceState?: ServiceState | string; -export namespace TunnelOption { /** - * @internal + *The Availability Zones in which the service is available.
*/ - export const filterSensitiveLog = (obj: TunnelOption): any => ({ - ...obj, - }); -} + AvailabilityZones?: string[]; -/** - *Describes VPN connection options.
- */ -export interface VpnConnectionOptions { /** - *Indicates whether acceleration is enabled for the VPN connection.
+ *Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.
*/ - EnableAcceleration?: boolean; + AcceptanceRequired?: boolean; /** - *Indicates whether the VPN connection uses static routes only. Static routes must be - * used for devices that don't support BGP.
+ *Indicates whether the service manages its VPC endpoints. Management of the service VPC + * endpoints using the VPC endpoint API is restricted.
*/ - StaticRoutesOnly?: boolean; + ManagesVpcEndpoints?: boolean; /** - *The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
+ *The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
*/ - LocalIpv4NetworkCidr?: string; + NetworkLoadBalancerArns?: string[]; /** - *The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
+ *The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
*/ - RemoteIpv4NetworkCidr?: string; + GatewayLoadBalancerArns?: string[]; /** - *The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
+ *The DNS names for the service.
*/ - LocalIpv6NetworkCidr?: string; + BaseEndpointDnsNames?: string[]; /** - *The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
+ *The private DNS name for the service.
*/ - RemoteIpv6NetworkCidr?: string; + PrivateDnsName?: string; /** - *Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
+ *Information about the endpoint service private DNS name configuration.
*/ - TunnelInsideIpVersion?: TunnelInsideIpVersion | string; + PrivateDnsNameConfiguration?: PrivateDnsNameConfiguration; /** - *Indicates the VPN tunnel options.
+ *Any tags assigned to the service.
*/ - TunnelOptions?: TunnelOption[]; + Tags?: Tag[]; } -export namespace VpnConnectionOptions { +export namespace ServiceConfiguration { /** * @internal */ - export const filterSensitiveLog = (obj: VpnConnectionOptions): any => ({ + export const filterSensitiveLog = (obj: ServiceConfiguration): any => ({ ...obj, }); } -export type VpnStaticRouteSource = "Static"; - -export type VpnState = "available" | "deleted" | "deleting" | "pending"; - -/** - *Describes a static route for a VPN connection.
- */ -export interface VpnStaticRoute { - /** - *The CIDR block associated with the local subnet of the customer data center.
- */ - DestinationCidrBlock?: string; - +export interface CreateVpcEndpointServiceConfigurationResult { /** - *Indicates how the routes were provided.
+ *Information about the service configuration.
*/ - Source?: VpnStaticRouteSource | string; + ServiceConfiguration?: ServiceConfiguration; /** - *The current state of the static route.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request.
*/ - State?: VpnState | string; + ClientToken?: string; } -export namespace VpnStaticRoute { +export namespace CreateVpcEndpointServiceConfigurationResult { /** * @internal */ - export const filterSensitiveLog = (obj: VpnStaticRoute): any => ({ + export const filterSensitiveLog = (obj: CreateVpcEndpointServiceConfigurationResult): any => ({ ...obj, }); } -export type TelemetryStatus = "DOWN" | "UP"; - -/** - *Describes telemetry for a VPN tunnel.
- */ -export interface VgwTelemetry { +export interface CreateVpcPeeringConnectionRequest { /** - *The number of accepted routes.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The date and time of the last change in status.
+ *The Amazon Web Services account ID of the owner of the accepter VPC.
+ *Default: Your Amazon Web Services account ID
*/ - LastStatusChange?: Date; + PeerOwnerId?: string; /** - *The Internet-routable IP address of the virtual private gateway's outside - * interface.
+ *The ID of the VPC with which you are creating the VPC peering connection. You must + * specify this parameter in the request.
*/ - OutsideIpAddress?: string; + PeerVpcId?: string; /** - *The status of the VPN tunnel.
+ *The ID of the requester VPC. You must specify this parameter in the + * request.
*/ - Status?: TelemetryStatus | string; + VpcId?: string; /** - *If an error occurs, a description of the error.
+ *The Region code for the accepter VPC, if the accepter VPC is located in a Region + * other than the Region in which you make the request.
+ *Default: The Region in which you make the request.
*/ - StatusMessage?: string; + PeerRegion?: string; /** - *The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
+ *The tags to assign to the peering connection.
*/ - CertificateArn?: string; + TagSpecifications?: TagSpecification[]; } -export namespace VgwTelemetry { +export namespace CreateVpcPeeringConnectionRequest { /** * @internal */ - export const filterSensitiveLog = (obj: VgwTelemetry): any => ({ + export const filterSensitiveLog = (obj: CreateVpcPeeringConnectionRequest): any => ({ ...obj, }); } -/** - *Describes a VPN connection.
- */ -export interface VpnConnection { +export interface CreateVpcPeeringConnectionResult { /** - *The configuration information for the VPN connection's customer gateway (in the native
- * XML format). This element is always present in the CreateVpnConnection
- * response; however, it's present in the DescribeVpnConnections response
- * only if the VPN connection is in the pending or available
- * state.
Information about the VPC peering connection.
*/ - CustomerGatewayConfiguration?: string; + VpcPeeringConnection?: VpcPeeringConnection; +} +export namespace CreateVpcPeeringConnectionResult { /** - *The ID of the customer gateway at your end of the VPN connection.
+ * @internal */ - CustomerGatewayId?: string; + export const filterSensitiveLog = (obj: CreateVpcPeeringConnectionResult): any => ({ + ...obj, + }); +} - /** - *The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.
The IKE version that is permitted for the VPN tunnel.
+ */ +export interface IKEVersionsRequestListValue { /** - *The current state of the VPN connection.
+ *The IKE version.
*/ - State?: VpnState | string; + Value?: string; +} +export namespace IKEVersionsRequestListValue { /** - *The type of VPN connection.
+ * @internal */ - Type?: GatewayType | string; + export const filterSensitiveLog = (obj: IKEVersionsRequestListValue): any => ({ + ...obj, + }); +} +/** + *Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE + * negotiations.
+ */ +export interface Phase1DHGroupNumbersRequestListValue { /** - *The ID of the VPN connection.
+ *The Diffie-Hellmann group number.
*/ - VpnConnectionId?: string; + Value?: number; +} +export namespace Phase1DHGroupNumbersRequestListValue { /** - *The ID of the virtual private gateway at the Amazon Web Services side of the VPN - * connection.
+ * @internal */ - VpnGatewayId?: string; + export const filterSensitiveLog = (obj: Phase1DHGroupNumbersRequestListValue): any => ({ + ...obj, + }); +} +/** + *Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE + * negotiations.
+ */ +export interface Phase1EncryptionAlgorithmsRequestListValue { /** - *The ID of the transit gateway associated with the VPN connection.
+ *The value for the encryption algorithm.
*/ - TransitGatewayId?: string; + Value?: string; +} +export namespace Phase1EncryptionAlgorithmsRequestListValue { /** - *The VPN connection options.
+ * @internal */ - Options?: VpnConnectionOptions; + export const filterSensitiveLog = (obj: Phase1EncryptionAlgorithmsRequestListValue): any => ({ + ...obj, + }); +} +/** + *Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE + * negotiations.
+ */ +export interface Phase1IntegrityAlgorithmsRequestListValue { /** - *The static routes associated with the VPN connection.
+ *The value for the integrity algorithm.
*/ - Routes?: VpnStaticRoute[]; + Value?: string; +} +export namespace Phase1IntegrityAlgorithmsRequestListValue { /** - *Any tags assigned to the VPN connection.
+ * @internal */ - Tags?: Tag[]; + export const filterSensitiveLog = (obj: Phase1IntegrityAlgorithmsRequestListValue): any => ({ + ...obj, + }); +} +/** + *Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE + * negotiations.
+ */ +export interface Phase2DHGroupNumbersRequestListValue { /** - *Information about the VPN tunnel.
+ *The Diffie-Hellmann group number.
*/ - VgwTelemetry?: VgwTelemetry[]; + Value?: number; } -export namespace VpnConnection { +export namespace Phase2DHGroupNumbersRequestListValue { /** * @internal */ - export const filterSensitiveLog = (obj: VpnConnection): any => ({ + export const filterSensitiveLog = (obj: Phase2DHGroupNumbersRequestListValue): any => ({ ...obj, }); } /** - *Contains the output of CreateVpnConnection.
+ *Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE + * negotiations.
*/ -export interface CreateVpnConnectionResult { +export interface Phase2EncryptionAlgorithmsRequestListValue { /** - *Information about the VPN connection.
+ *The encryption algorithm.
*/ - VpnConnection?: VpnConnection; + Value?: string; } -export namespace CreateVpnConnectionResult { +export namespace Phase2EncryptionAlgorithmsRequestListValue { /** * @internal */ - export const filterSensitiveLog = (obj: CreateVpnConnectionResult): any => ({ + export const filterSensitiveLog = (obj: Phase2EncryptionAlgorithmsRequestListValue): any => ({ ...obj, }); } /** - *Contains the parameters for CreateVpnConnectionRoute.
+ *Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE + * negotiations.
*/ -export interface CreateVpnConnectionRouteRequest { - /** - *The CIDR block associated with the local subnet of the customer network.
- */ - DestinationCidrBlock: string | undefined; - +export interface Phase2IntegrityAlgorithmsRequestListValue { /** - *The ID of the VPN connection.
+ *The integrity algorithm.
*/ - VpnConnectionId: string | undefined; + Value?: string; } -export namespace CreateVpnConnectionRouteRequest { +export namespace Phase2IntegrityAlgorithmsRequestListValue { /** * @internal */ - export const filterSensitiveLog = (obj: CreateVpnConnectionRouteRequest): any => ({ + export const filterSensitiveLog = (obj: Phase2IntegrityAlgorithmsRequestListValue): any => ({ ...obj, }); } /** - *Contains the parameters for CreateVpnGateway.
+ *The tunnel options for a single VPN tunnel.
*/ -export interface CreateVpnGatewayRequest { +export interface VpnTunnelOptionsSpecification { /** - *The Availability Zone for the virtual private gateway.
+ *The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be + * unique across all VPN connections that use the same virtual private gateway.
+ *Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The
+ * following CIDR blocks are reserved and cannot be used:
+ * 169.254.0.0/30
+ *
+ * 169.254.1.0/30
+ *
+ * 169.254.2.0/30
+ *
+ * 169.254.3.0/30
+ *
+ * 169.254.4.0/30
+ *
+ * 169.254.5.0/30
+ *
+ * 169.254.169.252/30
+ *
The type of VPN connection this virtual private gateway supports.
+ *The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be + * unique across all VPN connections that use the same transit gateway.
+ *Constraints: A size /126 CIDR block from the local fd00::/8 range.
The tags to apply to the virtual private gateway.
+ *The pre-shared key (PSK) to establish initial authentication between the virtual + * private gateway and customer gateway.
+ *Constraints: Allowed characters are alphanumeric characters, periods (.), and + * underscores (_). Must be between 8 and 64 characters in length and cannot start with + * zero (0).
*/ - TagSpecifications?: TagSpecification[]; + PreSharedKey?: string; /** - *A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If - * you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a - * 32-bit ASN, it must be in the 4200000000 to 4294967294 range.
- *Default: 64512
+ *The lifetime for phase 1 of the IKE negotiation, in seconds.
+ *Constraints: A value between 900 and 28,800.
+ *Default: 28800
+ *
Checks whether you have the required permissions for the action, without 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 lifetime for phase 2 of the IKE negotiation, in seconds.
+ *Constraints: A value between 900 and 3,600. The value must be less than the value for
+ * Phase1LifetimeSeconds.
Default: 3600
+ *
The margin time, in seconds, before the phase 2 lifetime expires, during which the
+ * Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time
+ * of the rekey is randomly selected based on the value for
+ * RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 540
+ *
Describes a virtual private gateway.
- */ -export interface VpnGateway { /** - *The Availability Zone where the virtual private gateway was created, if applicable. - * This field may be empty or not returned.
+ *The percentage of the rekey window (determined by RekeyMarginTimeSeconds)
+ * during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
+ *Default: 100
+ *
The current state of the virtual private gateway.
+ *The number of packets in an IKE replay window.
+ *Constraints: A value between 64 and 2048.
+ *Default: 1024
+ *
The type of VPN connection the virtual private gateway supports.
+ *The number of seconds after which a DPD timeout occurs.
+ *Constraints: A value between 0 and 30.
+ *Default: 30
+ *
Any VPCs attached to the virtual private gateway.
+ *The action to take after DPD timeout occurs. Specify restart to restart
+ * the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
+ *
Default: clear
+ *
The ID of the virtual private gateway.
+ *One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 + * IKE negotiations.
+ *Valid values: AES128 | AES256 | AES128-GCM-16 |
+ * AES256-GCM-16
+ *
The private Autonomous System Number (ASN) for the Amazon side of a BGP - * session.
+ *One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 + * IKE negotiations.
+ *Valid values: AES128 | AES256 | AES128-GCM-16 |
+ * AES256-GCM-16
+ *
Any tags assigned to the virtual private gateway.
+ *One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE + * negotiations.
+ *Valid values: SHA1 | SHA2-256 | SHA2-384 |
+ * SHA2-512
+ *
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE + * negotiations.
+ *Valid values: SHA1 | SHA2-256 | SHA2-384 |
+ * SHA2-512
+ *
Contains the output of CreateVpnGateway.
- */ -export interface CreateVpnGatewayResult { /** - *Information about the virtual private gateway.
+ *One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for + * phase 1 IKE negotiations.
+ *Valid values: 2 | 14 | 15 | 16 |
+ * 17 | 18 | 19 | 20 |
+ * 21 | 22 | 23 | 24
+ *
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for + * phase 2 IKE negotiations.
+ *Valid values: 2 | 5 | 14 | 15 |
+ * 16 | 17 | 18 | 19 |
+ * 20 | 21 | 22 | 23 |
+ * 24
+ *
The ID of the carrier gateway.
+ *The IKE versions that are permitted for the VPN tunnel.
+ *Valid values: ikev1 | ikev2
+ *
Checks whether you have the required permissions for the action, without 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 action to take when the establishing the tunnel for the VPN connection. By
+ * default, your customer gateway device must initiate the IKE negotiation and bring up the
+ * tunnel. Specify start for Amazon Web Services to initiate the IKE
+ * negotiation.
Valid Values: add | start
+ *
Default: add
+ *
Describes VPN connection options.
+ */ +export interface VpnConnectionOptionsSpecification { /** - *Information about the carrier gateway.
+ *Indicate whether to enable acceleration for the VPN connection.
+ *Default: false
+ *
Indicate whether the VPN connection uses static routes only. If you are creating a VPN
+ * connection for a device that does not support BGP, you must specify true.
+ * Use CreateVpnConnectionRoute to create a static route.
Default: false
+ *
The ID of the Client VPN to be deleted.
+ *Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
+ *Default: ipv4
+ *
Checks whether you have the required permissions for the action, without 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 tunnel options for the VPN connection.
*/ - DryRun?: boolean; -} + TunnelOptions?: VpnTunnelOptionsSpecification[]; -export namespace DeleteClientVpnEndpointRequest { /** - * @internal + *The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
+ *Default: 0.0.0.0/0
+ *
The current state of the Client VPN endpoint.
+ *The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
+ *Default: 0.0.0.0/0
+ *
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
+ *Default: ::/0
+ *
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
+ *Default: ::/0
+ *
Contains the parameters for CreateVpnConnection.
+ */ +export interface CreateVpnConnectionRequest { /** - *The ID of the Client VPN endpoint from which the route is to be deleted.
+ *The ID of the customer gateway.
*/ - ClientVpnEndpointId: string | undefined; + CustomerGatewayId: string | undefined; /** - *The ID of the target subnet used by the route.
+ *The type of VPN connection (ipsec.1).
The IPv4 address range, in CIDR notation, of the route to be deleted.
+ *The ID of the virtual private gateway. If you specify a virtual private gateway, you + * cannot specify a transit gateway.
*/ - DestinationCidrBlock: string | undefined; + VpnGatewayId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private + * gateway.
+ */ + TransitGatewayId?: string; + + /** + *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The options for the VPN connection.
+ */ + Options?: VpnConnectionOptionsSpecification; + + /** + *The tags to apply to the VPN connection.
+ */ + TagSpecifications?: TagSpecification[]; } -export namespace DeleteClientVpnRouteRequest { +export namespace CreateVpnConnectionRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteClientVpnRouteRequest): any => ({ + export const filterSensitiveLog = (obj: CreateVpnConnectionRequest): any => ({ ...obj, }); } -export interface DeleteClientVpnRouteResult { +/** + *The internet key exchange (IKE) version permitted for the VPN tunnel.
+ */ +export interface IKEVersionsListValue { /** - *The current state of the route.
+ *The IKE version.
*/ - Status?: ClientVpnRouteStatus; + Value?: string; } -export namespace DeleteClientVpnRouteResult { +export namespace IKEVersionsListValue { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteClientVpnRouteResult): any => ({ + export const filterSensitiveLog = (obj: IKEVersionsListValue): any => ({ ...obj, }); } /** - *Contains the parameters for DeleteCustomerGateway.
+ *The Diffie-Hellmann group number for phase 1 IKE negotiations.
*/ -export interface DeleteCustomerGatewayRequest { - /** - *The ID of the customer gateway.
- */ - CustomerGatewayId: string | undefined; - +export interface Phase1DHGroupNumbersListValue { /** - *Checks whether you have the required permissions for the action, without 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 Diffie-Hellmann group number.
*/ - DryRun?: boolean; + Value?: number; } -export namespace DeleteCustomerGatewayRequest { +export namespace Phase1DHGroupNumbersListValue { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteCustomerGatewayRequest): any => ({ + export const filterSensitiveLog = (obj: Phase1DHGroupNumbersListValue): any => ({ ...obj, }); } -export interface DeleteDhcpOptionsRequest { - /** - *The ID of the DHCP options set.
- */ - DhcpOptionsId: string | undefined; - +/** + *The encryption algorithm for phase 1 IKE negotiations.
+ */ +export interface Phase1EncryptionAlgorithmsListValue { /** - *Checks whether you have the required permissions for the action, without 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 value for the encryption algorithm.
*/ - DryRun?: boolean; + Value?: string; } -export namespace DeleteDhcpOptionsRequest { +export namespace Phase1EncryptionAlgorithmsListValue { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteDhcpOptionsRequest): any => ({ + export const filterSensitiveLog = (obj: Phase1EncryptionAlgorithmsListValue): any => ({ ...obj, }); } -export interface DeleteEgressOnlyInternetGatewayRequest { - /** - *Checks whether you have the required permissions for the action, without 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 integrity algorithm for phase 1 IKE negotiations.
+ */ +export interface Phase1IntegrityAlgorithmsListValue { /** - *The ID of the egress-only internet gateway.
+ *The value for the integrity algorithm.
*/ - EgressOnlyInternetGatewayId: string | undefined; + Value?: string; } -export namespace DeleteEgressOnlyInternetGatewayRequest { +export namespace Phase1IntegrityAlgorithmsListValue { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteEgressOnlyInternetGatewayRequest): any => ({ + export const filterSensitiveLog = (obj: Phase1IntegrityAlgorithmsListValue): any => ({ ...obj, }); } -export interface DeleteEgressOnlyInternetGatewayResult { +/** + *The Diffie-Hellmann group number for phase 2 IKE negotiations.
+ */ +export interface Phase2DHGroupNumbersListValue { /** - *Returns true if the request succeeds; otherwise, it returns an error.
The Diffie-Hellmann group number.
*/ - ReturnCode?: boolean; + Value?: number; } -export namespace DeleteEgressOnlyInternetGatewayResult { +export namespace Phase2DHGroupNumbersListValue { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteEgressOnlyInternetGatewayResult): any => ({ + export const filterSensitiveLog = (obj: Phase2DHGroupNumbersListValue): any => ({ ...obj, }); } -export interface DeleteFleetsRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The IDs of the EC2 Fleets.
- */ - FleetIds: string[] | undefined; - +/** + *The encryption algorithm for phase 2 IKE negotiations.
+ */ +export interface Phase2EncryptionAlgorithmsListValue { /** - *Indicates whether to terminate the instances when the EC2 Fleet is deleted. The default is to - * terminate the instances.
- *To let the instances continue to run after the EC2 Fleet is deleted, specify
- * NoTerminateInstances. Supported only for fleets of type
- * maintain and request.
For instant fleets, you cannot specify NoTerminateInstances. A
- * deleted instant fleet with running instances is not supported.
The encryption algorithm.
*/ - TerminateInstances: boolean | undefined; + Value?: string; } -export namespace DeleteFleetsRequest { +export namespace Phase2EncryptionAlgorithmsListValue { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteFleetsRequest): any => ({ + export const filterSensitiveLog = (obj: Phase2EncryptionAlgorithmsListValue): any => ({ ...obj, }); } -export enum FleetStateCode { - ACTIVE = "active", - DELETED = "deleted", - DELETED_RUNNING = "deleted_running", - DELETED_TERMINATING_INSTANCES = "deleted_terminating", - FAILED = "failed", - MODIFYING = "modifying", - SUBMITTED = "submitted", -} - /** - *Describes an EC2 Fleet that was successfully deleted.
+ *The integrity algorithm for phase 2 IKE negotiations.
*/ -export interface DeleteFleetSuccessItem { - /** - *The current state of the EC2 Fleet.
- */ - CurrentFleetState?: FleetStateCode | string; - - /** - *The previous state of the EC2 Fleet.
- */ - PreviousFleetState?: FleetStateCode | string; - +export interface Phase2IntegrityAlgorithmsListValue { /** - *The ID of the EC2 Fleet.
+ *The integrity algorithm.
*/ - FleetId?: string; + Value?: string; } -export namespace DeleteFleetSuccessItem { +export namespace Phase2IntegrityAlgorithmsListValue { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteFleetSuccessItem): any => ({ + export const filterSensitiveLog = (obj: Phase2IntegrityAlgorithmsListValue): any => ({ ...obj, }); } -export enum DeleteFleetErrorCode { - FLEET_ID_DOES_NOT_EXIST = "fleetIdDoesNotExist", - FLEET_ID_MALFORMED = "fleetIdMalformed", - FLEET_NOT_IN_DELETABLE_STATE = "fleetNotInDeletableState", - UNEXPECTED_ERROR = "unexpectedError", -} - /** - *Describes an EC2 Fleet error.
+ *The VPN tunnel options.
*/ -export interface DeleteFleetError { +export interface TunnelOption { /** - *The error code.
+ *The external IP address of the VPN tunnel.
*/ - Code?: DeleteFleetErrorCode | string; + OutsideIpAddress?: string; /** - *The description for the error code.
+ *The range of inside IPv4 addresses for the tunnel.
*/ - Message?: string; -} + TunnelInsideCidr?: string; -export namespace DeleteFleetError { /** - * @internal + *The range of inside IPv6 addresses for the tunnel.
*/ - export const filterSensitiveLog = (obj: DeleteFleetError): any => ({ - ...obj, - }); -} + TunnelInsideIpv6Cidr?: string; -/** - *Describes an EC2 Fleet that was not successfully deleted.
- */ -export interface DeleteFleetErrorItem { /** - *The error.
+ *The pre-shared key (PSK) to establish initial authentication between the virtual + * private gateway and the customer gateway.
*/ - Error?: DeleteFleetError; + PreSharedKey?: string; /** - *The ID of the EC2 Fleet.
+ *The lifetime for phase 1 of the IKE negotiation, in seconds.
*/ - FleetId?: string; -} + Phase1LifetimeSeconds?: number; -export namespace DeleteFleetErrorItem { /** - * @internal + *The lifetime for phase 2 of the IKE negotiation, in seconds.
*/ - export const filterSensitiveLog = (obj: DeleteFleetErrorItem): any => ({ - ...obj, - }); -} + Phase2LifetimeSeconds?: number; -export interface DeleteFleetsResult { /** - *Information about the EC2 Fleets that are successfully deleted.
+ *The margin time, in seconds, before the phase 2 lifetime expires, during which the + * Amazon Web Services side of the VPN connection performs an IKE rekey.
*/ - SuccessfulFleetDeletions?: DeleteFleetSuccessItem[]; + RekeyMarginTimeSeconds?: number; /** - *Information about the EC2 Fleets that are not successfully deleted.
+ *The percentage of the rekey window determined by RekeyMarginTimeSeconds
+ * during which the rekey time is randomly selected.
The number of packets in an IKE replay window.
*/ - export const filterSensitiveLog = (obj: DeleteFleetsResult): any => ({ - ...obj, - }); -} + ReplayWindowSize?: number; -export interface DeleteFlowLogsRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The number of seconds after which a DPD timeout occurs.
*/ - DryRun?: boolean; + DpdTimeoutSeconds?: number; /** - *One or more flow log IDs.
- *Constraint: Maximum of 1000 flow log IDs.
+ *The action to take after a DPD timeout occurs.
*/ - FlowLogIds: string[] | undefined; -} + DpdTimeoutAction?: string; -export namespace DeleteFlowLogsRequest { /** - * @internal + *The permitted encryption algorithms for the VPN tunnel for phase 1 IKE + * negotiations.
*/ - export const filterSensitiveLog = (obj: DeleteFlowLogsRequest): any => ({ - ...obj, - }); -} + Phase1EncryptionAlgorithms?: Phase1EncryptionAlgorithmsListValue[]; -export interface DeleteFlowLogsResult { /** - *Information about the flow logs that could not be deleted successfully.
+ *The permitted encryption algorithms for the VPN tunnel for phase 2 IKE + * negotiations.
*/ - Unsuccessful?: UnsuccessfulItem[]; -} + Phase2EncryptionAlgorithms?: Phase2EncryptionAlgorithmsListValue[]; -export namespace DeleteFlowLogsResult { /** - * @internal + *The permitted integrity algorithms for the VPN tunnel for phase 1 IKE + * negotiations.
*/ - export const filterSensitiveLog = (obj: DeleteFlowLogsResult): any => ({ - ...obj, - }); -} + Phase1IntegrityAlgorithms?: Phase1IntegrityAlgorithmsListValue[]; -export interface DeleteFpgaImageRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE + * negotiations.
*/ - DryRun?: boolean; + Phase2IntegrityAlgorithms?: Phase2IntegrityAlgorithmsListValue[]; /** - *The ID of the AFI.
+ *The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE + * negotiations.
*/ - FpgaImageId: string | undefined; -} + Phase1DHGroupNumbers?: Phase1DHGroupNumbersListValue[]; -export namespace DeleteFpgaImageRequest { /** - * @internal + *The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE + * negotiations.
*/ - export const filterSensitiveLog = (obj: DeleteFpgaImageRequest): any => ({ - ...obj, - }); -} + Phase2DHGroupNumbers?: Phase2DHGroupNumbersListValue[]; -export interface DeleteFpgaImageResult { /** - *Is true if the request succeeds, and an error otherwise.
The IKE versions that are permitted for the VPN tunnel.
*/ - Return?: boolean; + IkeVersions?: IKEVersionsListValue[]; + + /** + *The action to take when the establishing the VPN tunnels for a VPN connection.
+ */ + StartupAction?: string; } -export namespace DeleteFpgaImageResult { +export namespace TunnelOption { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteFpgaImageResult): any => ({ + export const filterSensitiveLog = (obj: TunnelOption): any => ({ ...obj, }); } -export interface DeleteInstanceEventWindowRequest { +/** + *Describes VPN connection options.
+ */ +export interface VpnConnectionOptions { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Indicates whether acceleration is enabled for the VPN connection.
*/ - DryRun?: boolean; + EnableAcceleration?: boolean; /** - *Specify true to force delete the event window. Use the force delete parameter
- * if the event window is currently associated with targets.
Indicates whether the VPN connection uses static routes only. Static routes must be + * used for devices that don't support BGP.
*/ - ForceDelete?: boolean; + StaticRoutesOnly?: boolean; /** - *The ID of the event window.
+ *The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
*/ - InstanceEventWindowId: string | undefined; -} + LocalIpv4NetworkCidr?: string; -export namespace DeleteInstanceEventWindowRequest { /** - * @internal + *The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
*/ - export const filterSensitiveLog = (obj: DeleteInstanceEventWindowRequest): any => ({ - ...obj, - }); -} + RemoteIpv4NetworkCidr?: string; -/** - *The state of the event window.
- */ -export interface InstanceEventWindowStateChange { /** - *The ID of the event window.
+ *The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
*/ - InstanceEventWindowId?: string; + LocalIpv6NetworkCidr?: string; /** - *The current state of the event window.
+ *The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
*/ - State?: InstanceEventWindowState | string; -} + RemoteIpv6NetworkCidr?: string; -export namespace InstanceEventWindowStateChange { /** - * @internal + *Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
*/ - export const filterSensitiveLog = (obj: InstanceEventWindowStateChange): any => ({ - ...obj, - }); -} + TunnelInsideIpVersion?: TunnelInsideIpVersion | string; -export interface DeleteInstanceEventWindowResult { /** - *The state of the event window.
+ *Indicates the VPN tunnel options.
*/ - InstanceEventWindowState?: InstanceEventWindowStateChange; + TunnelOptions?: TunnelOption[]; } -export namespace DeleteInstanceEventWindowResult { +export namespace VpnConnectionOptions { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteInstanceEventWindowResult): any => ({ + export const filterSensitiveLog = (obj: VpnConnectionOptions): any => ({ ...obj, }); } -export interface DeleteInternetGatewayRequest { +export type VpnStaticRouteSource = "Static"; + +export type VpnState = "available" | "deleted" | "deleting" | "pending"; + +/** + *Describes a static route for a VPN connection.
+ */ +export interface VpnStaticRoute { /** - *Checks whether you have the required permissions for the action, without 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 CIDR block associated with the local subnet of the customer data center.
*/ - DryRun?: boolean; + DestinationCidrBlock?: string; /** - *The ID of the internet gateway.
+ *Indicates how the routes were provided.
*/ - InternetGatewayId: string | undefined; + Source?: VpnStaticRouteSource | string; + + /** + *The current state of the static route.
+ */ + State?: VpnState | string; } -export namespace DeleteInternetGatewayRequest { +export namespace VpnStaticRoute { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteInternetGatewayRequest): any => ({ + export const filterSensitiveLog = (obj: VpnStaticRoute): any => ({ ...obj, }); } -export interface DeleteKeyPairRequest { - /** - *The name of the key pair.
- */ - KeyName?: string; +export type TelemetryStatus = "DOWN" | "UP"; +/** + *Describes telemetry for a VPN tunnel.
+ */ +export interface VgwTelemetry { /** - *The ID of the key pair.
+ *The number of accepted routes.
*/ - KeyPairId?: string; + AcceptedRouteCount?: number; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The date and time of the last change in status.
*/ - DryRun?: boolean; -} + LastStatusChange?: Date; -export namespace DeleteKeyPairRequest { /** - * @internal + *The Internet-routable IP address of the virtual private gateway's outside + * interface.
*/ - export const filterSensitiveLog = (obj: DeleteKeyPairRequest): any => ({ - ...obj, - }); -} + OutsideIpAddress?: string; -export interface DeleteLaunchTemplateRequest { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The status of the VPN tunnel.
*/ - DryRun?: boolean; + Status?: TelemetryStatus | string; /** - *The ID of the launch template. You must specify either the launch template ID or - * launch template name in the request.
+ *If an error occurs, a description of the error.
*/ - LaunchTemplateId?: string; + StatusMessage?: string; /** - *The name of the launch template. You must specify either the launch template ID or - * launch template name in the request.
+ *The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
*/ - LaunchTemplateName?: string; + CertificateArn?: string; } -export namespace DeleteLaunchTemplateRequest { +export namespace VgwTelemetry { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteLaunchTemplateRequest): any => ({ + export const filterSensitiveLog = (obj: VgwTelemetry): any => ({ ...obj, }); } -export interface DeleteLaunchTemplateResult { +/** + *Describes a VPN connection.
+ */ +export interface VpnConnection { /** - *Information about the launch template.
+ *The configuration information for the VPN connection's customer gateway (in the native
+ * XML format). This element is always present in the CreateVpnConnection
+ * response; however, it's present in the DescribeVpnConnections response
+ * only if the VPN connection is in the pending or available
+ * state.
The ID of the customer gateway at your end of the VPN connection.
*/ - export const filterSensitiveLog = (obj: DeleteLaunchTemplateResult): any => ({ - ...obj, - }); -} + CustomerGatewayId?: string; -export interface DeleteLaunchTemplateVersionsRequest { /** - *Checks whether you have the required permissions for the action, without 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 category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.
The ID of the launch template. You must specify either the launch template ID or - * launch template name in the request.
+ *The current state of the VPN connection.
*/ - LaunchTemplateId?: string; + State?: VpnState | string; /** - *The name of the launch template. You must specify either the launch template ID or - * launch template name in the request.
+ *The type of VPN connection.
*/ - LaunchTemplateName?: string; + Type?: GatewayType | string; /** - *The version numbers of one or more launch template versions to delete.
+ *The ID of the VPN connection.
*/ - Versions: string[] | undefined; -} + VpnConnectionId?: string; -export namespace DeleteLaunchTemplateVersionsRequest { /** - * @internal + *The ID of the virtual private gateway at the Amazon Web Services side of the VPN + * connection.
*/ - export const filterSensitiveLog = (obj: DeleteLaunchTemplateVersionsRequest): any => ({ - ...obj, - }); -} + VpnGatewayId?: string; -/** - *Describes a launch template version that was successfully deleted.
- */ -export interface DeleteLaunchTemplateVersionsResponseSuccessItem { /** - *The ID of the launch template.
+ *The ID of the transit gateway associated with the VPN connection.
*/ - LaunchTemplateId?: string; + TransitGatewayId?: string; /** - *The name of the launch template.
+ *The ARN of the core network.
*/ - LaunchTemplateName?: string; + CoreNetworkArn?: string; /** - *The version number of the launch template.
+ *The ARN of the core network attachment.
*/ - VersionNumber?: number; -} + CoreNetworkAttachmentArn?: string; -export namespace DeleteLaunchTemplateVersionsResponseSuccessItem { /** - * @internal + *The current state of the gateway association.
*/ - export const filterSensitiveLog = (obj: DeleteLaunchTemplateVersionsResponseSuccessItem): any => ({ - ...obj, - }); -} + GatewayAssociationState?: string; -export enum LaunchTemplateErrorCode { - LAUNCH_TEMPLATE_ID_DOES_NOT_EXIST = "launchTemplateIdDoesNotExist", - LAUNCH_TEMPLATE_ID_MALFORMED = "launchTemplateIdMalformed", - LAUNCH_TEMPLATE_NAME_DOES_NOT_EXIST = "launchTemplateNameDoesNotExist", - LAUNCH_TEMPLATE_NAME_MALFORMED = "launchTemplateNameMalformed", - LAUNCH_TEMPLATE_VERSION_DOES_NOT_EXIST = "launchTemplateVersionDoesNotExist", - UNEXPECTED_ERROR = "unexpectedError", -} + /** + *The VPN connection options.
+ */ + Options?: VpnConnectionOptions; -/** - *Describes the error that's returned when you cannot delete a launch template - * version.
- */ -export interface ResponseError { /** - *The error code.
+ *The static routes associated with the VPN connection.
*/ - Code?: LaunchTemplateErrorCode | string; + Routes?: VpnStaticRoute[]; /** - *The error message, if applicable.
+ *Any tags assigned to the VPN connection.
*/ - Message?: string; + Tags?: Tag[]; + + /** + *Information about the VPN tunnel.
+ */ + VgwTelemetry?: VgwTelemetry[]; } -export namespace ResponseError { +export namespace VpnConnection { /** * @internal */ - export const filterSensitiveLog = (obj: ResponseError): any => ({ + export const filterSensitiveLog = (obj: VpnConnection): any => ({ ...obj, }); } /** - *Describes a launch template version that could not be deleted.
+ *Contains the output of CreateVpnConnection.
*/ -export interface DeleteLaunchTemplateVersionsResponseErrorItem { +export interface CreateVpnConnectionResult { /** - *The ID of the launch template.
+ *Information about the VPN connection.
*/ - LaunchTemplateId?: string; + VpnConnection?: VpnConnection; +} +export namespace CreateVpnConnectionResult { /** - *The name of the launch template.
+ * @internal */ - LaunchTemplateName?: string; + export const filterSensitiveLog = (obj: CreateVpnConnectionResult): any => ({ + ...obj, + }); +} +/** + *Contains the parameters for CreateVpnConnectionRoute.
+ */ +export interface CreateVpnConnectionRouteRequest { /** - *The version number of the launch template.
+ *The CIDR block associated with the local subnet of the customer network.
*/ - VersionNumber?: number; + DestinationCidrBlock: string | undefined; /** - *Information about the error.
+ *The ID of the VPN connection.
*/ - ResponseError?: ResponseError; + VpnConnectionId: string | undefined; } -export namespace DeleteLaunchTemplateVersionsResponseErrorItem { +export namespace CreateVpnConnectionRouteRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteLaunchTemplateVersionsResponseErrorItem): any => ({ + export const filterSensitiveLog = (obj: CreateVpnConnectionRouteRequest): any => ({ ...obj, }); } -export interface DeleteLaunchTemplateVersionsResult { +/** + *Contains the parameters for CreateVpnGateway.
+ */ +export interface CreateVpnGatewayRequest { /** - *Information about the launch template versions that were successfully - * deleted.
+ *The Availability Zone for the virtual private gateway.
*/ - SuccessfullyDeletedLaunchTemplateVersions?: DeleteLaunchTemplateVersionsResponseSuccessItem[]; + AvailabilityZone?: string; /** - *Information about the launch template versions that could not be deleted.
+ *The type of VPN connection this virtual private gateway supports.
*/ - UnsuccessfullyDeletedLaunchTemplateVersions?: DeleteLaunchTemplateVersionsResponseErrorItem[]; + Type: GatewayType | string | undefined; + + /** + *The tags to apply to the virtual private gateway.
+ */ + TagSpecifications?: TagSpecification[]; + + /** + *A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If + * you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a + * 32-bit ASN, it must be in the 4200000000 to 4294967294 range.
+ *Default: 64512
+ */ + AmazonSideAsn?: number; + + /** + *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Describes a virtual private gateway.
+ */ +export interface VpnGateway { /** - *The CIDR range for the route. This must match the CIDR for the route exactly.
+ *The Availability Zone where the virtual private gateway was created, if applicable. + * This field may be empty or not returned.
*/ - DestinationCidrBlock: string | undefined; + AvailabilityZone?: string; /** - *The ID of the local gateway route table.
+ *The current state of the virtual private gateway.
*/ - LocalGatewayRouteTableId: string | undefined; + State?: VpnState | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The type of VPN connection the virtual private gateway supports.
*/ - DryRun?: boolean; + Type?: GatewayType | string; + + /** + *Any VPCs attached to the virtual private gateway.
+ */ + VpcAttachments?: VpcAttachment[]; + + /** + *The ID of the virtual private gateway.
+ */ + VpnGatewayId?: string; + + /** + *The private Autonomous System Number (ASN) for the Amazon side of a BGP + * session.
+ */ + AmazonSideAsn?: number; + + /** + *Any tags assigned to the virtual private gateway.
+ */ + Tags?: Tag[]; } -export namespace DeleteLocalGatewayRouteRequest { +export namespace VpnGateway { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteLocalGatewayRouteRequest): any => ({ + export const filterSensitiveLog = (obj: VpnGateway): any => ({ ...obj, }); } -export interface DeleteLocalGatewayRouteResult { +/** + *Contains the output of CreateVpnGateway.
+ */ +export interface CreateVpnGatewayResult { /** - *Information about the route.
+ *Information about the virtual private gateway.
*/ - Route?: LocalGatewayRoute; + VpnGateway?: VpnGateway; } -export namespace DeleteLocalGatewayRouteResult { +export namespace CreateVpnGatewayResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteLocalGatewayRouteResult): any => ({ + export const filterSensitiveLog = (obj: CreateVpnGatewayResult): any => ({ ...obj, }); } -export interface DeleteLocalGatewayRouteTableVpcAssociationRequest { +export interface DeleteCarrierGatewayRequest { /** - *The ID of the association.
+ *The ID of the carrier gateway.
*/ - LocalGatewayRouteTableVpcAssociationId: string | undefined; + CarrierGatewayId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -1392,166 +1497,166 @@ export interface DeleteLocalGatewayRouteTableVpcAssociationRequest { DryRun?: boolean; } -export namespace DeleteLocalGatewayRouteTableVpcAssociationRequest { +export namespace DeleteCarrierGatewayRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteLocalGatewayRouteTableVpcAssociationRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteCarrierGatewayRequest): any => ({ ...obj, }); } -export interface DeleteLocalGatewayRouteTableVpcAssociationResult { +export interface DeleteCarrierGatewayResult { /** - *
Information about the association.
+ *Information about the carrier gateway.
*/ - LocalGatewayRouteTableVpcAssociation?: LocalGatewayRouteTableVpcAssociation; + CarrierGateway?: CarrierGateway; } -export namespace DeleteLocalGatewayRouteTableVpcAssociationResult { +export namespace DeleteCarrierGatewayResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteLocalGatewayRouteTableVpcAssociationResult): any => ({ + export const filterSensitiveLog = (obj: DeleteCarrierGatewayResult): any => ({ ...obj, }); } -export interface DeleteManagedPrefixListRequest { +export interface DeleteClientVpnEndpointRequest { /** - *Checks whether you have the required permissions for the action, without 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.
*/ - DryRun?: boolean; + ClientVpnEndpointId: string | undefined; /** - *The ID of the prefix list.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the prefix list.
+ *The current state of the Client VPN endpoint.
*/ - PrefixList?: ManagedPrefixList; + Status?: ClientVpnEndpointStatus; } -export namespace DeleteManagedPrefixListResult { +export namespace DeleteClientVpnEndpointResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteManagedPrefixListResult): any => ({ + export const filterSensitiveLog = (obj: DeleteClientVpnEndpointResult): any => ({ ...obj, }); } -export interface DeleteNatGatewayRequest { +export interface DeleteClientVpnRouteRequest { /** - *Checks whether you have the required permissions for the action, without 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 endpoint from which the route is to be deleted.
*/ - DryRun?: boolean; + ClientVpnEndpointId: string | undefined; /** - *The ID of the NAT gateway.
+ *The ID of the target subnet used by the route.
*/ - NatGatewayId: string | undefined; + TargetVpcSubnetId?: string; + + /** + *The IPv4 address range, in CIDR notation, of the route to be deleted.
+ */ + DestinationCidrBlock: 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 NAT gateway.
+ *The current state of the route.
*/ - NatGatewayId?: string; + Status?: ClientVpnRouteStatus; } -export namespace DeleteNatGatewayResult { +export namespace DeleteClientVpnRouteResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteNatGatewayResult): any => ({ + export const filterSensitiveLog = (obj: DeleteClientVpnRouteResult): any => ({ ...obj, }); } -export interface DeleteNetworkAclRequest { +/** + *Contains the parameters for DeleteCustomerGateway.
+ */ +export interface DeleteCustomerGatewayRequest { /** - *Checks whether you have the required permissions for the action, without 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 customer gateway.
*/ - DryRun?: boolean; + CustomerGatewayId: string | undefined; /** - *The ID of the network ACL.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The ID of the DHCP options set.
+ */ + DhcpOptionsId: 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.
Indicates whether the rule is an egress rule.
- */ - Egress: boolean | undefined; - - /** - *The ID of the network ACL.
- */ - NetworkAclId: string | undefined; - - /** - *The rule number of the entry to delete.
- */ - RuleNumber: number | undefined; } -export namespace DeleteNetworkAclEntryRequest { +export namespace DeleteDhcpOptionsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteNetworkAclEntryRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteDhcpOptionsRequest): any => ({ ...obj, }); } -export interface DeleteNetworkInsightsAnalysisRequest { +export interface DeleteEgressOnlyInternetGatewayRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -1560,37 +1665,37 @@ export interface DeleteNetworkInsightsAnalysisRequest {
DryRun?: boolean;
/**
- *
The ID of the network insights analysis.
+ *The ID of the egress-only internet gateway.
*/ - NetworkInsightsAnalysisId: string | undefined; + EgressOnlyInternetGatewayId: string | undefined; } -export namespace DeleteNetworkInsightsAnalysisRequest { +export namespace DeleteEgressOnlyInternetGatewayRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteNetworkInsightsAnalysisRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteEgressOnlyInternetGatewayRequest): any => ({ ...obj, }); } -export interface DeleteNetworkInsightsAnalysisResult { +export interface DeleteEgressOnlyInternetGatewayResult { /** - *The ID of the network insights analysis.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -1599,292 +1704,295 @@ export interface DeleteNetworkInsightsPathRequest {
DryRun?: boolean;
/**
- *
The ID of the path.
+ *The IDs of the EC2 Fleets.
*/ - NetworkInsightsPathId: string | undefined; -} + FleetIds: string[] | undefined; -export namespace DeleteNetworkInsightsPathRequest { /** - * @internal - */ - export const filterSensitiveLog = (obj: DeleteNetworkInsightsPathRequest): any => ({ - ...obj, - }); -} - -export interface DeleteNetworkInsightsPathResult { - /** - *The ID of the path.
+ *Indicates whether to terminate the instances when the EC2 Fleet is deleted. The default is to + * terminate the instances.
+ *To let the instances continue to run after the EC2 Fleet is deleted, specify
+ * NoTerminateInstances. Supported only for fleets of type
+ * maintain and request.
For instant fleets, you cannot specify NoTerminateInstances. A
+ * deleted instant fleet with running instances is not supported.
Contains the parameters for DeleteNetworkInterface.
+ *Describes an EC2 Fleet that was successfully deleted.
*/ -export interface DeleteNetworkInterfaceRequest { +export interface DeleteFleetSuccessItem { /** - *Checks whether you have the required permissions for the action, without 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 EC2 Fleet.
*/ - DryRun?: boolean; + CurrentFleetState?: FleetStateCode | string; /** - *The ID of the network interface.
+ *The previous state of the EC2 Fleet.
*/ - NetworkInterfaceId: string | undefined; + PreviousFleetState?: FleetStateCode | string; + + /** + *The ID of the EC2 Fleet.
+ */ + FleetId?: string; } -export namespace DeleteNetworkInterfaceRequest { +export namespace DeleteFleetSuccessItem { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteNetworkInterfaceRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteFleetSuccessItem): any => ({ ...obj, }); } +export enum DeleteFleetErrorCode { + FLEET_ID_DOES_NOT_EXIST = "fleetIdDoesNotExist", + FLEET_ID_MALFORMED = "fleetIdMalformed", + FLEET_NOT_IN_DELETABLE_STATE = "fleetNotInDeletableState", + UNEXPECTED_ERROR = "unexpectedError", +} + /** - *Contains the parameters for DeleteNetworkInterfacePermission.
+ *Describes an EC2 Fleet error.
*/ -export interface DeleteNetworkInterfacePermissionRequest { - /** - *The ID of the network interface permission.
- */ - NetworkInterfacePermissionId: string | undefined; - +export interface DeleteFleetError { /** - *Specify true to remove the permission even if the network interface is
- * attached to an instance.
The error code.
*/ - Force?: boolean; + Code?: DeleteFleetErrorCode | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The description for the error code.
*/ - DryRun?: boolean; + Message?: string; } -export namespace DeleteNetworkInterfacePermissionRequest { +export namespace DeleteFleetError { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteNetworkInterfacePermissionRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteFleetError): any => ({ ...obj, }); } /** - *Contains the output for DeleteNetworkInterfacePermission.
+ *Describes an EC2 Fleet that was not successfully deleted.
*/ -export interface DeleteNetworkInterfacePermissionResult { +export interface DeleteFleetErrorItem { /** - *Returns true if the request succeeds, otherwise returns an error.
The error.
*/ - Return?: boolean; + Error?: DeleteFleetError; + + /** + *The ID of the EC2 Fleet.
+ */ + FleetId?: string; } -export namespace DeleteNetworkInterfacePermissionResult { +export namespace DeleteFleetErrorItem { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteNetworkInterfacePermissionResult): any => ({ + export const filterSensitiveLog = (obj: DeleteFleetErrorItem): any => ({ ...obj, }); } -export interface DeletePlacementGroupRequest { +export interface DeleteFleetsResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the EC2 Fleets that are successfully deleted.
*/ - DryRun?: boolean; + SuccessfulFleetDeletions?: DeleteFleetSuccessItem[]; /** - *The name of the placement group.
+ *Information about the EC2 Fleets that are not successfully deleted.
*/ - GroupName: string | undefined; + UnsuccessfulFleetDeletions?: DeleteFleetErrorItem[]; } -export namespace DeletePlacementGroupRequest { +export namespace DeleteFleetsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeletePlacementGroupRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteFleetsResult): any => ({ ...obj, }); } -export interface DeleteQueuedReservedInstancesRequest { +export interface DeleteFlowLogsRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
/**
- * The IDs of the Reserved Instances.
+ *One or more flow log IDs.
+ *Constraint: Maximum of 1000 flow log IDs.
*/ - ReservedInstancesIds: string[] | undefined; + FlowLogIds: string[] | undefined; } -export namespace DeleteQueuedReservedInstancesRequest { +export namespace DeleteFlowLogsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteQueuedReservedInstancesRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteFlowLogsRequest): any => ({ ...obj, }); } -export enum DeleteQueuedReservedInstancesErrorCode { - RESERVED_INSTANCES_ID_INVALID = "reserved-instances-id-invalid", - RESERVED_INSTANCES_NOT_IN_QUEUED_STATE = "reserved-instances-not-in-queued-state", - UNEXPECTED_ERROR = "unexpected-error", -} - -/** - *Describes the error for a Reserved Instance whose queued purchase could not be deleted.
- */ -export interface DeleteQueuedReservedInstancesError { - /** - *The error code.
- */ - Code?: DeleteQueuedReservedInstancesErrorCode | string; - +export interface DeleteFlowLogsResult { /** - *The error message.
+ *Information about the flow logs that could not be deleted successfully.
*/ - Message?: string; + Unsuccessful?: UnsuccessfulItem[]; } -export namespace DeleteQueuedReservedInstancesError { +export namespace DeleteFlowLogsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteQueuedReservedInstancesError): any => ({ + export const filterSensitiveLog = (obj: DeleteFlowLogsResult): any => ({ ...obj, }); } -/** - *Describes a Reserved Instance whose queued purchase was not deleted.
- */ -export interface FailedQueuedPurchaseDeletion { +export interface DeleteFpgaImageRequest { /** - *The error.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the Reserved Instance.
+ *The ID of the AFI.
*/ - ReservedInstancesId?: string; + FpgaImageId: string | undefined; } -export namespace FailedQueuedPurchaseDeletion { +export namespace DeleteFpgaImageRequest { /** * @internal */ - export const filterSensitiveLog = (obj: FailedQueuedPurchaseDeletion): any => ({ + export const filterSensitiveLog = (obj: DeleteFpgaImageRequest): any => ({ ...obj, }); } -/** - *Describes a Reserved Instance whose queued purchase was successfully deleted.
- */ -export interface SuccessfulQueuedPurchaseDeletion { +export interface DeleteFpgaImageResult { /** - *The ID of the Reserved Instance.
+ *Is true if the request succeeds, and an error otherwise.
Information about the queued purchases that were successfully deleted.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the queued purchases that could not be deleted.
+ *Specify true to force delete the event window. Use the force delete parameter
+ * if the event window is currently associated with targets.
The ID of the event window.
+ */ + InstanceEventWindowId: string | undefined; } -export namespace DeleteQueuedReservedInstancesResult { +export namespace DeleteInstanceEventWindowRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteQueuedReservedInstancesResult): any => ({ + export const filterSensitiveLog = (obj: DeleteInstanceEventWindowRequest): any => ({ ...obj, }); } -export interface DeleteRouteRequest { - /** - *The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
- */ - DestinationCidrBlock?: string; - +/** + *The state of the event window.
+ */ +export interface InstanceEventWindowStateChange { /** - *The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
+ *The ID of the event window.
*/ - DestinationIpv6CidrBlock?: string; + InstanceEventWindowId?: string; /** - *The ID of the prefix list for the route.
+ *The current state of the event window.
*/ - DestinationPrefixListId?: string; + State?: InstanceEventWindowState | string; +} +export namespace InstanceEventWindowStateChange { /** - *Checks whether you have the required permissions for the action, without 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 route table.
+ *The state of the event window.
*/ - RouteTableId: string | undefined; + InstanceEventWindowState?: InstanceEventWindowStateChange; } -export namespace DeleteRouteRequest { +export namespace DeleteInstanceEventWindowResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteRouteRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteInstanceEventWindowResult): any => ({ ...obj, }); } -export interface DeleteRouteTableRequest { +export interface DeleteInternetGatewayRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -1893,30 +2001,30 @@ export interface DeleteRouteTableRequest {
DryRun?: boolean;
/**
- *
The ID of the route table.
+ *The ID of the internet gateway.
*/ - RouteTableId: string | undefined; + InternetGatewayId: string | undefined; } -export namespace DeleteRouteTableRequest { +export namespace DeleteInternetGatewayRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteRouteTableRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteInternetGatewayRequest): any => ({ ...obj, }); } -export interface DeleteSecurityGroupRequest { +export interface DeleteKeyPairRequest { /** - *The ID of the security group. Required for a nondefault VPC.
+ *The name of the key pair.
*/ - GroupId?: string; + KeyName?: string; /** - *[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.
+ *The ID of the key pair.
*/ - GroupName?: string; + KeyPairId?: string; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -1926,240 +2034,227 @@ export interface DeleteSecurityGroupRequest { DryRun?: boolean; } -export namespace DeleteSecurityGroupRequest { +export namespace DeleteKeyPairRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteSecurityGroupRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteKeyPairRequest): any => ({ ...obj, }); } -export interface DeleteSnapshotRequest { - /** - *
The ID of the EBS snapshot.
- */ - SnapshotId: string | undefined; - +export interface DeleteLaunchTemplateRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The ID of the launch template. You must specify either the launch template ID or + * launch template name in the request.
*/ - export const filterSensitiveLog = (obj: DeleteSnapshotRequest): any => ({ - ...obj, - }); -} + LaunchTemplateId?: string; -/** - *Contains the parameters for DeleteSpotDatafeedSubscription.
- */ -export interface DeleteSpotDatafeedSubscriptionRequest { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The name of the launch template. You must specify either the launch template ID or + * launch template name in the request.
*/ - DryRun?: boolean; + LaunchTemplateName?: string; } -export namespace DeleteSpotDatafeedSubscriptionRequest { +export namespace DeleteLaunchTemplateRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteSpotDatafeedSubscriptionRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteLaunchTemplateRequest): any => ({ ...obj, }); } -export interface DeleteSubnetRequest { - /** - *The ID of the subnet.
- */ - SubnetId: string | undefined; - +export interface DeleteLaunchTemplateResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the launch template.
*/ - DryRun?: boolean; + LaunchTemplate?: LaunchTemplate; } -export namespace DeleteSubnetRequest { +export namespace DeleteLaunchTemplateResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteSubnetRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteLaunchTemplateResult): any => ({ ...obj, }); } -export interface DeleteSubnetCidrReservationRequest { +export interface DeleteLaunchTemplateVersionsRequest { /** - *The ID of the subnet CIDR reservation.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the launch template. You must specify either the launch template ID or + * launch template name in the request.
*/ - DryRun?: boolean; -} + LaunchTemplateId?: string; -export namespace DeleteSubnetCidrReservationRequest { /** - * @internal + *The name of the launch template. You must specify either the launch template ID or + * launch template name in the request.
*/ - export const filterSensitiveLog = (obj: DeleteSubnetCidrReservationRequest): any => ({ - ...obj, - }); -} + LaunchTemplateName?: string; -export interface DeleteSubnetCidrReservationResult { /** - *Information about the deleted subnet CIDR reservation.
+ *The version numbers of one or more launch template versions to delete.
*/ - DeletedSubnetCidrReservation?: SubnetCidrReservation; + Versions: string[] | undefined; } -export namespace DeleteSubnetCidrReservationResult { +export namespace DeleteLaunchTemplateVersionsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteSubnetCidrReservationResult): any => ({ + export const filterSensitiveLog = (obj: DeleteLaunchTemplateVersionsRequest): any => ({ ...obj, }); } -export interface DeleteTagsRequest { +/** + *Describes a launch template version that was successfully deleted.
+ */ +export interface DeleteLaunchTemplateVersionsResponseSuccessItem { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the launch template.
*/ - DryRun?: boolean; + LaunchTemplateId?: string; /** - *The IDs of the resources, separated by spaces.
- *Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
+ *The name of the launch template.
*/ - Resources: string[] | undefined; + LaunchTemplateName?: string; /** - *The tags to delete. Specify a tag key and an optional tag value to delete - * specific tags. If you specify a tag key without a tag value, we delete any tag with this - * key regardless of its value. If you specify a tag key with an empty string as the tag - * value, we delete the tag only if its value is an empty string.
- *If you omit this parameter, we delete all user-defined tags for the specified
- * resources. We do not delete Amazon Web Services-generated tags (tags that have the aws:
- * prefix).
The version number of the launch template.
*/ - Tags?: Tag[]; + VersionNumber?: number; } -export namespace DeleteTagsRequest { +export namespace DeleteLaunchTemplateVersionsResponseSuccessItem { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTagsRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteLaunchTemplateVersionsResponseSuccessItem): any => ({ ...obj, }); } -export interface DeleteTrafficMirrorFilterRequest { +export enum LaunchTemplateErrorCode { + LAUNCH_TEMPLATE_ID_DOES_NOT_EXIST = "launchTemplateIdDoesNotExist", + LAUNCH_TEMPLATE_ID_MALFORMED = "launchTemplateIdMalformed", + LAUNCH_TEMPLATE_NAME_DOES_NOT_EXIST = "launchTemplateNameDoesNotExist", + LAUNCH_TEMPLATE_NAME_MALFORMED = "launchTemplateNameMalformed", + LAUNCH_TEMPLATE_VERSION_DOES_NOT_EXIST = "launchTemplateVersionDoesNotExist", + UNEXPECTED_ERROR = "unexpectedError", +} + +/** + *Describes the error that's returned when you cannot delete a launch template + * version.
+ */ +export interface ResponseError { /** - *The ID of the Traffic Mirror filter.
+ *The error code.
*/ - TrafficMirrorFilterId: string | undefined; + Code?: LaunchTemplateErrorCode | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The error message, if applicable.
*/ - DryRun?: boolean; + Message?: string; } -export namespace DeleteTrafficMirrorFilterRequest { +export namespace ResponseError { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTrafficMirrorFilterRequest): any => ({ + export const filterSensitiveLog = (obj: ResponseError): any => ({ ...obj, }); } -export interface DeleteTrafficMirrorFilterResult { +/** + *Describes a launch template version that could not be deleted.
+ */ +export interface DeleteLaunchTemplateVersionsResponseErrorItem { /** - *The ID of the Traffic Mirror filter.
+ *The ID of the launch template.
*/ - TrafficMirrorFilterId?: string; -} + LaunchTemplateId?: string; -export namespace DeleteTrafficMirrorFilterResult { /** - * @internal + *The name of the launch template.
*/ - export const filterSensitiveLog = (obj: DeleteTrafficMirrorFilterResult): any => ({ - ...obj, - }); -} + LaunchTemplateName?: string; -export interface DeleteTrafficMirrorFilterRuleRequest { /** - *The ID of the Traffic Mirror rule.
+ *The version number of the launch template.
*/ - TrafficMirrorFilterRuleId: string | undefined; + VersionNumber?: number; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the error.
*/ - DryRun?: boolean; + ResponseError?: ResponseError; } -export namespace DeleteTrafficMirrorFilterRuleRequest { +export namespace DeleteLaunchTemplateVersionsResponseErrorItem { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTrafficMirrorFilterRuleRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteLaunchTemplateVersionsResponseErrorItem): any => ({ ...obj, }); } -export interface DeleteTrafficMirrorFilterRuleResult { +export interface DeleteLaunchTemplateVersionsResult { /** - *The ID of the deleted Traffic Mirror rule.
+ *Information about the launch template versions that were successfully + * deleted.
*/ - TrafficMirrorFilterRuleId?: string; + SuccessfullyDeletedLaunchTemplateVersions?: DeleteLaunchTemplateVersionsResponseSuccessItem[]; + + /** + *Information about the launch template versions that could not be deleted.
+ */ + UnsuccessfullyDeletedLaunchTemplateVersions?: DeleteLaunchTemplateVersionsResponseErrorItem[]; } -export namespace DeleteTrafficMirrorFilterRuleResult { +export namespace DeleteLaunchTemplateVersionsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTrafficMirrorFilterRuleResult): any => ({ + export const filterSensitiveLog = (obj: DeleteLaunchTemplateVersionsResult): any => ({ ...obj, }); } -export interface DeleteTrafficMirrorSessionRequest { +export interface DeleteLocalGatewayRouteRequest { /** - *The ID of the Traffic Mirror session.
+ *The CIDR range for the route. This must match the CIDR for the route exactly.
*/ - TrafficMirrorSessionId: string | undefined; + DestinationCidrBlock: string | undefined; + + /** + *The ID of the local gateway route table.
+ */ + LocalGatewayRouteTableId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -2169,36 +2264,36 @@ export interface DeleteTrafficMirrorSessionRequest { DryRun?: boolean; } -export namespace DeleteTrafficMirrorSessionRequest { +export namespace DeleteLocalGatewayRouteRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTrafficMirrorSessionRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteLocalGatewayRouteRequest): any => ({ ...obj, }); } -export interface DeleteTrafficMirrorSessionResult { +export interface DeleteLocalGatewayRouteResult { /** - *
The ID of the deleted Traffic Mirror session.
+ *Information about the route.
*/ - TrafficMirrorSessionId?: string; + Route?: LocalGatewayRoute; } -export namespace DeleteTrafficMirrorSessionResult { +export namespace DeleteLocalGatewayRouteResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTrafficMirrorSessionResult): any => ({ + export const filterSensitiveLog = (obj: DeleteLocalGatewayRouteResult): any => ({ ...obj, }); } -export interface DeleteTrafficMirrorTargetRequest { +export interface DeleteLocalGatewayRouteTableVpcAssociationRequest { /** - *The ID of the Traffic Mirror target.
+ *The ID of the association.
*/ - TrafficMirrorTargetId: string | undefined; + LocalGatewayRouteTableVpcAssociationId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -2208,524 +2303,476 @@ export interface DeleteTrafficMirrorTargetRequest { DryRun?: boolean; } -export namespace DeleteTrafficMirrorTargetRequest { +export namespace DeleteLocalGatewayRouteTableVpcAssociationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTrafficMirrorTargetRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteLocalGatewayRouteTableVpcAssociationRequest): any => ({ ...obj, }); } -export interface DeleteTrafficMirrorTargetResult { +export interface DeleteLocalGatewayRouteTableVpcAssociationResult { /** - *
The ID of the deleted Traffic Mirror target.
+ *Information about the association.
*/ - TrafficMirrorTargetId?: string; + LocalGatewayRouteTableVpcAssociation?: LocalGatewayRouteTableVpcAssociation; } -export namespace DeleteTrafficMirrorTargetResult { +export namespace DeleteLocalGatewayRouteTableVpcAssociationResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTrafficMirrorTargetResult): any => ({ + export const filterSensitiveLog = (obj: DeleteLocalGatewayRouteTableVpcAssociationResult): any => ({ ...obj, }); } -export interface DeleteTransitGatewayRequest { - /** - *The ID of the transit gateway.
- */ - TransitGatewayId: string | undefined; - +export interface DeleteManagedPrefixListRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the prefix list.
+ */ + PrefixListId: string | undefined; } -export namespace DeleteTransitGatewayRequest { +export namespace DeleteManagedPrefixListRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTransitGatewayRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteManagedPrefixListRequest): any => ({ ...obj, }); } -export interface DeleteTransitGatewayResult { +export interface DeleteManagedPrefixListResult { /** - *Information about the deleted transit gateway.
+ *Information about the prefix list.
*/ - TransitGateway?: TransitGateway; + PrefixList?: ManagedPrefixList; } -export namespace DeleteTransitGatewayResult { +export namespace DeleteManagedPrefixListResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTransitGatewayResult): any => ({ + export const filterSensitiveLog = (obj: DeleteManagedPrefixListResult): any => ({ ...obj, }); } -export interface DeleteTransitGatewayConnectRequest { - /** - *The ID of the Connect attachment.
- */ - TransitGatewayAttachmentId: string | undefined; - +export interface DeleteNatGatewayRequest { /** *Checks whether you have the required permissions for the action, without 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 NAT gateway.
+ */ + NatGatewayId: string | undefined; } -export namespace DeleteTransitGatewayConnectRequest { +export namespace DeleteNatGatewayRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTransitGatewayConnectRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteNatGatewayRequest): any => ({ ...obj, }); } -export interface DeleteTransitGatewayConnectResult { +export interface DeleteNatGatewayResult { /** - *Information about the deleted Connect attachment.
+ *The ID of the NAT gateway.
*/ - TransitGatewayConnect?: TransitGatewayConnect; + NatGatewayId?: string; } -export namespace DeleteTransitGatewayConnectResult { +export namespace DeleteNatGatewayResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTransitGatewayConnectResult): any => ({ + export const filterSensitiveLog = (obj: DeleteNatGatewayResult): any => ({ ...obj, }); } -export interface DeleteTransitGatewayConnectPeerRequest { - /** - *The ID of the Connect peer.
- */ - TransitGatewayConnectPeerId: string | undefined; - +export interface DeleteNetworkAclRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
Information about the deleted Connect peer.
+ *The ID of the network ACL.
*/ - TransitGatewayConnectPeer?: TransitGatewayConnectPeer; + NetworkAclId: string | undefined; } -export namespace DeleteTransitGatewayConnectPeerResult { +export namespace DeleteNetworkAclRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTransitGatewayConnectPeerResult): any => ({ + export const filterSensitiveLog = (obj: DeleteNetworkAclRequest): any => ({ ...obj, }); } -export interface DeleteTransitGatewayMulticastDomainRequest { - /** - *The ID of the transit gateway multicast domain.
- */ - TransitGatewayMulticastDomainId: string | undefined; - +export interface DeleteNetworkAclEntryRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
Indicates whether the rule is an egress rule.
*/ - export const filterSensitiveLog = (obj: DeleteTransitGatewayMulticastDomainRequest): any => ({ - ...obj, - }); -} + Egress: boolean | undefined; -export interface DeleteTransitGatewayMulticastDomainResult { /** - *Information about the deleted transit gateway multicast domain.
+ *The ID of the network ACL.
*/ - TransitGatewayMulticastDomain?: TransitGatewayMulticastDomain; + NetworkAclId: string | undefined; + + /** + *The rule number of the entry to delete.
+ */ + RuleNumber: number | undefined; } -export namespace DeleteTransitGatewayMulticastDomainResult { +export namespace DeleteNetworkAclEntryRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTransitGatewayMulticastDomainResult): any => ({ + export const filterSensitiveLog = (obj: DeleteNetworkAclEntryRequest): any => ({ ...obj, }); } -export interface DeleteTransitGatewayPeeringAttachmentRequest { - /** - *The ID of the transit gateway peering attachment.
- */ - TransitGatewayAttachmentId: string | undefined; - +export interface DeleteNetworkInsightsAnalysisRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the network insights analysis.
+ */ + NetworkInsightsAnalysisId: string | undefined; } -export namespace DeleteTransitGatewayPeeringAttachmentRequest { +export namespace DeleteNetworkInsightsAnalysisRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTransitGatewayPeeringAttachmentRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteNetworkInsightsAnalysisRequest): any => ({ ...obj, }); } -export interface DeleteTransitGatewayPeeringAttachmentResult { +export interface DeleteNetworkInsightsAnalysisResult { /** - *The transit gateway peering attachment.
+ *The ID of the network insights analysis.
*/ - TransitGatewayPeeringAttachment?: TransitGatewayPeeringAttachment; + NetworkInsightsAnalysisId?: string; } -export namespace DeleteTransitGatewayPeeringAttachmentResult { +export namespace DeleteNetworkInsightsAnalysisResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTransitGatewayPeeringAttachmentResult): any => ({ + export const filterSensitiveLog = (obj: DeleteNetworkInsightsAnalysisResult): any => ({ ...obj, }); } -export interface DeleteTransitGatewayPrefixListReferenceRequest { - /** - *The ID of the route table.
- */ - TransitGatewayRouteTableId: string | undefined; - - /** - *The ID of the prefix list.
- */ - PrefixListId: string | undefined; - +export interface DeleteNetworkInsightsPathRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the path.
+ */ + NetworkInsightsPathId: string | undefined; } -export namespace DeleteTransitGatewayPrefixListReferenceRequest { +export namespace DeleteNetworkInsightsPathRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTransitGatewayPrefixListReferenceRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteNetworkInsightsPathRequest): any => ({ ...obj, }); } -export interface DeleteTransitGatewayPrefixListReferenceResult { +export interface DeleteNetworkInsightsPathResult { /** - *Information about the deleted prefix list reference.
+ *The ID of the path.
*/ - TransitGatewayPrefixListReference?: TransitGatewayPrefixListReference; + NetworkInsightsPathId?: string; } -export namespace DeleteTransitGatewayPrefixListReferenceResult { +export namespace DeleteNetworkInsightsPathResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTransitGatewayPrefixListReferenceResult): any => ({ + export const filterSensitiveLog = (obj: DeleteNetworkInsightsPathResult): any => ({ ...obj, }); } -export interface DeleteTransitGatewayRouteRequest { - /** - *The ID of the transit gateway route table.
- */ - TransitGatewayRouteTableId: string | undefined; - +/** + *Contains the parameters for DeleteNetworkInterface.
+ */ +export interface DeleteNetworkInterfaceRequest { /** - *The CIDR range for the route. This must match the CIDR for the route exactly.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the network interface.
*/ - DryRun?: boolean; + NetworkInterfaceId: string | undefined; } -export namespace DeleteTransitGatewayRouteRequest { +export namespace DeleteNetworkInterfaceRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTransitGatewayRouteRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteNetworkInterfaceRequest): any => ({ ...obj, }); } -export interface DeleteTransitGatewayRouteResult { - /** - *Information about the route.
- */ - Route?: TransitGatewayRoute; -} - -export namespace DeleteTransitGatewayRouteResult { +/** + *Contains the parameters for DeleteNetworkInterfacePermission.
+ */ +export interface DeleteNetworkInterfacePermissionRequest { /** - * @internal + *The ID of the network interface permission.
*/ - export const filterSensitiveLog = (obj: DeleteTransitGatewayRouteResult): any => ({ - ...obj, - }); -} + NetworkInterfacePermissionId: string | undefined; -export interface DeleteTransitGatewayRouteTableRequest { /** - *The ID of the transit gateway route table.
+ *Specify true to remove the permission even if the network interface is
+ * attached to an instance.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
-export namespace DeleteTransitGatewayRouteTableRequest {
+export namespace DeleteNetworkInterfacePermissionRequest {
/**
* @internal
*/
- export const filterSensitiveLog = (obj: DeleteTransitGatewayRouteTableRequest): any => ({
+ export const filterSensitiveLog = (obj: DeleteNetworkInterfacePermissionRequest): any => ({
...obj,
});
}
-export interface DeleteTransitGatewayRouteTableResult {
+/**
+ * Contains the output for DeleteNetworkInterfacePermission.
+ */ +export interface DeleteNetworkInterfacePermissionResult { /** - *Information about the deleted transit gateway route table.
+ *Returns true if the request succeeds, otherwise returns an error.
The ID of the attachment.
- */ - TransitGatewayAttachmentId: string | undefined; - +export interface DeletePlacementGroupRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The name of the placement group.
*/ - export const filterSensitiveLog = (obj: DeleteTransitGatewayVpcAttachmentRequest): any => ({ - ...obj, - }); -} - -export interface DeleteTransitGatewayVpcAttachmentResult { - /** - *Information about the deleted VPC attachment.
- */ - TransitGatewayVpcAttachment?: TransitGatewayVpcAttachment; + GroupName: string | undefined; } -export namespace DeleteTransitGatewayVpcAttachmentResult { +export namespace DeletePlacementGroupRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteTransitGatewayVpcAttachmentResult): any => ({ + export const filterSensitiveLog = (obj: DeletePlacementGroupRequest): any => ({ ...obj, }); } -export interface DeleteVolumeRequest { +export interface DeleteQueuedReservedInstancesRequest { /** - *The ID of the volume.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The IDs of the Reserved Instances.
*/ - DryRun?: boolean; + ReservedInstancesIds: string[] | undefined; } -export namespace DeleteVolumeRequest { +export namespace DeleteQueuedReservedInstancesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteVolumeRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteQueuedReservedInstancesRequest): any => ({ ...obj, }); } -export interface DeleteVpcRequest { +export enum DeleteQueuedReservedInstancesErrorCode { + RESERVED_INSTANCES_ID_INVALID = "reserved-instances-id-invalid", + RESERVED_INSTANCES_NOT_IN_QUEUED_STATE = "reserved-instances-not-in-queued-state", + UNEXPECTED_ERROR = "unexpected-error", +} + +/** + *Describes the error for a Reserved Instance whose queued purchase could not be deleted.
+ */ +export interface DeleteQueuedReservedInstancesError { /** - *The ID of the VPC.
+ *The error code.
*/ - VpcId: string | undefined; + Code?: DeleteQueuedReservedInstancesErrorCode | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The error message.
*/ - DryRun?: boolean; + Message?: string; } -export namespace DeleteVpcRequest { +export namespace DeleteQueuedReservedInstancesError { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteVpcRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteQueuedReservedInstancesError): any => ({ ...obj, }); } -export interface DeleteVpcEndpointConnectionNotificationsRequest { +/** + *Describes a Reserved Instance whose queued purchase was not deleted.
+ */ +export interface FailedQueuedPurchaseDeletion { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The error.
*/ - DryRun?: boolean; + Error?: DeleteQueuedReservedInstancesError; /** - *One or more notification IDs.
+ *The ID of the Reserved Instance.
*/ - ConnectionNotificationIds: string[] | undefined; + ReservedInstancesId?: string; } -export namespace DeleteVpcEndpointConnectionNotificationsRequest { +export namespace FailedQueuedPurchaseDeletion { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteVpcEndpointConnectionNotificationsRequest): any => ({ + export const filterSensitiveLog = (obj: FailedQueuedPurchaseDeletion): any => ({ ...obj, }); } -export interface DeleteVpcEndpointConnectionNotificationsResult { +/** + *Describes a Reserved Instance whose queued purchase was successfully deleted.
+ */ +export interface SuccessfulQueuedPurchaseDeletion { /** - *Information about the notifications that could not be deleted - * successfully.
+ *The ID of the Reserved Instance.
*/ - Unsuccessful?: UnsuccessfulItem[]; + ReservedInstancesId?: string; } -export namespace DeleteVpcEndpointConnectionNotificationsResult { +export namespace SuccessfulQueuedPurchaseDeletion { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteVpcEndpointConnectionNotificationsResult): any => ({ + export const filterSensitiveLog = (obj: SuccessfulQueuedPurchaseDeletion): any => ({ ...obj, }); } -/** - *Contains the parameters for DeleteVpcEndpoints.
- */ -export interface DeleteVpcEndpointsRequest { +export interface DeleteQueuedReservedInstancesResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the queued purchases that were successfully deleted.
*/ - DryRun?: boolean; + SuccessfulQueuedPurchaseDeletions?: SuccessfulQueuedPurchaseDeletion[]; /** - *One or more VPC endpoint IDs.
+ *Information about the queued purchases that could not be deleted.
*/ - VpcEndpointIds: string[] | undefined; + FailedQueuedPurchaseDeletions?: FailedQueuedPurchaseDeletion[]; } -export namespace DeleteVpcEndpointsRequest { +export namespace DeleteQueuedReservedInstancesResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteVpcEndpointsRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteQueuedReservedInstancesResult): any => ({ ...obj, }); } -/** - *Contains the output of DeleteVpcEndpoints.
- */ -export interface DeleteVpcEndpointsResult { +export interface DeleteRouteRequest { /** - *Information about the VPC endpoints that were not successfully deleted.
+ *The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
*/ - Unsuccessful?: UnsuccessfulItem[]; -} + DestinationCidrBlock?: string; -export namespace DeleteVpcEndpointsResult { /** - * @internal + *The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
*/ - export const filterSensitiveLog = (obj: DeleteVpcEndpointsResult): any => ({ - ...obj, - }); -} + DestinationIpv6CidrBlock?: string; + + /** + *The ID of the prefix list for the route.
+ */ + DestinationPrefixListId?: string; -export interface DeleteVpcEndpointServiceConfigurationsRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -2734,38 +2781,21 @@ export interface DeleteVpcEndpointServiceConfigurationsRequest {
DryRun?: boolean;
/**
- *
The IDs of one or more services.
- */ - ServiceIds: string[] | undefined; -} - -export namespace DeleteVpcEndpointServiceConfigurationsRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DeleteVpcEndpointServiceConfigurationsRequest): any => ({ - ...obj, - }); -} - -export interface DeleteVpcEndpointServiceConfigurationsResult { - /** - *Information about the service configurations that were not deleted, if - * applicable.
+ *The ID of the route table.
*/ - Unsuccessful?: UnsuccessfulItem[]; + RouteTableId: string | undefined; } -export namespace DeleteVpcEndpointServiceConfigurationsResult { +export namespace DeleteRouteRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteVpcEndpointServiceConfigurationsResult): any => ({ + export const filterSensitiveLog = (obj: DeleteRouteRequest): any => ({ ...obj, }); } -export interface DeleteVpcPeeringConnectionRequest { +export interface DeleteRouteTableRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -2774,96 +2804,75 @@ export interface DeleteVpcPeeringConnectionRequest {
DryRun?: boolean;
/**
- *
The ID of the VPC peering connection.
+ *The ID of the route table.
*/ - VpcPeeringConnectionId: string | undefined; + RouteTableId: string | undefined; } -export namespace DeleteVpcPeeringConnectionRequest { +export namespace DeleteRouteTableRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteVpcPeeringConnectionRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteRouteTableRequest): any => ({ ...obj, }); } -export interface DeleteVpcPeeringConnectionResult { - /** - *Returns true if the request succeeds; otherwise, it returns an error.
The ID of the security group. Required for a nondefault VPC.
*/ - export const filterSensitiveLog = (obj: DeleteVpcPeeringConnectionResult): any => ({ - ...obj, - }); -} + GroupId?: string; -/** - *Contains the parameters for DeleteVpnConnection.
- */ -export interface DeleteVpnConnectionRequest { /** - *The ID of the VPN connection.
+ *[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.
*/ - VpnConnectionId: string | undefined; + GroupName?: string; /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Contains the parameters for DeleteVpnConnectionRoute.
- */ -export interface DeleteVpnConnectionRouteRequest { +export interface DeleteSnapshotRequest { /** - *The CIDR block associated with the local subnet of the customer network.
+ *The ID of the EBS snapshot.
*/ - DestinationCidrBlock: string | undefined; + SnapshotId: string | undefined; /** - *The ID of the VPN connection.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Contains the parameters for DeleteVpnGateway.
+ *Contains the parameters for DeleteSpotDatafeedSubscription.
*/ -export interface DeleteVpnGatewayRequest { - /** - *The ID of the virtual private gateway.
- */ - VpnGatewayId: string | undefined; - +export interface DeleteSpotDatafeedSubscriptionRequest { /** *Checks whether you have the required permissions for the action, without actually * making the request, and provides an error response. If you have the required @@ -2873,21 +2882,20 @@ export interface DeleteVpnGatewayRequest { DryRun?: boolean; } -export namespace DeleteVpnGatewayRequest { +export namespace DeleteSpotDatafeedSubscriptionRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeleteVpnGatewayRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteSpotDatafeedSubscriptionRequest): any => ({ ...obj, }); } -export interface DeprovisionByoipCidrRequest { +export interface DeleteSubnetRequest { /** - *
The address range, in CIDR notation. The prefix must be the same prefix - * that you specified when you provisioned the address range.
+ *The ID of the subnet.
*/ - Cidr: string | undefined; + SubnetId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -2897,85 +2905,55 @@ export interface DeprovisionByoipCidrRequest { DryRun?: boolean; } -export namespace DeprovisionByoipCidrRequest { +export namespace DeleteSubnetRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeprovisionByoipCidrRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteSubnetRequest): any => ({ ...obj, }); } -export interface DeprovisionByoipCidrResult { +export interface DeleteSubnetCidrReservationRequest { /** - *
Information about the address range.
+ *The ID of the subnet CIDR reservation.
*/ - ByoipCidr?: ByoipCidr; -} - -export namespace DeprovisionByoipCidrResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DeprovisionByoipCidrResult): any => ({ - ...obj, - }); -} - -/** - *Contains the parameters for DeregisterImage.
- */ -export interface DeregisterImageRequest { - /** - *The ID of the AMI.
- */ - ImageId: string | undefined; + SubnetCidrReservationId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
-export namespace DeregisterImageRequest {
+export namespace DeleteSubnetCidrReservationRequest {
/**
* @internal
*/
- export const filterSensitiveLog = (obj: DeregisterImageRequest): any => ({
+ export const filterSensitiveLog = (obj: DeleteSubnetCidrReservationRequest): any => ({
...obj,
});
}
-/**
- * Information about the tag keys to deregister for the current Region. You can either specify
- * individual tag keys or deregister all tag keys in the current Region. You must specify either
- * IncludeAllTagsOfInstance or InstanceTagKeys in the request
Indicates whether to deregister all tag keys in the current Region. Specify false
- * to deregister all tag keys.
Information about the tag keys to deregister.
+ *Information about the deleted subnet CIDR reservation.
*/ - InstanceTagKeys?: string[]; + DeletedSubnetCidrReservation?: SubnetCidrReservation; } -export namespace DeregisterInstanceTagAttributeRequest { +export namespace DeleteSubnetCidrReservationResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeregisterInstanceTagAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteSubnetCidrReservationResult): any => ({ ...obj, }); } -export interface DeregisterInstanceEventNotificationAttributesRequest { +export interface DeleteTagsRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -2984,76 +2962,76 @@ export interface DeregisterInstanceEventNotificationAttributesRequest {
DryRun?: boolean;
/**
- *
Information about the tag keys to deregister.
+ *The IDs of the resources, separated by spaces.
+ *Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
*/ - InstanceTagAttribute?: DeregisterInstanceTagAttributeRequest; + Resources: string[] | undefined; + + /** + *The tags to delete. Specify a tag key and an optional tag value to delete + * specific tags. If you specify a tag key without a tag value, we delete any tag with this + * key regardless of its value. If you specify a tag key with an empty string as the tag + * value, we delete the tag only if its value is an empty string.
+ *If you omit this parameter, we delete all user-defined tags for the specified
+ * resources. We do not delete Amazon Web Services-generated tags (tags that have the aws:
+ * prefix).
Describes the registered tag keys for the current Region.
- */ -export interface InstanceTagNotificationAttribute { +export interface DeleteTrafficMirrorFilterRequest { /** - *The registered tag keys.
+ *The ID of the Traffic Mirror filter.
*/ - InstanceTagKeys?: string[]; + TrafficMirrorFilterId: string | undefined; /** - *Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications.
- * true indicates that all tag keys in the current Region are registered.
Checks whether you have the required permissions for the action, without 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 resulting set of tag keys.
+ *The ID of the Traffic Mirror filter.
*/ - InstanceTagAttribute?: InstanceTagNotificationAttribute; + TrafficMirrorFilterId?: string; } -export namespace DeregisterInstanceEventNotificationAttributesResult { +export namespace DeleteTrafficMirrorFilterResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeregisterInstanceEventNotificationAttributesResult): any => ({ + export const filterSensitiveLog = (obj: DeleteTrafficMirrorFilterResult): any => ({ ...obj, }); } -export interface DeregisterTransitGatewayMulticastGroupMembersRequest { - /** - *The ID of the transit gateway multicast domain.
- */ - TransitGatewayMulticastDomainId?: string; - - /** - *The IP address assigned to the transit gateway multicast group.
- */ - GroupIpAddress?: string; - +export interface DeleteTrafficMirrorFilterRuleRequest { /** - *The IDs of the group members' network interfaces.
+ *The ID of the Traffic Mirror rule.
*/ - NetworkInterfaceIds?: string[]; + TrafficMirrorFilterRuleId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -3063,75 +3041,75 @@ export interface DeregisterTransitGatewayMulticastGroupMembersRequest { DryRun?: boolean; } -export namespace DeregisterTransitGatewayMulticastGroupMembersRequest { +export namespace DeleteTrafficMirrorFilterRuleRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeregisterTransitGatewayMulticastGroupMembersRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteTrafficMirrorFilterRuleRequest): any => ({ ...obj, }); } -/** - *
Describes the deregistered transit gateway multicast group members.
- */ -export interface TransitGatewayMulticastDeregisteredGroupMembers { - /** - *The ID of the transit gateway multicast domain.
- */ - TransitGatewayMulticastDomainId?: string; - - /** - *The network interface IDs of the deregistered members.
- */ - DeregisteredNetworkInterfaceIds?: string[]; - +export interface DeleteTrafficMirrorFilterRuleResult { /** - *The IP address assigned to the transit gateway multicast group.
+ *The ID of the deleted Traffic Mirror rule.
*/ - GroupIpAddress?: string; + TrafficMirrorFilterRuleId?: string; } -export namespace TransitGatewayMulticastDeregisteredGroupMembers { +export namespace DeleteTrafficMirrorFilterRuleResult { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayMulticastDeregisteredGroupMembers): any => ({ + export const filterSensitiveLog = (obj: DeleteTrafficMirrorFilterRuleResult): any => ({ ...obj, }); } -export interface DeregisterTransitGatewayMulticastGroupMembersResult { +export interface DeleteTrafficMirrorSessionRequest { /** - *Information about the deregistered members.
+ *The ID of the Traffic Mirror session.
*/ - DeregisteredMulticastGroupMembers?: TransitGatewayMulticastDeregisteredGroupMembers; + TrafficMirrorSessionId: 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 transit gateway multicast domain.
+ *The ID of the deleted Traffic Mirror session.
*/ - TransitGatewayMulticastDomainId?: string; + TrafficMirrorSessionId?: string; +} +export namespace DeleteTrafficMirrorSessionResult { /** - *The IP address assigned to the transit gateway multicast group.
+ * @internal */ - GroupIpAddress?: string; + export const filterSensitiveLog = (obj: DeleteTrafficMirrorSessionResult): any => ({ + ...obj, + }); +} +export interface DeleteTrafficMirrorTargetRequest { /** - *The IDs of the group sources' network interfaces.
+ *The ID of the Traffic Mirror target.
*/ - NetworkInterfaceIds?: string[]; + TrafficMirrorTargetId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -3141,189 +3119,153 @@ export interface DeregisterTransitGatewayMulticastGroupSourcesRequest { DryRun?: boolean; } -export namespace DeregisterTransitGatewayMulticastGroupSourcesRequest { +export namespace DeleteTrafficMirrorTargetRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DeregisterTransitGatewayMulticastGroupSourcesRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteTrafficMirrorTargetRequest): any => ({ ...obj, }); } -/** - *
Describes the deregistered transit gateway multicast group sources.
- */ -export interface TransitGatewayMulticastDeregisteredGroupSources { +export interface DeleteTrafficMirrorTargetResult { /** - *The ID of the transit gateway multicast domain.
+ *The ID of the deleted Traffic Mirror target.
*/ - TransitGatewayMulticastDomainId?: string; + TrafficMirrorTargetId?: string; +} +export namespace DeleteTrafficMirrorTargetResult { /** - *The network interface IDs of the non-registered members.
+ * @internal */ - DeregisteredNetworkInterfaceIds?: string[]; + export const filterSensitiveLog = (obj: DeleteTrafficMirrorTargetResult): any => ({ + ...obj, + }); +} +export interface DeleteTransitGatewayRequest { /** - *The IP address assigned to the transit gateway multicast group.
+ *The ID of the transit gateway.
*/ - GroupIpAddress?: string; + TransitGatewayId: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the deregistered group sources.
+ *Information about the deleted transit gateway.
*/ - DeregisteredMulticastGroupSources?: TransitGatewayMulticastDeregisteredGroupSources; + TransitGateway?: TransitGateway; } -export namespace DeregisterTransitGatewayMulticastGroupSourcesResult { +export namespace DeleteTransitGatewayResult { /** * @internal */ - export const filterSensitiveLog = (obj: DeregisterTransitGatewayMulticastGroupSourcesResult): any => ({ + export const filterSensitiveLog = (obj: DeleteTransitGatewayResult): any => ({ ...obj, }); } -export interface DescribeAccountAttributesRequest { +export interface DeleteTransitGatewayConnectRequest { /** - *The account attribute names.
+ *The ID of the Connect attachment.
*/ - AttributeNames?: (AccountAttributeName | string)[]; + TransitGatewayAttachmentId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
}
-export namespace DescribeAccountAttributesRequest {
+export namespace DeleteTransitGatewayConnectRequest {
/**
* @internal
*/
- export const filterSensitiveLog = (obj: DescribeAccountAttributesRequest): any => ({
+ export const filterSensitiveLog = (obj: DeleteTransitGatewayConnectRequest): any => ({
...obj,
});
}
-export interface DescribeAccountAttributesResult {
+export interface DeleteTransitGatewayConnectResult {
/**
- * Information about the account attributes.
+ *Information about the deleted Connect attachment.
*/ - AccountAttributes?: AccountAttribute[]; + TransitGatewayConnect?: TransitGatewayConnect; } -export namespace DescribeAccountAttributesResult { +export namespace DeleteTransitGatewayConnectResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeAccountAttributesResult): any => ({ + export const filterSensitiveLog = (obj: DeleteTransitGatewayConnectResult): any => ({ ...obj, }); } -/** - *A filter name and value pair that is used to return a more specific list of results from a describe operation. - * Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
- */ -export interface Filter { +export interface DeleteTransitGatewayConnectPeerRequest { /** - *The name of the filter. Filter names are case-sensitive.
+ *The ID of the Connect peer.
*/ - Name?: string; + TransitGatewayConnectPeerId: string | undefined; /** - *The filter values. Filter values are case-sensitive.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters. Filter names and values are case-sensitive.
- *
- * allocation-id - [EC2-VPC] The allocation ID for the address.
- * association-id - [EC2-VPC] The association ID for the address.
- * domain - Indicates whether the address is for use in EC2-Classic (standard)
- * or in a VPC (vpc).
- * instance-id - The ID of the instance the address is associated with, if any.
- * network-border-group - A unique set of Availability Zones, Local Zones,
- * or Wavelength Zones from where Amazon Web Services advertises IP addresses.
- * network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.
- * network-interface-owner-id - The Amazon Web Services account ID of the owner.
- * private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.
- * public-ip - The Elastic IP address, or the carrier IP address.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Information about the deleted Connect peer.
*/ - Filters?: Filter[]; + TransitGatewayConnectPeer?: TransitGatewayConnectPeer; +} +export namespace DeleteTransitGatewayConnectPeerResult { /** - *One or more Elastic IP addresses.
- *Default: Describes all your Elastic IP addresses.
+ * @internal */ - PublicIps?: string[]; + export const filterSensitiveLog = (obj: DeleteTransitGatewayConnectPeerResult): any => ({ + ...obj, + }); +} +export interface DeleteTransitGatewayMulticastDomainRequest { /** - *[EC2-VPC] Information about the allocation IDs.
+ *The ID of the transit gateway multicast domain.
*/ - AllocationIds?: string[]; + TransitGatewayMulticastDomainId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -3333,51 +3275,80 @@ export interface DescribeAddressesRequest { DryRun?: boolean; } -export namespace DescribeAddressesRequest { +export namespace DeleteTransitGatewayMulticastDomainRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeAddressesRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteTransitGatewayMulticastDomainRequest): any => ({ ...obj, }); } -export interface DescribeAddressesResult { +export interface DeleteTransitGatewayMulticastDomainResult { /** - *
Information about the Elastic IP addresses.
+ *Information about the deleted transit gateway multicast domain.
*/ - Addresses?: Address[]; + TransitGatewayMulticastDomain?: TransitGatewayMulticastDomain; } -export namespace DescribeAddressesResult { +export namespace DeleteTransitGatewayMulticastDomainResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeAddressesResult): any => ({ + export const filterSensitiveLog = (obj: DeleteTransitGatewayMulticastDomainResult): any => ({ ...obj, }); } -export interface DescribeAddressesAttributeRequest { +export interface DeleteTransitGatewayPeeringAttachmentRequest { /** - *[EC2-VPC] The allocation IDs.
+ *The ID of the transit gateway peering attachment.
*/ - AllocationIds?: string[]; + TransitGatewayAttachmentId: string | undefined; /** - *The attribute of the IP address.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
+ * @internal */ - NextToken?: string; + export const filterSensitiveLog = (obj: DeleteTransitGatewayPeeringAttachmentRequest): any => ({ + ...obj, + }); +} +export interface DeleteTransitGatewayPeeringAttachmentResult { /** - *The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The transit gateway peering attachment.
*/ - MaxResults?: number; + TransitGatewayPeeringAttachment?: TransitGatewayPeeringAttachment; +} + +export namespace DeleteTransitGatewayPeeringAttachmentResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteTransitGatewayPeeringAttachmentResult): any => ({ + ...obj, + }); +} + +export interface DeleteTransitGatewayPrefixListReferenceRequest { + /** + *The ID of the route table.
+ */ + TransitGatewayRouteTableId: string | undefined; + + /** + *The ID of the prefix list.
+ */ + PrefixListId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -3387,37 +3358,42 @@ export interface DescribeAddressesAttributeRequest { DryRun?: boolean; } -export namespace DescribeAddressesAttributeRequest { +export namespace DeleteTransitGatewayPrefixListReferenceRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeAddressesAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteTransitGatewayPrefixListReferenceRequest): any => ({ ...obj, }); } -export interface DescribeAddressesAttributeResult { - /** - *
Information about the IP addresses.
- */ - Addresses?: AddressAttribute[]; - +export interface DeleteTransitGatewayPrefixListReferenceResult { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the deleted prefix list reference.
*/ - NextToken?: string; + TransitGatewayPrefixListReference?: TransitGatewayPrefixListReference; } -export namespace DescribeAddressesAttributeResult { +export namespace DeleteTransitGatewayPrefixListReferenceResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeAddressesAttributeResult): any => ({ + export const filterSensitiveLog = (obj: DeleteTransitGatewayPrefixListReferenceResult): any => ({ ...obj, }); } -export interface DescribeAggregateIdFormatRequest { +export interface DeleteTransitGatewayRouteRequest { + /** + *The ID of the transit gateway route table.
+ */ + TransitGatewayRouteTableId: string | undefined; + + /** + *The CIDR range for the route. This must match the CIDR for the route exactly.
+ */ + DestinationCidrBlock: 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.
@@ -3426,148 +3402,137 @@ export interface DescribeAggregateIdFormatRequest {
DryRun?: boolean;
}
-export namespace DescribeAggregateIdFormatRequest {
+export namespace DeleteTransitGatewayRouteRequest {
/**
* @internal
*/
- export const filterSensitiveLog = (obj: DescribeAggregateIdFormatRequest): any => ({
+ export const filterSensitiveLog = (obj: DeleteTransitGatewayRouteRequest): any => ({
...obj,
});
}
-/**
- *
Describes the ID format for a resource.
- */ -export interface IdFormat { +export interface DeleteTransitGatewayRouteResult { /** - *The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.
+ *Information about the route.
*/ - Deadline?: Date; + Route?: TransitGatewayRoute; +} +export namespace DeleteTransitGatewayRouteResult { /** - *The type of resource.
+ * @internal */ - Resource?: string; + export const filterSensitiveLog = (obj: DeleteTransitGatewayRouteResult): any => ({ + ...obj, + }); +} +export interface DeleteTransitGatewayRouteTableRequest { /** - *Indicates whether longer IDs (17-character IDs) are enabled for the resource.
+ *The ID of the transit gateway route table.
*/ - UseLongIds?: boolean; + TransitGatewayRouteTableId: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Indicates whether all resource types in the Region are configured to use longer IDs.
- * This value is only true if all users are configured to use longer IDs for
- * all resources types in the Region.
Information about the deleted transit gateway route table.
*/ - UseLongIdsAggregated?: boolean; + TransitGatewayRouteTable?: TransitGatewayRouteTable; +} +export namespace DeleteTransitGatewayRouteTableResult { /** - *Information about each resource's ID format.
+ * @internal */ - Statuses?: IdFormat[]; + export const filterSensitiveLog = (obj: DeleteTransitGatewayRouteTableResult): any => ({ + ...obj, + }); } -export namespace DescribeAggregateIdFormatResult { +export interface DeleteTransitGatewayVpcAttachmentRequest { + /** + *The ID of the attachment.
+ */ + TransitGatewayAttachmentId: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The filters.
- *
- * group-name - For Availability Zones, use the Region name. For Local
- * Zones, use the name of the group associated with the Local Zone (for example,
- * us-west-2-lax-1) For Wavelength Zones, use the name of the group associated
- * with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
- * message - The Zone message.
- * opt-in-status - The opt-in status (opted-in, and
- * not-opted-in | opt-in-not-required).
- * parent-zoneID - The ID of the zone that handles some of the Local Zone
- * and Wavelength Zone control plane operations, such as API calls.
- * parent-zoneName - The ID of the zone that handles some of the Local Zone
- * and Wavelength Zone control plane operations, such as API calls.
- * region-name - The name of the Region for the Zone (for example,
- * us-east-1).
- * state - The state of the Availability Zone, the Local Zone, or the
- * Wavelength Zone (available | information | impaired
- * | unavailable).
- * zone-id - The ID of the Availability Zone (for example,
- * use1-az1), the Local Zone (for example, usw2-lax1-az1), or the
- * Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
- * zone-type - The type of zone, for example, local-zone.
- * zone-name - The name of the Availability Zone (for example,
- * us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or
- * the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
- * zone-type - The type of zone, for example, local-zone.
Information about the deleted VPC attachment.
*/ - Filters?: Filter[]; + TransitGatewayVpcAttachment?: TransitGatewayVpcAttachment; +} +export namespace DeleteTransitGatewayVpcAttachmentResult { /** - *The names of the Availability Zones, Local Zones, and Wavelength Zones.
+ * @internal */ - ZoneNames?: string[]; + export const filterSensitiveLog = (obj: DeleteTransitGatewayVpcAttachmentResult): any => ({ + ...obj, + }); +} +export interface DeleteVolumeRequest { /** - *The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
+ *The ID of the volume.
*/ - ZoneIds?: string[]; + VolumeId: string | undefined; /** - *Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your - * opt-in status.
- *If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.
+ *Checks whether you have the required permissions for the action, without 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.
+ */ + VpcId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -3577,715 +3542,699 @@ export interface DescribeAvailabilityZonesRequest { DryRun?: boolean; } -export namespace DescribeAvailabilityZonesRequest { +export namespace DeleteVpcRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeAvailabilityZonesRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteVpcRequest): any => ({ ...obj, }); } -/** - *
Describes a message about an Availability Zone, Local Zone, or Wavelength Zone.
- */ -export interface AvailabilityZoneMessage { +export interface DeleteVpcEndpointConnectionNotificationsRequest { /** - *The message about the Availability Zone, Local Zone, or Wavelength Zone.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more notification IDs.
+ */ + ConnectionNotificationIds: string[] | undefined; } -export namespace AvailabilityZoneMessage { +export namespace DeleteVpcEndpointConnectionNotificationsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: AvailabilityZoneMessage): any => ({ + export const filterSensitiveLog = (obj: DeleteVpcEndpointConnectionNotificationsRequest): any => ({ ...obj, }); } -export type AvailabilityZoneOptInStatus = "not-opted-in" | "opt-in-not-required" | "opted-in"; +export interface DeleteVpcEndpointConnectionNotificationsResult { + /** + *Information about the notifications that could not be deleted + * successfully.
+ */ + Unsuccessful?: UnsuccessfulItem[]; +} -export type AvailabilityZoneState = "available" | "impaired" | "information" | "unavailable"; +export namespace DeleteVpcEndpointConnectionNotificationsResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeleteVpcEndpointConnectionNotificationsResult): any => ({ + ...obj, + }); +} /** - *Describes Availability Zones, Local Zones, and Wavelength Zones.
+ *Contains the parameters for DeleteVpcEndpoints.
*/ -export interface AvailabilityZone { +export interface DeleteVpcEndpointsRequest { /** - *The state of the Availability Zone, Local Zone, or Wavelength Zone.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
For Availability Zones, this parameter always has the value of
- * opt-in-not-required.
For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible
- * values are opted-in, and not-opted-in.
One or more VPC endpoint IDs.
*/ - OptInStatus?: AvailabilityZoneOptInStatus | string; + VpcEndpointIds: string[] | undefined; +} +export namespace DeleteVpcEndpointsRequest { /** - *Any messages about the Availability Zone, Local Zone, or Wavelength Zone.
+ * @internal */ - Messages?: AvailabilityZoneMessage[]; + export const filterSensitiveLog = (obj: DeleteVpcEndpointsRequest): any => ({ + ...obj, + }); +} +/** + *Contains the output of DeleteVpcEndpoints.
+ */ +export interface DeleteVpcEndpointsResult { /** - *The name of the Region.
+ *Information about the VPC endpoints that were not successfully deleted.
*/ - RegionName?: string; + Unsuccessful?: UnsuccessfulItem[]; +} +export namespace DeleteVpcEndpointsResult { /** - *The name of the Availability Zone, Local Zone, or Wavelength Zone.
+ * @internal */ - ZoneName?: string; + export const filterSensitiveLog = (obj: DeleteVpcEndpointsResult): any => ({ + ...obj, + }); +} +export interface DeleteVpcEndpointServiceConfigurationsRequest { /** - *The ID of the Availability Zone, Local Zone, or Wavelength Zone.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
For Availability Zones, this parameter has the same value as the Region name.
- *For Local Zones, the name of the associated group, for example
- * us-west-2-lax-1.
For Wavelength Zones, the name of the associated group, for example
- * us-east-1-wl1-bos-wlz-1.
The IDs of one or more services.
*/ - GroupName?: string; + ServiceIds: string[] | undefined; +} +export namespace DeleteVpcEndpointServiceConfigurationsRequest { /** - *The name of the network border group.
+ * @internal */ - NetworkBorderGroup?: string; + export const filterSensitiveLog = (obj: DeleteVpcEndpointServiceConfigurationsRequest): any => ({ + ...obj, + }); +} +export interface DeleteVpcEndpointServiceConfigurationsResult { /** - *The type of zone. The valid values are availability-zone,
- * local-zone, and wavelength-zone.
Information about the service configurations that were not deleted, if + * applicable.
*/ - ZoneType?: string; + Unsuccessful?: UnsuccessfulItem[]; +} +export namespace DeleteVpcEndpointServiceConfigurationsResult { /** - *The name of the zone that handles some of the Local Zone or Wavelength Zone control plane - * operations, such as API calls.
+ * @internal */ - ParentZoneName?: string; + export const filterSensitiveLog = (obj: DeleteVpcEndpointServiceConfigurationsResult): any => ({ + ...obj, + }); +} +export interface DeleteVpcPeeringConnectionRequest { /** - *The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane - * operations, such as API calls.
+ *Checks whether you have the required permissions for the action, without 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 peering connection.
+ */ + VpcPeeringConnectionId: string | undefined; } -export namespace AvailabilityZone { +export namespace DeleteVpcPeeringConnectionRequest { /** * @internal */ - export const filterSensitiveLog = (obj: AvailabilityZone): any => ({ + export const filterSensitiveLog = (obj: DeleteVpcPeeringConnectionRequest): any => ({ ...obj, }); } -export interface DescribeAvailabilityZonesResult { +export interface DeleteVpcPeeringConnectionResult { /** - *Information about the Availability Zones, Local Zones, and Wavelength Zones.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Contains the parameters for DeleteVpnConnection.
+ */ +export interface DeleteVpnConnectionRequest { /** - *The bundle task IDs.
- *Default: Describes all your bundle tasks.
+ *The ID of the VPN connection.
*/ - BundleIds?: string[]; + VpnConnectionId: string | undefined; /** - *The filters.
- *
- * bundle-id - The ID of the bundle task.
- * error-code - If the task failed, the error code returned.
- * error-message - If the task failed, the error message returned.
- * instance-id - The ID of the instance.
- * progress - The level of task completion, as a percentage (for example, 20%).
- * s3-bucket - The Amazon S3 bucket to store the AMI.
- * s3-prefix - The beginning of the AMI name.
- * start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
- * state - The state of the task (pending | waiting-for-shutdown | bundling |
- * storing | cancelling | complete | failed).
- * update-time - The time of the most recent update for the task.
Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Contains the parameters for DeleteVpnConnectionRoute.
+ */ +export interface DeleteVpnConnectionRouteRequest { + /** + *The CIDR block associated with the local subnet of the customer network.
+ */ + DestinationCidrBlock: string | undefined; + + /** + *The ID of the VPN connection.
+ */ + VpnConnectionId: string | undefined; +} + +export namespace DeleteVpnConnectionRouteRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeBundleTasksRequest): any => ({ + export const filterSensitiveLog = (obj: DeleteVpnConnectionRouteRequest): any => ({ ...obj, }); } -export interface DescribeBundleTasksResult { +/** + *Contains the parameters for DeleteVpnGateway.
+ */ +export interface DeleteVpnGatewayRequest { /** - *Information about the bundle tasks.
+ *The ID of the virtual private gateway.
*/ - BundleTasks?: BundleTask[]; + VpnGatewayId: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The address range, in CIDR notation. The prefix must be the same prefix + * that you specified when you provisioned the address range.
+ */ + Cidr: 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 maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ *Information about the address range.
*/ - NextToken?: string; + ByoipCidr?: ByoipCidr; } -export namespace DescribeByoipCidrsRequest { +export namespace DeprovisionByoipCidrResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeByoipCidrsRequest): any => ({ + export const filterSensitiveLog = (obj: DeprovisionByoipCidrResult): any => ({ ...obj, }); } -export interface DescribeByoipCidrsResult { +/** + *Contains the parameters for DeregisterImage.
+ */ +export interface DeregisterImageRequest { /** - *Information about your address ranges.
+ *The ID of the AMI.
*/ - ByoipCidrs?: ByoipCidr[]; + ImageId: string | undefined; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the tag keys to deregister for the current Region. You can either specify
+ * individual tag keys or deregister all tag keys in the current Region. You must specify either
+ * IncludeAllTagsOfInstance or InstanceTagKeys in the request
The IDs of the Capacity Reservation Fleets to describe.
+ *Indicates whether to deregister all tag keys in the current Region. Specify false
+ * to deregister all tag keys.
The token to use to retrieve the next page of results.
+ *Information about the tag keys to deregister.
*/ - NextToken?: string; + InstanceTagKeys?: string[]; +} +export namespace DeregisterInstanceTagAttributeRequest { /** - *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
One or more filters.
- *
- * state - The state of the Fleet (submitted | modifying | active |
- * partially_fulfilled | expiring | expired | cancelling |
- * cancelled | failed).
- * instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.
- * tenancy - The tenancy of the Fleet (default | dedicated).
- * allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the tag keys to deregister.
*/ - DryRun?: boolean; + InstanceTagAttribute?: DeregisterInstanceTagAttributeRequest; } -export namespace DescribeCapacityReservationFleetsRequest { +export namespace DeregisterInstanceEventNotificationAttributesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeCapacityReservationFleetsRequest): any => ({ + export const filterSensitiveLog = (obj: DeregisterInstanceEventNotificationAttributesRequest): any => ({ ...obj, }); } /** - *Information about a Capacity Reservation Fleet.
+ *Describes the registered tag keys for the current Region.
*/ -export interface CapacityReservationFleet { +export interface InstanceTagNotificationAttribute { /** - *The ID of the Capacity Reservation Fleet.
+ *The registered tag keys.
*/ - CapacityReservationFleetId?: string; + InstanceTagKeys?: string[]; /** - *The ARN of the Capacity Reservation Fleet.
+ *Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications.
+ * true indicates that all tag keys in the current Region are registered.
The state of the Capacity Reservation Fleet. Possible states include:
- *
- * submitted - The Capacity Reservation Fleet request has been submitted
- * and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.
- * modifying - The Capacity Reservation Fleet is being modified. The Fleet
- * remains in this state until the modification is complete.
- * active - The Capacity Reservation Fleet has fulfilled its total target
- * capacity and it is attempting to maintain this capacity. The Fleet remains in this
- * state until it is modified or deleted.
- * partially_fulfilled - The Capacity Reservation Fleet has partially
- * fulfilled its total target capacity. There is insufficient Amazon EC2 to
- * fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill
- * its total target capacity.
- * expiring - The Capacity Reservation Fleet has reach its end date and it
- * is in the process of expiring. One or more of its Capacity reservations might still
- * be active.
- * expired - The Capacity Reservation Fleet has reach its end date. The Fleet
- * and its Capacity Reservations are expired. The Fleet can't create new Capacity
- * Reservations.
- * cancelling - The Capacity Reservation Fleet is in the process of being
- * cancelled. One or more of its Capacity reservations might still be active.
- * cancelled - The Capacity Reservation Fleet has been manually cancelled.
- * The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new
- * Capacity Reservations.
- * failed - The Capacity Reservation Fleet failed to reserve capacity for
- * the specified instance types.
The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. - * For more information, see Total target capacity - * in the Amazon EC2 User Guide.
+ *The resulting set of tag keys.
*/ - TotalTargetCapacity?: number; + InstanceTagAttribute?: InstanceTagNotificationAttribute; +} +export namespace DeregisterInstanceEventNotificationAttributesResult { /** - *The capacity units that have been fulfilled.
+ * @internal */ - TotalFulfilledCapacity?: number; + export const filterSensitiveLog = (obj: DeregisterInstanceEventNotificationAttributesResult): any => ({ + ...obj, + }); +} +export interface DeregisterTransitGatewayMulticastGroupMembersRequest { /** - *The tenancy of the Capacity Reservation Fleet. Tenancies include:
- *
- * default - The Capacity Reservation Fleet is created on hardware that is
- * shared with other Amazon Web Services accounts.
- * dedicated - The Capacity Reservation Fleet is created on single-tenant
- * hardware that is dedicated to a single Amazon Web Services account.
The ID of the transit gateway multicast domain.
*/ - Tenancy?: FleetCapacityReservationTenancy | string; + TransitGatewayMulticastDomainId?: string; /** - *The date and time at which the Capacity Reservation Fleet expires.
+ *The IP address assigned to the transit gateway multicast group.
*/ - EndDate?: Date; + GroupIpAddress?: string; /** - *The date and time at which the Capacity Reservation Fleet was created.
+ *The IDs of the group members' network interfaces.
*/ - CreateTime?: Date; + NetworkInterfaceIds?: string[]; /** - *Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All - * Capacity Reservations in the Fleet inherit this instance matching criteria.
- *Currently, Capacity Reservation Fleets support open instance matching criteria
- * only. This means that instances that have matching attributes (instance type, platform, and
- * Availability Zone) run in the Capacity Reservations automatically. Instances do not need to
- * explicitly target a Capacity Reservation Fleet to use its reserved capacity.
Checks whether you have the required permissions for the action, without 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 strategy used by the Capacity Reservation Fleet to determine which of the specified - * instance types to use. For more information, see For more information, see - * - * Allocation strategy in the Amazon EC2 User Guide.
+ * @internal */ - AllocationStrategy?: string; + export const filterSensitiveLog = (obj: DeregisterTransitGatewayMulticastGroupMembersRequest): any => ({ + ...obj, + }); +} +/** + *Describes the deregistered transit gateway multicast group members.
+ */ +export interface TransitGatewayMulticastDeregisteredGroupMembers { /** - *Information about the instance types for which to reserve the capacity.
+ *The ID of the transit gateway multicast domain.
*/ - InstanceTypeSpecifications?: FleetCapacityReservation[]; + TransitGatewayMulticastDomainId?: string; /** - *The tags assigned to the Capacity Reservation Fleet.
+ *The network interface IDs of the deregistered members.
*/ - Tags?: Tag[]; + DeregisteredNetworkInterfaceIds?: string[]; + + /** + *The IP address assigned to the transit gateway multicast group.
+ */ + GroupIpAddress?: string; } -export namespace CapacityReservationFleet { +export namespace TransitGatewayMulticastDeregisteredGroupMembers { /** * @internal */ - export const filterSensitiveLog = (obj: CapacityReservationFleet): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayMulticastDeregisteredGroupMembers): any => ({ ...obj, }); } -export interface DescribeCapacityReservationFleetsResult { +export interface DeregisterTransitGatewayMulticastGroupMembersResult { /** - *Information about the Capacity Reservation Fleets.
+ *Information about the deregistered members.
*/ - CapacityReservationFleets?: CapacityReservationFleet[]; + DeregisteredMulticastGroupMembers?: TransitGatewayMulticastDeregisteredGroupMembers; +} +export namespace DeregisterTransitGatewayMulticastGroupMembersResult { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the transit gateway multicast domain.
+ */ + TransitGatewayMulticastDomainId?: string; + + /** + *The IP address assigned to the transit gateway multicast group.
+ */ + GroupIpAddress?: string; + + /** + *The IDs of the group sources' network interfaces.
+ */ + NetworkInterfaceIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the deregistered transit gateway multicast group sources.
+ */ +export interface TransitGatewayMulticastDeregisteredGroupSources { /** - *The ID of the Capacity Reservation.
+ *The ID of the transit gateway multicast domain.
*/ - CapacityReservationIds?: string[]; + TransitGatewayMulticastDomainId?: string; /** - *The token to use to retrieve the next page of results.
+ *The network interface IDs of the non-registered members.
*/ - NextToken?: string; + DeregisteredNetworkInterfaceIds?: string[]; /** - *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
The IP address assigned to the transit gateway multicast group.
*/ - MaxResults?: number; + GroupIpAddress?: string; +} +export namespace TransitGatewayMulticastDeregisteredGroupSources { /** - *One or more filters.
- *
- * instance-type - The type of instance for which the Capacity Reservation reserves capacity.
- * owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
- * availability-zone-id - The Availability Zone ID of the Capacity Reservation.
- * instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
- * availability-zone - The Availability Zone ID of the Capacity Reservation.
- * tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the
- * following tenancy settings:
- * default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
- * dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
- * outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
- * state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
- * active- The Capacity Reservation is active and the capacity is available for your use.
- * expired - The Capacity Reservation expired automatically at the date and time specified in your request.
- * The reserved capacity is no longer available for your use.
- * cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
- * pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
- * failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters,
- * capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
- * start-date - The date and time at which the Capacity Reservation was started.
- * end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is
- * released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
- * end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
- * unlimited - The Capacity Reservation remains active until you explicitly cancel it.
- * limited - The Capacity Reservation expires automatically at a specified date and time.
- * instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
- * open - The Capacity Reservation accepts all instances that have matching
- * attributes (instance type, platform, and Availability Zone). Instances
- * that have matching attributes launch into the Capacity Reservation
- * automatically without specifying any additional parameters.
- * targeted - The Capacity Reservation only accepts instances that have matching
- * attributes (instance type, platform, and Availability Zone), and
- * explicitly target the Capacity Reservation. This ensures that only
- * permitted instances can use the reserved capacity.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the deregistered group sources.
+ */ + DeregisteredMulticastGroupSources?: TransitGatewayMulticastDeregisteredGroupSources; +} + +export namespace DeregisterTransitGatewayMulticastGroupSourcesResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DeregisterTransitGatewayMulticastGroupSourcesResult): any => ({ + ...obj, + }); +} + +export interface DescribeAccountAttributesRequest { + /** + *The account attribute names.
+ */ + AttributeNames?: (AccountAttributeName | string)[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the account attributes.
*/ - DryRun?: boolean; + AccountAttributes?: AccountAttribute[]; } -export namespace DescribeCapacityReservationsRequest { +export namespace DescribeAccountAttributesResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeCapacityReservationsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeAccountAttributesResult): any => ({ ...obj, }); } -export interface DescribeCapacityReservationsResult { +/** + *A filter name and value pair that is used to return a more specific list of results from a describe operation. + * Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
+ */ +export interface Filter { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The name of the filter. Filter names are case-sensitive.
*/ - NextToken?: string; + Name?: string; /** - *Information about the Capacity Reservations.
+ *The filter values. Filter values are case-sensitive.
*/ - CapacityReservations?: CapacityReservation[]; + Values?: string[]; } -export namespace DescribeCapacityReservationsResult { +export namespace Filter { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeCapacityReservationsResult): any => ({ + export const filterSensitiveLog = (obj: Filter): any => ({ ...obj, }); } -export interface DescribeCarrierGatewaysRequest { - /** - *One or more carrier gateway IDs.
- */ - CarrierGatewayIds?: string[]; - +export interface DescribeAddressesRequest { /** - *One or more filters.
- *One or more filters. Filter names and values are case-sensitive.
+ *
- * carrier-gateway-id - The ID of the carrier gateway.
+ * allocation-id - [EC2-VPC] The allocation ID for the address.
- * state - The state of the carrier gateway (pending |
- * failed | available | deleting | deleted).
+ * association-id - [EC2-VPC] The association ID for the address.
- * owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.
+ * domain - Indicates whether the address is for use in EC2-Classic (standard)
+ * or in a VPC (vpc).
+ *
+ * instance-id - The ID of the instance the address is associated with, if any.
+ * network-border-group - A unique set of Availability Zones, Local Zones,
+ * or Wavelength Zones from where Amazon Web Services advertises IP addresses.
+ * network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.
+ * network-interface-owner-id - The Amazon Web Services account ID of the owner.
+ * private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.
+ * public-ip - The Elastic IP address, or the carrier IP address.
* tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ *
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * vpc-id - The ID of the VPC associated with the carrier gateway.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
One or more Elastic IP addresses.
+ *Default: Describes all your Elastic IP addresses.
*/ - MaxResults?: number; + PublicIps?: string[]; /** - *The token for the next page of results.
+ *[EC2-VPC] Information about the allocation IDs.
*/ - NextToken?: string; + AllocationIds?: string[]; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -4295,144 +4244,74 @@ export interface DescribeCarrierGatewaysRequest { DryRun?: boolean; } -export namespace DescribeCarrierGatewaysRequest { +export namespace DescribeAddressesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeCarrierGatewaysRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeAddressesRequest): any => ({ ...obj, }); } -export interface DescribeCarrierGatewaysResult { - /** - *
Information about the carrier gateway.
- */ - CarrierGateways?: CarrierGateway[]; - +export interface DescribeAddressesResult { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the Elastic IP addresses.
*/ - NextToken?: string; + Addresses?: Address[]; } -export namespace DescribeCarrierGatewaysResult { +export namespace DescribeAddressesResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeCarrierGatewaysResult): any => ({ + export const filterSensitiveLog = (obj: DescribeAddressesResult): any => ({ ...obj, }); } -export interface DescribeClassicLinkInstancesRequest { - /** - *One or more filters.
- *
- * group-id - The ID of a VPC security group that's associated with the instance.
- * instance-id - The ID of the instance.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * vpc-id - The ID of the VPC to which the instance is
- * linked.
- * vpc-id - The ID of the VPC that the instance is linked to.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
+ *[EC2-VPC] The allocation IDs.
*/ - InstanceIds?: string[]; + AllocationIds?: string[]; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Constraint: If the value is greater than 1000, we return only 1000 items.
+ *The attribute of the IP address.
*/ - MaxResults?: number; + Attribute?: AddressAttributeName | string; /** *The token for the next page of results.
*/ NextToken?: string; -} - -export namespace DescribeClassicLinkInstancesRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribeClassicLinkInstancesRequest): any => ({ - ...obj, - }); -} - -/** - *Describes a linked EC2-Classic instance.
- */ -export interface ClassicLinkInstance { - /** - *A list of security groups.
- */ - Groups?: GroupIdentifier[]; /** - *The ID of the instance.
- */ - InstanceId?: string; - - /** - *Any tags assigned to the instance.
+ *The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The ID of the VPC.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about one or more linked EC2-Classic instances.
+ *Information about the IP addresses.
*/ - Instances?: ClassicLinkInstance[]; + Addresses?: AddressAttribute[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Client VPN endpoint.
- */ - ClientVpnEndpointId: string | undefined; - +export interface DescribeAggregateIdFormatRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token to retrieve the next page of results.
- */ - NextToken?: string; - - /** - *One or more filters. Filter names and values are case-sensitive.
- *
- * description - The description of the authorization rule.
- * destination-cidr - The CIDR of the network to which the authorization rule
- * applies.
- * group-id - The ID of the Active Directory group to which the authorization rule grants access.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
- */ - MaxResults?: number; } -export namespace DescribeClientVpnAuthorizationRulesRequest { +export namespace DescribeAggregateIdFormatRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeClientVpnAuthorizationRulesRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeAggregateIdFormatRequest): any => ({ ...obj, }); } /** - *Information about an authorization rule.
+ *Describes the ID format for a resource.
*/ -export interface AuthorizationRule { - /** - *The ID of the Client VPN endpoint with which the authorization rule is associated.
- */ - ClientVpnEndpointId?: string; - - /** - *A brief description of the authorization rule.
- */ - Description?: string; - - /** - *The ID of the Active Directory group to which the authorization rule grants access.
- */ - GroupId?: string; - +export interface IdFormat { /** - *Indicates whether the authorization rule grants access to all clients.
+ *The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.
*/ - AccessAll?: boolean; + Deadline?: Date; /** - *The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.
+ *The type of resource.
*/ - DestinationCidr?: string; + Resource?: string; /** - *The current state of the authorization rule.
+ *Indicates whether longer IDs (17-character IDs) are enabled for the resource.
*/ - Status?: ClientVpnAuthorizationRuleStatus; + UseLongIds?: boolean; } -export namespace AuthorizationRule { +export namespace IdFormat { /** * @internal */ - export const filterSensitiveLog = (obj: AuthorizationRule): any => ({ + export const filterSensitiveLog = (obj: IdFormat): any => ({ ...obj, }); } -export interface DescribeClientVpnAuthorizationRulesResult { +export interface DescribeAggregateIdFormatResult { /** - *Information about the authorization rules.
+ *Indicates whether all resource types in the Region are configured to use longer IDs.
+ * This value is only true if all users are configured to use longer IDs for
+ * all resources types in the Region.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about each resource's ID format.
*/ - NextToken?: string; + Statuses?: IdFormat[]; } -export namespace DescribeClientVpnAuthorizationRulesResult { +export namespace DescribeAggregateIdFormatResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeClientVpnAuthorizationRulesResult): any => ({ + export const filterSensitiveLog = (obj: DescribeAggregateIdFormatResult): any => ({ ...obj, }); } -export interface DescribeClientVpnConnectionsRequest { - /** - *The ID of the Client VPN endpoint.
- */ - ClientVpnEndpointId: string | undefined; - +export interface DescribeAvailabilityZonesRequest { /** - *One or more filters. Filter names and values are case-sensitive.
- *The filters.
+ *
- * connection-id - The ID of the connection.
group-name - For Availability Zones, use the Region name. For Local
+ * Zones, use the name of the group associated with the Local Zone (for example,
+ * us-west-2-lax-1) For Wavelength Zones, use the name of the group associated
+ * with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
*
- * username - For Active Directory client authentication, the user name of the
- * client who established the client connection.
message - The Zone message.
+ *
+ * opt-in-status - The opt-in status (opted-in, and
+ * not-opted-in | opt-in-not-required).
+ * parent-zoneID - The ID of the zone that handles some of the Local Zone
+ * and Wavelength Zone control plane operations, such as API calls.
+ * parent-zoneName - The ID of the zone that handles some of the Local Zone
+ * and Wavelength Zone control plane operations, such as API calls.
+ * region-name - The name of the Region for the Zone (for example,
+ * us-east-1).
+ * state - The state of the Availability Zone, the Local Zone, or the
+ * Wavelength Zone (available | information | impaired
+ * | unavailable).
+ * zone-id - The ID of the Availability Zone (for example,
+ * use1-az1), the Local Zone (for example, usw2-lax1-az1), or the
+ * Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
+ * zone-type - The type of zone, for example, local-zone.
+ * zone-name - The name of the Availability Zone (for example,
+ * us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or
+ * the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
+ * zone-type - The type of zone, for example, local-zone.
The token to retrieve the next page of results.
+ *The names of the Availability Zones, Local Zones, and Wavelength Zones.
*/ - NextToken?: string; + ZoneNames?: string[]; /** - *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
+ *The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
*/ - MaxResults?: number; + ZoneIds?: string[]; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your + * opt-in status.
+ *If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.
+ */ + AllAvailabilityZones?: boolean; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the status of a client connection.
+ *Describes a message about an Availability Zone, Local Zone, or Wavelength Zone.
*/ -export interface ClientVpnConnectionStatus { - /** - *The state of the client connection.
- */ - Code?: ClientVpnConnectionStatusCode | string; - +export interface AvailabilityZoneMessage { /** - *A message about the status of the client connection, if applicable.
+ *The message about the Availability Zone, Local Zone, or Wavelength Zone.
*/ Message?: string; } -export namespace ClientVpnConnectionStatus { +export namespace AvailabilityZoneMessage { /** * @internal */ - export const filterSensitiveLog = (obj: ClientVpnConnectionStatus): any => ({ + export const filterSensitiveLog = (obj: AvailabilityZoneMessage): any => ({ ...obj, }); } -/** - *Describes a client connection.
- */ -export interface ClientVpnConnection { - /** - *The ID of the Client VPN endpoint to which the client is connected.
- */ - ClientVpnEndpointId?: string; - - /** - *The current date and time.
- */ - Timestamp?: string; - - /** - *The ID of the client connection.
- */ - ConnectionId?: string; - - /** - *The username of the client who established the client connection. This information is only provided - * if Active Directory client authentication is used.
- */ - Username?: string; - - /** - *The date and time the client connection was established.
- */ - ConnectionEstablishedTime?: string; +export type AvailabilityZoneOptInStatus = "not-opted-in" | "opt-in-not-required" | "opted-in"; - /** - *The number of bytes sent by the client.
- */ - IngressBytes?: string; +export type AvailabilityZoneState = "available" | "impaired" | "information" | "unavailable"; +/** + *Describes Availability Zones, Local Zones, and Wavelength Zones.
+ */ +export interface AvailabilityZone { /** - *The number of bytes received by the client.
+ *The state of the Availability Zone, Local Zone, or Wavelength Zone.
*/ - EgressBytes?: string; + State?: AvailabilityZoneState | string; /** - *The number of packets sent by the client.
+ *For Availability Zones, this parameter always has the value of
+ * opt-in-not-required.
For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible
+ * values are opted-in, and not-opted-in.
The number of packets received by the client.
+ *Any messages about the Availability Zone, Local Zone, or Wavelength Zone.
*/ - EgressPackets?: string; + Messages?: AvailabilityZoneMessage[]; /** - *The IP address of the client.
+ *The name of the Region.
*/ - ClientIp?: string; + RegionName?: string; /** - *The common name associated with the client. This is either the name of the client certificate, - * or the Active Directory user name.
+ *The name of the Availability Zone, Local Zone, or Wavelength Zone.
*/ - CommonName?: string; + ZoneName?: string; /** - *The current state of the client connection.
+ *The ID of the Availability Zone, Local Zone, or Wavelength Zone.
*/ - Status?: ClientVpnConnectionStatus; + ZoneId?: string; /** - *The date and time the client connection was terminated.
+ *For Availability Zones, this parameter has the same value as the Region name.
+ *For Local Zones, the name of the associated group, for example
+ * us-west-2-lax-1.
For Wavelength Zones, the name of the associated group, for example
+ * us-east-1-wl1-bos-wlz-1.
The statuses returned by the client connect handler for posture compliance, if applicable.
+ *The name of the network border group.
*/ - PostureComplianceStatuses?: string[]; -} + NetworkBorderGroup?: string; -export namespace ClientVpnConnection { /** - * @internal + *The type of zone. The valid values are availability-zone,
+ * local-zone, and wavelength-zone.
Information about the active and terminated client connections.
+ *The name of the zone that handles some of the Local Zone or Wavelength Zone control plane + * operations, such as API calls.
*/ - Connections?: ClientVpnConnection[]; + ParentZoneName?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane + * operations, such as API calls.
*/ - NextToken?: string; + ParentZoneId?: string; } -export namespace DescribeClientVpnConnectionsResult { +export namespace AvailabilityZone { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeClientVpnConnectionsResult): any => ({ + export const filterSensitiveLog = (obj: AvailabilityZone): any => ({ ...obj, }); } -export interface DescribeClientVpnEndpointsRequest { +export interface DescribeAvailabilityZonesResult { /** - *The ID of the Client VPN endpoint.
+ *Information about the Availability Zones, Local Zones, and Wavelength Zones.
*/ - ClientVpnEndpointIds?: string[]; + AvailabilityZones?: AvailabilityZone[]; +} +export namespace DescribeAvailabilityZonesResult { /** - *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
+ * @internal */ - MaxResults?: number; + export const filterSensitiveLog = (obj: DescribeAvailabilityZonesResult): any => ({ + ...obj, + }); +} +export interface DescribeBundleTasksRequest { /** - *The token to retrieve the next page of results.
+ *The bundle task IDs.
+ *Default: Describes all your bundle tasks.
*/ - NextToken?: string; + BundleIds?: string[]; /** - *One or more filters. Filter names and values are case-sensitive.
- *The filters.
+ *
- * endpoint-id - The ID of the Client VPN endpoint.
bundle-id - The ID of the bundle task.
*
- * transport-protocol - The transport protocol (tcp |
- * udp).
error-code - If the task failed, the error code returned.
+ *
+ * error-message - If the task failed, the error message returned.
+ * instance-id - The ID of the instance.
+ * progress - The level of task completion, as a percentage (for example, 20%).
+ * s3-bucket - The Amazon S3 bucket to store the AMI.
+ * s3-prefix - The beginning of the AMI name.
+ * start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
+ * state - The state of the task (pending | waiting-for-shutdown | bundling |
+ * storing | cancelling | complete | failed).
+ * update-time - The time of the most recent update for the task.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.
- */ -export interface AssociatedTargetNetwork { - /** - *The ID of the subnet.
- */ - NetworkId?: string; - +export interface DescribeBundleTasksResult { /** - *The target network type.
+ *Information about the bundle tasks.
*/ - NetworkType?: AssociatedNetworkType | string; + BundleTasks?: BundleTask[]; } -export namespace AssociatedTargetNetwork { +export namespace DescribeBundleTasksResult { /** * @internal */ - export const filterSensitiveLog = (obj: AssociatedTargetNetwork): any => ({ + export const filterSensitiveLog = (obj: DescribeBundleTasksResult): any => ({ ...obj, }); } -/** - *Describes an Active Directory.
- */ -export interface DirectoryServiceAuthentication { +export interface DescribeByoipCidrsRequest { /** - *The ID of the Active Directory used for authentication.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ */ + NextToken?: string; } -export namespace DirectoryServiceAuthentication { +export namespace DescribeByoipCidrsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DirectoryServiceAuthentication): any => ({ + export const filterSensitiveLog = (obj: DescribeByoipCidrsRequest): any => ({ ...obj, }); } -/** - *Describes the IAM SAML identity providers used for federated authentication.
- */ -export interface FederatedAuthentication { +export interface DescribeByoipCidrsResult { /** - *The Amazon Resource Name (ARN) of the IAM SAML identity provider.
+ *Information about your address ranges.
*/ - SamlProviderArn?: string; + ByoipCidrs?: ByoipCidr[]; /** - *The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the client certificate used for authentication.
- */ -export interface CertificateAuthentication { +export interface DescribeCapacityReservationFleetsRequest { /** - *The ARN of the client certificate.
+ *The IDs of the Capacity Reservation Fleets to describe.
*/ - ClientRootCertificateChain?: string; + CapacityReservationFleetIds?: string[]; + + /** + *The token to use to retrieve the next page of results.
+ */ + NextToken?: string; + + /** + *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
One or more filters.
+ *
+ * state - The state of the Fleet (submitted | modifying | active |
+ * partially_fulfilled | expiring | expired | cancelling |
+ * cancelled | failed).
+ * instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.
+ * tenancy - The tenancy of the Fleet (default | dedicated).
+ * allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Describes the authentication methods used by a Client VPN endpoint. For more information, see Authentication - * in the Client VPN Administrator Guide.
+ *Information about a Capacity Reservation Fleet.
*/ -export interface ClientVpnAuthentication { +export interface CapacityReservationFleet { /** - *The authentication type used.
+ *The ID of the Capacity Reservation Fleet.
*/ - Type?: ClientVpnAuthenticationType | string; + CapacityReservationFleetId?: string; /** - *Information about the Active Directory, if applicable.
+ *The ARN of the Capacity Reservation Fleet.
+ */ + CapacityReservationFleetArn?: string; + + /** + *The state of the Capacity Reservation Fleet. Possible states include:
+ *
+ * submitted - The Capacity Reservation Fleet request has been submitted
+ * and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.
+ * modifying - The Capacity Reservation Fleet is being modified. The Fleet
+ * remains in this state until the modification is complete.
+ * active - The Capacity Reservation Fleet has fulfilled its total target
+ * capacity and it is attempting to maintain this capacity. The Fleet remains in this
+ * state until it is modified or deleted.
+ * partially_fulfilled - The Capacity Reservation Fleet has partially
+ * fulfilled its total target capacity. There is insufficient Amazon EC2 to
+ * fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill
+ * its total target capacity.
+ * expiring - The Capacity Reservation Fleet has reach its end date and it
+ * is in the process of expiring. One or more of its Capacity reservations might still
+ * be active.
+ * expired - The Capacity Reservation Fleet has reach its end date. The Fleet
+ * and its Capacity Reservations are expired. The Fleet can't create new Capacity
+ * Reservations.
+ * cancelling - The Capacity Reservation Fleet is in the process of being
+ * cancelled. One or more of its Capacity reservations might still be active.
+ * cancelled - The Capacity Reservation Fleet has been manually cancelled.
+ * The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new
+ * Capacity Reservations.
+ * failed - The Capacity Reservation Fleet failed to reserve capacity for
+ * the specified instance types.
Information about the authentication certificates, if applicable.
+ *The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. + * For more information, see Total target capacity + * in the Amazon EC2 User Guide.
*/ - MutualAuthentication?: CertificateAuthentication; + TotalTargetCapacity?: number; /** - *Information about the IAM SAML identity provider, if applicable.
+ *The capacity units that have been fulfilled.
*/ - FederatedAuthentication?: FederatedAuthentication; -} + TotalFulfilledCapacity?: number; -export namespace ClientVpnAuthentication { /** - * @internal + *The tenancy of the Capacity Reservation Fleet. Tenancies include:
+ *
+ * default - The Capacity Reservation Fleet is created on hardware that is
+ * shared with other Amazon Web Services accounts.
+ * dedicated - The Capacity Reservation Fleet is created on single-tenant
+ * hardware that is dedicated to a single Amazon Web Services account.
Describes the status of the Client VPN endpoint attribute.
- */ -export interface ClientVpnEndpointAttributeStatus { /** - *The status code.
+ *The date and time at which the Capacity Reservation Fleet expires.
*/ - Code?: ClientVpnEndpointAttributeStatusCode | string; + EndDate?: Date; /** - *The status message.
+ *The date and time at which the Capacity Reservation Fleet was created.
*/ - Message?: string; -} + CreateTime?: Date; -export namespace ClientVpnEndpointAttributeStatus { /** - * @internal + *Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All + * Capacity Reservations in the Fleet inherit this instance matching criteria.
+ *Currently, Capacity Reservation Fleets support open instance matching criteria
+ * only. This means that instances that have matching attributes (instance type, platform, and
+ * Availability Zone) run in the Capacity Reservations automatically. Instances do not need to
+ * explicitly target a Capacity Reservation Fleet to use its reserved capacity.
The options for managing connection authorization for new client connections.
- */ -export interface ClientConnectResponseOptions { /** - *Indicates whether client connect options are enabled.
+ *The strategy used by the Capacity Reservation Fleet to determine which of the specified + * instance types to use. For more information, see For more information, see + * + * Allocation strategy in the Amazon EC2 User Guide.
*/ - Enabled?: boolean; + AllocationStrategy?: string; /** - *The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
+ *Information about the instance types for which to reserve the capacity.
*/ - LambdaFunctionArn?: string; + InstanceTypeSpecifications?: FleetCapacityReservation[]; /** - *The status of any updates to the client connect options.
+ *The tags assigned to the Capacity Reservation Fleet.
*/ - Status?: ClientVpnEndpointAttributeStatus; + Tags?: Tag[]; } -export namespace ClientConnectResponseOptions { +export namespace CapacityReservationFleet { /** * @internal */ - export const filterSensitiveLog = (obj: ClientConnectResponseOptions): any => ({ + export const filterSensitiveLog = (obj: CapacityReservationFleet): any => ({ ...obj, }); } -/** - *Information about the client connection logging options for a Client VPN endpoint.
- */ -export interface ConnectionLogResponseOptions { - /** - *Indicates whether client connection logging is enabled for the Client VPN endpoint.
- */ - Enabled?: boolean; - +export interface DescribeCapacityReservationFleetsResult { /** - *The name of the Amazon CloudWatch Logs log group to which connection logging data is published.
+ *Information about the Capacity Reservation Fleets.
*/ - CloudwatchLogGroup?: string; + CapacityReservationFleets?: CapacityReservationFleet[]; /** - *The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes a Client VPN endpoint.
- */ -export interface ClientVpnEndpoint { - /** - *The ID of the Client VPN endpoint.
- */ - ClientVpnEndpointId?: string; - - /** - *A brief description of the endpoint.
- */ - Description?: string; - - /** - *The current state of the Client VPN endpoint.
- */ - Status?: ClientVpnEndpointStatus; - - /** - *The date and time the Client VPN endpoint was created.
- */ - CreationTime?: string; - - /** - *The date and time the Client VPN endpoint was deleted, if applicable.
- */ - DeletionTime?: string; - - /** - *The DNS name to be used by clients when connecting to the Client VPN endpoint.
- */ - DnsName?: string; - - /** - *The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
- */ - ClientCidrBlock?: string; - +export interface DescribeCapacityReservationsRequest { /** - *Information about the DNS servers to be used for DNS resolution.
+ *The ID of the Capacity Reservation.
*/ - DnsServers?: string[]; + CapacityReservationIds?: string[]; /** - *Indicates whether split-tunnel is enabled in the Client VPN endpoint.
- *For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint - * in the Client VPN Administrator Guide.
+ *The token to use to retrieve the next page of results.
*/ - SplitTunnel?: boolean; + NextToken?: string; /** - *The protocol used by the VPN session.
+ *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
The transport protocol used by the Client VPN endpoint.
+ *One or more filters.
+ *
+ * instance-type - The type of instance for which the Capacity Reservation reserves capacity.
+ * owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
+ * availability-zone-id - The Availability Zone ID of the Capacity Reservation.
+ * instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
+ * availability-zone - The Availability Zone ID of the Capacity Reservation.
+ * tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the
+ * following tenancy settings:
+ * default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
+ * dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
+ * outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
+ * state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
+ * active- The Capacity Reservation is active and the capacity is available for your use.
+ * expired - The Capacity Reservation expired automatically at the date and time specified in your request.
+ * The reserved capacity is no longer available for your use.
+ * cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
+ * pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
+ * failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters,
+ * capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
+ * start-date - The date and time at which the Capacity Reservation was started.
+ * end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is
+ * released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
+ * end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
+ * unlimited - The Capacity Reservation remains active until you explicitly cancel it.
+ * limited - The Capacity Reservation expires automatically at a specified date and time.
+ * instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
+ * open - The Capacity Reservation accepts all instances that have matching
+ * attributes (instance type, platform, and Availability Zone). Instances
+ * that have matching attributes launch into the Capacity Reservation
+ * automatically without specifying any additional parameters.
+ * targeted - The Capacity Reservation only accepts instances that have matching
+ * attributes (instance type, platform, and Availability Zone), and
+ * explicitly target the Capacity Reservation. This ensures that only
+ * permitted instances can use the reserved capacity.
The port number for the Client VPN endpoint.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the associated target networks. A target network is a subnet in a VPC.
+ * @internal */ - AssociatedTargetNetworks?: AssociatedTargetNetwork[]; + export const filterSensitiveLog = (obj: DescribeCapacityReservationsRequest): any => ({ + ...obj, + }); +} +export interface DescribeCapacityReservationsResult { /** - *The ARN of the server certificate.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the authentication method used by the Client VPN endpoint.
+ *Information about the Capacity Reservations.
*/ - AuthenticationOptions?: ClientVpnAuthentication[]; + CapacityReservations?: CapacityReservation[]; +} +export namespace DescribeCapacityReservationsResult { /** - *Information about the client connection logging options for the Client VPN endpoint.
+ * @internal */ - ConnectionLogOptions?: ConnectionLogResponseOptions; + export const filterSensitiveLog = (obj: DescribeCapacityReservationsResult): any => ({ + ...obj, + }); +} +export interface DescribeCarrierGatewaysRequest { /** - *Any tags assigned to the Client VPN endpoint.
+ *One or more carrier gateway IDs.
*/ - Tags?: Tag[]; + CarrierGatewayIds?: string[]; /** - *The IDs of the security groups for the target network.
+ *One or more filters.
+ *
+ * carrier-gateway-id - The ID of the carrier gateway.
+ * state - The state of the carrier gateway (pending |
+ * failed | available | deleting | deleted).
+ * owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * vpc-id - The ID of the VPC associated with the carrier gateway.
The ID of the VPC.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The URL of the self-service portal.
+ *The token for the next page of results.
*/ - SelfServicePortalUrl?: string; + NextToken?: string; /** - *The options for managing connection authorization for new client connections.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the Client VPN endpoints.
+ *Information about the carrier gateway.
*/ - ClientVpnEndpoints?: ClientVpnEndpoint[]; + CarrierGateways?: CarrierGateway[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Client VPN endpoint.
- */ - ClientVpnEndpointId: string | undefined; - +export interface DescribeClassicLinkInstancesRequest { /** - *One or more filters. Filter names and values are case-sensitive.
- *One or more filters.
+ *
- * destination-cidr - The CIDR of the route destination.
+ * group-id - The ID of a VPC security group that's associated with the instance.
- * origin - How the route was associated with the Client VPN endpoint (associate | add-route).
+ * instance-id - The ID of the instance.
- * target-subnet - The ID of the subnet through which traffic is routed.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * vpc-id - The ID of the VPC to which the instance is
+ * linked.
+ * vpc-id - The ID of the VPC that the instance is linked to.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token to retrieve the next page of results.
+ *One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
*/ - NextToken?: string; + InstanceIds?: string[]; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Constraint: If the value is greater than 1000, we return only 1000 items.
*/ - DryRun?: boolean; + MaxResults?: number; + + /** + *The token for the next page of results.
+ */ + NextToken?: string; } -export namespace DescribeClientVpnRoutesRequest { +export namespace DescribeClassicLinkInstancesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeClientVpnRoutesRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeClassicLinkInstancesRequest): any => ({ ...obj, }); } /** - *Information about a Client VPN endpoint route.
+ *Describes a linked EC2-Classic instance.
*/ -export interface ClientVpnRoute { - /** - *The ID of the Client VPN endpoint with which the route is associated.
- */ - ClientVpnEndpointId?: string; - - /** - *The IPv4 address range, in CIDR notation, of the route destination.
- */ - DestinationCidr?: string; - - /** - *The ID of the subnet through which traffic is routed.
- */ - TargetSubnet?: string; - +export interface ClassicLinkInstance { /** - *The route type.
+ *A list of security groups.
*/ - Type?: string; + Groups?: GroupIdentifier[]; /** - *Indicates how the route was associated with the Client VPN endpoint.
- * associate indicates that the route was automatically added when the target network
- * was associated with the Client VPN endpoint. add-route indicates that the route
- * was manually added using the CreateClientVpnRoute action.
The ID of the instance.
*/ - Origin?: string; + InstanceId?: string; /** - *The current state of the route.
+ *Any tags assigned to the instance.
*/ - Status?: ClientVpnRouteStatus; + Tags?: Tag[]; /** - *A brief description of the route.
+ *The ID of the VPC.
*/ - Description?: string; + VpcId?: string; } -export namespace ClientVpnRoute { +export namespace ClassicLinkInstance { /** * @internal */ - export const filterSensitiveLog = (obj: ClientVpnRoute): any => ({ + export const filterSensitiveLog = (obj: ClassicLinkInstance): any => ({ ...obj, }); } -export interface DescribeClientVpnRoutesResult { +export interface DescribeClassicLinkInstancesResult { /** - *Information about the Client VPN endpoint routes.
+ *Information about one or more linked EC2-Classic instances.
*/ - Routes?: ClientVpnRoute[]; + Instances?: ClassicLinkInstance[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Client VPN endpoint.
*/ - ClientVpnEndpointId: string | undefined; - - /** - *The IDs of the target network associations.
- */ - AssociationIds?: string[]; + ClientVpnEndpointId: string | undefined; /** - *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The token to retrieve the next page of results.
@@ -5294,84 +5381,85 @@ export interface DescribeClientVpnTargetNetworksRequest { *
- * association-id - The ID of the association.
description - The description of the authorization rule.
*
- * target-network-id - The ID of the subnet specified as the target network.
destination-cidr - The CIDR of the network to which the authorization rule
+ * applies.
*
- * vpc-id - The ID of the VPC in which the target network is located.
group-id - The ID of the Active Directory group to which the authorization rule grants access.
* Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
*/ - DryRun?: boolean; + MaxResults?: number; } -export namespace DescribeClientVpnTargetNetworksRequest { +export namespace DescribeClientVpnAuthorizationRulesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeClientVpnTargetNetworksRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeClientVpnAuthorizationRulesRequest): any => ({ ...obj, }); } /** - *Describes a target network associated with a Client VPN endpoint.
+ *Information about an authorization rule.
*/ -export interface TargetNetwork { +export interface AuthorizationRule { /** - *The ID of the association.
+ *The ID of the Client VPN endpoint with which the authorization rule is associated.
*/ - AssociationId?: string; + ClientVpnEndpointId?: string; /** - *The ID of the VPC in which the target network (subnet) is located.
+ *A brief description of the authorization rule.
*/ - VpcId?: string; + Description?: string; /** - *The ID of the subnet specified as the target network.
+ *The ID of the Active Directory group to which the authorization rule grants access.
*/ - TargetNetworkId?: string; + GroupId?: string; /** - *The ID of the Client VPN endpoint with which the target network is associated.
+ *Indicates whether the authorization rule grants access to all clients.
*/ - ClientVpnEndpointId?: string; + AccessAll?: boolean; /** - *The current state of the target network association.
+ *The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.
*/ - Status?: AssociationStatus; + DestinationCidr?: string; /** - *The IDs of the security groups applied to the target network association.
+ *The current state of the authorization rule.
*/ - SecurityGroups?: string[]; + Status?: ClientVpnAuthorizationRuleStatus; } -export namespace TargetNetwork { +export namespace AuthorizationRule { /** * @internal */ - export const filterSensitiveLog = (obj: TargetNetwork): any => ({ + export const filterSensitiveLog = (obj: AuthorizationRule): any => ({ ...obj, }); } -export interface DescribeClientVpnTargetNetworksResult { +export interface DescribeClientVpnAuthorizationRulesResult { /** - *Information about the associated target networks.
+ *Information about the authorization rules.
*/ - ClientVpnTargetNetworks?: TargetNetwork[]; + AuthorizationRules?: AuthorizationRule[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the address pools.
+ *The ID of the Client VPN endpoint.
*/ - PoolIds?: string[]; + ClientVpnEndpointId: string | undefined; /** - *The filters. The following are the possible values:
- *One or more filters. Filter names and values are case-sensitive.
+ *
- * coip-pool.pool-id
- *
connection-id - The ID of the connection.
*
- * coip-pool.local-gateway-route-table-id
- *
username - For Active Directory client authentication, the user name of the
+ * client who established the client connection.
* The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The token to retrieve the next page of results.
*/ - MaxResults?: number; + NextToken?: string; /** - *The token for the next page of results.
+ *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
*/ - NextToken?: string; + MaxResults?: number; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Describes a customer-owned address pool.
+ *Describes the status of a client connection.
*/ -export interface CoipPool { - /** - *The ID of the address pool.
- */ - PoolId?: string; - - /** - *The address ranges of the address pool.
- */ - PoolCidrs?: string[]; - - /** - *The ID of the local gateway route table.
- */ - LocalGatewayRouteTableId?: string; - - /** - *The tags.
- */ - Tags?: Tag[]; - - /** - *The ARN of the address pool.
- */ - PoolArn?: string; -} - -export namespace CoipPool { - /** - * @internal - */ - export const filterSensitiveLog = (obj: CoipPool): any => ({ - ...obj, - }); -} - -export interface DescribeCoipPoolsResult { - /** - *Information about the address pools.
- */ - CoipPools?: CoipPool[]; - - /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The conversion task IDs.
+ *The state of the client connection.
*/ - ConversionTaskIds?: string[]; + Code?: ClientVpnConnectionStatusCode | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
A message about the status of the client connection, if applicable.
*/ - DryRun?: boolean; + Message?: string; } -export namespace DescribeConversionTasksRequest { +export namespace ClientVpnConnectionStatus { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeConversionTasksRequest): any => ({ + export const filterSensitiveLog = (obj: ClientVpnConnectionStatus): any => ({ ...obj, }); } /** - *Describes a disk image.
+ *Describes a client connection.
*/ -export interface DiskImageDescription { - /** - *The checksum computed for the disk image.
- */ - Checksum?: string; - +export interface ClientVpnConnection { /** - *The disk image format.
+ *The ID of the Client VPN endpoint to which the client is connected.
*/ - Format?: DiskImageFormat | string; + ClientVpnEndpointId?: string; /** - *A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for - * an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in - * the Amazon Simple Storage Service Developer Guide.
- *For information about the import manifest referenced by this API action, see VM Import Manifest.
+ *The current date and time.
*/ - ImportManifestUrl?: string; + Timestamp?: string; /** - *The size of the disk image, in GiB.
+ *The ID of the client connection.
*/ - Size?: number; -} + ConnectionId?: string; -export namespace DiskImageDescription { /** - * @internal + *The username of the client who established the client connection. This information is only provided + * if Active Directory client authentication is used.
*/ - export const filterSensitiveLog = (obj: DiskImageDescription): any => ({ - ...obj, - }); -} + Username?: string; -/** - *Describes a disk image volume.
- */ -export interface DiskImageVolumeDescription { /** - *The volume identifier.
+ *The date and time the client connection was established.
*/ - Id?: string; + ConnectionEstablishedTime?: string; /** - *The size of the volume, in GiB.
+ *The number of bytes sent by the client.
*/ - Size?: number; -} + IngressBytes?: string; -export namespace DiskImageVolumeDescription { /** - * @internal + *The number of bytes received by the client.
*/ - export const filterSensitiveLog = (obj: DiskImageVolumeDescription): any => ({ - ...obj, - }); -} + EgressBytes?: string; -/** - *Describes an import volume task.
- */ -export interface ImportInstanceVolumeDetailItem { /** - *The Availability Zone where the resulting instance will reside.
+ *The number of packets sent by the client.
*/ - AvailabilityZone?: string; + IngressPackets?: string; /** - *The number of bytes converted so far.
+ *The number of packets received by the client.
*/ - BytesConverted?: number; + EgressPackets?: string; /** - *A description of the task.
+ *The IP address of the client.
*/ - Description?: string; + ClientIp?: string; /** - *The image.
+ *The common name associated with the client. This is either the name of the client certificate, + * or the Active Directory user name.
*/ - Image?: DiskImageDescription; + CommonName?: string; /** - *The status of the import of this particular disk image.
+ *The current state of the client connection.
*/ - Status?: string; + Status?: ClientVpnConnectionStatus; /** - *The status information or errors related to the disk image.
+ *The date and time the client connection was terminated.
*/ - StatusMessage?: string; + ConnectionEndTime?: string; /** - *The volume.
+ *The statuses returned by the client connect handler for posture compliance, if applicable.
*/ - Volume?: DiskImageVolumeDescription; + PostureComplianceStatuses?: string[]; } -export namespace ImportInstanceVolumeDetailItem { +export namespace ClientVpnConnection { /** * @internal */ - export const filterSensitiveLog = (obj: ImportInstanceVolumeDetailItem): any => ({ + export const filterSensitiveLog = (obj: ClientVpnConnection): any => ({ ...obj, }); } -/** - *Describes an import instance task.
- */ -export interface ImportInstanceTaskDetails { - /** - *A description of the task.
- */ - Description?: string; - - /** - *The ID of the instance.
- */ - InstanceId?: string; - +export interface DescribeClientVpnConnectionsResult { /** - *The instance operating system.
+ *Information about the active and terminated client connections.
*/ - Platform?: PlatformValues | string; + Connections?: ClientVpnConnection[]; /** - *The volumes.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes an import volume task.
- */ -export interface ImportVolumeTaskDetails { +export interface DescribeClientVpnEndpointsRequest { /** - *The Availability Zone where the resulting volume will reside.
+ *The ID of the Client VPN endpoint.
*/ - AvailabilityZone?: string; + ClientVpnEndpointIds?: string[]; /** - *The number of bytes converted so far.
+ *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
*/ - BytesConverted?: number; + MaxResults?: number; /** - *The description you provided when starting the import volume task.
+ *The token to retrieve the next page of results.
*/ - Description?: string; + NextToken?: string; /** - *The image.
+ *One or more filters. Filter names and values are case-sensitive.
+ *
+ * endpoint-id - The ID of the Client VPN endpoint.
+ * transport-protocol - The transport protocol (tcp |
+ * udp).
The volume.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Describes a conversion task.
+ *Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.
*/ -export interface ConversionTask { - /** - *The ID of the conversion task.
- */ - ConversionTaskId?: string; - - /** - *The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel - * the task.
- */ - ExpirationTime?: string; - - /** - *If the task is for importing an instance, this contains information about the import instance task.
- */ - ImportInstance?: ImportInstanceTaskDetails; - - /** - *If the task is for importing a volume, this contains information about the import volume task.
- */ - ImportVolume?: ImportVolumeTaskDetails; - - /** - *The state of the conversion task.
- */ - State?: ConversionTaskState | string; - +export interface AssociatedTargetNetwork { /** - *The status message related to the conversion task.
+ *The ID of the subnet.
*/ - StatusMessage?: string; + NetworkId?: string; /** - *Any tags assigned to the task.
+ *The target network type.
*/ - Tags?: Tag[]; + NetworkType?: AssociatedNetworkType | string; } -export namespace ConversionTask { +export namespace AssociatedTargetNetwork { /** * @internal */ - export const filterSensitiveLog = (obj: ConversionTask): any => ({ + export const filterSensitiveLog = (obj: AssociatedTargetNetwork): any => ({ ...obj, }); } -export interface DescribeConversionTasksResult { +/** + *Describes an Active Directory.
+ */ +export interface DirectoryServiceAuthentication { /** - *Information about the conversion tasks.
+ *The ID of the Active Directory used for authentication.
*/ - ConversionTasks?: ConversionTask[]; + DirectoryId?: string; } -export namespace DescribeConversionTasksResult { +export namespace DirectoryServiceAuthentication { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeConversionTasksResult): any => ({ + export const filterSensitiveLog = (obj: DirectoryServiceAuthentication): any => ({ ...obj, }); } /** - *Contains the parameters for DescribeCustomerGateways.
+ *Describes the IAM SAML identity providers used for federated authentication.
*/ -export interface DescribeCustomerGatewaysRequest { - /** - *One or more customer gateway IDs.
- *Default: Describes all your customer gateways.
- */ - CustomerGatewayIds?: string[]; - +export interface FederatedAuthentication { /** - *One or more filters.
- *
- * bgp-asn - The customer gateway's Border Gateway Protocol (BGP)
- * Autonomous System Number (ASN).
- * customer-gateway-id - The ID of the customer gateway.
- * ip-address - The IP address of the customer gateway's
- * Internet-routable external interface.
- * state - The state of the customer gateway (pending |
- * available | deleting |
- * deleted).
- * type - The type of customer gateway. Currently, the only
- * supported type is ipsec.1.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The Amazon Resource Name (ARN) of the IAM SAML identity provider.
*/ - Filters?: Filter[]; + SamlProviderArn?: string; /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.
*/ - DryRun?: boolean; + SelfServiceSamlProviderArn?: string; } -export namespace DescribeCustomerGatewaysRequest { +export namespace FederatedAuthentication { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeCustomerGatewaysRequest): any => ({ + export const filterSensitiveLog = (obj: FederatedAuthentication): any => ({ ...obj, }); } /** - *Contains the output of DescribeCustomerGateways.
+ *Information about the client certificate used for authentication.
*/ -export interface DescribeCustomerGatewaysResult { +export interface CertificateAuthentication { /** - *Information about one or more customer gateways.
+ *The ARN of the client certificate.
*/ - CustomerGateways?: CustomerGateway[]; + ClientRootCertificateChain?: string; } -export namespace DescribeCustomerGatewaysResult { +export namespace CertificateAuthentication { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeCustomerGatewaysResult): any => ({ + export const filterSensitiveLog = (obj: CertificateAuthentication): any => ({ ...obj, }); } -export interface DescribeDhcpOptionsRequest { - /** - *The IDs of one or more DHCP options sets.
- *Default: Describes all your DHCP options sets.
- */ - DhcpOptionsIds?: string[]; - +/** + *Describes the authentication methods used by a Client VPN endpoint. For more information, see Authentication + * in the Client VPN Administrator Guide.
+ */ +export interface ClientVpnAuthentication { /** - *One or more filters.
- *
- * dhcp-options-id - The ID of a DHCP options set.
- * key - The key for one of the options (for example, domain-name).
- * value - The value for one of the options.
- * owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The authentication type used.
*/ - Filters?: Filter[]; + Type?: ClientVpnAuthenticationType | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the Active Directory, if applicable.
*/ - DryRun?: boolean; + ActiveDirectory?: DirectoryServiceAuthentication; /** - *The token for the next page of results.
+ *Information about the authentication certificates, if applicable.
*/ - NextToken?: string; + MutualAuthentication?: CertificateAuthentication; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Information about the IAM SAML identity provider, if applicable.
*/ - MaxResults?: number; + FederatedAuthentication?: FederatedAuthentication; } -export namespace DescribeDhcpOptionsRequest { +export namespace ClientVpnAuthentication { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeDhcpOptionsRequest): any => ({ + export const filterSensitiveLog = (obj: ClientVpnAuthentication): any => ({ ...obj, }); } -export interface DescribeDhcpOptionsResult { +export type ClientVpnEndpointAttributeStatusCode = "applied" | "applying"; + +/** + *Describes the status of the Client VPN endpoint attribute.
+ */ +export interface ClientVpnEndpointAttributeStatus { /** - *Information about one or more DHCP options sets.
+ *The status code.
*/ - DhcpOptions?: DhcpOptions[]; + Code?: ClientVpnEndpointAttributeStatusCode | string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The status message.
*/ - NextToken?: string; + Message?: string; } -export namespace DescribeDhcpOptionsResult { +export namespace ClientVpnEndpointAttributeStatus { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeDhcpOptionsResult): any => ({ + export const filterSensitiveLog = (obj: ClientVpnEndpointAttributeStatus): any => ({ ...obj, }); } -export interface DescribeEgressOnlyInternetGatewaysRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more egress-only internet gateway IDs.
- */ - EgressOnlyInternetGatewayIds?: string[]; - +/** + *The options for managing connection authorization for new client connections.
+ */ +export interface ClientConnectResponseOptions { /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Indicates whether client connect options are enabled.
*/ - MaxResults?: number; + Enabled?: boolean; /** - *The token for the next page of results.
+ *The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
*/ - NextToken?: string; + LambdaFunctionArn?: string; /** - *One or more filters.
- *
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The status of any updates to the client connect options.
*/ - Filters?: Filter[]; + Status?: ClientVpnEndpointAttributeStatus; } -export namespace DescribeEgressOnlyInternetGatewaysRequest { +export namespace ClientConnectResponseOptions { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeEgressOnlyInternetGatewaysRequest): any => ({ + export const filterSensitiveLog = (obj: ClientConnectResponseOptions): any => ({ ...obj, }); } -export interface DescribeEgressOnlyInternetGatewaysResult { +/** + *Information about the client connection logging options for a Client VPN endpoint.
+ */ +export interface ConnectionLogResponseOptions { /** - *Information about the egress-only internet gateways.
+ *Indicates whether client connection logging is enabled for the Client VPN endpoint.
*/ - EgressOnlyInternetGateways?: EgressOnlyInternetGateway[]; + Enabled?: boolean; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The name of the Amazon CloudWatch Logs log group to which connection logging data is published.
*/ - NextToken?: string; + CloudwatchLogGroup?: string; + + /** + *The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.
+ */ + CloudwatchLogStream?: string; } -export namespace DescribeEgressOnlyInternetGatewaysResult { +export namespace ConnectionLogResponseOptions { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeEgressOnlyInternetGatewaysResult): any => ({ + export const filterSensitiveLog = (obj: ConnectionLogResponseOptions): any => ({ ...obj, }); } -export interface DescribeElasticGpusRequest { +export type VpnProtocol = "openvpn"; + +/** + *Describes a Client VPN endpoint.
+ */ +export interface ClientVpnEndpoint { /** - *The Elastic Graphics accelerator IDs.
+ *The ID of the Client VPN endpoint.
*/ - ElasticGpuIds?: string[]; + ClientVpnEndpointId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
A brief description of the endpoint.
*/ - DryRun?: boolean; + Description?: string; /** - *The filters.
- *
- * availability-zone - The Availability Zone in which the
- * Elastic Graphics accelerator resides.
- * elastic-gpu-health - The status of the Elastic Graphics accelerator
- * (OK | IMPAIRED).
- * elastic-gpu-state - The state of the Elastic Graphics accelerator
- * (ATTACHED).
- * elastic-gpu-type - The type of Elastic Graphics accelerator; for example,
- * eg1.medium.
- * instance-id - The ID of the instance to which the
- * Elastic Graphics accelerator is associated.
The current state of the Client VPN endpoint.
*/ - Filters?: Filter[]; + Status?: ClientVpnEndpointStatus; /** - *The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another call with the returned NextToken value. This value
- * can be between 5 and 1000.
The date and time the Client VPN endpoint was created.
*/ - MaxResults?: number; + CreationTime?: string; /** - *The token to request the next page of results.
+ *The date and time the Client VPN endpoint was deleted, if applicable.
*/ - NextToken?: string; -} + DeletionTime?: string; -export namespace DescribeElasticGpusRequest { /** - * @internal + *The DNS name to be used by clients when connecting to the Client VPN endpoint.
*/ - export const filterSensitiveLog = (obj: DescribeElasticGpusRequest): any => ({ - ...obj, - }); -} + DnsName?: string; -export enum ElasticGpuStatus { - Impaired = "IMPAIRED", - Ok = "OK", -} + /** + *The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
+ */ + ClientCidrBlock?: string; -/** - *Describes the status of an Elastic Graphics accelerator.
- */ -export interface ElasticGpuHealth { /** - *The health status.
+ *Information about the DNS servers to be used for DNS resolution.
*/ - Status?: ElasticGpuStatus | string; -} + DnsServers?: string[]; -export namespace ElasticGpuHealth { /** - * @internal + *Indicates whether split-tunnel is enabled in the Client VPN endpoint.
+ *For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint + * in the Client VPN Administrator Guide.
*/ - export const filterSensitiveLog = (obj: ElasticGpuHealth): any => ({ - ...obj, - }); -} + SplitTunnel?: boolean; -export enum ElasticGpuState { - Attached = "ATTACHED", -} + /** + *The protocol used by the VPN session.
+ */ + VpnProtocol?: VpnProtocol | string; -/** - *Describes an Elastic Graphics accelerator.
- */ -export interface ElasticGpus { /** - *The ID of the Elastic Graphics accelerator.
+ *The transport protocol used by the Client VPN endpoint.
*/ - ElasticGpuId?: string; + TransportProtocol?: TransportProtocol | string; /** - *The Availability Zone in the which the Elastic Graphics accelerator resides.
+ *The port number for the Client VPN endpoint.
*/ - AvailabilityZone?: string; + VpnPort?: number; /** - *The type of Elastic Graphics accelerator.
+ * @deprecated + * + *Information about the associated target networks. A target network is a subnet in a VPC.
*/ - ElasticGpuType?: string; + AssociatedTargetNetworks?: AssociatedTargetNetwork[]; /** - *The status of the Elastic Graphics accelerator.
+ *The ARN of the server certificate.
*/ - ElasticGpuHealth?: ElasticGpuHealth; + ServerCertificateArn?: string; /** - *The state of the Elastic Graphics accelerator.
+ *Information about the authentication method used by the Client VPN endpoint.
*/ - ElasticGpuState?: ElasticGpuState | string; + AuthenticationOptions?: ClientVpnAuthentication[]; /** - *The ID of the instance to which the Elastic Graphics accelerator is attached.
+ *Information about the client connection logging options for the Client VPN endpoint.
*/ - InstanceId?: string; + ConnectionLogOptions?: ConnectionLogResponseOptions; /** - *The tags assigned to the Elastic Graphics accelerator.
+ *Any tags assigned to the Client VPN endpoint.
*/ Tags?: Tag[]; -} -export namespace ElasticGpus { /** - * @internal + *The IDs of the security groups for the target network.
*/ - export const filterSensitiveLog = (obj: ElasticGpus): any => ({ - ...obj, - }); -} + SecurityGroupIds?: string[]; -export interface DescribeElasticGpusResult { /** - *Information about the Elastic Graphics accelerators.
+ *The ID of the VPC.
*/ - ElasticGpuSet?: ElasticGpus[]; + VpcId?: string; /** - *The total number of items to return. If the total number of items available is more - * than the value specified in max-items then a Next-Token will be provided in the output - * that you can use to resume pagination.
+ *The URL of the self-service portal.
*/ - MaxResults?: number; + SelfServicePortalUrl?: string; /** - *The token to use to retrieve the next page of results. This value is
- * null when there are no more results to return.
The options for managing connection authorization for new client connections.
*/ - NextToken?: string; + ClientConnectOptions?: ClientConnectResponseOptions; } -export namespace DescribeElasticGpusResult { +export namespace ClientVpnEndpoint { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeElasticGpusResult): any => ({ + export const filterSensitiveLog = (obj: ClientVpnEndpoint): any => ({ ...obj, }); } -export interface DescribeExportImageTasksRequest { +export interface DescribeClientVpnEndpointsResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the Client VPN endpoints.
*/ - DryRun?: boolean; + ClientVpnEndpoints?: ClientVpnEndpoint[]; /** - *Filter tasks using the task-state filter and one of the following values: active,
- * completed, deleting, or deleted.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the export image tasks.
+ * @internal */ - ExportImageTaskIds?: string[]; + export const filterSensitiveLog = (obj: DescribeClientVpnEndpointsResult): any => ({ + ...obj, + }); +} +export interface DescribeClientVpnRoutesRequest { /** - *The maximum number of results to return in a single call.
+ *The ID of the Client VPN endpoint.
*/ - MaxResults?: number; + ClientVpnEndpointId: string | undefined; /** - *A token that indicates the next page of results.
+ *One or more filters. Filter names and values are case-sensitive.
+ *
+ * destination-cidr - The CIDR of the route destination.
+ * origin - How the route was associated with the Client VPN endpoint (associate | add-route).
+ * target-subnet - The ID of the subnet through which traffic is routed.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
*/ - export const filterSensitiveLog = (obj: DescribeExportImageTasksRequest): any => ({ - ...obj, - }); -} + MaxResults?: number; -/** - *Describes the destination for an export image task.
- */ -export interface ExportTaskS3Location { /** - *The destination Amazon S3 bucket.
+ *The token to retrieve the next page of results.
*/ - S3Bucket?: string; + NextToken?: string; /** - *The prefix (logical hierarchy) in the bucket.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Describes an export image task.
+ *Information about a Client VPN endpoint route.
*/ -export interface ExportImageTask { - /** - *A description of the image being exported.
- */ - Description?: string; - +export interface ClientVpnRoute { /** - *The ID of the export image task.
+ *The ID of the Client VPN endpoint with which the route is associated.
*/ - ExportImageTaskId?: string; + ClientVpnEndpointId?: string; /** - *The ID of the image.
+ *The IPv4 address range, in CIDR notation, of the route destination.
*/ - ImageId?: string; + DestinationCidr?: string; /** - *The percent complete of the export image task.
+ *The ID of the subnet through which traffic is routed.
*/ - Progress?: string; + TargetSubnet?: string; /** - *Information about the destination Amazon S3 bucket.
+ *The route type.
*/ - S3ExportLocation?: ExportTaskS3Location; + Type?: string; /** - *The status of the export image task. The possible values are active, completed,
- * deleting, and deleted.
Indicates how the route was associated with the Client VPN endpoint.
+ * associate indicates that the route was automatically added when the target network
+ * was associated with the Client VPN endpoint. add-route indicates that the route
+ * was manually added using the CreateClientVpnRoute action.
The status message for the export image task.
+ *The current state of the route.
*/ - StatusMessage?: string; + Status?: ClientVpnRouteStatus; /** - *Any tags assigned to the export image task.
+ *A brief description of the route.
*/ - Tags?: Tag[]; + Description?: string; } -export namespace ExportImageTask { +export namespace ClientVpnRoute { /** * @internal */ - export const filterSensitiveLog = (obj: ExportImageTask): any => ({ + export const filterSensitiveLog = (obj: ClientVpnRoute): any => ({ ...obj, }); } -export interface DescribeExportImageTasksResult { +export interface DescribeClientVpnRoutesResult { /** - *Information about the export image tasks.
+ *Information about the Client VPN endpoint routes.
*/ - ExportImageTasks?: ExportImageTask[]; + Routes?: ClientVpnRoute[]; /** - *The token to use to get the next page of results. This value is null when there are no more results
- * to return.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The export task IDs.
- */ - ExportTaskIds?: string[]; - +export interface DescribeClientVpnTargetNetworksRequest { /** - *the filters for the export tasks.
+ *The ID of the Client VPN endpoint.
*/ - Filters?: Filter[]; -} + ClientVpnEndpointId: string | undefined; -export namespace DescribeExportTasksRequest { /** - * @internal + *The IDs of the target network associations.
*/ - export const filterSensitiveLog = (obj: DescribeExportTasksRequest): any => ({ - ...obj, - }); -} + AssociationIds?: string[]; -export interface DescribeExportTasksResult { /** - *Information about the export tasks.
+ *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
*/ - ExportTasks?: ExportTask[]; -} + MaxResults?: number; -export namespace DescribeExportTasksResult { /** - * @internal + *The token to retrieve the next page of results.
*/ - export const filterSensitiveLog = (obj: DescribeExportTasksResult): any => ({ - ...obj, - }); -} + NextToken?: string; -export interface DescribeFastSnapshotRestoresRequest { /** - *The filters. The possible values are:
- *
- * availability-zone: The Availability Zone of the snapshot.
One or more filters. Filter names and values are case-sensitive.
+ *
- * owner-id: The ID of the Amazon Web Services account that enabled fast snapshot restore on the snapshot.
association-id - The ID of the association.
*
- * snapshot-id: The ID of the snapshot.
target-network-id - The ID of the subnet specified as the target network.
*
- * state: The state of fast snapshot restores for the snapshot
- * (enabling |
- * optimizing |
- * enabled |
- * disabling |
- * disabled).
vpc-id - The ID of the VPC in which the target network is located.
* The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
- */ - NextToken?: string; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Describes fast snapshot restores for a snapshot.
+ *Describes a target network associated with a Client VPN endpoint.
*/ -export interface DescribeFastSnapshotRestoreSuccessItem { - /** - *The ID of the snapshot.
- */ - SnapshotId?: string; - - /** - *The Availability Zone.
- */ - AvailabilityZone?: string; - - /** - *The state of fast snapshot restores.
- */ - State?: FastSnapshotRestoreStateCode | string; - - /** - *The reason for the state transition. The possible values are as follows:
- *
- * Client.UserInitiated - The state successfully transitioned to enabling or
- * disabling.
- * Client.UserInitiated - Lifecycle state transition - The state successfully transitioned
- * to optimizing, enabled, or disabled.
The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.
- */ - OwnerId?: string; - +export interface TargetNetwork { /** - *The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
+ *The ID of the association.
*/ - OwnerAlias?: string; + AssociationId?: string; /** - *The time at which fast snapshot restores entered the enabling state.
The ID of the VPC in which the target network (subnet) is located.
*/ - EnablingTime?: Date; + VpcId?: string; /** - *The time at which fast snapshot restores entered the optimizing state.
The ID of the subnet specified as the target network.
*/ - OptimizingTime?: Date; + TargetNetworkId?: string; /** - *The time at which fast snapshot restores entered the enabled state.
The ID of the Client VPN endpoint with which the target network is associated.
*/ - EnabledTime?: Date; + ClientVpnEndpointId?: string; /** - *The time at which fast snapshot restores entered the disabling state.
The current state of the target network association.
*/ - DisablingTime?: Date; + Status?: AssociationStatus; /** - *The time at which fast snapshot restores entered the disabled state.
The IDs of the security groups applied to the target network association.
*/ - DisabledTime?: Date; + SecurityGroups?: string[]; } -export namespace DescribeFastSnapshotRestoreSuccessItem { +export namespace TargetNetwork { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeFastSnapshotRestoreSuccessItem): any => ({ + export const filterSensitiveLog = (obj: TargetNetwork): any => ({ ...obj, }); } -export interface DescribeFastSnapshotRestoresResult { +export interface DescribeClientVpnTargetNetworksResult { /** - *Information about the state of fast snapshot restores.
+ *Information about the associated target networks.
*/ - FastSnapshotRestores?: DescribeFastSnapshotRestoreSuccessItem[]; + ClientVpnTargetNetworks?: TargetNetwork[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the address pools.
+ */ + PoolIds?: string[]; + + /** + *The filters. The following are the possible values:
+ *
+ * coip-pool.pool-id
+ *
+ * coip-pool.local-gateway-route-table-id
+ *
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ */ + NextToken?: string; -export interface DescribeFleetHistoryRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The type of events to describe. By default, all events are described.
+ * @internal */ - EventType?: FleetEventType | string; + export const filterSensitiveLog = (obj: DescribeCoipPoolsRequest): any => ({ + ...obj, + }); +} +/** + *Describes a customer-owned address pool.
+ */ +export interface CoipPool { /** - *The maximum number of results to return in a single call. Specify a value between 1 and
- * 1000. The default value is 1000. To retrieve the remaining results, make another call with
- * the returned NextToken value.
The ID of the address pool.
*/ - MaxResults?: number; + PoolId?: string; /** - *The token for the next set of results.
+ *The address ranges of the address pool.
*/ - NextToken?: string; + PoolCidrs?: string[]; /** - *The ID of the EC2 Fleet.
+ *The ID of the local gateway route table.
*/ - FleetId: string | undefined; + LocalGatewayRouteTableId?: string; /** - *The start date and time for the events, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *The tags.
*/ - StartTime: Date | undefined; + Tags?: Tag[]; + + /** + *The ARN of the address pool.
+ */ + PoolArn?: string; } -export namespace DescribeFleetHistoryRequest { +export namespace CoipPool { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeFleetHistoryRequest): any => ({ + export const filterSensitiveLog = (obj: CoipPool): any => ({ ...obj, }); } -/** - *Describes an EC2 Fleet or Spot Fleet event.
- */ -export interface EventInformation { +export interface DescribeCoipPoolsResult { /** - *The description of the event.
+ *Information about the address pools.
*/ - EventDescription?: string; - - /** - *The event.
- * - *
- * error events:
- * iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet does not have the required
- * permissions either to launch or terminate an instance.
- * allLaunchSpecsTemporarilyBlacklisted - None of the configurations
- * are valid, and several attempts to launch instances have failed. For more
- * information, see the description of the event.
- * spotInstanceCountLimitExceeded - You've reached the limit on the
- * number of Spot Instances that you can launch.
- * spotFleetRequestConfigurationInvalid - The configuration is not
- * valid. For more information, see the description of the event.
- * fleetRequestChange events:
- * active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is
- * attempting to maintain the target number of running instances.
- * cancelled - The EC2 Fleet or Spot Fleet request is canceled and has no running
- * instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are
- * terminated.
- * cancelled_running - The EC2 Fleet or Spot Fleet request is canceled and does
- * not launch additional instances. Its existing instances continue to run until
- * they are interrupted or terminated. The request remains in this state until all
- * instances are interrupted or terminated.
- * cancelled_terminating - The EC2 Fleet or Spot Fleet request is canceled and
- * its instances are terminating. The request remains in this state until all
- * instances are terminated.
- * expired - The EC2 Fleet or Spot Fleet request has expired. If the request was
- * created with TerminateInstancesWithExpiration set, a subsequent
- * terminated event indicates that the instances are
- * terminated.
- * modify_in_progress - The EC2 Fleet or Spot Fleet request is being modified.
- * The request remains in this state until the modification is fully
- * processed.
- * modify_succeeded - The EC2 Fleet or Spot Fleet request was modified.
- * submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2
- * is preparing to launch the target number of instances.
- * progress - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.
- * instanceChange events:
- * launched - A new instance was launched.
- * terminated - An instance was terminated by the user.
- * termination_notified - An instance termination notification was
- * sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target
- * capacity of the fleet was modified down, for example, from a target capacity of
- * 4 to a target capacity of 3.
- * Information events:
- * fleetProgressHalted - The price in every launch specification is
- * not valid because it is below the Spot price (all the launch specifications have
- * produced launchSpecUnusable events). A launch specification might
- * become valid if the Spot price changes.
- * launchSpecTemporarilyBlacklisted - The configuration is not valid
- * and several attempts to launch instances have failed. For more information, see
- * the description of the event.
- * launchSpecUnusable - The price in a launch specification is not
- * valid because it is below the Spot price.
- * registerWithLoadBalancersFailed - An attempt to register
- * instances with load balancers failed. For more information, see the description
- * of the event.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the instance. This information is available only for
- * instanceChange events.
The conversion task IDs.
+ */ + ConversionTaskIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes an event in the history of an EC2 Fleet.
+ *Describes a disk image.
*/ -export interface HistoryRecordEntry { +export interface DiskImageDescription { /** - *Information about the event.
+ *The checksum computed for the disk image.
*/ - EventInformation?: EventInformation; + Checksum?: string; /** - *The event type.
+ *The disk image format.
*/ - EventType?: FleetEventType | string; + Format?: DiskImageFormat | string; /** - *The date and time of the event, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for + * an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in + * the Amazon Simple Storage Service Developer Guide.
+ *For information about the import manifest referenced by this API action, see VM Import Manifest.
*/ - Timestamp?: Date; + ImportManifestUrl?: string; + + /** + *The size of the disk image, in GiB.
+ */ + Size?: number; } -export namespace HistoryRecordEntry { +export namespace DiskImageDescription { /** * @internal */ - export const filterSensitiveLog = (obj: HistoryRecordEntry): any => ({ + export const filterSensitiveLog = (obj: DiskImageDescription): any => ({ ...obj, }); } -export interface DescribeFleetHistoryResult { +/** + *Describes a disk image volume.
+ */ +export interface DiskImageVolumeDescription { /** - *Information about the events in the history of the EC2 Fleet.
+ *The volume identifier.
*/ - HistoryRecords?: HistoryRecordEntry[]; + Id?: string; /** - *The last date and time for the events, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ). - * All records up to this time were retrieved.
- *If nextToken indicates that there are more results, this value is not
- * present.
The size of the volume, in GiB.
*/ - LastEvaluatedTime?: Date; + Size?: number; +} +export namespace DiskImageVolumeDescription { /** - *The token for the next set of results.
+ * @internal */ - NextToken?: string; + export const filterSensitiveLog = (obj: DiskImageVolumeDescription): any => ({ + ...obj, + }); +} +/** + *Describes an import volume task.
+ */ +export interface ImportInstanceVolumeDetailItem { /** - *The ID of the EC Fleet.
+ *The Availability Zone where the resulting instance will reside.
*/ - FleetId?: string; + AvailabilityZone?: string; /** - *The start date and time for the events, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *The number of bytes converted so far.
*/ - StartTime?: Date; + BytesConverted?: number; + + /** + *A description of the task.
+ */ + Description?: string; + + /** + *The image.
+ */ + Image?: DiskImageDescription; + + /** + *The status of the import of this particular disk image.
+ */ + Status?: string; + + /** + *The status information or errors related to the disk image.
+ */ + StatusMessage?: string; + + /** + *The volume.
+ */ + Volume?: DiskImageVolumeDescription; } -export namespace DescribeFleetHistoryResult { +export namespace ImportInstanceVolumeDetailItem { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeFleetHistoryResult): any => ({ + export const filterSensitiveLog = (obj: ImportInstanceVolumeDetailItem): any => ({ ...obj, }); } -export interface DescribeFleetInstancesRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes an import instance task.
+ */ +export interface ImportInstanceTaskDetails { /** - *The maximum number of results to return in a single call. Specify a value between 1 and
- * 1000. The default value is 1000. To retrieve the remaining results, make another call with
- * the returned NextToken value.
A description of the task.
*/ - MaxResults?: number; + Description?: string; /** - *The token for the next set of results.
+ *The ID of the instance.
*/ - NextToken?: string; + InstanceId?: string; /** - *The ID of the EC2 Fleet.
+ *The instance operating system.
*/ - FleetId: string | undefined; + Platform?: PlatformValues | string; /** - *The filters.
- *
- * instance-type - The instance type.
The volumes.
*/ - Filters?: Filter[]; + Volumes?: ImportInstanceVolumeDetailItem[]; } -export namespace DescribeFleetInstancesRequest { +export namespace ImportInstanceTaskDetails { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeFleetInstancesRequest): any => ({ + export const filterSensitiveLog = (obj: ImportInstanceTaskDetails): any => ({ ...obj, }); } -export interface DescribeFleetInstancesResult { +/** + *Describes an import volume task.
+ */ +export interface ImportVolumeTaskDetails { /** - *The running instances. This list is refreshed periodically and might be out of - * date.
+ *The Availability Zone where the resulting volume will reside.
*/ - ActiveInstances?: ActiveInstance[]; + AvailabilityZone?: string; /** - *The token for the next set of results.
+ *The number of bytes converted so far.
*/ - NextToken?: string; + BytesConverted?: number; /** - *The ID of the EC2 Fleet.
+ *The description you provided when starting the import volume task.
*/ - FleetId?: string; + Description?: string; + + /** + *The image.
+ */ + Image?: DiskImageDescription; + + /** + *The volume.
+ */ + Volume?: DiskImageVolumeDescription; } -export namespace DescribeFleetInstancesResult { +export namespace ImportVolumeTaskDetails { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeFleetInstancesResult): any => ({ + export const filterSensitiveLog = (obj: ImportVolumeTaskDetails): any => ({ ...obj, }); } -export interface DescribeFleetsRequest { +export type ConversionTaskState = "active" | "cancelled" | "cancelling" | "completed"; + +/** + *Describes a conversion task.
+ */ +export interface ConversionTask { /** - *Checks whether you have the required permissions for the action, without 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 conversion task.
*/ - DryRun?: boolean; + ConversionTaskId?: string; + + /** + *The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel + * the task.
+ */ + ExpirationTime?: string; + + /** + *If the task is for importing an instance, this contains information about the import instance task.
+ */ + ImportInstance?: ImportInstanceTaskDetails; + + /** + *If the task is for importing a volume, this contains information about the import volume task.
+ */ + ImportVolume?: ImportVolumeTaskDetails; + + /** + *The state of the conversion task.
+ */ + State?: ConversionTaskState | string; + + /** + *The status message related to the conversion task.
+ */ + StatusMessage?: string; /** - *The maximum number of results to return in a single call. Specify a value between 1 and
- * 1000. The default value is 1000. To retrieve the remaining results, make another call with
- * the returned NextToken value.
Any tags assigned to the task.
+ */ + Tags?: Tag[]; +} + +export namespace ConversionTask { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ConversionTask): any => ({ + ...obj, + }); +} + +export interface DescribeConversionTasksResult { + /** + *Information about the conversion tasks.
*/ - MaxResults?: number; + ConversionTasks?: ConversionTask[]; +} +export namespace DescribeConversionTasksResult { /** - *The token for the next set of results.
+ * @internal */ - NextToken?: string; + export const filterSensitiveLog = (obj: DescribeConversionTasksResult): any => ({ + ...obj, + }); +} +/** + *Contains the parameters for DescribeCustomerGateways.
+ */ +export interface DescribeCustomerGatewaysRequest { /** - *The ID of the EC2 Fleets.
+ *One or more customer gateway IDs.
+ *Default: Describes all your customer gateways.
*/ - FleetIds?: string[]; + CustomerGatewayIds?: string[]; /** - *The filters.
- *One or more filters.
+ *
- * activity-status - The progress of the EC2 Fleet ( error |
- * pending-fulfillment | pending-termination |
- * fulfilled).
+ * bgp-asn - The customer gateway's Border Gateway Protocol (BGP)
+ * Autonomous System Number (ASN).
- * excess-capacity-termination-policy - Indicates whether to terminate
- * running instances if the target capacity is decreased below the current EC2 Fleet size
- * (true | false).
+ * customer-gateway-id - The ID of the customer gateway.
- * fleet-state - The state of the EC2 Fleet (submitted |
- * active | deleted | failed |
- * deleted-running | deleted-terminating |
- * modifying).
+ * ip-address - The IP address of the customer gateway's
+ * Internet-routable external interface.
+ * state - The state of the customer gateway (pending |
+ * available | deleting |
+ * deleted).
+ * type - The type of customer gateway. Currently, the only
+ * supported type is ipsec.1.
- * replace-unhealthy-instances - Indicates whether EC2 Fleet should replace
- * unhealthy instances (true | false).
tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
*
- * type - The type of request (instant |
- * request | maintain).
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
* Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Describes the instances that could not be launched by the fleet.
+ *Contains the output of DescribeCustomerGateways.
*/ -export interface DescribeFleetError { - /** - *The launch templates and overrides that were used for launching the instances. The - * values that you specify in the Overrides replace the values in the launch template.
- */ - LaunchTemplateAndOverrides?: LaunchTemplateAndOverridesResponse; - - /** - *Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
- */ - Lifecycle?: InstanceLifecycle | string; - - /** - *The error code that indicates why the instance could not be launched. For more - * information about error codes, see Error Codes.
- */ - ErrorCode?: string; - +export interface DescribeCustomerGatewaysResult { /** - *The error message that describes why the instance could not be launched. For more - * information about error messages, see Error Codes.
+ *Information about one or more customer gateways.
*/ - ErrorMessage?: string; + CustomerGateways?: CustomerGateway[]; } -export namespace DescribeFleetError { +export namespace DescribeCustomerGatewaysResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeFleetError): any => ({ + export const filterSensitiveLog = (obj: DescribeCustomerGatewaysResult): any => ({ ...obj, }); } -/** - *Describes the instances that were launched by the fleet.
- */ -export interface DescribeFleetsInstances { +export interface DescribeDhcpOptionsRequest { /** - *The launch templates and overrides that were used for launching the instances. The - * values that you specify in the Overrides replace the values in the launch template.
+ *The IDs of one or more DHCP options sets.
+ *Default: Describes all your DHCP options sets.
*/ - LaunchTemplateAndOverrides?: LaunchTemplateAndOverridesResponse; + DhcpOptionsIds?: string[]; /** - *Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
+ *One or more filters.
+ *
+ * dhcp-options-id - The ID of a DHCP options set.
+ * key - The key for one of the options (for example, domain-name).
+ * value - The value for one of the options.
+ * owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The IDs of the instances.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The instance type.
+ *The token for the next page of results.
*/ - InstanceType?: _InstanceType | string; + NextToken?: string; /** - *The value is Windows for Windows instances. Otherwise, the value is
- * blank.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Describes a launch template and overrides.
- */ -export interface FleetLaunchTemplateConfig { +export interface DescribeDhcpOptionsResult { /** - *The launch template.
+ *Information about one or more DHCP options sets.
*/ - LaunchTemplateSpecification?: FleetLaunchTemplateSpecification; + DhcpOptions?: DhcpOptions[]; /** - *Any parameters that you specify override the same parameters in the launch - * template.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand - * capacity.
- *This strategy can only be used if the EC2 Fleet is of type
- * instant.
For more information about Capacity Reservations, see On-Demand Capacity - * Reservations in the Amazon EC2 User Guide. For examples of using - * Capacity Reservations in an EC2 Fleet, see EC2 Fleet example - * configurations in the Amazon EC2 User Guide.
- */ -export interface CapacityReservationOptions { +export interface DescribeEgressOnlyInternetGatewaysRequest { /** - *Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
- *If you specify use-capacity-reservations-first, the fleet uses unused
- * Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If
- * multiple instance pools have unused Capacity Reservations, the On-Demand allocation
- * strategy (lowest-price or prioritized) is applied. If the number
- * of unused Capacity Reservations is less than the On-Demand target capacity, the remaining
- * On-Demand target capacity is launched according to the On-Demand allocation strategy
- * (lowest-price or prioritized).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the - * chosen On-Demand allocation strategy.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more egress-only internet gateway IDs.
+ */ + EgressOnlyInternetGatewayIds?: string[]; + + /** + *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ */ + NextToken?: string; + + /** + *One or more filters.
+ *
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Describes the configuration of On-Demand Instances in an EC2 Fleet.
- */ -export interface OnDemandOptions { +export interface DescribeEgressOnlyInternetGatewaysResult { /** - *The order of the launch template overrides to use in fulfilling On-Demand capacity. If
- * you specify lowest-price, EC2 Fleet uses price to determine the order, launching
- * the lowest price first. If you specify prioritized, EC2 Fleet uses the priority
- * that you assigned to each launch template override, launching the highest priority first.
- * If you do not specify a value, EC2 Fleet defaults to lowest-price.
Information about the egress-only internet gateways.
*/ - AllocationStrategy?: FleetOnDemandAllocationStrategy | string; + EgressOnlyInternetGateways?: EgressOnlyInternetGateway[]; /** - *The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
- * Supported only for fleets of type instant.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
- * Supported only for fleets of type instant.
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported
- * only for fleets of type instant.
The Elastic Graphics accelerator IDs.
*/ - SingleAvailabilityZone?: boolean; + ElasticGpuIds?: string[]; /** - *The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is - * not reached, the fleet launches no instances.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The maximum amount per hour for On-Demand Instances that you're willing to pay.
+ *The filters.
+ *
+ * availability-zone - The Availability Zone in which the
+ * Elastic Graphics accelerator resides.
+ * elastic-gpu-health - The status of the Elastic Graphics accelerator
+ * (OK | IMPAIRED).
+ * elastic-gpu-state - The state of the Elastic Graphics accelerator
+ * (ATTACHED).
+ * elastic-gpu-type - The type of Elastic Graphics accelerator; for example,
+ * eg1.medium.
+ * instance-id - The ID of the instance to which the
+ * Elastic Graphics accelerator is associated.
The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another call with the returned NextToken value. This value
+ * can be between 5 and 1000.
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an - * elevated risk of being interrupted.
- */ -export interface FleetSpotCapacityRebalance { /** - *To allow EC2 Fleet to launch a replacement Spot Instance when an instance rebalance
- * notification is emitted for an existing Spot Instance in the fleet, specify
- * launch. Only available for fleets of type maintain.
When a replacement instance is launched, the instance marked for rebalance is not - * automatically terminated. You can terminate it, or you can leave it running. You are charged for both instances while they are running.
- *The token to request the next page of results.
*/ - ReplacementStrategy?: FleetReplacementStrategy | string; + NextToken?: string; } -export namespace FleetSpotCapacityRebalance { +export namespace DescribeElasticGpusRequest { /** * @internal */ - export const filterSensitiveLog = (obj: FleetSpotCapacityRebalance): any => ({ + export const filterSensitiveLog = (obj: DescribeElasticGpusRequest): any => ({ ...obj, }); } +export enum ElasticGpuStatus { + Impaired = "IMPAIRED", + Ok = "OK", +} + /** - *The strategies for managing your Spot Instances that are at an elevated risk of being - * interrupted.
+ *Describes the status of an Elastic Graphics accelerator.
*/ -export interface FleetSpotMaintenanceStrategies { +export interface ElasticGpuHealth { /** - *The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an - * elevated risk of being interrupted.
+ *The health status.
*/ - CapacityRebalance?: FleetSpotCapacityRebalance; + Status?: ElasticGpuStatus | string; } -export namespace FleetSpotMaintenanceStrategies { +export namespace ElasticGpuHealth { /** * @internal */ - export const filterSensitiveLog = (obj: FleetSpotMaintenanceStrategies): any => ({ + export const filterSensitiveLog = (obj: ElasticGpuHealth): any => ({ ...obj, }); } +export enum ElasticGpuState { + Attached = "ATTACHED", +} + /** - *Describes the configuration of Spot Instances in an EC2 Fleet.
+ *Describes an Elastic Graphics accelerator.
*/ -export interface SpotOptions { +export interface ElasticGpus { /** - *Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by - * the EC2 Fleet.
- *If the allocation strategy is lowest-price, EC2 Fleet launches instances from
- * the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified, EC2 Fleet launches instances from all
- * of the Spot Instance pools that you specify.
If the allocation strategy is capacity-optimized (recommended), EC2 Fleet
- * launches instances from Spot Instance pools with optimal capacity for the number of instances that
- * are launching. To give certain instance types a higher chance of launching first, use
- * capacity-optimized-prioritized. Set a priority for each instance type by
- * using the Priority parameter for LaunchTemplateOverrides. You can
- * assign the same priority to different LaunchTemplateOverrides. EC2 implements
- * the priorities on a best-effort basis, but optimizes for capacity first.
- * capacity-optimized-prioritized is supported only if your fleet uses a
- * launch template. Note that if the On-Demand AllocationStrategy is set to
- * prioritized, the same priority is applied when fulfilling On-Demand
- * capacity.
The ID of the Elastic Graphics accelerator.
*/ - AllocationStrategy?: SpotAllocationStrategy | string; + ElasticGpuId?: string; /** - *The strategies for managing your workloads on your Spot Instances that will be - * interrupted. Currently only the capacity rebalance strategy is available.
+ *The Availability Zone in the which the Elastic Graphics accelerator resides.
*/ - MaintenanceStrategies?: FleetSpotMaintenanceStrategies; + AvailabilityZone?: string; /** - *The behavior when a Spot Instance is interrupted. The default is terminate.
The type of Elastic Graphics accelerator.
*/ - InstanceInterruptionBehavior?: SpotInstanceInterruptionBehavior | string; + ElasticGpuType?: string; /** - *The number of Spot pools across which to allocate your target Spot capacity. Valid only
- * when AllocationStrategy is set to
- * lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates
- * your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a - * best effort basis. If a pool runs out of Spot capacity before fulfilling your target - * capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest - * pool. To ensure that your target capacity is met, you might receive Spot Instances from more than - * the number of pools that you specified. Similarly, if most of the pools have no Spot - * capacity, you might receive your full target capacity from fewer than the number of pools - * that you specified.
+ *The status of the Elastic Graphics accelerator.
*/ - InstancePoolsToUseCount?: number; + ElasticGpuHealth?: ElasticGpuHealth; /** - *Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
- * Supported only for fleets of type instant.
The state of the Elastic Graphics accelerator.
*/ - SingleInstanceType?: boolean; + ElasticGpuState?: ElasticGpuState | string; /** - *Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported
- * only for fleets of type instant.
The ID of the instance to which the Elastic Graphics accelerator is attached.
*/ - SingleAvailabilityZone?: boolean; + InstanceId?: string; /** - *The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is - * not reached, the fleet launches no instances.
+ *The tags assigned to the Elastic Graphics accelerator.
*/ - MinTargetCapacity?: number; + Tags?: Tag[]; +} +export namespace ElasticGpus { /** - *The maximum amount per hour for Spot Instances that you're willing to pay.
+ * @internal */ - MaxTotalPrice?: string; + export const filterSensitiveLog = (obj: ElasticGpus): any => ({ + ...obj, + }); } -export namespace SpotOptions { +export interface DescribeElasticGpusResult { + /** + *Information about the Elastic Graphics accelerators.
+ */ + ElasticGpuSet?: ElasticGpus[]; + + /** + *The total number of items to return. If the total number of items available is more + * than the value specified in max-items then a Next-Token will be provided in the output + * that you can use to resume pagination.
+ */ + MaxResults?: number; + + /** + *The token to use to retrieve the next page of results. This value is
+ * null when there are no more results to return.
The number of units to request. You can choose to set the target capacity in terms of
- * instances or a performance characteristic that is important to your application workload,
- * such as vCPUs, memory, or I/O. If the request type is maintain, you can
- * specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance
- * MaxTotalPrice, or both to ensure that your fleet cost does not exceed your
- * budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet
- * will launch instances until it reaches the maximum amount that you're willing to pay. When
- * the maximum amount you're willing to pay is reached, the fleet stops launching instances
- * even if it hasn’t met the target capacity. The MaxTotalPrice parameters are
- * located in OnDemandOptions
- * and SpotOptions.
The number of units to request, filled using
- * DefaultTargetCapacityType.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.
+ *Filter tasks using the task-state filter and one of the following values: active,
+ * completed, deleting, or deleted.
The IDs of the export image tasks.
+ */ + ExportImageTaskIds?: string[]; /** - *The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.
+ *The maximum number of results to return in a single call.
*/ - SpotTargetCapacity?: number; + MaxResults?: number; /** - *The default TotalTargetCapacity, which is either Spot or
- * On-Demand.
A token that indicates the next page of results.
*/ - DefaultTargetCapacityType?: DefaultTargetCapacityType | string; + NextToken?: string; } -export namespace TargetCapacitySpecification { +export namespace DescribeExportImageTasksRequest { /** * @internal */ - export const filterSensitiveLog = (obj: TargetCapacitySpecification): any => ({ + export const filterSensitiveLog = (obj: DescribeExportImageTasksRequest): any => ({ ...obj, }); } /** - *Describes an EC2 Fleet.
+ *Describes the destination for an export image task.
*/ -export interface FleetData { +export interface ExportTaskS3Location { /** - *The progress of the EC2 Fleet. If there is an error, the status is error. After
- * all requests are placed, the status is pending_fulfillment. If the size of the
- * EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled.
- * If the size of the EC2 Fleet is decreased, the status is pending_termination while
- * instances are terminating.
The destination Amazon S3 bucket.
*/ - ActivityStatus?: FleetActivityStatus | string; + S3Bucket?: string; /** - *The creation date and time of the EC2 Fleet.
+ *The prefix (logical hierarchy) in the bucket.
*/ - CreateTime?: Date; + S3Prefix?: string; +} +export namespace ExportTaskS3Location { /** - *The ID of the EC2 Fleet.
+ * @internal */ - FleetId?: string; + export const filterSensitiveLog = (obj: ExportTaskS3Location): any => ({ + ...obj, + }); +} +/** + *Describes an export image task.
+ */ +export interface ExportImageTask { /** - *The state of the EC2 Fleet.
+ *A description of the image being exported.
*/ - FleetState?: FleetStateCode | string; + Description?: string; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see Ensuring - * Idempotency.
- *Constraints: Maximum 64 ASCII characters
+ *The ID of the export image task.
*/ - ClientToken?: string; + ExportImageTaskId?: string; /** - *Indicates whether running instances should be terminated if the target capacity of the - * EC2 Fleet is decreased below the current size of the EC2 Fleet.
+ *The ID of the image.
*/ - ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy | string; + ImageId?: string; /** - *The number of units fulfilled by this request compared to the set target - * capacity.
+ *The percent complete of the export image task.
*/ - FulfilledCapacity?: number; + Progress?: string; /** - *The number of units fulfilled by this request compared to the set target On-Demand - * capacity.
+ *Information about the destination Amazon S3 bucket.
*/ - FulfilledOnDemandCapacity?: number; + S3ExportLocation?: ExportTaskS3Location; /** - *The launch template and overrides.
+ *The status of the export image task. The possible values are active, completed,
+ * deleting, and deleted.
The number of units to request. You can choose to set the target capacity in terms of
- * instances or a performance characteristic that is important to your application workload,
- * such as vCPUs, memory, or I/O. If the request type is maintain, you can
- * specify a target capacity of 0 and add capacity later.
The status message for the export image task.
*/ - TargetCapacitySpecification?: TargetCapacitySpecification; + StatusMessage?: string; /** - *Indicates whether running instances should be terminated when the EC2 Fleet expires.
+ *Any tags assigned to the export image task.
*/ - TerminateInstancesWithExpiration?: boolean; + Tags?: Tag[]; +} +export namespace ExportImageTask { /** - *The type of request. Indicates whether the EC2 Fleet only requests the target
- * capacity, or also attempts to maintain it. If you request a certain target
- * capacity, EC2 Fleet only places the required requests; it does not attempt to replenish
- * instances if capacity is diminished, and it does not submit requests in alternative
- * capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet
- * places the required requests to meet this target capacity. It also automatically
- * replenishes any interrupted Spot Instances. Default: maintain.
The start date and time of the request, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ). - * The default is to start fulfilling the request immediately.
+ *Information about the export image tasks.
*/ - ValidFrom?: Date; + ExportImageTasks?: ExportImageTask[]; /** - *The end date and time of the request, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ). - * At this point, no new instance requests are placed or able to fulfill the request. The - * default end date is 7 days from the current date.
+ *The token to use to get the next page of results. This value is null when there are no more results
+ * to return.
Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for
- * fleets of type maintain. For more information, see EC2 Fleet
- * health checks in the Amazon EC2 User Guide.
The configuration of Spot Instances in an EC2 Fleet.
+ *The export task IDs.
*/ - SpotOptions?: SpotOptions; + ExportTaskIds?: string[]; /** - *The allocation strategy of On-Demand Instances in an EC2 Fleet.
+ *the filters for the export tasks.
*/ - OnDemandOptions?: OnDemandOptions; + Filters?: Filter[]; +} +export namespace DescribeExportTasksRequest { /** - *The tags for an EC2 Fleet resource.
+ * @internal */ - Tags?: Tag[]; + export const filterSensitiveLog = (obj: DescribeExportTasksRequest): any => ({ + ...obj, + }); +} +export interface DescribeExportTasksResult { /** - *Information about the instances that could not be launched by the fleet. Valid only when
- * Type is set to instant.
Information about the export tasks.
*/ - Errors?: DescribeFleetError[]; + ExportTasks?: ExportTask[]; +} +export namespace DescribeExportTasksResult { /** - *Information about the instances that were launched by the fleet. Valid only when
- * Type is set to instant.
Reserved.
+ *The filters. The possible values are:
+ *
+ * availability-zone: The Availability Zone of the snapshot.
+ * owner-id: The ID of the Amazon Web Services account that enabled fast snapshot restore on the snapshot.
+ * snapshot-id: The ID of the snapshot.
+ * state: The state of fast snapshot restores for the snapshot
+ * (enabling |
+ * optimizing |
+ * enabled |
+ * disabling |
+ * disabled).
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next set of results.
+ *The token for the next page of results.
*/ NextToken?: string; /** - *Information about the EC2 Fleets.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes fast snapshot restores for a snapshot.
+ */ +export interface DescribeFastSnapshotRestoreSuccessItem { /** - *Checks whether you have the required permissions for the action, without 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 snapshot.
*/ - DryRun?: boolean; + SnapshotId?: string; /** - *One or more filters.
- *
- * deliver-log-status - The status of the logs delivery (SUCCESS |
- * FAILED).
- * log-destination-type - The type of destination to which the flow
- * log publishes data. Possible destination types include
- * cloud-watch-logs and s3.
- * flow-log-id - The ID of the flow log.
- * log-group-name - The name of the log group.
- * resource-id - The ID of the VPC, subnet, or network interface.
- * traffic-type - The type of traffic (ACCEPT |
- * REJECT | ALL).
The Availability Zone.
+ */ + AvailabilityZone?: string; + + /** + *The state of fast snapshot restores.
+ */ + State?: FastSnapshotRestoreStateCode | string; + + /** + *The reason for the state transition. The possible values are as follows:
+ *
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
Client.UserInitiated - The state successfully transitioned to enabling or
+ * disabling.
*
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Client.UserInitiated - Lifecycle state transition - The state successfully transitioned
+ * to optimizing, enabled, or disabled.
* One or more flow log IDs.
- *Constraint: Maximum of 1000 flow log IDs.
+ *The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.
*/ - FlowLogIds?: string[]; + OwnerId?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
*/ - MaxResults?: number; + OwnerAlias?: string; /** - *The token for the next page of results.
+ *The time at which fast snapshot restores entered the enabling state.
The time at which fast snapshot restores entered the optimizing state.
Describes the destination options for a flow log.
- */ -export interface DestinationOptionsResponse { /** - *The format for the flow log.
+ *The time at which fast snapshot restores entered the enabled state.
Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.
+ *The time at which fast snapshot restores entered the disabling state.
Indicates whether to partition the flow log per hour.
+ *The time at which fast snapshot restores entered the disabled state.
Describes a flow log.
- */ -export interface FlowLog { +export interface DescribeFastSnapshotRestoresResult { /** - *The date and time the flow log was created.
+ *Information about the state of fast snapshot restores.
*/ - CreationTime?: Date; + FastSnapshotRestores?: DescribeFastSnapshotRestoreSuccessItem[]; /** - *Information about the error that occurred. Rate limited indicates that
- * CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've
- * reached the limit on the number of log groups that you can create. Access
- * error indicates that the IAM role associated with the flow log does not have
- * sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an
- * internal error.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ARN of the IAM role that posts logs to CloudWatch Logs.
+ * @internal */ - DeliverLogsPermissionArn?: string; + export const filterSensitiveLog = (obj: DescribeFastSnapshotRestoresResult): any => ({ + ...obj, + }); +} + +export enum FleetEventType { + FLEET_CHANGE = "fleet-change", + INSTANCE_CHANGE = "instance-change", + SERVICE_ERROR = "service-error", +} +export interface DescribeFleetHistoryRequest { /** - *The status of the logs delivery (SUCCESS | FAILED).
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The flow log ID.
+ *The type of events to describe. By default, all events are described.
*/ - FlowLogId?: string; + EventType?: FleetEventType | string; /** - *The status of the flow log (ACTIVE).
The maximum number of results to return in a single call. Specify a value between 1 and
+ * 1000. The default value is 1000. To retrieve the remaining results, make another call with
+ * the returned NextToken value.
The name of the flow log group.
+ *The token for the next set of results.
*/ - LogGroupName?: string; + NextToken?: string; /** - *The ID of the resource on which the flow log was created.
+ *The ID of the EC2 Fleet.
*/ - ResourceId?: string; + FleetId: string | undefined; /** - *The type of traffic captured for the flow log.
+ *The start date and time for the events, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
*/ - TrafficType?: TrafficType | string; + StartTime: Date | undefined; +} +export namespace DescribeFleetHistoryRequest { /** - *The type of destination to which the flow log data is published. Flow log data can be - * published to CloudWatch Logs or Amazon S3.
+ * @internal + */ + export const filterSensitiveLog = (obj: DescribeFleetHistoryRequest): any => ({ + ...obj, + }); +} + +/** + *Describes an EC2 Fleet or Spot Fleet event.
+ */ +export interface EventInformation { + /** + *The description of the event.
+ */ + EventDescription?: string; + + /** + *The event.
+ * + *
+ * error events:
+ * iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet does not have the required
+ * permissions either to launch or terminate an instance.
+ * allLaunchSpecsTemporarilyBlacklisted - None of the configurations
+ * are valid, and several attempts to launch instances have failed. For more
+ * information, see the description of the event.
+ * spotInstanceCountLimitExceeded - You've reached the limit on the
+ * number of Spot Instances that you can launch.
+ * spotFleetRequestConfigurationInvalid - The configuration is not
+ * valid. For more information, see the description of the event.
+ * fleetRequestChange events:
+ * active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is
+ * attempting to maintain the target number of running instances.
+ * cancelled - The EC2 Fleet or Spot Fleet request is canceled and has no running
+ * instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are
+ * terminated.
+ * cancelled_running - The EC2 Fleet or Spot Fleet request is canceled and does
+ * not launch additional instances. Its existing instances continue to run until
+ * they are interrupted or terminated. The request remains in this state until all
+ * instances are interrupted or terminated.
+ * cancelled_terminating - The EC2 Fleet or Spot Fleet request is canceled and
+ * its instances are terminating. The request remains in this state until all
+ * instances are terminated.
+ * expired - The EC2 Fleet or Spot Fleet request has expired. If the request was
+ * created with TerminateInstancesWithExpiration set, a subsequent
+ * terminated event indicates that the instances are
+ * terminated.
+ * modify_in_progress - The EC2 Fleet or Spot Fleet request is being modified.
+ * The request remains in this state until the modification is fully
+ * processed.
+ * modify_succeeded - The EC2 Fleet or Spot Fleet request was modified.
+ * submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2
+ * is preparing to launch the target number of instances.
+ * progress - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.
+ * instanceChange events:
+ * launched - A new instance was launched.
+ * terminated - An instance was terminated by the user.
+ * termination_notified - An instance termination notification was
+ * sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target
+ * capacity of the fleet was modified down, for example, from a target capacity of
+ * 4 to a target capacity of 3.
+ * Information events:
+ * fleetProgressHalted - The price in every launch specification is
+ * not valid because it is below the Spot price (all the launch specifications have
+ * produced launchSpecUnusable events). A launch specification might
+ * become valid if the Spot price changes.
+ * launchSpecTemporarilyBlacklisted - The configuration is not valid
+ * and several attempts to launch instances have failed. For more information, see
+ * the description of the event.
+ * launchSpecUnusable - The price in a launch specification is not
+ * valid because it is below the Spot price.
+ * registerWithLoadBalancersFailed - An attempt to register
+ * instances with load balancers failed. For more information, see the description
+ * of the event.
The destination to which the flow log data is published. Flow log data can be - * published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, - * this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which - * the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN - * of the Amazon S3 bucket to which the data is published.
+ *The ID of the instance. This information is available only for
+ * instanceChange events.
The format of the flow log record.
+ * @internal */ - LogFormat?: string; + export const filterSensitiveLog = (obj: EventInformation): any => ({ + ...obj, + }); +} +/** + *Describes an event in the history of an EC2 Fleet.
+ */ +export interface HistoryRecordEntry { /** - *The tags for the flow log.
+ *Information about the event.
*/ - Tags?: Tag[]; + EventInformation?: EventInformation; /** - *The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
- *When a network interface is attached to a Nitro-based - * instance, the aggregation interval is always 60 seconds (1 minute) or less, - * regardless of the specified value.
- *Valid Values: 60 | 600
- *
The event type.
*/ - MaxAggregationInterval?: number; + EventType?: FleetEventType | string; /** - *The destination options.
+ *The date and time of the event, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
*/ - DestinationOptions?: DestinationOptionsResponse; + Timestamp?: Date; } -export namespace FlowLog { +export namespace HistoryRecordEntry { /** * @internal */ - export const filterSensitiveLog = (obj: FlowLog): any => ({ + export const filterSensitiveLog = (obj: HistoryRecordEntry): any => ({ ...obj, }); } -export interface DescribeFlowLogsResult { - /** - *Information about the flow logs.
- */ - FlowLogs?: FlowLog[]; - +export interface DescribeFleetHistoryResult { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the events in the history of the EC2 Fleet.
*/ - NextToken?: string; -} + HistoryRecords?: HistoryRecordEntry[]; -export namespace DescribeFlowLogsResult { /** - * @internal + *The last date and time for the events, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ). + * All records up to this time were retrieved.
+ *If nextToken indicates that there are more results, this value is not
+ * present.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The token for the next set of results.
*/ - DryRun?: boolean; + NextToken?: string; /** - *The ID of the AFI.
+ *The ID of the EC Fleet.
*/ - FpgaImageId: string | undefined; + FleetId?: string; /** - *The AFI attribute.
+ *The start date and time for the events, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
*/ - Attribute: FpgaImageAttributeName | string | undefined; + StartTime?: Date; } -export namespace DescribeFpgaImageAttributeRequest { +export namespace DescribeFleetHistoryResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeFpgaImageAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeFleetHistoryResult): any => ({ ...obj, }); } -export type PermissionGroup = "all"; - -/** - *Describes a load permission.
- */ -export interface LoadPermission { +export interface DescribeFleetInstancesRequest { /** - *The Amazon Web Services account ID.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The name of the group.
+ *The maximum number of results to return in a single call. Specify a value between 1 and
+ * 1000. The default value is 1000. To retrieve the remaining results, make another call with
+ * the returned NextToken value.
The token for the next set of results.
*/ - export const filterSensitiveLog = (obj: LoadPermission): any => ({ - ...obj, - }); -} - -export type ProductCodeValues = "devpay" | "marketplace"; + NextToken?: string; -/** - *Describes a product code.
- */ -export interface ProductCode { /** - *The product code.
+ *The ID of the EC2 Fleet.
*/ - ProductCodeId?: string; + FleetId: string | undefined; /** - *The type of product code.
+ *The filters.
+ *
+ * instance-type - The instance type.
Describes an Amazon FPGA image (AFI) attribute.
- */ -export interface FpgaImageAttribute { - /** - *The ID of the AFI.
- */ - FpgaImageId?: string; - - /** - *The name of the AFI.
- */ - Name?: string; - - /** - *The description of the AFI.
- */ - Description?: string; - - /** - *The load permissions.
- */ - LoadPermissions?: LoadPermission[]; - +export interface DescribeFleetInstancesResult { /** - *The product codes.
+ *The running instances. This list is refreshed periodically and might be out of + * date.
*/ - ProductCodes?: ProductCode[]; -} + ActiveInstances?: ActiveInstance[]; -export namespace FpgaImageAttribute { /** - * @internal + *The token for the next set of results.
*/ - export const filterSensitiveLog = (obj: FpgaImageAttribute): any => ({ - ...obj, - }); -} + NextToken?: string; -export interface DescribeFpgaImageAttributeResult { /** - *Information about the attribute.
+ *The ID of the EC2 Fleet.
*/ - FpgaImageAttribute?: FpgaImageAttribute; + FleetId?: string; } -export namespace DescribeFpgaImageAttributeResult { +export namespace DescribeFleetInstancesResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeFpgaImageAttributeResult): any => ({ + export const filterSensitiveLog = (obj: DescribeFleetInstancesResult): any => ({ ...obj, }); } -export interface DescribeFpgaImagesRequest { +export interface DescribeFleetsRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -7884,1748 +7809,1681 @@ export interface DescribeFpgaImagesRequest {
DryRun?: boolean;
/**
- *
The AFI IDs.
+ *The maximum number of results to return in a single call. Specify a value between 1 and
+ * 1000. The default value is 1000. To retrieve the remaining results, make another call with
+ * the returned NextToken value.
Filters the AFI by owner. Specify an Amazon Web Services account ID, self
- * (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are
- * amazon | aws-marketplace).
The token for the next set of results.
*/ - Owners?: string[]; + NextToken?: string; /** - *The filters.
- *
- * create-time - The creation time of the AFI.
- * fpga-image-id - The FPGA image identifier (AFI ID).
- * fpga-image-global-id - The global FPGA image identifier (AGFI ID).
- * name - The name of the AFI.
- * owner-id - The Amazon Web Services account ID of the AFI owner.
- * product-code - The product code.
The ID of the EC2 Fleets.
+ */ + FleetIds?: string[]; + + /** + *The filters.
+ *
- * shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.
activity-status - The progress of the EC2 Fleet ( error |
+ * pending-fulfillment | pending-termination |
+ * fulfilled).
*
- * state - The state of the AFI (pending | failed | available | unavailable).
excess-capacity-termination-policy - Indicates whether to terminate
+ * running instances if the target capacity is decreased below the current EC2 Fleet size
+ * (true | false).
*
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
fleet-state - The state of the EC2 Fleet (submitted |
+ * active | deleted | failed |
+ * deleted-running | deleted-terminating |
+ * modifying).
*
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
replace-unhealthy-instances - Indicates whether EC2 Fleet should replace
+ * unhealthy instances (true | false).
*
- * update-time - The time of the most recent update.
type - The type of request (instant |
+ * request | maintain).
* The token to retrieve the next page of results.
- */ - NextToken?: string; - - /** - *The maximum number of results to return in a single call.
- */ - MaxResults?: number; } -export namespace DescribeFpgaImagesRequest { +export namespace DescribeFleetsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeFpgaImagesRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeFleetsRequest): any => ({ ...obj, }); } +export enum FleetActivityStatus { + ERROR = "error", + FULFILLED = "fulfilled", + PENDING_FULFILLMENT = "pending_fulfillment", + PENDING_TERMINATION = "pending_termination", +} + /** - *Describes the data that identifies an Amazon FPGA image (AFI) on the PCI bus.
+ *Describes the instances that could not be launched by the fleet.
*/ -export interface PciId { +export interface DescribeFleetError { /** - *The ID of the device.
+ *The launch templates and overrides that were used for launching the instances. The + * values that you specify in the Overrides replace the values in the launch template.
*/ - DeviceId?: string; + LaunchTemplateAndOverrides?: LaunchTemplateAndOverridesResponse; /** - *The ID of the vendor.
+ *Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
*/ - VendorId?: string; + Lifecycle?: InstanceLifecycle | string; /** - *The ID of the subsystem.
+ *The error code that indicates why the instance could not be launched. For more + * information about error codes, see Error Codes.
*/ - SubsystemId?: string; + ErrorCode?: string; /** - *The ID of the vendor for the subsystem.
+ *The error message that describes why the instance could not be launched. For more + * information about error messages, see Error Codes.
*/ - SubsystemVendorId?: string; + ErrorMessage?: string; } -export namespace PciId { +export namespace DescribeFleetError { /** * @internal */ - export const filterSensitiveLog = (obj: PciId): any => ({ + export const filterSensitiveLog = (obj: DescribeFleetError): any => ({ ...obj, }); } -export type FpgaImageStateCode = "available" | "failed" | "pending" | "unavailable"; - /** - *Describes the state of the bitstream generation process for an Amazon FPGA image (AFI).
+ *Describes the instances that were launched by the fleet.
*/ -export interface FpgaImageState { +export interface DescribeFleetsInstances { /** - *The state. The following are the possible values:
- *
- * pending - AFI bitstream generation is in progress.
- * available - The AFI is available for use.
- * failed - AFI bitstream generation failed.
- * unavailable - The AFI is no longer available for use.
The launch templates and overrides that were used for launching the instances. The + * values that you specify in the Overrides replace the values in the launch template.
*/ - Code?: FpgaImageStateCode | string; + LaunchTemplateAndOverrides?: LaunchTemplateAndOverridesResponse; /** - *If the state is failed, this is the error message.
Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
*/ - Message?: string; + Lifecycle?: InstanceLifecycle | string; + + /** + *The IDs of the instances.
+ */ + InstanceIds?: string[]; + + /** + *The instance type.
+ */ + InstanceType?: _InstanceType | string; + + /** + *The value is Windows for Windows instances. Otherwise, the value is
+ * blank.
Describes an Amazon FPGA image (AFI).
+ *Describes a launch template and overrides.
*/ -export interface FpgaImage { +export interface FleetLaunchTemplateConfig { /** - *The FPGA image identifier (AFI ID).
+ *The launch template.
*/ - FpgaImageId?: string; + LaunchTemplateSpecification?: FleetLaunchTemplateSpecification; /** - *The global FPGA image identifier (AGFI ID).
+ *Any parameters that you specify override the same parameters in the launch + * template.
*/ - FpgaImageGlobalId?: string; + Overrides?: FleetLaunchTemplateOverrides[]; +} +export namespace FleetLaunchTemplateConfig { /** - *The name of the AFI.
+ * @internal */ - Name?: string; + export const filterSensitiveLog = (obj: FleetLaunchTemplateConfig): any => ({ + ...obj, + }); +} +/** + *Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand + * capacity.
+ *This strategy can only be used if the EC2 Fleet is of type
+ * instant.
For more information about Capacity Reservations, see On-Demand Capacity + * Reservations in the Amazon EC2 User Guide. For examples of using + * Capacity Reservations in an EC2 Fleet, see EC2 Fleet example + * configurations in the Amazon EC2 User Guide.
+ */ +export interface CapacityReservationOptions { /** - *The description of the AFI.
+ *Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
+ *If you specify use-capacity-reservations-first, the fleet uses unused
+ * Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If
+ * multiple instance pools have unused Capacity Reservations, the On-Demand allocation
+ * strategy (lowest-price or prioritized) is applied. If the number
+ * of unused Capacity Reservations is less than the On-Demand target capacity, the remaining
+ * On-Demand target capacity is launched according to the On-Demand allocation strategy
+ * (lowest-price or prioritized).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the + * chosen On-Demand allocation strategy.
*/ - Description?: string; + UsageStrategy?: FleetCapacityReservationUsageStrategy | string; +} +export namespace CapacityReservationOptions { /** - *The version of the Amazon Web Services Shell that was used to create the bitstream.
+ * @internal */ - ShellVersion?: string; + export const filterSensitiveLog = (obj: CapacityReservationOptions): any => ({ + ...obj, + }); +} +/** + *Describes the configuration of On-Demand Instances in an EC2 Fleet.
+ */ +export interface OnDemandOptions { /** - *Information about the PCI bus.
+ *The order of the launch template overrides to use in fulfilling On-Demand capacity. If
+ * you specify lowest-price, EC2 Fleet uses price to determine the order, launching
+ * the lowest price first. If you specify prioritized, EC2 Fleet uses the priority
+ * that you assigned to each launch template override, launching the highest priority first.
+ * If you do not specify a value, EC2 Fleet defaults to lowest-price.
Information about the state of the AFI.
+ *The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
+ * Supported only for fleets of type instant.
The date and time the AFI was created.
+ *Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
+ * Supported only for fleets of type instant.
The time of the most recent update to the AFI.
+ *Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported
+ * only for fleets of type instant.
The ID of the Amazon Web Services account that owns the AFI.
+ *The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is + * not reached, the fleet launches no instances.
*/ - OwnerId?: string; + MinTargetCapacity?: number; /** - *The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace.
The maximum amount per hour for On-Demand Instances that you're willing to pay.
*/ - OwnerAlias?: string; + MaxTotalPrice?: string; +} +export namespace OnDemandOptions { /** - *The product codes for the AFI.
+ * @internal */ - ProductCodes?: ProductCode[]; + export const filterSensitiveLog = (obj: OnDemandOptions): any => ({ + ...obj, + }); +} +/** + *The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an + * elevated risk of being interrupted.
+ */ +export interface FleetSpotCapacityRebalance { /** - *Any tags assigned to the AFI.
+ *To allow EC2 Fleet to launch a replacement Spot Instance when an instance rebalance
+ * notification is emitted for an existing Spot Instance in the fleet, specify
+ * launch. Only available for fleets of type maintain.
When a replacement instance is launched, the instance marked for rebalance is not + * automatically terminated. You can terminate it, or you can leave it running. You are charged for both instances while they are running.
+ *Indicates whether the AFI is public.
+ * @internal */ - Public?: boolean; + export const filterSensitiveLog = (obj: FleetSpotCapacityRebalance): any => ({ + ...obj, + }); +} +/** + *The strategies for managing your Spot Instances that are at an elevated risk of being + * interrupted.
+ */ +export interface FleetSpotMaintenanceStrategies { /** - *Indicates whether data retention support is enabled for the AFI.
+ *The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an + * elevated risk of being interrupted.
*/ - DataRetentionSupport?: boolean; + CapacityRebalance?: FleetSpotCapacityRebalance; } -export namespace FpgaImage { +export namespace FleetSpotMaintenanceStrategies { /** * @internal */ - export const filterSensitiveLog = (obj: FpgaImage): any => ({ + export const filterSensitiveLog = (obj: FleetSpotMaintenanceStrategies): any => ({ ...obj, }); } -export interface DescribeFpgaImagesResult { - /** - *Information about the FPGA images.
- */ - FpgaImages?: FpgaImage[]; - +/** + *Describes the configuration of Spot Instances in an EC2 Fleet.
+ */ +export interface SpotOptions { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by + * the EC2 Fleet.
+ *If the allocation strategy is lowest-price, EC2 Fleet launches instances from
+ * the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified, EC2 Fleet launches instances from all
+ * of the Spot Instance pools that you specify.
If the allocation strategy is capacity-optimized (recommended), EC2 Fleet
+ * launches instances from Spot Instance pools with optimal capacity for the number of instances that
+ * are launching. To give certain instance types a higher chance of launching first, use
+ * capacity-optimized-prioritized. Set a priority for each instance type by
+ * using the Priority parameter for LaunchTemplateOverrides. You can
+ * assign the same priority to different LaunchTemplateOverrides. EC2 implements
+ * the priorities on a best-effort basis, but optimizes for capacity first.
+ * capacity-optimized-prioritized is supported only if your fleet uses a
+ * launch template. Note that if the On-Demand AllocationStrategy is set to
+ * prioritized, the same priority is applied when fulfilling On-Demand
+ * capacity.
The strategies for managing your workloads on your Spot Instances that will be + * interrupted. Currently only the capacity rebalance strategy is available.
*/ - export const filterSensitiveLog = (obj: DescribeFpgaImagesResult): any => ({ - ...obj, - }); -} + MaintenanceStrategies?: FleetSpotMaintenanceStrategies; -export interface DescribeHostReservationOfferingsRequest { /** - *The filters.
- *
- * instance-family - The instance family of the offering (for example,
- * m4).
- * payment-option - The payment option (NoUpfront |
- * PartialUpfront | AllUpfront).
The behavior when a Spot Instance is interrupted. The default is terminate.
This is the maximum duration of the reservation to purchase, specified in seconds. - * Reservations are available in one-year and three-year terms. The number of seconds - * specified must be the number of seconds in a year (365x24x60x60) times one of the - * supported durations (1 or 3). For example, specify 94608000 for three years.
+ *The number of Spot pools across which to allocate your target Spot capacity. Valid only
+ * when AllocationStrategy is set to
+ * lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates
+ * your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a + * best effort basis. If a pool runs out of Spot capacity before fulfilling your target + * capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest + * pool. To ensure that your target capacity is met, you might receive Spot Instances from more than + * the number of pools that you specified. Similarly, if most of the pools have no Spot + * capacity, you might receive your full target capacity from fewer than the number of pools + * that you specified.
*/ - MaxDuration?: number; + InstancePoolsToUseCount?: number; /** - *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
+ * Supported only for fleets of type instant.
This is the minimum duration of the reservation you'd like to purchase, specified - * in seconds. Reservations are available in one-year and three-year terms. The number of - * seconds specified must be the number of seconds in a year (365x24x60x60) times one of - * the supported durations (1 or 3). For example, specify 31536000 for one year.
+ *Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported
+ * only for fleets of type instant.
The token to use to retrieve the next page of results.
+ *The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is + * not reached, the fleet launches no instances.
*/ - NextToken?: string; + MinTargetCapacity?: number; /** - *The ID of the reservation offering.
+ *The maximum amount per hour for Spot Instances that you're willing to pay.
*/ - OfferingId?: string; + MaxTotalPrice?: string; } -export namespace DescribeHostReservationOfferingsRequest { +export namespace SpotOptions { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeHostReservationOfferingsRequest): any => ({ + export const filterSensitiveLog = (obj: SpotOptions): any => ({ ...obj, }); } -export enum PaymentOption { - ALL_UPFRONT = "AllUpfront", - NO_UPFRONT = "NoUpfront", - PARTIAL_UPFRONT = "PartialUpfront", -} - /** - *Details about the Dedicated Host Reservation offering.
+ *The number of units to request. You can choose to set the target capacity in terms of
+ * instances or a performance characteristic that is important to your application workload,
+ * such as vCPUs, memory, or I/O. If the request type is maintain, you can
+ * specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance
+ * MaxTotalPrice, or both to ensure that your fleet cost does not exceed your
+ * budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet
+ * will launch instances until it reaches the maximum amount that you're willing to pay. When
+ * the maximum amount you're willing to pay is reached, the fleet stops launching instances
+ * even if it hasn’t met the target capacity. The MaxTotalPrice parameters are
+ * located in OnDemandOptions
+ * and SpotOptions.
The currency of the offering.
- */ - CurrencyCode?: CurrencyCodeValues | string; - - /** - *The duration of the offering (in seconds).
- */ - Duration?: number; - +export interface TargetCapacitySpecification { /** - *The hourly price of the offering.
+ *The number of units to request, filled using
+ * DefaultTargetCapacityType.
The instance family of the offering.
+ *The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.
*/ - InstanceFamily?: string; + OnDemandTargetCapacity?: number; /** - *The ID of the offering.
+ *The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.
*/ - OfferingId?: string; + SpotTargetCapacity?: number; /** - *The available payment option.
+ *The default TotalTargetCapacity, which is either Spot or
+ * On-Demand.
The upfront price of the offering. Does not apply to No Upfront - * offerings.
+ *The unit for the target capacity.
+ *Default: units (translates to number of instances)
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes an EC2 Fleet.
+ */ +export interface FleetData { /** - *Information about the offerings.
+ *The progress of the EC2 Fleet. If there is an error, the status is error. After
+ * all requests are placed, the status is pending_fulfillment. If the size of the
+ * EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled.
+ * If the size of the EC2 Fleet is decreased, the status is pending_termination while
+ * instances are terminating.
The creation date and time of the EC2 Fleet.
*/ - export const filterSensitiveLog = (obj: DescribeHostReservationOfferingsResult): any => ({ - ...obj, - }); -} + CreateTime?: Date; -export interface DescribeHostReservationsRequest { /** - *The filters.
- *
- * instance-family - The instance family (for example,
- * m4).
- * payment-option - The payment option (NoUpfront |
- * PartialUpfront | AllUpfront).
- * state - The state of the reservation (payment-pending
- * | payment-failed | active |
- * retired).
- * tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.
- * For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The ID of the EC2 Fleet.
*/ - Filter?: Filter[]; + FleetId?: string; /** - *The host reservation IDs.
+ *The state of the EC2 Fleet.
*/ - HostReservationIdSet?: string[]; + FleetState?: FleetStateCode | string; /** - *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. For more information, see Ensuring + * Idempotency.
+ *Constraints: Maximum 64 ASCII characters
*/ - MaxResults?: number; + ClientToken?: string; /** - *The token to use to retrieve the next page of results.
+ *Indicates whether running instances should be terminated if the target capacity of the + * EC2 Fleet is decreased below the current size of the EC2 Fleet.
*/ - NextToken?: string; -} + ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy | string; -export namespace DescribeHostReservationsRequest { /** - * @internal + *The number of units fulfilled by this request compared to the set target + * capacity.
*/ - export const filterSensitiveLog = (obj: DescribeHostReservationsRequest): any => ({ - ...obj, - }); -} - -export enum ReservationState { - ACTIVE = "active", - PAYMENT_FAILED = "payment-failed", - PAYMENT_PENDING = "payment-pending", - RETIRED = "retired", -} + FulfilledCapacity?: number; -/** - *Details about the Dedicated Host Reservation and associated Dedicated - * Hosts.
- */ -export interface HostReservation { /** - *The number of Dedicated Hosts the reservation is associated with.
+ *The number of units fulfilled by this request compared to the set target On-Demand + * capacity.
*/ - Count?: number; + FulfilledOnDemandCapacity?: number; /** - *The currency in which the upfrontPrice and hourlyPrice
- * amounts are specified. At this time, the only supported currency is
- * USD.
The launch template and overrides.
*/ - CurrencyCode?: CurrencyCodeValues | string; + LaunchTemplateConfigs?: FleetLaunchTemplateConfig[]; /** - *The length of the reservation's term, specified in seconds. Can be 31536000
- * (1 year) | 94608000 (3 years).
The number of units to request. You can choose to set the target capacity in terms of
+ * instances or a performance characteristic that is important to your application workload,
+ * such as vCPUs, memory, or I/O. If the request type is maintain, you can
+ * specify a target capacity of 0 and add capacity later.
The date and time that the reservation ends.
+ *Indicates whether running instances should be terminated when the EC2 Fleet expires.
*/ - End?: Date; + TerminateInstancesWithExpiration?: boolean; /** - *The IDs of the Dedicated Hosts associated with the reservation.
+ *The type of request. Indicates whether the EC2 Fleet only requests the target
+ * capacity, or also attempts to maintain it. If you request a certain target
+ * capacity, EC2 Fleet only places the required requests; it does not attempt to replenish
+ * instances if capacity is diminished, and it does not submit requests in alternative
+ * capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet
+ * places the required requests to meet this target capacity. It also automatically
+ * replenishes any interrupted Spot Instances. Default: maintain.
The ID of the reservation that specifies the associated Dedicated Hosts.
+ *The start date and time of the request, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ). + * The default is to start fulfilling the request immediately.
*/ - HostReservationId?: string; + ValidFrom?: Date; /** - *The hourly price of the reservation.
+ *The end date and time of the request, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ). + * At this point, no new instance requests are placed or able to fulfill the request. The + * default end date is 7 days from the current date.
*/ - HourlyPrice?: string; + ValidUntil?: Date; /** - *The instance family of the Dedicated Host Reservation. The instance family on the - * Dedicated Host must be the same in order for it to benefit from the - * reservation.
+ *Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for
+ * fleets of type maintain. For more information, see EC2 Fleet
+ * health checks in the Amazon EC2 User Guide.
The ID of the reservation. This remains the same regardless of which Dedicated - * Hosts are associated with it.
+ *The configuration of Spot Instances in an EC2 Fleet.
*/ - OfferingId?: string; + SpotOptions?: SpotOptions; /** - *The payment option selected for this reservation.
+ *The allocation strategy of On-Demand Instances in an EC2 Fleet.
*/ - PaymentOption?: PaymentOption | string; + OnDemandOptions?: OnDemandOptions; /** - *The date and time that the reservation started.
+ *The tags for an EC2 Fleet resource.
*/ - Start?: Date; + Tags?: Tag[]; /** - *The state of the reservation.
+ *Information about the instances that could not be launched by the fleet. Valid only when
+ * Type is set to instant.
The upfront price of the reservation.
+ *Information about the instances that were launched by the fleet. Valid only when
+ * Type is set to instant.
Any tags assigned to the Dedicated Host Reservation.
+ *Reserved.
*/ - Tags?: Tag[]; + Context?: string; } -export namespace HostReservation { +export namespace FleetData { /** * @internal */ - export const filterSensitiveLog = (obj: HostReservation): any => ({ + export const filterSensitiveLog = (obj: FleetData): any => ({ ...obj, }); } -export interface DescribeHostReservationsResult { +export interface DescribeFleetsResult { /** - *Details about the reservation's configuration.
+ *The token for the next set of results.
*/ - HostReservationSet?: HostReservation[]; + NextToken?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the EC2 Fleets.
*/ - NextToken?: string; + Fleets?: FleetData[]; } -export namespace DescribeHostReservationsResult { +export namespace DescribeFleetsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeHostReservationsResult): any => ({ + export const filterSensitiveLog = (obj: DescribeFleetsResult): any => ({ ...obj, }); } -export interface DescribeHostsRequest { +export interface DescribeFlowLogsRequest { /** - *The filters.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters.
*
- * auto-placement - Whether auto-placement is enabled or disabled
- * (on | off).
deliver-log-status - The status of the logs delivery (SUCCESS |
+ * FAILED).
*
- * availability-zone - The Availability Zone of the
- * host.
log-destination-type - The type of destination to which the flow
+ * log publishes data. Possible destination types include
+ * cloud-watch-logs and s3.
*
- * client-token - The idempotency token that you provided when you
- * allocated the host.
flow-log-id - The ID of the flow log.
*
- * host-reservation-id - The ID of the reservation assigned to
- * this host.
log-group-name - The name of the log group.
*
- * instance-type - The instance type size that the Dedicated Host
- * is configured to support.
resource-id - The ID of the VPC, subnet, or network interface.
*
- * state - The allocation state of the Dedicated Host
- * (available | under-assessment |
- * permanent-failure | released |
- * released-permanent-failure).
traffic-type - The type of traffic (ACCEPT |
+ * REJECT | ALL).
* + *
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The IDs of the Dedicated Hosts. The IDs are used for targeted instance - * launches.
+ *One or more flow log IDs.
+ *Constraint: Maximum of 1000 flow log IDs.
*/ - HostIds?: string[]; + FlowLogIds?: string[]; /** - *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
You cannot specify this parameter and the host IDs parameter in the same request.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token to use to retrieve the next page of results.
+ *The token for the next page of results.
*/ NextToken?: string; } -export namespace DescribeHostsRequest { +export namespace DescribeFlowLogsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeHostsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeFlowLogsRequest): any => ({ ...obj, }); } /** - *Information about the number of instances that can be launched onto the Dedicated - * Host.
+ *Describes the destination options for a flow log.
*/ -export interface InstanceCapacity { +export interface DestinationOptionsResponse { /** - *The number of instances that can be launched onto the Dedicated Host based on the - * host's available capacity.
+ *The format for the flow log.
*/ - AvailableCapacity?: number; + FileFormat?: DestinationFileFormat | string; /** - *The instance type supported by the Dedicated Host.
+ *Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.
*/ - InstanceType?: string; + HiveCompatiblePartitions?: boolean; /** - *The total number of instances that can be launched onto the Dedicated Host if there - * are no instances running on it.
+ *Indicates whether to partition the flow log per hour.
*/ - TotalCapacity?: number; + PerHourPartition?: boolean; } -export namespace InstanceCapacity { +export namespace DestinationOptionsResponse { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceCapacity): any => ({ + export const filterSensitiveLog = (obj: DestinationOptionsResponse): any => ({ ...obj, }); } /** - *The capacity information for instances that can be launched onto the Dedicated Host.
+ *Describes a flow log.
*/ -export interface AvailableCapacity { +export interface FlowLog { + /** + *The date and time the flow log was created.
+ */ + CreationTime?: Date; + /** - *The number of instances that can be launched onto the Dedicated Host depending on - * the host's available capacity. For Dedicated Hosts that support multiple instance types, - * this parameter represents the number of instances for each instance size that is - * supported on the host.
+ *Information about the error that occurred. Rate limited indicates that
+ * CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've
+ * reached the limit on the number of log groups that you can create. Access
+ * error indicates that the IAM role associated with the flow log does not have
+ * sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an
+ * internal error.
The number of vCPUs available for launching instances onto the Dedicated Host.
+ *The ARN of the IAM role that posts logs to CloudWatch Logs.
*/ - AvailableVCpus?: number; -} + DeliverLogsPermissionArn?: string; -export namespace AvailableCapacity { /** - * @internal + *The status of the logs delivery (SUCCESS | FAILED).
Describes the properties of a Dedicated Host.
- */ -export interface HostProperties { /** - *The number of cores on the Dedicated Host.
+ *The flow log ID.
*/ - Cores?: number; + FlowLogId?: string; /** - *The instance type supported by the Dedicated Host. For example, m5.large.
- * If the host supports multiple instance types, no instanceType
- * is returned.
The status of the flow log (ACTIVE).
The instance family supported by the Dedicated Host. For example, m5.
The name of the flow log group.
*/ - InstanceFamily?: string; + LogGroupName?: string; + + /** + *The ID of the resource on which the flow log was created.
+ */ + ResourceId?: string; + + /** + *The type of traffic captured for the flow log.
+ */ + TrafficType?: TrafficType | string; + + /** + *The type of destination to which the flow log data is published. Flow log data can be + * published to CloudWatch Logs or Amazon S3.
+ */ + LogDestinationType?: LogDestinationType | string; + + /** + *The destination to which the flow log data is published. Flow log data can be + * published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, + * this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which + * the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN + * of the Amazon S3 bucket to which the data is published.
+ */ + LogDestination?: string; + + /** + *The format of the flow log record.
+ */ + LogFormat?: string; + + /** + *The tags for the flow log.
+ */ + Tags?: Tag[]; /** - *The number of sockets on the Dedicated Host.
+ *The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
+ *When a network interface is attached to a Nitro-based + * instance, the aggregation interval is always 60 seconds (1 minute) or less, + * regardless of the specified value.
+ *Valid Values: 60 | 600
+ *
The total number of vCPUs on the Dedicated Host.
+ *The destination options.
*/ - TotalVCpus?: number; + DestinationOptions?: DestinationOptionsResponse; } -export namespace HostProperties { +export namespace FlowLog { /** * @internal */ - export const filterSensitiveLog = (obj: HostProperties): any => ({ + export const filterSensitiveLog = (obj: FlowLog): any => ({ ...obj, }); } -/** - *Describes an instance running on a Dedicated Host.
- */ -export interface HostInstance { - /** - *The ID of instance that is running on the Dedicated Host.
- */ - InstanceId?: string; - +export interface DescribeFlowLogsResult { /** - *The instance type (for example, m3.medium) of the running instance.
Information about the flow logs.
*/ - InstanceType?: string; + FlowLogs?: FlowLog[]; /** - *The ID of the Amazon Web Services account that owns the instance.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the properties of the Dedicated Host.
- */ -export interface Host { - /** - *Whether auto-placement is on or off.
- */ - AutoPlacement?: AutoPlacement | string; +export type FpgaImageAttributeName = "description" | "loadPermission" | "name" | "productCodes"; +export interface DescribeFpgaImageAttributeRequest { /** - *The Availability Zone of the Dedicated Host.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the instances running on the Dedicated Host.
+ *The ID of the AFI.
*/ - AvailableCapacity?: AvailableCapacity; + FpgaImageId: string | undefined; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
+ *The AFI attribute.
*/ - ClientToken?: string; + Attribute: FpgaImageAttributeName | string | undefined; +} +export namespace DescribeFpgaImageAttributeRequest { /** - *The ID of the Dedicated Host.
+ * @internal */ - HostId?: string; + export const filterSensitiveLog = (obj: DescribeFpgaImageAttributeRequest): any => ({ + ...obj, + }); +} - /** - *The hardware specifications of the Dedicated Host.
- */ - HostProperties?: HostProperties; +export type PermissionGroup = "all"; +/** + *Describes a load permission.
+ */ +export interface LoadPermission { /** - *The reservation ID of the Dedicated Host. This returns a null response
- * if the Dedicated Host doesn't have an associated reservation.
The Amazon Web Services account ID.
*/ - HostReservationId?: string; + UserId?: string; /** - *The IDs and instance type that are currently running on the Dedicated - * Host.
+ *The name of the group.
*/ - Instances?: HostInstance[]; + Group?: PermissionGroup | string; +} +export namespace LoadPermission { /** - *The Dedicated Host's state.
+ * @internal */ - State?: AllocationState | string; + export const filterSensitiveLog = (obj: LoadPermission): any => ({ + ...obj, + }); +} +export type ProductCodeValues = "devpay" | "marketplace"; + +/** + *Describes a product code.
+ */ +export interface ProductCode { /** - *The time that the Dedicated Host was allocated.
+ *The product code.
*/ - AllocationTime?: Date; + ProductCodeId?: string; /** - *The time that the Dedicated Host was released.
+ *The type of product code.
*/ - ReleaseTime?: Date; + ProductCodeType?: ProductCodeValues | string; +} +export namespace ProductCode { /** - *Any tags assigned to the Dedicated Host.
+ * @internal */ - Tags?: Tag[]; + export const filterSensitiveLog = (obj: ProductCode): any => ({ + ...obj, + }); +} +/** + *Describes an Amazon FPGA image (AFI) attribute.
+ */ +export interface FpgaImageAttribute { /** - *Indicates whether host recovery is enabled or disabled for the Dedicated Host.
+ *The ID of the AFI.
*/ - HostRecovery?: HostRecovery | string; + FpgaImageId?: string; /** - *Indicates whether the Dedicated Host supports multiple instance types of the same instance family.
- * If the value is on, the Dedicated Host supports multiple instance types in the instance family.
- * If the value is off, the Dedicated Host supports a single instance type only.
The name of the AFI.
*/ - AllowsMultipleInstanceTypes?: AllowsMultipleInstanceTypes | string; + Name?: string; /** - *The ID of the Amazon Web Services account that owns the Dedicated Host.
+ *The description of the AFI.
*/ - OwnerId?: string; + Description?: string; /** - *The ID of the Availability Zone in which the Dedicated Host is allocated.
+ *The load permissions.
*/ - AvailabilityZoneId?: string; + LoadPermissions?: LoadPermission[]; /** - *Indicates whether the Dedicated Host is in a host resource group. If
- * memberOfServiceLinkedResourceGroup is
- * true, the host is in a host resource group; otherwise, it is not.
The product codes.
*/ - MemberOfServiceLinkedResourceGroup?: boolean; + ProductCodes?: ProductCode[]; } -export namespace Host { +export namespace FpgaImageAttribute { /** * @internal */ - export const filterSensitiveLog = (obj: Host): any => ({ + export const filterSensitiveLog = (obj: FpgaImageAttribute): any => ({ ...obj, }); } -export interface DescribeHostsResult { - /** - *Information about the Dedicated Hosts.
- */ - Hosts?: Host[]; - +export interface DescribeFpgaImageAttributeResult { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the attribute.
*/ - NextToken?: string; + FpgaImageAttribute?: FpgaImageAttribute; } -export namespace DescribeHostsResult { +export namespace DescribeFpgaImageAttributeResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeHostsResult): any => ({ + export const filterSensitiveLog = (obj: DescribeFpgaImageAttributeResult): any => ({ ...obj, }); } -export interface DescribeIamInstanceProfileAssociationsRequest { +export interface DescribeFpgaImagesRequest { /** - *The IAM instance profile associations.
+ *Checks whether you have the required permissions for the action, without 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 AFI IDs.
+ */ + FpgaImageIds?: string[]; + + /** + *Filters the AFI by owner. Specify an Amazon Web Services account ID, self
+ * (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are
+ * amazon | aws-marketplace).
The filters.
- *
- * instance-id - The ID of the instance.
create-time - The creation time of the AFI.
+ *
+ * fpga-image-id - The FPGA image identifier (AFI ID).
+ * fpga-image-global-id - The global FPGA image identifier (AGFI ID).
+ * name - The name of the AFI.
+ * owner-id - The Amazon Web Services account ID of the AFI owner.
+ * product-code - The product code.
+ * shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.
+ * state - The state of the AFI (pending | failed | available | unavailable).
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * state - The state of the association (associating |
- * associated | disassociating).
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ *
+ * update-time - The time of the most recent update.
The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another call with the returned NextToken value.
The token to request the next page of results.
+ *The token to retrieve the next page of results.
*/ NextToken?: string; -} - -export namespace DescribeIamInstanceProfileAssociationsRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribeIamInstanceProfileAssociationsRequest): any => ({ - ...obj, - }); -} -export interface DescribeIamInstanceProfileAssociationsResult { /** - *Information about the IAM instance profile associations.
- */ - IamInstanceProfileAssociations?: IamInstanceProfileAssociation[]; - - /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The maximum number of results to return in a single call.
*/ - NextToken?: string; + MaxResults?: number; } -export namespace DescribeIamInstanceProfileAssociationsResult { +export namespace DescribeFpgaImagesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeIamInstanceProfileAssociationsResult): any => ({ + export const filterSensitiveLog = (obj: DescribeFpgaImagesRequest): any => ({ ...obj, }); } -export interface DescribeIdentityIdFormatRequest { +/** + *Describes the data that identifies an Amazon FPGA image (AFI) on the PCI bus.
+ */ +export interface PciId { /** - *The ARN of the principal, which can be an IAM role, IAM user, or the root user.
+ *The ID of the device.
*/ - PrincipalArn: string | undefined; + DeviceId?: string; /** - *The type of resource: bundle |
- * conversion-task | customer-gateway | dhcp-options |
- * elastic-ip-allocation | elastic-ip-association |
- * export-task | flow-log | image |
- * import-task | instance | internet-gateway |
- * network-acl | network-acl-association |
- * network-interface | network-interface-attachment |
- * prefix-list | reservation | route-table |
- * route-table-association | security-group |
- * snapshot | subnet |
- * subnet-cidr-block-association | volume | vpc
- * | vpc-cidr-block-association | vpc-endpoint |
- * vpc-peering-connection | vpn-connection | vpn-gateway
- *
The ID of the vendor.
*/ - Resource?: string; -} + VendorId?: string; -export namespace DescribeIdentityIdFormatRequest { /** - * @internal + *The ID of the subsystem.
*/ - export const filterSensitiveLog = (obj: DescribeIdentityIdFormatRequest): any => ({ - ...obj, - }); -} + SubsystemId?: string; -export interface DescribeIdentityIdFormatResult { /** - *Information about the ID format for the resources.
+ *The ID of the vendor for the subsystem.
*/ - Statuses?: IdFormat[]; + SubsystemVendorId?: string; } -export namespace DescribeIdentityIdFormatResult { +export namespace PciId { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeIdentityIdFormatResult): any => ({ + export const filterSensitiveLog = (obj: PciId): any => ({ ...obj, }); } -export interface DescribeIdFormatRequest { - /** - *The type of resource: bundle |
- * conversion-task | customer-gateway | dhcp-options |
- * elastic-ip-allocation | elastic-ip-association |
- * export-task | flow-log | image |
- * import-task | instance | internet-gateway |
- * network-acl | network-acl-association |
- * network-interface | network-interface-attachment |
- * prefix-list | reservation | route-table |
- * route-table-association | security-group |
- * snapshot | subnet |
- * subnet-cidr-block-association | volume | vpc
- * | vpc-cidr-block-association | vpc-endpoint |
- * vpc-peering-connection | vpn-connection | vpn-gateway
- *
Describes the state of the bitstream generation process for an Amazon FPGA image (AFI).
+ */ +export interface FpgaImageState { /** - * @internal + *The state. The following are the possible values:
+ *
+ * pending - AFI bitstream generation is in progress.
+ * available - The AFI is available for use.
+ * failed - AFI bitstream generation failed.
+ * unavailable - The AFI is no longer available for use.
Information about the ID format for the resource.
+ *If the state is failed, this is the error message.
Contains the parameters for DescribeImageAttribute.
+ *Describes an Amazon FPGA image (AFI).
*/ -export interface DescribeImageAttributeRequest { - /** - *The AMI attribute.
- *
- * Note: The blockDeviceMapping attribute is deprecated.
- * Using this attribute returns the Client.AuthFailure error. To get information about
- * the block device mappings for an AMI, use the DescribeImages action.
The ID of the AMI.
+ *The FPGA image identifier (AFI ID).
*/ - ImageId: string | undefined; + FpgaImageId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The global FPGA image identifier (AGFI ID).
*/ - DryRun?: boolean; -} + FpgaImageGlobalId?: string; -export namespace DescribeImageAttributeRequest { /** - * @internal + *The name of the AFI.
*/ - export const filterSensitiveLog = (obj: DescribeImageAttributeRequest): any => ({ - ...obj, - }); -} + Name?: string; -/** - *Describes a launch permission.
- */ -export interface LaunchPermission { /** - *The name of the group.
+ *The description of the AFI.
*/ - Group?: PermissionGroup | string; + Description?: string; /** - *The Amazon Web Services account ID.
- *Constraints: Up to 10 000 account IDs can be specified in a single request.
+ *The version of the Amazon Web Services Shell that was used to create the bitstream.
*/ - UserId?: string; -} + ShellVersion?: string; -export namespace LaunchPermission { /** - * @internal + *Information about the PCI bus.
*/ - export const filterSensitiveLog = (obj: LaunchPermission): any => ({ - ...obj, - }); -} + PciId?: PciId; -/** - *Describes an image attribute.
- */ -export interface ImageAttribute { /** - *The block device mapping entries.
+ *Information about the state of the AFI.
*/ - BlockDeviceMappings?: BlockDeviceMapping[]; + State?: FpgaImageState; /** - *The ID of the AMI.
+ *The date and time the AFI was created.
*/ - ImageId?: string; + CreateTime?: Date; /** - *The launch permissions.
+ *The time of the most recent update to the AFI.
*/ - LaunchPermissions?: LaunchPermission[]; + UpdateTime?: Date; /** - *The product codes.
+ *The ID of the Amazon Web Services account that owns the AFI.
*/ - ProductCodes?: ProductCode[]; + OwnerId?: string; /** - *A description for the AMI.
+ *The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace.
The kernel ID.
+ *The product codes for the AFI.
*/ - KernelId?: AttributeValue; + ProductCodes?: ProductCode[]; /** - *The RAM disk ID.
+ *Any tags assigned to the AFI.
*/ - RamdiskId?: AttributeValue; + Tags?: Tag[]; /** - *Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
+ *Indicates whether the AFI is public.
*/ - SriovNetSupport?: AttributeValue; + Public?: boolean; /** - *Describes a value for a resource attribute that is a String.
+ *Indicates whether data retention support is enabled for the AFI.
*/ - BootMode?: AttributeValue; + DataRetentionSupport?: boolean; } -export namespace ImageAttribute { +export namespace FpgaImage { /** * @internal */ - export const filterSensitiveLog = (obj: ImageAttribute): any => ({ + export const filterSensitiveLog = (obj: FpgaImage): any => ({ ...obj, }); } -export interface DescribeImagesRequest { - /** - *Scopes the images by users with explicit launch permissions.
- * Specify an Amazon Web Services account ID, self (the sender of the request),
- * or all (public AMIs).
The filters.
- *
- * architecture - The image architecture (i386 |
- * x86_64 | arm64).
- * block-device-mapping.delete-on-termination - A Boolean value that indicates
- * whether the Amazon EBS volume is deleted on instance termination.
- * block-device-mapping.device-name - The device name specified in the block device mapping (for
- * example, /dev/sdh or xvdh).
- * block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS
- * volume.
- * block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
- * block-device-mapping.volume-type - The volume type of the Amazon EBS volume
- * (io1 | io2 | gp2 | gp3 | sc1
- * | st1 | standard).
- * block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
- * description - The description of the image (provided during image
- * creation).
- * ena-support - A Boolean that indicates whether enhanced networking
- * with ENA is enabled.
- * hypervisor - The hypervisor type (ovm |
- * xen).
- * image-id - The ID of the image.
- * image-type - The image type (machine | kernel |
- * ramdisk).
- * is-public - A Boolean that indicates whether the image is public.
- * kernel-id - The kernel ID.
- * manifest-location - The location of the image manifest.
- * name - The name of the AMI (provided during image creation).
- * owner-alias - The owner alias (amazon | aws-marketplace).
- * The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be
- * set using the IAM console. We recommend that you use the Owner
- * request parameter instead of this filter.
- * owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the
- * Owner request parameter instead of this filter.
- * platform - The platform. To only list Windows-based AMIs, use
- * windows.
- * product-code - The product code.
- * product-code.type - The type of the product code (marketplace).
- * ramdisk-id - The RAM disk ID.
- * root-device-name - The device name of the root device volume (for example, /dev/sda1).
- * root-device-type - The type of the root device volume (ebs |
- * instance-store).
- * state - The state of the image (available | pending
- * | failed).
- * state-reason-code - The reason code for the state change.
- * state-reason-message - The message for the state change.
- * sriov-net-support - A value of simple indicates
- * that enhanced networking with the Intel 82599 VF interface is enabled.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * virtualization-type - The virtualization type (paravirtual |
- * hvm).
The image IDs.
- *Default: Describes all images available to you.
- */ - ImageIds?: string[]; - - /** - *Scopes the results to images with the specified owners. You can specify a combination of
- * Amazon Web Services account IDs, self, amazon, and aws-marketplace.
- * If you omit this parameter, the results include all images for which you have launch permissions,
- * regardless of ownership.
If true, all deprecated AMIs are included in the response. If
- * false, no deprecated AMIs are included in the response. If no value is
- * specified, the default value is false.
If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false) that you set for this parameter.
Information about the FPGA images.
*/ - IncludeDeprecated?: boolean; + FpgaImages?: FpgaImage[]; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes a state change.
- */ -export interface StateReason { - /** - *The reason code for the state change.
- */ - Code?: string; - +export interface DescribeHostReservationOfferingsRequest { /** - *The message for the state change.
+ *The filters.
*
- * Server.InsufficientInstanceCapacity: There was insufficient
- * capacity available to satisfy the launch request.
- * Server.InternalError: An internal error caused the instance to
- * terminate during launch.
- * Server.ScheduledStop: The instance was stopped due to a scheduled
- * retirement.
- * Server.SpotInstanceShutdown: The instance was stopped because the
- * number of Spot requests with a maximum price equal to or higher than the Spot
- * price exceeded available capacity or because of an increase in the Spot
- * price.
- * Server.SpotInstanceTermination: The instance was terminated
- * because the number of Spot requests with a maximum price equal to or higher than
- * the Spot price exceeded available capacity or because of an increase in the Spot
- * price.
- * Client.InstanceInitiatedShutdown: The instance was shut down
- * using the shutdown -h command from the instance.
- * Client.InstanceTerminated: The instance was terminated or
- * rebooted during AMI creation.
- * Client.InternalError: A client error caused the instance to
- * terminate during launch.
- * Client.InvalidSnapshot.NotFound: The specified snapshot was not
- * found.
- * Client.UserInitiatedHibernate: Hibernation was initiated on the
- * instance.
- * Client.UserInitiatedShutdown: The instance was shut down using
- * the Amazon EC2 API.
instance-family - The instance family of the offering (for example,
+ * m4).
*
- * Client.VolumeLimitExceeded: The limit on the number of EBS
- * volumes or total storage was exceeded. Decrease usage or request an increase in
- * your account limits.
payment-option - The payment option (NoUpfront |
+ * PartialUpfront | AllUpfront).
* This is the maximum duration of the reservation to purchase, specified in seconds. + * Reservations are available in one-year and three-year terms. The number of seconds + * specified must be the number of seconds in a year (365x24x60x60) times one of the + * supported durations (1 or 3). For example, specify 94608000 for three years.
+ */ + MaxDuration?: number; + + /** + *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
This is the minimum duration of the reservation you'd like to purchase, specified + * in seconds. Reservations are available in one-year and three-year terms. The number of + * seconds specified must be the number of seconds in a year (365x24x60x60) times one of + * the supported durations (1 or 3). For example, specify 31536000 for one year.
+ */ + MinDuration?: number; + + /** + *The token to use to retrieve the next page of results.
+ */ + NextToken?: string; + + /** + *The ID of the reservation offering.
+ */ + OfferingId?: string; } -export namespace StateReason { +export namespace DescribeHostReservationOfferingsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: StateReason): any => ({ + export const filterSensitiveLog = (obj: DescribeHostReservationOfferingsRequest): any => ({ ...obj, }); } -export type VirtualizationType = "hvm" | "paravirtual"; +export enum PaymentOption { + ALL_UPFRONT = "AllUpfront", + NO_UPFRONT = "NoUpfront", + PARTIAL_UPFRONT = "PartialUpfront", +} /** - *Describes an image.
+ *Details about the Dedicated Host Reservation offering.
*/ -export interface Image { +export interface HostOffering { /** - *The architecture of the image.
+ *The currency of the offering.
*/ - Architecture?: ArchitectureValues | string; + CurrencyCode?: CurrencyCodeValues | string; /** - *The date and time the image was created.
+ *The duration of the offering (in seconds).
*/ - CreationDate?: string; + Duration?: number; /** - *The ID of the AMI.
+ *The hourly price of the offering.
*/ - ImageId?: string; + HourlyPrice?: string; /** - *The location of the AMI.
+ *The instance family of the offering.
*/ - ImageLocation?: string; + InstanceFamily?: string; /** - *The type of image.
+ *The ID of the offering.
*/ - ImageType?: ImageTypeValues | string; + OfferingId?: string; /** - *Indicates whether the image has public launch permissions. The value is true if
- * this image has public launch permissions or false
- * if it has only implicit and explicit launch permissions.
The available payment option.
*/ - Public?: boolean; + PaymentOption?: PaymentOption | string; /** - *The kernel associated with the image, if any. Only applicable for machine images.
+ *The upfront price of the offering. Does not apply to No Upfront + * offerings.
*/ - KernelId?: string; + UpfrontPrice?: string; +} +export namespace HostOffering { /** - *The ID of the Amazon Web Services account that owns the image.
+ * @internal */ - OwnerId?: string; + export const filterSensitiveLog = (obj: HostOffering): any => ({ + ...obj, + }); +} +export interface DescribeHostReservationOfferingsResult { /** - *This value is set to windows for Windows AMIs; otherwise, it is blank.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The platform details associated with the billing code of the AMI. For more information, - * see Understanding - * AMI billing in the Amazon Elastic Compute Cloud User Guide.
+ *Information about the offerings.
+ */ + OfferingSet?: HostOffering[]; +} + +export namespace DescribeHostReservationOfferingsResult { + /** + * @internal */ - PlatformDetails?: string; + export const filterSensitiveLog = (obj: DescribeHostReservationOfferingsResult): any => ({ + ...obj, + }); +} +export interface DescribeHostReservationsRequest { /** - *The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
- * usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price
- * List API. You can view these fields on the Instances or
- * AMIs pages in the Amazon EC2 console, or in the responses that are
- * returned by the DescribeImages
- * command in the Amazon EC2 API, or the describe-images
- * command in the CLI.
The filters.
+ *
+ * instance-family - The instance family (for example,
+ * m4).
+ * payment-option - The payment option (NoUpfront |
+ * PartialUpfront | AllUpfront).
+ * state - The state of the reservation (payment-pending
+ * | payment-failed | active |
+ * retired).
+ * tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.
+ * For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Any product codes associated with the AMI.
+ *The host reservation IDs.
*/ - ProductCodes?: ProductCode[]; + HostReservationIdSet?: string[]; /** - *The RAM disk associated with the image, if any. Only applicable for machine images.
+ *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
The token to use to retrieve the next page of results.
*/ - State?: ImageState | string; + NextToken?: string; +} +export namespace DescribeHostReservationsRequest { /** - *Any block device mapping entries.
+ * @internal */ - BlockDeviceMappings?: BlockDeviceMapping[]; + export const filterSensitiveLog = (obj: DescribeHostReservationsRequest): any => ({ + ...obj, + }); +} +export enum ReservationState { + ACTIVE = "active", + PAYMENT_FAILED = "payment-failed", + PAYMENT_PENDING = "payment-pending", + RETIRED = "retired", +} + +/** + *Details about the Dedicated Host Reservation and associated Dedicated + * Hosts.
+ */ +export interface HostReservation { /** - *The description of the AMI that was provided during image creation.
+ *The number of Dedicated Hosts the reservation is associated with.
*/ - Description?: string; + Count?: number; + + /** + *The currency in which the upfrontPrice and hourlyPrice
+ * amounts are specified. At this time, the only supported currency is
+ * USD.
Specifies whether enhanced networking with ENA is enabled.
+ *The length of the reservation's term, specified in seconds. Can be 31536000
+ * (1 year) | 94608000 (3 years).
The hypervisor type of the image.
+ *The date and time that the reservation ends.
*/ - Hypervisor?: HypervisorType | string; + End?: Date; /** - *The Amazon Web Services account alias (for example, amazon, self) or
- * the Amazon Web Services account ID of the AMI owner.
The IDs of the Dedicated Hosts associated with the reservation.
*/ - ImageOwnerAlias?: string; + HostIdSet?: string[]; /** - *The name of the AMI that was provided during image creation.
+ *The ID of the reservation that specifies the associated Dedicated Hosts.
*/ - Name?: string; + HostReservationId?: string; /** - *The device name of the root device volume (for example, /dev/sda1).
The hourly price of the reservation.
*/ - RootDeviceName?: string; + HourlyPrice?: string; /** - *The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
+ *The instance family of the Dedicated Host Reservation. The instance family on the + * Dedicated Host must be the same in order for it to benefit from the + * reservation.
*/ - RootDeviceType?: DeviceType | string; + InstanceFamily?: string; /** - *Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
+ *The ID of the reservation. This remains the same regardless of which Dedicated + * Hosts are associated with it.
*/ - SriovNetSupport?: string; + OfferingId?: string; /** - *The reason for the state change.
+ *The payment option selected for this reservation.
*/ - StateReason?: StateReason; + PaymentOption?: PaymentOption | string; /** - *Any tags assigned to the image.
+ *The date and time that the reservation started.
*/ - Tags?: Tag[]; + Start?: Date; /** - *The type of virtualization of the AMI.
+ *The state of the reservation.
*/ - VirtualizationType?: VirtualizationType | string; + State?: ReservationState | string; /** - *The boot mode of the image. For more information, see Boot modes in the - * Amazon Elastic Compute Cloud User Guide.
+ *The upfront price of the reservation.
*/ - BootMode?: BootModeValues | string; + UpfrontPrice?: string; /** - *The date and time to deprecate the AMI, in UTC, in the following format: - * YYYY-MM-DDTHH:MM:SSZ. - * If you specified a value for seconds, Amazon EC2 rounds the seconds to the - * nearest minute.
+ *Any tags assigned to the Dedicated Host Reservation.
*/ - DeprecationTime?: string; + Tags?: Tag[]; } -export namespace Image { +export namespace HostReservation { /** * @internal */ - export const filterSensitiveLog = (obj: Image): any => ({ + export const filterSensitiveLog = (obj: HostReservation): any => ({ ...obj, }); } -export interface DescribeImagesResult { +export interface DescribeHostReservationsResult { + /** + *Details about the reservation's configuration.
+ */ + HostReservationSet?: HostReservation[]; + /** - *Information about the images.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Filter tasks using the task-state filter and one of the following values: active,
- * completed, deleting, or deleted.
The filters.
+ *
+ * auto-placement - Whether auto-placement is enabled or disabled
+ * (on | off).
+ * availability-zone - The Availability Zone of the
+ * host.
+ * client-token - The idempotency token that you provided when you
+ * allocated the host.
+ * host-reservation-id - The ID of the reservation assigned to
+ * this host.
+ * instance-type - The instance type size that the Dedicated Host
+ * is configured to support.
+ * state - The allocation state of the Dedicated Host
+ * (available | under-assessment |
+ * permanent-failure | released |
+ * released-permanent-failure).
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The IDs of the import image tasks.
+ *The IDs of the Dedicated Hosts. The IDs are used for targeted instance + * launches.
*/ - ImportTaskIds?: string[]; + HostIds?: string[]; /** - *The maximum number of results to return in a single call.
+ *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
You cannot specify this parameter and the host IDs parameter in the same request.
*/ MaxResults?: number; /** - *A token that indicates the next page of results.
+ *The token to use to retrieve the next page of results.
*/ NextToken?: string; } -export namespace DescribeImportImageTasksRequest { +export namespace DescribeHostsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeImportImageTasksRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeHostsRequest): any => ({ ...obj, }); } /** - *The response information for license configurations.
+ *Information about the number of instances that can be launched onto the Dedicated + * Host.
*/ -export interface ImportImageLicenseConfigurationResponse { +export interface InstanceCapacity { /** - *The ARN of a license configuration.
+ *The number of instances that can be launched onto the Dedicated Host based on the + * host's available capacity.
+ */ + AvailableCapacity?: number; + + /** + *The instance type supported by the Dedicated Host.
+ */ + InstanceType?: string; + + /** + *The total number of instances that can be launched onto the Dedicated Host if there + * are no instances running on it.
*/ - LicenseConfigurationArn?: string; + TotalCapacity?: number; } -export namespace ImportImageLicenseConfigurationResponse { +export namespace InstanceCapacity { /** * @internal */ - export const filterSensitiveLog = (obj: ImportImageLicenseConfigurationResponse): any => ({ + export const filterSensitiveLog = (obj: InstanceCapacity): any => ({ ...obj, }); } diff --git a/clients/client-ec2/src/models/models_3.ts b/clients/client-ec2/src/models/models_3.ts index 4bc429c50972..42799994a9fe 100644 --- a/clients/client-ec2/src/models/models_3.ts +++ b/clients/client-ec2/src/models/models_3.ts @@ -2,41 +2,42 @@ import { _InstanceType, ActiveInstance, ActivityStatus, + AllocationState, AllocationStrategy, + AllowsMultipleInstanceTypes, AlternatePathHint, AttachmentStatus, AttributeValue, + AutoPlacement, BatchState, - BlockDeviceMapping, CurrencyCodeValues, FleetLaunchTemplateSpecification, FleetType, + HostRecovery, IamInstanceProfile, + IamInstanceProfileAssociation, IamInstanceProfileSpecification, InstanceEventWindow, IpPermission, Placement, - PlatformValues, ReservedInstancesListing, ResourceType, SecurityGroupRule, Subnet, Tag, TagSpecification, + TargetCapacityUnitType, Tenancy, - TransitGatewayAssociationState, - TransitGatewayAttachmentResourceType, - TransitGatewayAttachmentState, - TransitGatewayPeeringAttachment, - TransitGatewayVpcAttachment, UserIdGroupPair, } from "./models_0"; import { + BlockDeviceMapping, CapacityReservationPreference, CapacityReservationTargetResponse, GroupIdentifier, InstanceInterruptionBehavior, InstanceIpv6Address, + InstanceRequirements, InternetGateway, Ipv4PrefixSpecificationRequest, Ipv6PrefixSpecificationRequest, @@ -53,6 +54,7 @@ import { NetworkInterfacePermission, NetworkInterfaceStatus, PlacementGroup, + PlatformValues, PortRange, PrivateIpAddressSpecification, ReplaceRootVolumeTask, @@ -61,4065 +63,3522 @@ import { SpotDatafeedSubscription, SpotInstanceStateFault, SpotInstanceType, - TrafficMirrorFilter, - TrafficMirrorSession, - TrafficMirrorTarget, - TransitGateway, - TransitGatewayConnect, - TransitGatewayConnectPeer, - TransitGatewayMulticastDomain, - TransitGatewayRouteTable, } from "./models_1"; import { - ArchitectureValues, - BootModeValues, - DeviceType, EventInformation, Filter, - HypervisorType, IdFormat, - ImportImageLicenseConfigurationResponse, + InstanceCapacity, InstanceTagNotificationAttribute, PermissionGroup, ProductCode, - StateReason, - VirtualizationType, } from "./models_2"; /** - *Describes the Amazon S3 bucket for the disk image.
+ *The capacity information for instances that can be launched onto the Dedicated Host.
*/ -export interface UserBucketDetails { +export interface AvailableCapacity { /** - *The Amazon S3 bucket from which the disk image was created.
+ *The number of instances that can be launched onto the Dedicated Host depending on + * the host's available capacity. For Dedicated Hosts that support multiple instance types, + * this parameter represents the number of instances for each instance size that is + * supported on the host.
*/ - S3Bucket?: string; + AvailableInstanceCapacity?: InstanceCapacity[]; /** - *The file name of the disk image.
+ *The number of vCPUs available for launching instances onto the Dedicated Host.
*/ - S3Key?: string; + AvailableVCpus?: number; } -export namespace UserBucketDetails { +export namespace AvailableCapacity { /** * @internal */ - export const filterSensitiveLog = (obj: UserBucketDetails): any => ({ + export const filterSensitiveLog = (obj: AvailableCapacity): any => ({ ...obj, }); } /** - *Describes the snapshot created from the imported disk.
+ *Describes the properties of a Dedicated Host.
*/ -export interface SnapshotDetail { - /** - *A description for the snapshot.
- */ - Description?: string; - +export interface HostProperties { /** - *The block device mapping for the snapshot.
+ *The number of cores on the Dedicated Host.
*/ - DeviceName?: string; + Cores?: number; /** - *The size of the disk in the snapshot, in GiB.
+ *The instance type supported by the Dedicated Host. For example, m5.large.
+ * If the host supports multiple instance types, no instanceType
+ * is returned.
The format of the disk image from which the snapshot is created.
+ *The instance family supported by the Dedicated Host. For example, m5.
The percentage of progress for the task.
+ *The number of sockets on the Dedicated Host.
*/ - Progress?: string; + Sockets?: number; /** - *The snapshot ID of the disk being imported.
+ *The total number of vCPUs on the Dedicated Host.
*/ - SnapshotId?: string; + TotalVCpus?: number; +} +export namespace HostProperties { /** - *A brief status of the snapshot creation.
+ * @internal */ - Status?: string; + export const filterSensitiveLog = (obj: HostProperties): any => ({ + ...obj, + }); +} +/** + *Describes an instance running on a Dedicated Host.
+ */ +export interface HostInstance { /** - *A detailed status message for the snapshot creation.
+ *The ID of instance that is running on the Dedicated Host.
*/ - StatusMessage?: string; + InstanceId?: string; /** - *The URL used to access the disk image.
+ *The instance type (for example, m3.medium) of the running instance.
The Amazon S3 bucket for the disk image.
+ *The ID of the Amazon Web Services account that owns the instance.
*/ - UserBucket?: UserBucketDetails; + OwnerId?: string; } -export namespace SnapshotDetail { +export namespace HostInstance { /** * @internal */ - export const filterSensitiveLog = (obj: SnapshotDetail): any => ({ + export const filterSensitiveLog = (obj: HostInstance): any => ({ ...obj, }); } /** - *Describes an import image task.
+ *Describes the properties of the Dedicated Host.
*/ -export interface ImportImageTask { +export interface Host { /** - *The architecture of the virtual machine.
- *Valid values: i386 | x86_64 | arm64
- *
Whether auto-placement is on or off.
*/ - Architecture?: string; + AutoPlacement?: AutoPlacement | string; /** - *A description of the import task.
+ *The Availability Zone of the Dedicated Host.
*/ - Description?: string; + AvailabilityZone?: string; /** - *Indicates whether the image is encrypted.
+ *Information about the instances running on the Dedicated Host.
*/ - Encrypted?: boolean; + AvailableCapacity?: AvailableCapacity; /** - *The target hypervisor for the import task.
- *Valid values: xen
- *
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
*/ - Hypervisor?: string; + ClientToken?: string; /** - *The ID of the Amazon Machine Image (AMI) of the imported virtual machine.
+ *The ID of the Dedicated Host.
*/ - ImageId?: string; + HostId?: string; /** - *The ID of the import image task.
+ *The hardware specifications of the Dedicated Host.
*/ - ImportTaskId?: string; + HostProperties?: HostProperties; /** - *The identifier for the KMS key that was used to create the encrypted image.
+ *The reservation ID of the Dedicated Host. This returns a null response
+ * if the Dedicated Host doesn't have an associated reservation.
The license type of the virtual machine.
+ *The IDs and instance type that are currently running on the Dedicated + * Host.
*/ - LicenseType?: string; + Instances?: HostInstance[]; /** - *The description string for the import image task.
+ *The Dedicated Host's state.
*/ - Platform?: string; + State?: AllocationState | string; /** - *The percentage of progress of the import image task.
+ *The time that the Dedicated Host was allocated.
*/ - Progress?: string; + AllocationTime?: Date; /** - *Information about the snapshots.
+ *The time that the Dedicated Host was released.
*/ - SnapshotDetails?: SnapshotDetail[]; + ReleaseTime?: Date; /** - *A brief status for the import image task.
+ *Any tags assigned to the Dedicated Host.
*/ - Status?: string; + Tags?: Tag[]; /** - *A descriptive status message for the import image task.
+ *Indicates whether host recovery is enabled or disabled for the Dedicated Host.
*/ - StatusMessage?: string; + HostRecovery?: HostRecovery | string; /** - *The tags for the import image task.
+ *Indicates whether the Dedicated Host supports multiple instance types of the same instance family.
+ * If the value is on, the Dedicated Host supports multiple instance types in the instance family.
+ * If the value is off, the Dedicated Host supports a single instance type only.
The ARNs of the license configurations that are associated with the import image task.
+ *The ID of the Amazon Web Services account that owns the Dedicated Host.
*/ - LicenseSpecifications?: ImportImageLicenseConfigurationResponse[]; + OwnerId?: string; /** - *The usage operation value.
+ *The ID of the Availability Zone in which the Dedicated Host is allocated.
*/ - UsageOperation?: string; + AvailabilityZoneId?: string; /** - *The boot mode of the virtual machine.
+ *Indicates whether the Dedicated Host is in a host resource group. If
+ * memberOfServiceLinkedResourceGroup is
+ * true, the host is in a host resource group; otherwise, it is not.
A list of zero or more import image tasks that are currently active or were completed or canceled in the - * previous 7 days.
+ *Information about the Dedicated Hosts.
*/ - ImportImageTasks?: ImportImageTask[]; + Hosts?: Host[]; /** - *The token to use to get the next page of results. This value is null when there are no more results
- * to return.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without 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 IAM instance profile associations.
*/ - DryRun?: boolean; + AssociationIds?: string[]; /** *The filters.
+ *
+ * instance-id - The ID of the instance.
+ * state - The state of the association (associating |
+ * associated | disassociating).
A list of import snapshot task IDs.
- */ - ImportTaskIds?: string[]; - - /** - *The maximum number of results to return in a single call. To retrieve the remaining results, make another call
- * with the returned NextToken value.
The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another call with the returned NextToken value.
A token that indicates the next page of results.
+ *The token to request the next page of results.
*/ NextToken?: string; } -export namespace DescribeImportSnapshotTasksRequest { +export namespace DescribeIamInstanceProfileAssociationsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeImportSnapshotTasksRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeIamInstanceProfileAssociationsRequest): any => ({ ...obj, }); } -/** - *Details about the import snapshot task.
- */ -export interface SnapshotTaskDetail { +export interface DescribeIamInstanceProfileAssociationsResult { /** - *The description of the snapshot.
+ *Information about the IAM instance profile associations.
*/ - Description?: string; + IamInstanceProfileAssociations?: IamInstanceProfileAssociation[]; /** - *The size of the disk in the snapshot, in GiB.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Indicates whether the snapshot is encrypted.
+ * @internal */ - Encrypted?: boolean; + export const filterSensitiveLog = (obj: DescribeIamInstanceProfileAssociationsResult): any => ({ + ...obj, + }); +} +export interface DescribeIdentityIdFormatRequest { /** - *The format of the disk image from which the snapshot is created.
+ *The ARN of the principal, which can be an IAM role, IAM user, or the root user.
*/ - Format?: string; + PrincipalArn: string | undefined; /** - *The identifier for the KMS key that was used to create the encrypted snapshot.
+ *The type of resource: bundle |
+ * conversion-task | customer-gateway | dhcp-options |
+ * elastic-ip-allocation | elastic-ip-association |
+ * export-task | flow-log | image |
+ * import-task | instance | internet-gateway |
+ * network-acl | network-acl-association |
+ * network-interface | network-interface-attachment |
+ * prefix-list | reservation | route-table |
+ * route-table-association | security-group |
+ * snapshot | subnet |
+ * subnet-cidr-block-association | volume | vpc
+ * | vpc-cidr-block-association | vpc-endpoint |
+ * vpc-peering-connection | vpn-connection | vpn-gateway
+ *
The percentage of completion for the import snapshot task.
+ * @internal */ - Progress?: string; + export const filterSensitiveLog = (obj: DescribeIdentityIdFormatRequest): any => ({ + ...obj, + }); +} +export interface DescribeIdentityIdFormatResult { /** - *The snapshot ID of the disk being imported.
+ *Information about the ID format for the resources.
*/ - SnapshotId?: string; + Statuses?: IdFormat[]; +} +export namespace DescribeIdentityIdFormatResult { /** - *A brief status for the import snapshot task.
+ * @internal */ - Status?: string; + export const filterSensitiveLog = (obj: DescribeIdentityIdFormatResult): any => ({ + ...obj, + }); +} +export interface DescribeIdFormatRequest { /** - *A detailed status message for the import snapshot task.
+ *The type of resource: bundle |
+ * conversion-task | customer-gateway | dhcp-options |
+ * elastic-ip-allocation | elastic-ip-association |
+ * export-task | flow-log | image |
+ * import-task | instance | internet-gateway |
+ * network-acl | network-acl-association |
+ * network-interface | network-interface-attachment |
+ * prefix-list | reservation | route-table |
+ * route-table-association | security-group |
+ * snapshot | subnet |
+ * subnet-cidr-block-association | volume | vpc
+ * | vpc-cidr-block-association | vpc-endpoint |
+ * vpc-peering-connection | vpn-connection | vpn-gateway
+ *
The URL of the disk image from which the snapshot is created.
+ * @internal */ - Url?: string; + export const filterSensitiveLog = (obj: DescribeIdFormatRequest): any => ({ + ...obj, + }); +} +export interface DescribeIdFormatResult { /** - *The Amazon S3 bucket for the disk image.
+ *Information about the ID format for the resource.
*/ - UserBucket?: UserBucketDetails; + Statuses?: IdFormat[]; } -export namespace SnapshotTaskDetail { +export namespace DescribeIdFormatResult { /** * @internal */ - export const filterSensitiveLog = (obj: SnapshotTaskDetail): any => ({ + export const filterSensitiveLog = (obj: DescribeIdFormatResult): any => ({ ...obj, }); } +export type ImageAttributeName = + | "blockDeviceMapping" + | "bootMode" + | "description" + | "kernel" + | "launchPermission" + | "productCodes" + | "ramdisk" + | "sriovNetSupport"; + /** - *Describes an import snapshot task.
+ *Contains the parameters for DescribeImageAttribute.
*/ -export interface ImportSnapshotTask { - /** - *A description of the import snapshot task.
- */ - Description?: string; - +export interface DescribeImageAttributeRequest { /** - *The ID of the import snapshot task.
+ *The AMI attribute.
+ *
+ * Note: The blockDeviceMapping attribute is deprecated.
+ * Using this attribute returns the Client.AuthFailure error. To get information about
+ * the block device mappings for an AMI, use the DescribeImages action.
Describes an import snapshot task.
+ *The ID of the AMI.
*/ - SnapshotTaskDetail?: SnapshotTaskDetail; + ImageId: string | undefined; /** - *The tags for the import snapshot task.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a launch permission.
+ */ +export interface LaunchPermission { /** - *A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the - * previous 7 days.
+ *The name of the group.
*/ - ImportSnapshotTasks?: ImportSnapshotTask[]; + Group?: PermissionGroup | string; /** - *The token to use to get the next page of results. This value is null when there are no more results
- * to return.
The Amazon Web Services account ID.
+ *Constraints: Up to 10 000 account IDs can be specified in a single request.
*/ - NextToken?: string; + UserId?: string; } -export namespace DescribeImportSnapshotTasksResult { +export namespace LaunchPermission { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeImportSnapshotTasksResult): any => ({ + export const filterSensitiveLog = (obj: LaunchPermission): any => ({ ...obj, }); } -export type InstanceAttributeName = - | "blockDeviceMapping" - | "disableApiTermination" - | "ebsOptimized" - | "enaSupport" - | "enclaveOptions" - | "groupSet" - | "instanceInitiatedShutdownBehavior" - | "instanceType" - | "kernel" - | "productCodes" - | "ramdisk" - | "rootDeviceName" - | "sourceDestCheck" - | "sriovNetSupport" - | "userData"; - -export interface DescribeInstanceAttributeRequest { +/** + *Describes an image attribute.
+ */ +export interface ImageAttribute { /** - *The instance attribute.
- *Note: The enaSupport attribute is not supported at this time.
The block device mapping entries.
*/ - Attribute: InstanceAttributeName | string | undefined; + BlockDeviceMappings?: BlockDeviceMapping[]; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the AMI.
*/ - DryRun?: boolean; + ImageId?: string; /** - *The ID of the instance.
+ *The launch permissions.
*/ - InstanceId: string | undefined; -} + LaunchPermissions?: LaunchPermission[]; -export namespace DescribeInstanceAttributeRequest { /** - * @internal + *The product codes.
*/ - export const filterSensitiveLog = (obj: DescribeInstanceAttributeRequest): any => ({ - ...obj, - }); -} + ProductCodes?: ProductCode[]; -/** - *Describes a parameter used to set up an EBS volume in a block device mapping.
- */ -export interface EbsInstanceBlockDevice { /** - *The time stamp when the attachment initiated.
+ *A description for the AMI.
*/ - AttachTime?: Date; + Description?: AttributeValue; /** - *Indicates whether the volume is deleted on instance termination.
+ *The kernel ID.
*/ - DeleteOnTermination?: boolean; + KernelId?: AttributeValue; /** - *The attachment state.
+ *The RAM disk ID.
*/ - Status?: AttachmentStatus | string; + RamdiskId?: AttributeValue; /** - *The ID of the EBS volume.
+ *Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
*/ - VolumeId?: string; + SriovNetSupport?: AttributeValue; + + /** + *Describes a value for a resource attribute that is a String.
+ */ + BootMode?: AttributeValue; } -export namespace EbsInstanceBlockDevice { +export namespace ImageAttribute { /** * @internal */ - export const filterSensitiveLog = (obj: EbsInstanceBlockDevice): any => ({ + export const filterSensitiveLog = (obj: ImageAttribute): any => ({ ...obj, }); } -/** - *Describes a block device mapping.
- */ -export interface InstanceBlockDeviceMapping { +export interface DescribeImagesRequest { /** - *The device name (for example, /dev/sdh or xvdh).
Scopes the images by users with explicit launch permissions.
+ * Specify an Amazon Web Services account ID, self (the sender of the request),
+ * or all (public AMIs).
Parameters used to automatically set up EBS volumes when the instance is - * launched.
+ *The filters.
+ *
+ * architecture - The image architecture (i386 |
+ * x86_64 | arm64).
+ * block-device-mapping.delete-on-termination - A Boolean value that indicates
+ * whether the Amazon EBS volume is deleted on instance termination.
+ * block-device-mapping.device-name - The device name specified in the block device mapping (for
+ * example, /dev/sdh or xvdh).
+ * block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS
+ * volume.
+ * block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
+ * block-device-mapping.volume-type - The volume type of the Amazon EBS volume
+ * (io1 | io2 | gp2 | gp3 | sc1
+ * | st1 | standard).
+ * block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
+ * description - The description of the image (provided during image
+ * creation).
+ * ena-support - A Boolean that indicates whether enhanced networking
+ * with ENA is enabled.
+ * hypervisor - The hypervisor type (ovm |
+ * xen).
+ * image-id - The ID of the image.
+ * image-type - The image type (machine | kernel |
+ * ramdisk).
+ * is-public - A Boolean that indicates whether the image is public.
+ * kernel-id - The kernel ID.
+ * manifest-location - The location of the image manifest.
+ * name - The name of the AMI (provided during image creation).
+ * owner-alias - The owner alias (amazon | aws-marketplace).
+ * The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be
+ * set using the IAM console. We recommend that you use the Owner
+ * request parameter instead of this filter.
+ * owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the
+ * Owner request parameter instead of this filter.
+ * platform - The platform. To only list Windows-based AMIs, use
+ * windows.
+ * product-code - The product code.
+ * product-code.type - The type of the product code (marketplace).
+ * ramdisk-id - The RAM disk ID.
+ * root-device-name - The device name of the root device volume (for example, /dev/sda1).
+ * root-device-type - The type of the root device volume (ebs |
+ * instance-store).
+ * state - The state of the image (available | pending
+ * | failed).
+ * state-reason-code - The reason code for the state change.
+ * state-reason-message - The message for the state change.
+ * sriov-net-support - A value of simple indicates
+ * that enhanced networking with the Intel 82599 VF interface is enabled.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * virtualization-type - The virtualization type (paravirtual |
+ * hvm).
The image IDs.
+ *Default: Describes all images available to you.
*/ - export const filterSensitiveLog = (obj: InstanceBlockDeviceMapping): any => ({ - ...obj, - }); -} + ImageIds?: string[]; -/** - *Describes a value for a resource attribute that is a Boolean value.
- */ -export interface AttributeBooleanValue { /** - *The attribute value. The valid values are true or false.
Scopes the results to images with the specified owners. You can specify a combination of
+ * Amazon Web Services account IDs, self, amazon, and aws-marketplace.
+ * If you omit this parameter, the results include all images for which you have launch permissions,
+ * regardless of ownership.
If true, all deprecated AMIs are included in the response. If
+ * false, no deprecated AMIs are included in the response. If no value is
+ * specified, the default value is false.
If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false) that you set for this parameter.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
+ *Describes a state change.
*/ -export interface EnclaveOptions { +export interface StateReason { /** - *If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves;
- * otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.
The reason code for the state change.
*/ - Enabled?: boolean; + Code?: string; + + /** + *The message for the state change.
+ *
+ * Server.InsufficientInstanceCapacity: There was insufficient
+ * capacity available to satisfy the launch request.
+ * Server.InternalError: An internal error caused the instance to
+ * terminate during launch.
+ * Server.ScheduledStop: The instance was stopped due to a scheduled
+ * retirement.
+ * Server.SpotInstanceShutdown: The instance was stopped because the
+ * number of Spot requests with a maximum price equal to or higher than the Spot
+ * price exceeded available capacity or because of an increase in the Spot
+ * price.
+ * Server.SpotInstanceTermination: The instance was terminated
+ * because the number of Spot requests with a maximum price equal to or higher than
+ * the Spot price exceeded available capacity or because of an increase in the Spot
+ * price.
+ * Client.InstanceInitiatedShutdown: The instance was shut down
+ * using the shutdown -h command from the instance.
+ * Client.InstanceTerminated: The instance was terminated or
+ * rebooted during AMI creation.
+ * Client.InternalError: A client error caused the instance to
+ * terminate during launch.
+ * Client.InvalidSnapshot.NotFound: The specified snapshot was not
+ * found.
+ * Client.UserInitiatedHibernate: Hibernation was initiated on the
+ * instance.
+ * Client.UserInitiatedShutdown: The instance was shut down using
+ * the Amazon EC2 API.
+ * Client.VolumeLimitExceeded: The limit on the number of EBS
+ * volumes or total storage was exceeded. Decrease usage or request an increase in
+ * your account limits.
Describes an instance attribute.
+ *Describes an image.
*/ -export interface InstanceAttribute { +export interface Image { /** - *The security groups associated with the instance.
+ *The architecture of the image.
*/ - Groups?: GroupIdentifier[]; + Architecture?: ArchitectureValues | string; /** - *The block device mapping of the instance.
+ *The date and time the image was created.
*/ - BlockDeviceMappings?: InstanceBlockDeviceMapping[]; + CreationDate?: string; /** - *If the value is true, you can't terminate the instance through the Amazon
- * EC2 console, CLI, or API; otherwise, you can.
The ID of the AMI.
*/ - DisableApiTermination?: AttributeBooleanValue; + ImageId?: string; /** - *Indicates whether enhanced networking with ENA is enabled.
+ *The location of the AMI.
*/ - EnaSupport?: AttributeBooleanValue; + ImageLocation?: string; /** - *To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise,
- * set it to false.
The type of image.
*/ - EnclaveOptions?: EnclaveOptions; + ImageType?: ImageTypeValues | string; /** - *Indicates whether the instance is optimized for Amazon EBS I/O.
+ *Indicates whether the image has public launch permissions. The value is true if
+ * this image has public launch permissions or false
+ * if it has only implicit and explicit launch permissions.
The ID of the instance.
+ *The kernel associated with the image, if any. Only applicable for machine images.
*/ - InstanceId?: string; + KernelId?: string; /** - *Indicates whether an instance stops or terminates when you initiate shutdown from the - * instance (using the operating system command for system shutdown).
+ *The ID of the Amazon Web Services account that owns the image.
*/ - InstanceInitiatedShutdownBehavior?: AttributeValue; + OwnerId?: string; /** - *The instance type.
+ *This value is set to windows for Windows AMIs; otherwise, it is blank.
The kernel ID.
+ *The platform details associated with the billing code of the AMI. For more information, + * see Understanding + * AMI billing in the Amazon Elastic Compute Cloud User Guide.
*/ - KernelId?: AttributeValue; + PlatformDetails?: string; /** - *A list of product codes.
+ *The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
+ * usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price
+ * List API. You can view these fields on the Instances or
+ * AMIs pages in the Amazon EC2 console, or in the responses that are
+ * returned by the DescribeImages
+ * command in the Amazon EC2 API, or the describe-images
+ * command in the CLI.
Any product codes associated with the AMI.
*/ ProductCodes?: ProductCode[]; /** - *The RAM disk ID.
+ *The RAM disk associated with the image, if any. Only applicable for machine images.
*/ - RamdiskId?: AttributeValue; + RamdiskId?: string; /** - *The device name of the root device volume (for example,
- * /dev/sda1).
The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
Enable or disable source/destination checks, which ensure that the instance
- * is either the source or the destination of any traffic that it receives.
- * If the value is true, source/destination checks are enabled;
- * otherwise, they are disabled. The default value is true.
- * You must disable source/destination checks if the instance runs services
- * such as network address translation, routing, or firewalls.
Any block device mapping entries.
*/ - SourceDestCheck?: AttributeBooleanValue; + BlockDeviceMappings?: BlockDeviceMapping[]; /** - *Indicates whether enhanced networking with the Intel 82599 Virtual Function interface - * is enabled.
+ *The description of the AMI that was provided during image creation.
*/ - SriovNetSupport?: AttributeValue; + Description?: string; /** - *The user data.
+ *Specifies whether enhanced networking with ENA is enabled.
*/ - UserData?: AttributeValue; -} + EnaSupport?: boolean; -export namespace InstanceAttribute { /** - * @internal + *The hypervisor type of the image.
*/ - export const filterSensitiveLog = (obj: InstanceAttribute): any => ({ - ...obj, - }); -} + Hypervisor?: HypervisorType | string; -export interface DescribeInstanceCreditSpecificationsRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The Amazon Web Services account alias (for example, amazon, self) or
+ * the Amazon Web Services account ID of the AMI owner.
The filters.
- *
- * instance-id - The ID of the instance.
The name of the AMI that was provided during image creation.
*/ - Filters?: Filter[]; + Name?: string; /** - *The instance IDs.
- *Default: Describes all your instances.
- *Constraints: Maximum 1000 explicitly specified instance IDs.
+ *The device name of the root device volume (for example, /dev/sda1).
The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another call with the returned NextToken value. This value
- * can be between 5 and 1000. You cannot specify this parameter and the instance IDs
- * parameter in the same call.
The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
*/ - MaxResults?: number; + RootDeviceType?: DeviceType | string; /** - *The token to retrieve the next page of results.
+ *Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
*/ - NextToken?: string; -} + SriovNetSupport?: string; -export namespace DescribeInstanceCreditSpecificationsRequest { /** - * @internal + *The reason for the state change.
*/ - export const filterSensitiveLog = (obj: DescribeInstanceCreditSpecificationsRequest): any => ({ - ...obj, - }); -} + StateReason?: StateReason; -/** - *Describes the credit option for CPU usage of a burstable performance instance.
- */ -export interface InstanceCreditSpecification { /** - *The ID of the instance.
+ *Any tags assigned to the image.
*/ - InstanceId?: string; + Tags?: Tag[]; /** - *The credit option for CPU usage of the instance. Valid values are
- * standard and unlimited.
The type of virtualization of the AMI.
*/ - CpuCredits?: string; + VirtualizationType?: VirtualizationType | string; + + /** + *The boot mode of the image. For more information, see Boot modes in the + * Amazon Elastic Compute Cloud User Guide.
+ */ + BootMode?: BootModeValues | string; + + /** + *The date and time to deprecate the AMI, in UTC, in the following format: + * YYYY-MM-DDTHH:MM:SSZ. + * If you specified a value for seconds, Amazon EC2 rounds the seconds to the + * nearest minute.
+ */ + DeprecationTime?: string; } -export namespace InstanceCreditSpecification { +export namespace Image { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceCreditSpecification): any => ({ + export const filterSensitiveLog = (obj: Image): any => ({ ...obj, }); } -export interface DescribeInstanceCreditSpecificationsResult { - /** - *Information about the credit option for CPU usage of an instance.
- */ - InstanceCreditSpecifications?: InstanceCreditSpecification[]; - +export interface DescribeImagesResult { /** - *The token to use to retrieve the next page of results. This value is null
- * when there are no more results to return.
Information about the images.
*/ - NextToken?: string; + Images?: Image[]; } -export namespace DescribeInstanceCreditSpecificationsResult { +export namespace DescribeImagesResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeInstanceCreditSpecificationsResult): any => ({ + export const filterSensitiveLog = (obj: DescribeImagesResult): any => ({ ...obj, }); } -export interface DescribeInstanceEventNotificationAttributesRequest { +export interface DescribeImportImageTasksRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
Filter tasks using the task-state filter and one of the following values: active,
+ * completed, deleting, or deleted.
The IDs of the import image tasks.
+ */ + ImportTaskIds?: string[]; + + /** + *The maximum number of results to return in a single call.
+ */ + MaxResults?: number; + + /** + *A token that indicates the next page of results.
+ */ + NextToken?: string; } -export namespace DescribeInstanceEventNotificationAttributesRequest { +export namespace DescribeImportImageTasksRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeInstanceEventNotificationAttributesRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeImportImageTasksRequest): any => ({ ...obj, }); } -export interface DescribeInstanceEventNotificationAttributesResult { +/** + *The response information for license configurations.
+ */ +export interface ImportImageLicenseConfigurationResponse { /** - *Information about the registered tag keys.
+ *The ARN of a license configuration.
*/ - InstanceTagAttribute?: InstanceTagNotificationAttribute; + LicenseConfigurationArn?: string; } -export namespace DescribeInstanceEventNotificationAttributesResult { +export namespace ImportImageLicenseConfigurationResponse { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeInstanceEventNotificationAttributesResult): any => ({ + export const filterSensitiveLog = (obj: ImportImageLicenseConfigurationResponse): any => ({ ...obj, }); } /** - *Describes the Amazon S3 bucket for the disk image.
*/ -export interface DescribeInstanceEventWindowsRequest { +export interface UserBucketDetails { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The Amazon S3 bucket from which the disk image was created.
*/ - DryRun?: boolean; + S3Bucket?: string; /** - *The IDs of the event windows.
+ *The file name of the disk image.
*/ - InstanceEventWindowIds?: string[]; + S3Key?: string; +} +export namespace UserBucketDetails { /** - *One or more filters.
- *
- * dedicated-host-id - The event windows associated with the specified
- * Dedicated Host ID.
- * event-window-name - The event windows associated with the specified
- * names.
- * instance-id - The event windows associated with the specified instance
- * ID.
- * instance-tag - The event windows associated with the specified tag and
- * value.
- * instance-tag-key - The event windows associated with the specified tag
- * key, regardless of the value.
- * instance-tag-value - The event windows associated with the specified tag
- * value, regardless of the key.
- * tag: - The key/value combination of a tag assigned to the
- * event window. Use the tag key in the filter name and the tag value as the filter
- * value. For example, to find all resources that have a tag with the key
- * Owner and the value CMX, specify tag:Owner
- * for the filter name and CMX for the filter value.
- * tag-key - The key of a tag assigned to the event window. Use this filter
- * to find all event windows that have a tag with a specific key, regardless of the tag
- * value.
- * tag-value - The value of a tag assigned to the event window. Use this
- * filter to find all event windows that have a tag with a specific value, regardless of
- * the tag key.
Describes the snapshot created from the imported disk.
+ */ +export interface SnapshotDetail { /** - *The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another call with the returned NextToken value. This value can
- * be between 20 and 500. You cannot specify this parameter and the event window IDs parameter
- * in the same call.
A description for the snapshot.
*/ - MaxResults?: number; + Description?: string; /** - *The token to request the next page of results.
+ *The block device mapping for the snapshot.
*/ - NextToken?: string; -} + DeviceName?: string; -export namespace DescribeInstanceEventWindowsRequest { /** - * @internal + *The size of the disk in the snapshot, in GiB.
*/ - export const filterSensitiveLog = (obj: DescribeInstanceEventWindowsRequest): any => ({ - ...obj, - }); -} + DiskImageSize?: number; -export interface DescribeInstanceEventWindowsResult { /** - *Information about the event windows.
+ *The format of the disk image from which the snapshot is created.
*/ - InstanceEventWindows?: InstanceEventWindow[]; + Format?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The percentage of progress for the task.
*/ - NextToken?: string; -} + Progress?: string; -export namespace DescribeInstanceEventWindowsResult { /** - * @internal + *The snapshot ID of the disk being imported.
*/ - export const filterSensitiveLog = (obj: DescribeInstanceEventWindowsResult): any => ({ - ...obj, - }); -} + SnapshotId?: string; -export interface DescribeInstancesRequest { /** - *The filters.
- *
- * affinity - The affinity setting for an instance running on a
- * Dedicated Host (default | host).
- * architecture - The instance architecture (i386 |
- * x86_64 | arm64).
- * availability-zone - The Availability Zone of the instance.
- * block-device-mapping.attach-time - The attach time for an EBS
- * volume mapped to the instance, for example,
- * 2010-09-15T17:15:20.000Z.
- * block-device-mapping.delete-on-termination - A Boolean that
- * indicates whether the EBS volume is deleted on instance termination.
- * block-device-mapping.device-name - The device name specified in the
- * block device mapping (for example, /dev/sdh or
- * xvdh).
- * block-device-mapping.status - The status for the EBS volume
- * (attaching | attached | detaching |
- * detached).
- * block-device-mapping.volume-id - The volume ID of the EBS
- * volume.
- * client-token - The idempotency token you provided when you launched
- * the instance.
- * dns-name - The public DNS name of the instance.
- * group-id - The ID of the security group for the instance.
- * EC2-Classic only.
- * group-name - The name of the security group for the instance.
- * EC2-Classic only.
- * hibernation-options.configured - A Boolean that indicates whether
- * the instance is enabled for hibernation. A value of true means that
- * the instance is enabled for hibernation.
- * host-id - The ID of the Dedicated Host on which the instance is
- * running, if applicable.
- * hypervisor - The hypervisor type of the instance
- * (ovm | xen). The value xen
- * is used for both Xen and Nitro hypervisors.
- * iam-instance-profile.arn - The instance profile associated with
- * the instance. Specified as an ARN.
- * image-id - The ID of the image used to launch the
- * instance.
- * instance-id - The ID of the instance.
- * instance-lifecycle - Indicates whether this is a Spot Instance or
- * a Scheduled Instance (spot | scheduled).
- * instance-state-code - The state of the instance, as a 16-bit
- * unsigned integer. The high byte is used for internal purposes and should be
- * ignored. The low byte is set based on the state represented. The valid values
- * are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64
- * (stopping), and 80 (stopped).
- * instance-state-name - The state of the instance
- * (pending | running | shutting-down |
- * terminated | stopping |
- * stopped).
- * instance-type - The type of instance (for example,
- * t2.micro).
- * instance.group-id - The ID of the security group for the
- * instance.
- * instance.group-name - The name of the security group for the
- * instance.
- * ip-address - The public IPv4 address of the instance.
- * kernel-id - The kernel ID.
- * key-name - The name of the key pair used when the instance was
- * launched.
- * launch-index - When launching multiple instances, this is the
- * index for the instance in the launch group (for example, 0, 1, 2, and so on).
- * launch-time - The time when the instance was launched.
- * metadata-options.http-tokens - The metadata request authorization
- * state (optional | required)
- * metadata-options.http-put-response-hop-limit - The http metadata
- * request put response hop limit (integer, possible values 1 to
- * 64)
- * metadata-options.http-endpoint - Enable or disable metadata
- * access on http endpoint (enabled | disabled)
- * monitoring-state - Indicates whether detailed monitoring is
- * enabled (disabled | enabled).
- * network-interface.addresses.private-ip-address - The private IPv4
- * address associated with the network interface.
- * network-interface.addresses.primary - Specifies whether the IPv4
- * address of the network interface is the primary private IPv4 address.
- * network-interface.addresses.association.public-ip - The ID of the
- * association of an Elastic IP address (IPv4) with a network interface.
- * network-interface.addresses.association.ip-owner-id - The owner
- * ID of the private IPv4 address associated with the network interface.
- * network-interface.association.public-ip - The address of the
- * Elastic IP address (IPv4) bound to the network interface.
- * network-interface.association.ip-owner-id - The owner of the
- * Elastic IP address (IPv4) associated with the network interface.
- * network-interface.association.allocation-id - The allocation ID
- * returned when you allocated the Elastic IP address (IPv4) for your network
- * interface.
- * network-interface.association.association-id - The association ID
- * returned when the network interface was associated with an IPv4 address.
- * network-interface.attachment.attachment-id - The ID of the
- * interface attachment.
- * network-interface.attachment.instance-id - The ID of the instance
- * to which the network interface is attached.
- * network-interface.attachment.instance-owner-id - The owner ID of
- * the instance to which the network interface is attached.
- * network-interface.attachment.device-index - The device index to
- * which the network interface is attached.
- * network-interface.attachment.status - The status of the
- * attachment (attaching | attached |
- * detaching | detached).
- * network-interface.attachment.attach-time - The time that the
- * network interface was attached to an instance.
- * network-interface.attachment.delete-on-termination - Specifies
- * whether the attachment is deleted when an instance is terminated.
- * network-interface.availability-zone - The Availability Zone for
- * the network interface.
- * network-interface.description - The description of the network
- * interface.
- * network-interface.group-id - The ID of a security group
- * associated with the network interface.
- * network-interface.group-name - The name of a security group
- * associated with the network interface.
- * network-interface.ipv6-addresses.ipv6-address - The IPv6 address
- * associated with the network interface.
- * network-interface.mac-address - The MAC address of the network
- * interface.
- * network-interface.network-interface-id - The ID of the network
- * interface.
- * network-interface.owner-id - The ID of the owner of the network
- * interface.
- * network-interface.private-dns-name - The private DNS name of the
- * network interface.
- * network-interface.requester-id - The requester ID for the network
- * interface.
- * network-interface.requester-managed - Indicates whether the
- * network interface is being managed by Amazon Web Services.
- * network-interface.status - The status of the network interface
- * (available) | in-use).
- * network-interface.source-dest-check - Whether the network
- * interface performs source/destination checking. A value of true
- * means that checking is enabled, and false means that checking is
- * disabled. The value must be false for the network interface to
- * perform network address translation (NAT) in your VPC.
- * network-interface.subnet-id - The ID of the subnet for the
- * network interface.
- * network-interface.vpc-id - The ID of the VPC for the network
- * interface.
- * outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
- * owner-id - The Amazon Web Services account ID of the instance owner.
- * placement-group-name - The name of the placement group for the
- * instance.
- * placement-partition-number - The partition in which the instance is
- * located.
- * platform - The platform. To list only Windows instances, use
- * windows.
- * private-dns-name - The private IPv4 DNS name of the
- * instance.
- * private-ip-address - The private IPv4 address of the
- * instance.
- * product-code - The product code associated with the AMI used to
- * launch the instance.
- * product-code.type - The type of product code (devpay |
- * marketplace).
- * ramdisk-id - The RAM disk ID.
- * reason - The reason for the current state of the instance (for
- * example, shows "User Initiated [date]" when you stop or terminate the instance).
- * Similar to the state-reason-code filter.
- * requester-id - The ID of the entity that launched the instance on
- * your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so
- * on).
- * reservation-id - The ID of the instance's reservation. A
- * reservation ID is created any time you launch an instance. A reservation ID has
- * a one-to-one relationship with an instance launch request, but can be associated
- * with more than one instance if you launch multiple instances using the same
- * launch request. For example, if you launch one instance, you get one reservation
- * ID. If you launch ten instances using the same launch request, you also get one
- * reservation ID.
- * root-device-name - The device name of the root device volume (for
- * example, /dev/sda1).
- * root-device-type - The type of the root device volume
- * (ebs | instance-store).
- * source-dest-check - Indicates whether the instance performs
- * source/destination checking. A value of true means that checking is
- * enabled, and false means that checking is disabled. The value must
- * be false for the instance to perform network address translation
- * (NAT) in your VPC.
- * spot-instance-request-id - The ID of the Spot Instance
- * request.
- * state-reason-code - The reason code for the state change.
- * state-reason-message - A message that describes the state
- * change.
- * subnet-id - The ID of the subnet for the instance.
- * tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.
- * For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
- * tenancy - The tenancy of an instance (dedicated |
- * default | host).
- * virtualization-type - The virtualization type of the instance
- * (paravirtual | hvm).
- * vpc-id - The ID of the VPC that the instance is running in.
The instance IDs.
- *Default: Describes all your instances.
- */ - InstanceIds?: string[]; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another call with the returned NextToken value. This value
- * can be between 5 and 1000. You cannot specify this parameter and the instance IDs
- * parameter in the same call.
The token to request the next page of results.
- */ - NextToken?: string; -} - -export namespace DescribeInstancesRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribeInstancesRequest): any => ({ - ...obj, - }); -} - -/** - *Describes the instance's Capacity Reservation targeting preferences. The action returns the
- * capacityReservationPreference response element if the instance is
- * configured to run in On-Demand capacity, or if it is configured in run in any
- * open Capacity Reservation that has matching attributes (instance type, platform,
- * Availability Zone). The action returns the capacityReservationTarget
- * response element if the instance explicily targets a specific Capacity Reservation or Capacity Reservation group.
Describes the instance's Capacity Reservation preferences. Possible preferences include:
- *
- * open - The instance can run in any open Capacity Reservation that
- * has matching attributes (instance type, platform, Availability Zone).
- * none - The instance avoids running in a Capacity Reservation even if one is
- * available. The instance runs in On-Demand capacity.
Information about the targeted Capacity Reservation or Capacity Reservation group.
- */ - CapacityReservationTarget?: CapacityReservationTargetResponse; -} - -export namespace CapacityReservationSpecificationResponse { - /** - * @internal - */ - export const filterSensitiveLog = (obj: CapacityReservationSpecificationResponse): any => ({ - ...obj, - }); -} - -/** - *The CPU options for the instance.
- */ -export interface CpuOptions { - /** - *The number of CPU cores for the instance.
- */ - CoreCount?: number; - - /** - *The number of threads per CPU core.
- */ - ThreadsPerCore?: number; -} - -export namespace CpuOptions { - /** - * @internal - */ - export const filterSensitiveLog = (obj: CpuOptions): any => ({ - ...obj, - }); -} - -/** - *Describes the association between an instance and an Elastic Graphics accelerator.
- */ -export interface ElasticGpuAssociation { - /** - *The ID of the Elastic Graphics accelerator.
- */ - ElasticGpuId?: string; - - /** - *The ID of the association.
- */ - ElasticGpuAssociationId?: string; - - /** - *The state of the association between the instance and the - * Elastic Graphics accelerator.
- */ - ElasticGpuAssociationState?: string; - - /** - *The time the Elastic Graphics accelerator was associated with the instance.
- */ - ElasticGpuAssociationTime?: string; -} - -export namespace ElasticGpuAssociation { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ElasticGpuAssociation): any => ({ - ...obj, - }); -} - -/** - *- * Describes the association between an instance and an elastic inference accelerator. - *
- */ -export interface ElasticInferenceAcceleratorAssociation { - /** - *- * The Amazon Resource Name (ARN) of the elastic inference accelerator. - *
- */ - ElasticInferenceAcceleratorArn?: string; - - /** - *- * The ID of the association. - *
- */ - ElasticInferenceAcceleratorAssociationId?: string; - - /** - *- * The state of the elastic inference accelerator. - *
- */ - ElasticInferenceAcceleratorAssociationState?: string; - - /** - *- * The time at which the elastic inference accelerator is associated with an instance. - *
- */ - ElasticInferenceAcceleratorAssociationTime?: Date; -} - -export namespace ElasticInferenceAcceleratorAssociation { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ElasticInferenceAcceleratorAssociation): any => ({ - ...obj, - }); -} - -/** - *Indicates whether your instance is configured for hibernation. This parameter is valid - * only if the instance meets the hibernation - * prerequisites. For - * more information, see Hibernate your instance in the - * Amazon EC2 User Guide.
- */ -export interface HibernationOptions { - /** - *If this parameter is set to true, your instance is enabled for
- * hibernation; otherwise, it is not enabled for hibernation.
Describes a license configuration.
- */ -export interface LicenseConfiguration { - /** - *The Amazon Resource Name (ARN) of the license configuration.
- */ - LicenseConfigurationArn?: string; -} - -export namespace LicenseConfiguration { - /** - * @internal - */ - export const filterSensitiveLog = (obj: LicenseConfiguration): any => ({ - ...obj, - }); -} - -export type InstanceMetadataEndpointState = "disabled" | "enabled"; - -export enum InstanceMetadataProtocolState { - disabled = "disabled", - enabled = "enabled", -} - -export enum HttpTokensState { - optional = "optional", - required = "required", -} - -export type InstanceMetadataOptionsState = "applied" | "pending"; - -/** - *The metadata options for the instance.
- */ -export interface InstanceMetadataOptionsResponse { - /** - *The state of the metadata option changes.
- *
- * pending - The metadata options are being updated and the instance is not
- * ready to process metadata traffic with the new selection.
- * applied - The metadata options have been successfully applied on the
- * instance.
The state of token usage for your instance metadata requests. If the parameter is not
- * specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata
- * with or without a signed token header on your request. If you retrieve the IAM role
- * credentials without a token, the version 1.0 role credentials are returned. If you
- * retrieve the IAM role credentials using a valid signed token, the version 2.0 role
- * credentials are returned.
If the state is required, you must send a signed token header with any
- * instance metadata retrieval requests. In this state, retrieving the IAM role credential
- * always returns the version 2.0 credentials; the version 1.0 credentials are not
- * available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the - * number, the further instance metadata requests can travel.
- *Default: 1
- *Possible values: Integers from 1 to 64
- */ - HttpPutResponseHopLimit?: number; - - /** - *Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
- */ - HttpEndpoint?: InstanceMetadataEndpointState | string; - - /** - *Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
- */ - HttpProtocolIpv6?: InstanceMetadataProtocolState | string; -} - -export namespace InstanceMetadataOptionsResponse { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InstanceMetadataOptionsResponse): any => ({ - ...obj, - }); -} - -export type MonitoringState = "disabled" | "disabling" | "enabled" | "pending"; - -/** - *Describes the monitoring of an instance.
- */ -export interface Monitoring { - /** - *Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is - * enabled.
- */ - State?: MonitoringState | string; -} - -export namespace Monitoring { - /** - * @internal - */ - export const filterSensitiveLog = (obj: Monitoring): any => ({ - ...obj, - }); -} - -/** - *Describes association information for an Elastic IP address (IPv4).
- */ -export interface InstanceNetworkInterfaceAssociation { - /** - *The carrier IP address associated with the network interface.
- */ - CarrierIp?: string; - - /** - *The ID of the owner of the Elastic IP address.
- */ - IpOwnerId?: string; - - /** - *The public DNS name.
- */ - PublicDnsName?: string; - - /** - *The public IP address or Elastic IP address bound to the network interface.
- */ - PublicIp?: string; -} - -export namespace InstanceNetworkInterfaceAssociation { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InstanceNetworkInterfaceAssociation): any => ({ - ...obj, - }); -} - -/** - *Describes a network interface attachment.
- */ -export interface InstanceNetworkInterfaceAttachment { - /** - *The time stamp when the attachment initiated.
- */ - AttachTime?: Date; - - /** - *The ID of the network interface attachment.
- */ - AttachmentId?: string; - - /** - *Indicates whether the network interface is deleted when the instance is terminated.
- */ - DeleteOnTermination?: boolean; - - /** - *The index of the device on the instance for the network interface attachment.
- */ - DeviceIndex?: number; - - /** - *The attachment state.
- */ - Status?: AttachmentStatus | string; - - /** - *The index of the network card.
- */ - NetworkCardIndex?: number; -} - -export namespace InstanceNetworkInterfaceAttachment { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InstanceNetworkInterfaceAttachment): any => ({ - ...obj, - }); -} - -/** - *Information about an IPv4 prefix.
- */ -export interface InstanceIpv4Prefix { - /** - *One or more IPv4 prefixes assigned to the network interface.
- */ - Ipv4Prefix?: string; -} - -export namespace InstanceIpv4Prefix { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InstanceIpv4Prefix): any => ({ - ...obj, - }); -} - -/** - *Information about an IPv6 prefix.
- */ -export interface InstanceIpv6Prefix { - /** - *One or more IPv6 prefixes assigned to the network interface.
- */ - Ipv6Prefix?: string; -} - -export namespace InstanceIpv6Prefix { - /** - * @internal - */ - export const filterSensitiveLog = (obj: InstanceIpv6Prefix): any => ({ - ...obj, - }); -} - -/** - *Describes a private IPv4 address.
- */ -export interface InstancePrivateIpAddress { - /** - *The association information for an Elastic IP address for the network interface.
+ *A brief status of the snapshot creation.
*/ - Association?: InstanceNetworkInterfaceAssociation; + Status?: string; /** - *Indicates whether this IPv4 address is the primary private IP address of the network interface.
+ *A detailed status message for the snapshot creation.
*/ - Primary?: boolean; + StatusMessage?: string; /** - *The private IPv4 DNS name.
+ *The URL used to access the disk image.
*/ - PrivateDnsName?: string; + Url?: string; /** - *The private IPv4 address of the network interface.
+ *The Amazon S3 bucket for the disk image.
*/ - PrivateIpAddress?: string; + UserBucket?: UserBucketDetails; } -export namespace InstancePrivateIpAddress { +export namespace SnapshotDetail { /** * @internal */ - export const filterSensitiveLog = (obj: InstancePrivateIpAddress): any => ({ + export const filterSensitiveLog = (obj: SnapshotDetail): any => ({ ...obj, }); } /** - *Describes a network interface.
+ *Describes an import image task.
*/ -export interface InstanceNetworkInterface { - /** - *The association information for an Elastic IPv4 associated with the network - * interface.
- */ - Association?: InstanceNetworkInterfaceAssociation; - +export interface ImportImageTask { /** - *The network interface attachment.
+ *The architecture of the virtual machine.
+ *Valid values: i386 | x86_64 | arm64
+ *
The description.
+ *A description of the import task.
*/ Description?: string; /** - *One or more security groups.
- */ - Groups?: GroupIdentifier[]; - - /** - *One or more IPv6 addresses associated with the network interface.
- */ - Ipv6Addresses?: InstanceIpv6Address[]; - - /** - *The MAC address.
- */ - MacAddress?: string; - - /** - *The ID of the network interface.
- */ - NetworkInterfaceId?: string; - - /** - *The ID of the Amazon Web Services account that created the network interface.
- */ - OwnerId?: string; - - /** - *The private DNS name.
- */ - PrivateDnsName?: string; - - /** - *The IPv4 address of the network interface within the subnet.
- */ - PrivateIpAddress?: string; - - /** - *One or more private IPv4 addresses associated with the network interface.
- */ - PrivateIpAddresses?: InstancePrivateIpAddress[]; - - /** - *Indicates whether source/destination checking is enabled.
- */ - SourceDestCheck?: boolean; - - /** - *The status of the network interface.
- */ - Status?: NetworkInterfaceStatus | string; - - /** - *The ID of the subnet.
- */ - SubnetId?: string; - - /** - *The ID of the VPC.
+ *Indicates whether the image is encrypted.
*/ - VpcId?: string; + Encrypted?: boolean; /** - *Describes the type of network interface.
- *Valid values: interface | efa | trunk
+ *
The target hypervisor for the import task.
+ *Valid values: xen
*
The IPv4 delegated prefixes that are assigned to the network interface.
- */ - Ipv4Prefixes?: InstanceIpv4Prefix[]; - - /** - *The IPv6 delegated prefixes that are assigned to the network interface.
- */ - Ipv6Prefixes?: InstanceIpv6Prefix[]; -} + Hypervisor?: string; -export namespace InstanceNetworkInterface { /** - * @internal + *The ID of the Amazon Machine Image (AMI) of the imported virtual machine.
*/ - export const filterSensitiveLog = (obj: InstanceNetworkInterface): any => ({ - ...obj, - }); -} - -export type InstanceStateName = "pending" | "running" | "shutting-down" | "stopped" | "stopping" | "terminated"; - -/** - *Describes the current state of an instance.
- */ -export interface InstanceState { - /** - *The state of the instance as a 16-bit unsigned integer.
- *The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values - * between 256 and 65,535. These numerical values are used for internal purposes and should - * be ignored.
- *The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values - * between 0 and 255.
- *The valid values for instance-state-code will all be in the range of the low byte and - * they are:
- *
- * 0 : pending
- *
- * 16 : running
- *
- * 32 : shutting-down
- *
- * 48 : terminated
- *
- * 64 : stopping
- *
- * 80 : stopped
- *
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in - * decimal.
+ ImageId?: string; + + /** + *The ID of the import image task.
*/ - Code?: number; + ImportTaskId?: string; /** - *The current state of the instance.
+ *The identifier for the KMS key that was used to create the encrypted image.
*/ - Name?: InstanceStateName | string; -} + KmsKeyId?: string; -export namespace InstanceState { /** - * @internal + *The license type of the virtual machine.
*/ - export const filterSensitiveLog = (obj: InstanceState): any => ({ - ...obj, - }); -} + LicenseType?: string; -/** - *Describes an instance.
- */ -export interface Instance { /** - *The AMI launch index, which can be used to find this instance in the launch - * group.
+ *The description string for the import image task.
*/ - AmiLaunchIndex?: number; + Platform?: string; /** - *The ID of the AMI used to launch the instance.
+ *The percentage of progress of the import image task.
*/ - ImageId?: string; + Progress?: string; /** - *The ID of the instance.
+ *Information about the snapshots.
*/ - InstanceId?: string; + SnapshotDetails?: SnapshotDetail[]; /** - *The instance type.
+ *A brief status for the import image task.
*/ - InstanceType?: _InstanceType | string; + Status?: string; /** - *The kernel associated with this instance, if applicable.
+ *A descriptive status message for the import image task.
*/ - KernelId?: string; + StatusMessage?: string; /** - *The name of the key pair, if this instance was launched with an associated key - * pair.
+ *The tags for the import image task.
*/ - KeyName?: string; + Tags?: Tag[]; /** - *The time the instance was launched.
+ *The ARNs of the license configurations that are associated with the import image task.
*/ - LaunchTime?: Date; + LicenseSpecifications?: ImportImageLicenseConfigurationResponse[]; /** - *The monitoring for the instance.
+ *The usage operation value.
*/ - Monitoring?: Monitoring; + UsageOperation?: string; /** - *The location where the instance launched, if applicable.
+ *The boot mode of the virtual machine.
*/ - Placement?: Placement; + BootMode?: BootModeValues | string; +} +export namespace ImportImageTask { /** - *The value is Windows for Windows instances; otherwise blank.
(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname
- * can only be used inside the Amazon EC2 network. This name is not available until the
- * instance enters the running state.
[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS - * hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not - * using the Amazon-provided DNS server in your VPC, your custom domain name servers must - * resolve the hostname as appropriate.
+ *A list of zero or more import image tasks that are currently active or were completed or canceled in the + * previous 7 days.
*/ - PrivateDnsName?: string; + ImportImageTasks?: ImportImageTask[]; /** - *The private IPv4 address assigned to the instance.
+ *The token to use to get the next page of results. This value is null when there are no more results
+ * to return.
The product codes attached to this instance, if applicable.
+ * @internal */ - ProductCodes?: ProductCode[]; + export const filterSensitiveLog = (obj: DescribeImportImageTasksResult): any => ({ + ...obj, + }); +} +export interface DescribeImportSnapshotTasksRequest { /** - *(IPv4 only) The public DNS name assigned to the instance. This name is not available
- * until the instance enters the running state. For EC2-VPC, this name is only
- * available if you've enabled DNS hostnames for your VPC.
Checks whether you have the required permissions for the action, without 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 public IPv4 address, or the Carrier IP address assigned to the instance, if - * applicable.
- *A Carrier IP address only applies to an instance launched in a subnet associated with - * a Wavelength Zone.
+ *The filters.
*/ - PublicIpAddress?: string; + Filters?: Filter[]; /** - *The RAM disk associated with this instance, if applicable.
+ *A list of import snapshot task IDs.
*/ - RamdiskId?: string; + ImportTaskIds?: string[]; /** - *The current state of the instance.
+ *The maximum number of results to return in a single call. To retrieve the remaining results, make another call
+ * with the returned NextToken value.
The reason for the most recent state transition. This might be an empty string.
+ *A token that indicates the next page of results.
*/ - StateTransitionReason?: string; + NextToken?: string; +} +export namespace DescribeImportSnapshotTasksRequest { /** - *[EC2-VPC] The ID of the subnet in which the instance is running.
+ * @internal */ - SubnetId?: string; + export const filterSensitiveLog = (obj: DescribeImportSnapshotTasksRequest): any => ({ + ...obj, + }); +} +/** + *Details about the import snapshot task.
+ */ +export interface SnapshotTaskDetail { /** - *[EC2-VPC] The ID of the VPC in which the instance is running.
+ *The description of the snapshot.
*/ - VpcId?: string; + Description?: string; /** - *The architecture of the image.
+ *The size of the disk in the snapshot, in GiB.
*/ - Architecture?: ArchitectureValues | string; + DiskImageSize?: number; /** - *Any block device mapping entries for the instance.
+ *Indicates whether the snapshot is encrypted.
*/ - BlockDeviceMappings?: InstanceBlockDeviceMapping[]; + Encrypted?: boolean; /** - *The idempotency token you provided when you launched the instance, if - * applicable.
+ *The format of the disk image from which the snapshot is created.
*/ - ClientToken?: string; + Format?: string; /** - *Indicates whether the instance is optimized for Amazon EBS I/O. This optimization - * provides dedicated throughput to Amazon EBS and an optimized configuration stack to - * provide optimal I/O performance. This optimization isn't available with all instance - * types. Additional usage charges apply when using an EBS Optimized instance.
+ *The identifier for the KMS key that was used to create the encrypted snapshot.
*/ - EbsOptimized?: boolean; + KmsKeyId?: string; /** - *Specifies whether enhanced networking with ENA is enabled.
+ *The percentage of completion for the import snapshot task.
*/ - EnaSupport?: boolean; + Progress?: string; /** - *The hypervisor type of the instance. The value xen is used for both Xen and
- * Nitro hypervisors.
The snapshot ID of the disk being imported.
*/ - Hypervisor?: HypervisorType | string; + SnapshotId?: string; /** - *The IAM instance profile associated with the instance, if applicable.
+ *A brief status for the import snapshot task.
*/ - IamInstanceProfile?: IamInstanceProfile; + Status?: string; /** - *Indicates whether this is a Spot Instance or a Scheduled Instance.
+ *A detailed status message for the import snapshot task.
*/ - InstanceLifecycle?: InstanceLifecycleType | string; + StatusMessage?: string; /** - *The Elastic GPU associated with the instance.
+ *The URL of the disk image from which the snapshot is created.
*/ - ElasticGpuAssociations?: ElasticGpuAssociation[]; + Url?: string; /** - *The elastic inference accelerator associated with the instance.
+ *The Amazon S3 bucket for the disk image.
*/ - ElasticInferenceAcceleratorAssociations?: ElasticInferenceAcceleratorAssociation[]; + UserBucket?: UserBucketDetails; +} +export namespace SnapshotTaskDetail { /** - *[EC2-VPC] The network interfaces for the instance.
+ * @internal */ - NetworkInterfaces?: InstanceNetworkInterface[]; + export const filterSensitiveLog = (obj: SnapshotTaskDetail): any => ({ + ...obj, + }); +} +/** + *Describes an import snapshot task.
+ */ +export interface ImportSnapshotTask { /** - *The Amazon Resource Name (ARN) of the Outpost.
+ *A description of the import snapshot task.
*/ - OutpostArn?: string; + Description?: string; /** - *The device name of the root device volume (for example,
- * /dev/sda1).
The ID of the import snapshot task.
*/ - RootDeviceName?: string; + ImportTaskId?: string; /** - *The root device type used by the AMI. The AMI can use an EBS volume or an instance - * store volume.
+ *Describes an import snapshot task.
*/ - RootDeviceType?: DeviceType | string; + SnapshotTaskDetail?: SnapshotTaskDetail; /** - *The security groups for the instance.
+ *The tags for the import snapshot task.
*/ - SecurityGroups?: GroupIdentifier[]; + Tags?: Tag[]; +} +export namespace ImportSnapshotTask { /** - *Indicates whether source/destination checking is enabled.
+ * @internal */ - SourceDestCheck?: boolean; + export const filterSensitiveLog = (obj: ImportSnapshotTask): any => ({ + ...obj, + }); +} +export interface DescribeImportSnapshotTasksResult { /** - *If the request is a Spot Instance request, the ID of the request.
+ *A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the + * previous 7 days.
*/ - SpotInstanceRequestId?: string; + ImportSnapshotTasks?: ImportSnapshotTask[]; + + /** + *The token to use to get the next page of results. This value is null when there are no more results
+ * to return.
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface - * is enabled.
+ *The instance attribute.
+ *Note: The enaSupport attribute is not supported at this time.
The reason for the most recent state transition.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Any tags assigned to the instance.
+ *The ID of the instance.
*/ - Tags?: Tag[]; + InstanceId: string | undefined; +} +export namespace DescribeInstanceAttributeRequest { /** - *The virtualization type of the instance.
+ * @internal */ - VirtualizationType?: VirtualizationType | string; + export const filterSensitiveLog = (obj: DescribeInstanceAttributeRequest): any => ({ + ...obj, + }); +} +/** + *Describes a parameter used to set up an EBS volume in a block device mapping.
+ */ +export interface EbsInstanceBlockDevice { /** - *The CPU options for the instance.
+ *The time stamp when the attachment initiated.
*/ - CpuOptions?: CpuOptions; + AttachTime?: Date; /** - *The ID of the Capacity Reservation.
+ *Indicates whether the volume is deleted on instance termination.
*/ - CapacityReservationId?: string; + DeleteOnTermination?: boolean; /** - *Information about the Capacity Reservation targeting option.
+ *The attachment state.
*/ - CapacityReservationSpecification?: CapacityReservationSpecificationResponse; + Status?: AttachmentStatus | string; /** - *Indicates whether the instance is enabled for hibernation.
+ *The ID of the EBS volume.
*/ - HibernationOptions?: HibernationOptions; + VolumeId?: string; +} +export namespace EbsInstanceBlockDevice { /** - *The license configurations for the instance.
+ * @internal */ - Licenses?: LicenseConfiguration[]; + export const filterSensitiveLog = (obj: EbsInstanceBlockDevice): any => ({ + ...obj, + }); +} +/** + *Describes a block device mapping.
+ */ +export interface InstanceBlockDeviceMapping { /** - *The metadata options for the instance.
+ *The device name (for example, /dev/sdh or xvdh).
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
+ *Parameters used to automatically set up EBS volumes when the instance is + * launched.
*/ - EnclaveOptions?: EnclaveOptions; + Ebs?: EbsInstanceBlockDevice; +} +export namespace InstanceBlockDeviceMapping { /** - *The boot mode of the instance. For more information, see Boot modes in the - * Amazon EC2 User Guide.
+ * @internal */ - BootMode?: BootModeValues | string; + export const filterSensitiveLog = (obj: InstanceBlockDeviceMapping): any => ({ + ...obj, + }); +} +/** + *Describes a value for a resource attribute that is a Boolean value.
+ */ +export interface AttributeBooleanValue { /** - *The platform details value for the instance. For more information, see AMI - * billing information fields in the - * Amazon EC2 User Guide.
+ *The attribute value. The valid values are true or false.
The usage operation value for the instance. For more information, see AMI billing information fields - * in the Amazon EC2 User Guide.
+ * @internal */ - UsageOperation?: string; + export const filterSensitiveLog = (obj: AttributeBooleanValue): any => ({ + ...obj, + }); +} +/** + *Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
+ */ +export interface EnclaveOptions { /** - *The time that the usage operation was last updated.
+ *If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves;
+ * otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.
Describes a launch request for one or more instances, and includes - * owner, requester, and security group information that applies to all - * instances in the launch request.
+ *Describes an instance attribute.
*/ -export interface Reservation { +export interface InstanceAttribute { /** - *[EC2-Classic only] The security groups.
+ *The security groups associated with the instance.
*/ Groups?: GroupIdentifier[]; /** - *The instances.
- */ - Instances?: Instance[]; - - /** - *The ID of the Amazon Web Services account that owns the reservation.
- */ - OwnerId?: string; - - /** - *The ID of the requester that launched the instances on your behalf (for example, - * Amazon Web Services Management Console or Auto Scaling).
- */ - RequesterId?: string; - - /** - *The ID of the reservation.
+ *The block device mapping of the instance.
*/ - ReservationId?: string; -} + BlockDeviceMappings?: InstanceBlockDeviceMapping[]; -export namespace Reservation { /** - * @internal + *If the value is true, you can't terminate the instance through the Amazon
+ * EC2 console, CLI, or API; otherwise, you can.
Information about the reservations.
+ *Indicates whether enhanced networking with ENA is enabled.
*/ - Reservations?: Reservation[]; + EnaSupport?: AttributeBooleanValue; /** - *The token to use to retrieve the next page of results. This value is null
- * when there are no more results to return.
To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise,
+ * set it to false.
Indicates whether the instance is optimized for Amazon EBS I/O.
*/ - export const filterSensitiveLog = (obj: DescribeInstancesResult): any => ({ - ...obj, - }); -} + EbsOptimized?: AttributeBooleanValue; -export interface DescribeInstanceStatusRequest { /** - *The filters.
- *
- * availability-zone - The Availability Zone of the instance.
- * event.code - The code for the scheduled event
- * (instance-reboot | system-reboot |
- * system-maintenance | instance-retirement |
- * instance-stop).
- * event.description - A description of the event.
- * event.instance-event-id - The ID of the event whose date and time
- * you are modifying.
- * event.not-after - The latest end time for the scheduled event
- * (for example, 2014-09-15T17:15:20.000Z).
- * event.not-before - The earliest start time for the scheduled
- * event (for example, 2014-09-15T17:15:20.000Z).
- * event.not-before-deadline - The deadline for starting the event
- * (for example, 2014-09-15T17:15:20.000Z).
- * instance-state-code - The code for the instance state, as a
- * 16-bit unsigned integer. The high byte is used for internal purposes and should
- * be ignored. The low byte is set based on the state represented. The valid values
- * are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64
- * (stopping), and 80 (stopped).
- * instance-state-name - The state of the instance
- * (pending | running | shutting-down |
- * terminated | stopping |
- * stopped).
- * instance-status.reachability - Filters on instance status where
- * the name is reachability (passed | failed
- * | initializing | insufficient-data).
- * instance-status.status - The status of the instance
- * (ok | impaired | initializing |
- * insufficient-data | not-applicable).
- * system-status.reachability - Filters on system status where the
- * name is reachability (passed | failed |
- * initializing | insufficient-data).
- * system-status.status - The system status of the instance
- * (ok | impaired | initializing |
- * insufficient-data | not-applicable).
The ID of the instance.
*/ - Filters?: Filter[]; + InstanceId?: string; /** - *The instance IDs.
- *Default: Describes all your instances.
- *Constraints: Maximum 100 explicitly specified instance IDs.
+ *Indicates whether an instance stops or terminates when you initiate shutdown from the + * instance (using the operating system command for system shutdown).
*/ - InstanceIds?: string[]; + InstanceInitiatedShutdownBehavior?: AttributeValue; /** - *The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another call with the returned NextToken value. This value
- * can be between 5 and 1000. You cannot specify this parameter and the instance IDs
- * parameter in the same call.
The instance type.
*/ - MaxResults?: number; + InstanceType?: AttributeValue; /** - *The token to retrieve the next page of results.
+ *The kernel ID.
*/ - NextToken?: string; + KernelId?: AttributeValue; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
A list of product codes.
*/ - DryRun?: boolean; + ProductCodes?: ProductCode[]; /** - *When true, includes the health status for all instances. When
- * false, includes the health status for running instances only.
Default: false
- *
The RAM disk ID.
*/ - IncludeAllInstances?: boolean; + RamdiskId?: AttributeValue; + + /** + *The device name of the root device volume (for example,
+ * /dev/sda1).
Enable or disable source/destination checks, which ensure that the instance
+ * is either the source or the destination of any traffic that it receives.
+ * If the value is true, source/destination checks are enabled;
+ * otherwise, they are disabled. The default value is true.
+ * You must disable source/destination checks if the instance runs services
+ * such as network address translation, routing, or firewalls.
Indicates whether enhanced networking with the Intel 82599 Virtual Function interface + * is enabled.
+ */ + SriovNetSupport?: AttributeValue; + + /** + *The user data.
+ */ + UserData?: AttributeValue; } -export namespace DescribeInstanceStatusRequest { +export namespace InstanceAttribute { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeInstanceStatusRequest): any => ({ + export const filterSensitiveLog = (obj: InstanceAttribute): any => ({ ...obj, }); } -export type EventCode = - | "instance-reboot" - | "instance-retirement" - | "instance-stop" - | "system-maintenance" - | "system-reboot"; - -/** - *Describes a scheduled event for an instance.
- */ -export interface InstanceStatusEvent { - /** - *The ID of the event.
- */ - InstanceEventId?: string; - +export interface DescribeInstanceCreditSpecificationsRequest { /** - *The event code.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
A description of the event.
- *After a scheduled event is completed, it can still be described for up to a week. If - * the event has been completed, this description starts with the following text: - * [Completed].
+ *The filters.
+ *
+ * instance-id - The ID of the instance.
The latest scheduled end time for the event.
+ *The instance IDs.
+ *Default: Describes all your instances.
+ *Constraints: Maximum 1000 explicitly specified instance IDs.
*/ - NotAfter?: Date; + InstanceIds?: string[]; /** - *The earliest scheduled start time for the event.
+ *The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another call with the returned NextToken value. This value
+ * can be between 5 and 1000. You cannot specify this parameter and the instance IDs
+ * parameter in the same call.
The deadline for starting the event.
+ *The token to retrieve the next page of results.
*/ - NotBeforeDeadline?: Date; + NextToken?: string; } -export namespace InstanceStatusEvent { +export namespace DescribeInstanceCreditSpecificationsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceStatusEvent): any => ({ + export const filterSensitiveLog = (obj: DescribeInstanceCreditSpecificationsRequest): any => ({ ...obj, }); } -export type StatusName = "reachability"; - -export type StatusType = "failed" | "initializing" | "insufficient-data" | "passed"; - /** - *Describes the instance status.
+ *Describes the credit option for CPU usage of a burstable performance instance.
*/ -export interface InstanceStatusDetails { - /** - *The time when a status check failed. For an instance that was launched and impaired, - * this is the time when the instance was launched.
- */ - ImpairedSince?: Date; - +export interface InstanceCreditSpecification { /** - *The type of instance status.
+ *The ID of the instance.
*/ - Name?: StatusName | string; + InstanceId?: string; /** - *The status.
+ *The credit option for CPU usage of the instance. Valid values are
+ * standard and unlimited.
Information about the credit option for CPU usage of an instance.
+ */ + InstanceCreditSpecifications?: InstanceCreditSpecification[]; -/** - *Describes the status of an instance.
- */ -export interface InstanceStatusSummary { /** - *The system instance health or application instance health.
+ *The token to use to retrieve the next page of results. This value is null
+ * when there are no more results to return.
The status.
+ * @internal */ - Status?: SummaryStatus | string; + export const filterSensitiveLog = (obj: DescribeInstanceCreditSpecificationsResult): any => ({ + ...obj, + }); } -export namespace InstanceStatusSummary { +export interface DescribeInstanceEventNotificationAttributesRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the status of an instance.
- */ -export interface InstanceStatus { +export interface DescribeInstanceEventNotificationAttributesResult { /** - *The Availability Zone of the instance.
+ *Information about the registered tag keys.
*/ - AvailabilityZone?: string; + InstanceTagAttribute?: InstanceTagNotificationAttribute; +} +export namespace DescribeInstanceEventNotificationAttributesResult { /** - *The Amazon Resource Name (ARN) of the Outpost.
+ * @internal */ - OutpostArn?: string; + export const filterSensitiveLog = (obj: DescribeInstanceEventNotificationAttributesResult): any => ({ + ...obj, + }); +} +/** + *Any scheduled events associated with the instance.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the instance.
+ *The IDs of the event windows.
*/ - InstanceId?: string; + InstanceEventWindowIds?: string[]; /** - *The intended state of the instance. DescribeInstanceStatus requires
- * that an instance be in the running state.
One or more filters.
+ *
+ * dedicated-host-id - The event windows associated with the specified
+ * Dedicated Host ID.
+ * event-window-name - The event windows associated with the specified
+ * names.
+ * instance-id - The event windows associated with the specified instance
+ * ID.
+ * instance-tag - The event windows associated with the specified tag and
+ * value.
+ * instance-tag-key - The event windows associated with the specified tag
+ * key, regardless of the value.
+ * instance-tag-value - The event windows associated with the specified tag
+ * value, regardless of the key.
+ * tag: - The key/value combination of a tag assigned to the
+ * event window. Use the tag key in the filter name and the tag value as the filter
+ * value. For example, to find all resources that have a tag with the key
+ * Owner and the value CMX, specify tag:Owner
+ * for the filter name and CMX for the filter value.
+ * tag-key - The key of a tag assigned to the event window. Use this filter
+ * to find all event windows that have a tag with a specific key, regardless of the tag
+ * value.
+ * tag-value - The value of a tag assigned to the event window. Use this
+ * filter to find all event windows that have a tag with a specific value, regardless of
+ * the tag key.
Reports impaired functionality that stems from issues internal to the instance, such - * as impaired reachability.
+ *The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another call with the returned NextToken value. This value can
+ * be between 20 and 500. You cannot specify this parameter and the event window IDs parameter
+ * in the same call.
Reports impaired functionality that stems from issues related to the systems that - * support an instance, such as hardware failures and network connectivity problems.
+ *The token to request the next page of results.
*/ - SystemStatus?: InstanceStatusSummary; + NextToken?: string; } -export namespace InstanceStatus { +export namespace DescribeInstanceEventWindowsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceStatus): any => ({ + export const filterSensitiveLog = (obj: DescribeInstanceEventWindowsRequest): any => ({ ...obj, }); } -export interface DescribeInstanceStatusResult { +export interface DescribeInstanceEventWindowsResult { /** - *Information about the status of the instances.
+ *Information about the event windows.
*/ - InstanceStatuses?: InstanceStatus[]; + InstanceEventWindows?: InstanceEventWindow[]; /** - *The token to use to retrieve the next page of results. This value is null
- * when there are no more results to return.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is
- * DryRunOperation. Otherwise, it is UnauthorizedOperation.
The location type.
- */ - LocationType?: LocationType | string; - +export interface DescribeInstancesRequest { /** - *One or more filters. Filter names and values are case-sensitive.
- *The filters.
+ *
+ * affinity - The affinity setting for an instance running on a
+ * Dedicated Host (default | host).
+ * architecture - The instance architecture (i386 |
+ * x86_64 | arm64).
+ * availability-zone - The Availability Zone of the instance.
+ * block-device-mapping.attach-time - The attach time for an EBS
+ * volume mapped to the instance, for example,
+ * 2010-09-15T17:15:20.000Z.
+ * block-device-mapping.delete-on-termination - A Boolean that
+ * indicates whether the EBS volume is deleted on instance termination.
+ * block-device-mapping.device-name - The device name specified in the
+ * block device mapping (for example, /dev/sdh or
+ * xvdh).
+ * block-device-mapping.status - The status for the EBS volume
+ * (attaching | attached | detaching |
+ * detached).
+ * block-device-mapping.volume-id - The volume ID of the EBS
+ * volume.
+ * client-token - The idempotency token you provided when you launched
+ * the instance.
+ * dns-name - The public DNS name of the instance.
+ * group-id - The ID of the security group for the instance.
+ * EC2-Classic only.
+ * group-name - The name of the security group for the instance.
+ * EC2-Classic only.
+ * hibernation-options.configured - A Boolean that indicates whether
+ * the instance is enabled for hibernation. A value of true means that
+ * the instance is enabled for hibernation.
+ * host-id - The ID of the Dedicated Host on which the instance is
+ * running, if applicable.
+ * hypervisor - The hypervisor type of the instance
+ * (ovm | xen). The value xen
+ * is used for both Xen and Nitro hypervisors.
+ * iam-instance-profile.arn - The instance profile associated with
+ * the instance. Specified as an ARN.
+ * image-id - The ID of the image used to launch the
+ * instance.
+ * instance-id - The ID of the instance.
+ * instance-lifecycle - Indicates whether this is a Spot Instance or
+ * a Scheduled Instance (spot | scheduled).
+ * instance-state-code - The state of the instance, as a 16-bit
+ * unsigned integer. The high byte is used for internal purposes and should be
+ * ignored. The low byte is set based on the state represented. The valid values
+ * are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64
+ * (stopping), and 80 (stopped).
+ * instance-state-name - The state of the instance
+ * (pending | running | shutting-down |
+ * terminated | stopping |
+ * stopped).
+ * instance-type - The type of instance (for example,
+ * t2.micro).
+ * instance.group-id - The ID of the security group for the
+ * instance.
+ * instance.group-name - The name of the security group for the
+ * instance.
+ * ip-address - The public IPv4 address of the instance.
+ * kernel-id - The kernel ID.
+ * key-name - The name of the key pair used when the instance was
+ * launched.
+ * launch-index - When launching multiple instances, this is the
+ * index for the instance in the launch group (for example, 0, 1, 2, and so on).
+ * launch-time - The time when the instance was launched, in the ISO
+ * 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,
+ * 2021-09-29T11:04:43.305Z. You can use a wildcard
+ * (*), for example, 2021-09-29T*, which matches an
+ * entire day.
+ * metadata-options.http-tokens - The metadata request authorization
+ * state (optional | required)
+ * metadata-options.http-put-response-hop-limit - The http metadata
+ * request put response hop limit (integer, possible values 1 to
+ * 64)
+ * metadata-options.http-endpoint - Enable or disable metadata
+ * access on http endpoint (enabled | disabled)
+ * monitoring-state - Indicates whether detailed monitoring is
+ * enabled (disabled | enabled).
+ * network-interface.addresses.private-ip-address - The private IPv4
+ * address associated with the network interface.
+ * network-interface.addresses.primary - Specifies whether the IPv4
+ * address of the network interface is the primary private IPv4 address.
+ * network-interface.addresses.association.public-ip - The ID of the
+ * association of an Elastic IP address (IPv4) with a network interface.
+ * network-interface.addresses.association.ip-owner-id - The owner
+ * ID of the private IPv4 address associated with the network interface.
- * location - This depends on the location type. For example, if the location type is
- * region (default), the location is the Region code (for example, us-east-2.)
+ * network-interface.association.public-ip - The address of the
+ * Elastic IP address (IPv4) bound to the network interface.
- * instance-type - The instance type. For example,
- * c5.2xlarge.
+ * network-interface.association.ip-owner-id - The owner of the
+ * Elastic IP address (IPv4) associated with the network interface.
The maximum number of results to return for the request in a single page. The remaining results - * can be seen by sending another request with the next token value.
- */ - MaxResults?: number; - - /** - *The token to retrieve the next page of results.
- */ - NextToken?: string; -} - -export namespace DescribeInstanceTypeOfferingsRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribeInstanceTypeOfferingsRequest): any => ({ - ...obj, - }); -} - -/** - *The instance types offered.
- */ -export interface InstanceTypeOffering { - /** - *The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
- */ - InstanceType?: _InstanceType | string; - - /** - *The location type.
- */ - LocationType?: LocationType | string; - - /** - *The identifier for the location. This depends on the location type. For example, if the location type is
- * region, the location is the Region code (for example, us-east-2.)
The instance types offered.
- */ - InstanceTypeOfferings?: InstanceTypeOffering[]; - - /** - *The token to use to retrieve the next page of results. This value is null when there
- * are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is
- * DryRunOperation. Otherwise, it is UnauthorizedOperation.
The instance types. For more information, see Instance types in the Amazon EC2 User Guide.
- */ - InstanceTypes?: (_InstanceType | string)[]; - - /** - *One or more filters. Filter names and values are case-sensitive.
- *
- * auto-recovery-supported - Indicates whether auto recovery is supported (true | false).
+ * network-interface.association.allocation-id - The allocation ID
+ * returned when you allocated the Elastic IP address (IPv4) for your network
+ * interface.
- * bare-metal - Indicates whether it is a bare metal instance type (true | false).
+ * network-interface.association.association-id - The association ID
+ * returned when the network interface was associated with an IPv4 address.
- * burstable-performance-supported - Indicates whether it is a burstable
- * performance instance type (true | false).
+ * network-interface.attachment.attachment-id - The ID of the
+ * interface attachment.
- * current-generation - Indicates whether this instance type is the latest
- * generation instance type of an instance family (true | false).
+ * network-interface.attachment.instance-id - The ID of the instance
+ * to which the network interface is attached.
- * ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline
- * bandwidth performance for an EBS-optimized instance type, in Mbps.
+ * network-interface.attachment.instance-owner-id - The owner ID of
+ * the instance to which the network interface is attached.
- * ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage
- * operations per second for an EBS-optimized instance type.
+ * network-interface.attachment.device-index - The device index to
+ * which the network interface is attached.
- * ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline
- * throughput performance for an EBS-optimized instance type, in MB/s.
+ * network-interface.attachment.status - The status of the
+ * attachment (attaching | attached |
+ * detaching | detached).
- * ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth
- * performance for an EBS-optimized instance type, in Mbps.
+ * network-interface.attachment.attach-time - The time that the
+ * network interface was attached to an instance.
- * ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage
- * operations per second for an EBS-optimized instance type.
+ * network-interface.attachment.delete-on-termination - Specifies
+ * whether the attachment is deleted when an instance is terminated.
- * ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum
- * throughput performance for an EBS-optimized instance type, in MB/s.
+ * network-interface.availability-zone - The Availability Zone for
+ * the network interface.
- * ebs-info.ebs-optimized-support - Indicates whether the instance type is
- * EBS-optimized (supported | unsupported |
- * default).
+ * network-interface.description - The description of the network
+ * interface.
- * ebs-info.encryption-support - Indicates whether EBS encryption is supported
- * (supported | unsupported).
+ * network-interface.group-id - The ID of a security group
+ * associated with the network interface.
- * ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe)
- * is supported for EBS volumes (required | supported | unsupported).
+ * network-interface.group-name - The name of a security group
+ * associated with the network interface.
- * free-tier-eligible - Indicates whether the instance type is eligible to use
- * in the free tier (true | false).
+ * network-interface.ipv6-addresses.ipv6-address - The IPv6 address
+ * associated with the network interface.
- * hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
+ * network-interface.mac-address - The MAC address of the network
+ * interface.
- * hypervisor - The hypervisor (nitro | xen).
+ * network-interface.network-interface-id - The ID of the network
+ * interface.
- * instance-storage-info.disk.count - The number of local disks.
+ * network-interface.owner-id - The ID of the owner of the network
+ * interface.
- * instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in
- * GB.
+ * network-interface.private-dns-name - The private DNS name of the
+ * network interface.
- * instance-storage-info.disk.type - The storage technology for the local
- * instance storage disks (hdd | ssd).
+ * network-interface.requester-id - The requester ID for the network
+ * interface.
- * instance-storage-info.encryption-supported - Indicates whether data is encrypted at rest
- * (required | unsupported).
+ * network-interface.requester-managed - Indicates whether the
+ * network interface is being managed by Amazon Web Services.
- * instance-storage-info.nvme-support - Indicates whether non-volatile memory
- * express (NVMe) is supported for instance store (required | supported |
- * unsupported).
+ * network-interface.status - The status of the network interface
+ * (available) | in-use).
- * instance-storage-info.total-size-in-gb - The total amount of storage available from all local
- * instance storage, in GB.
+ * network-interface.source-dest-check - Whether the network
+ * interface performs source/destination checking. A value of true
+ * means that checking is enabled, and false means that checking is
+ * disabled. The value must be false for the network interface to
+ * perform network address translation (NAT) in your VPC.
+ * network-interface.subnet-id - The ID of the subnet for the
+ * network interface.
+ * network-interface.vpc-id - The ID of the VPC for the network
+ * interface.
+ * outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
+ * owner-id - The Amazon Web Services account ID of the instance owner.
- * instance-storage-supported - Indicates whether the instance type has local
- * instance storage (true | false).
+ * placement-group-name - The name of the placement group for the
+ * instance.
- * instance-type - The instance type (for example c5.2xlarge or
- * c5*).
+ * placement-partition-number - The partition in which the instance is
+ * located.
- * memory-info.size-in-mib - The memory size.
+ * platform - The platform. To list only Windows instances, use
+ * windows.
- * network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic
- * Fabric Adapters (EFAs) per instance.
+ * private-dns-name - The private IPv4 DNS name of the
+ * instance.
- * network-info.efa-supported - Indicates whether the instance type supports
- * Elastic Fabric Adapter (EFA) (true | false).
+ * private-ip-address - The private IPv4 address of the
+ * instance.
- * network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is
- * supported or required (required | supported |
- * unsupported).
+ * product-code - The product code associated with the AMI used to
+ * launch the instance.
- * network-info.encryption-in-transit-supported - Indicates whether the instance type
- * automatically encrypts in-transit traffic between instances (true | false).
+ * product-code.type - The type of product code (devpay |
+ * marketplace).
- * network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per
- * network interface.
+ * ramdisk-id - The RAM disk ID.
- * network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per
- * network interface.
+ * reason - The reason for the current state of the instance (for
+ * example, shows "User Initiated [date]" when you stop or terminate the instance).
+ * Similar to the state-reason-code filter.
- * network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
+ * requester-id - The ID of the entity that launched the instance on
+ * your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so
+ * on).
- * network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
+ * reservation-id - The ID of the instance's reservation. A
+ * reservation ID is created any time you launch an instance. A reservation ID has
+ * a one-to-one relationship with an instance launch request, but can be associated
+ * with more than one instance if you launch multiple instances using the same
+ * launch request. For example, if you launch one instance, you get one reservation
+ * ID. If you launch ten instances using the same launch request, you also get one
+ * reservation ID.
- * network-info.network-performance - The network performance (for example, "25
- * Gigabit").
+ * root-device-name - The device name of the root device volume (for
+ * example, /dev/sda1).
- * processor-info.supported-architecture - The CPU architecture
- * (arm64 | i386 | x86_64).
+ * root-device-type - The type of the root device volume
+ * (ebs | instance-store).
- * processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
+ * source-dest-check - Indicates whether the instance performs
+ * source/destination checking. A value of true means that checking is
+ * enabled, and false means that checking is disabled. The value must
+ * be false for the instance to perform network address translation
+ * (NAT) in your VPC.
- * supported-boot-mode - The boot mode (legacy-bios |
- * uefi).
+ * spot-instance-request-id - The ID of the Spot Instance
+ * request.
- * supported-root-device-type - The root device type (ebs |
- * instance-store).
+ * state-reason-code - The reason code for the state change.
- * supported-usage-class - The usage class (on-demand |
- * spot).
+ * state-reason-message - A message that describes the state
+ * change.
- * supported-virtualization-type - The virtualization type (hvm |
- * paravirtual).
+ * subnet-id - The ID of the subnet for the instance.
- * vcpu-info.default-cores - The default number of cores for the instance type.
tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.
+ * For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
*
- * vcpu-info.default-threads-per-core - The default number of threads per core for the instance
- * type.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
*
- * vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
+ * tenancy - The tenancy of an instance (dedicated |
+ * default | host).
- * vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
+ * virtualization-type - The virtualization type of the instance
+ * (paravirtual | hvm).
- * vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type.
- * For example, "1" or "1,2".
+ * vpc-id - The ID of the VPC that the instance is running in.
The maximum number of results to return for the request in a single page. The remaining results - * can be seen by sending another request with the next token value.
- */ - MaxResults?: number; - - /** - *The token to retrieve the next page of results.
- */ - NextToken?: string; -} - -export namespace DescribeInstanceTypesRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribeInstanceTypesRequest): any => ({ - ...obj, - }); -} - -/** - *Describes the optimized EBS performance for supported instance types.
- */ -export interface EbsOptimizedInfo { - /** - *The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
- */ - BaselineBandwidthInMbps?: number; - - /** - *The baseline throughput performance for an EBS-optimized instance type, in MB/s.
- */ - BaselineThroughputInMBps?: number; - - /** - *The baseline input/output storage operations per seconds for an EBS-optimized instance type.
+ *The instance IDs.
+ *Default: Describes all your instances.
*/ - BaselineIops?: number; + InstanceIds?: string[]; /** - *The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The maximum throughput performance for an EBS-optimized instance type, in MB/s.
+ *The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another call with the returned NextToken value. This value
+ * can be between 5 and 1000. You cannot specify this parameter and the instance IDs
+ * parameter in the same call.
The maximum input/output storage operations per second for an EBS-optimized instance type.
+ *The token to request the next page of results.
*/ - MaximumIops?: number; + NextToken?: string; } -export namespace EbsOptimizedInfo { +export namespace DescribeInstancesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EbsOptimizedInfo): any => ({ + export const filterSensitiveLog = (obj: DescribeInstancesRequest): any => ({ ...obj, }); } -export type EbsOptimizedSupport = "default" | "supported" | "unsupported"; - -export type EbsEncryptionSupport = "supported" | "unsupported"; - -export enum EbsNvmeSupport { - REQUIRED = "required", - SUPPORTED = "supported", - UNSUPPORTED = "unsupported", -} - /** - *Describes the Amazon EBS features supported by the instance type.
+ *Describes the instance's Capacity Reservation targeting preferences. The action returns the
+ * capacityReservationPreference response element if the instance is
+ * configured to run in On-Demand capacity, or if it is configured in run in any
+ * open Capacity Reservation that has matching attributes (instance type, platform,
+ * Availability Zone). The action returns the capacityReservationTarget
+ * response element if the instance explicily targets a specific Capacity Reservation or Capacity Reservation group.
Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized - * instances in Amazon EC2 User Guide.
- */ - EbsOptimizedSupport?: EbsOptimizedSupport | string; - - /** - *Indicates whether Amazon EBS encryption is supported.
- */ - EncryptionSupport?: EbsEncryptionSupport | string; - +export interface CapacityReservationSpecificationResponse { /** - *Describes the optimized EBS performance for the instance type.
+ *Describes the instance's Capacity Reservation preferences. Possible preferences include:
+ *
+ * open - The instance can run in any open Capacity Reservation that
+ * has matching attributes (instance type, platform, Availability Zone).
+ * none - The instance avoids running in a Capacity Reservation even if one is
+ * available. The instance runs in On-Demand capacity.
Indicates whether non-volatile memory express (NVMe) is supported.
+ *Information about the targeted Capacity Reservation or Capacity Reservation group.
*/ - NvmeSupport?: EbsNvmeSupport | string; + CapacityReservationTarget?: CapacityReservationTargetResponse; } -export namespace EbsInfo { +export namespace CapacityReservationSpecificationResponse { /** * @internal */ - export const filterSensitiveLog = (obj: EbsInfo): any => ({ + export const filterSensitiveLog = (obj: CapacityReservationSpecificationResponse): any => ({ ...obj, }); } /** - *Describes the memory for the FPGA accelerator for the instance type.
+ *The CPU options for the instance.
*/ -export interface FpgaDeviceMemoryInfo { +export interface CpuOptions { + /** + *The number of CPU cores for the instance.
+ */ + CoreCount?: number; + /** - *The size of the memory available to the FPGA accelerator, in MiB.
+ *The number of threads per CPU core.
*/ - SizeInMiB?: number; + ThreadsPerCore?: number; } -export namespace FpgaDeviceMemoryInfo { +export namespace CpuOptions { /** * @internal */ - export const filterSensitiveLog = (obj: FpgaDeviceMemoryInfo): any => ({ + export const filterSensitiveLog = (obj: CpuOptions): any => ({ ...obj, }); } /** - *Describes the FPGA accelerator for the instance type.
+ *Describes the association between an instance and an Elastic Graphics accelerator.
*/ -export interface FpgaDeviceInfo { +export interface ElasticGpuAssociation { /** - *The name of the FPGA accelerator.
+ *The ID of the Elastic Graphics accelerator.
*/ - Name?: string; + ElasticGpuId?: string; /** - *The manufacturer of the FPGA accelerator.
+ *The ID of the association.
*/ - Manufacturer?: string; + ElasticGpuAssociationId?: string; /** - *The count of FPGA accelerators for the instance type.
+ *The state of the association between the instance and the + * Elastic Graphics accelerator.
*/ - Count?: number; + ElasticGpuAssociationState?: string; /** - *Describes the memory for the FPGA accelerator for the instance type.
+ *The time the Elastic Graphics accelerator was associated with the instance.
*/ - MemoryInfo?: FpgaDeviceMemoryInfo; + ElasticGpuAssociationTime?: string; } -export namespace FpgaDeviceInfo { +export namespace ElasticGpuAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: FpgaDeviceInfo): any => ({ + export const filterSensitiveLog = (obj: ElasticGpuAssociation): any => ({ ...obj, }); } /** - *Describes the FPGAs for the instance type.
+ *+ * Describes the association between an instance and an elastic inference accelerator. + *
*/ -export interface FpgaInfo { +export interface ElasticInferenceAcceleratorAssociation { /** - *Describes the FPGAs for the instance type.
+ *+ * The Amazon Resource Name (ARN) of the elastic inference accelerator. + *
*/ - Fpgas?: FpgaDeviceInfo[]; + ElasticInferenceAcceleratorArn?: string; /** - *The total memory of all FPGA accelerators for the instance type.
+ *+ * The ID of the association. + *
*/ - TotalFpgaMemoryInMiB?: number; -} + ElasticInferenceAcceleratorAssociationId?: string; -export namespace FpgaInfo { /** - * @internal + *+ * The state of the elastic inference accelerator. + *
*/ - export const filterSensitiveLog = (obj: FpgaInfo): any => ({ - ...obj, - }); -} + ElasticInferenceAcceleratorAssociationState?: string; -/** - *Describes the memory available to the GPU accelerator.
- */ -export interface GpuDeviceMemoryInfo { /** - *The size of the memory available to the GPU accelerator, in MiB.
+ *+ * The time at which the elastic inference accelerator is associated with an instance. + *
*/ - SizeInMiB?: number; + ElasticInferenceAcceleratorAssociationTime?: Date; } -export namespace GpuDeviceMemoryInfo { +export namespace ElasticInferenceAcceleratorAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: GpuDeviceMemoryInfo): any => ({ + export const filterSensitiveLog = (obj: ElasticInferenceAcceleratorAssociation): any => ({ ...obj, }); } /** - *Describes the GPU accelerators for the instance type.
+ *Indicates whether your instance is configured for hibernation. This parameter is valid + * only if the instance meets the hibernation + * prerequisites. For + * more information, see Hibernate your instance in the + * Amazon EC2 User Guide.
*/ -export interface GpuDeviceInfo { - /** - *The name of the GPU accelerator.
- */ - Name?: string; - - /** - *The manufacturer of the GPU accelerator.
- */ - Manufacturer?: string; - - /** - *The number of GPUs for the instance type.
- */ - Count?: number; - +export interface HibernationOptions { /** - *Describes the memory available to the GPU accelerator.
+ *If this parameter is set to true, your instance is enabled for
+ * hibernation; otherwise, it is not enabled for hibernation.
Describes the GPU accelerators for the instance type.
+ *Describes a license configuration.
*/ -export interface GpuInfo { - /** - *Describes the GPU accelerators for the instance type.
- */ - Gpus?: GpuDeviceInfo[]; - +export interface LicenseConfiguration { /** - *The total size of the memory for the GPU accelerators for the instance type, in MiB.
+ *The Amazon Resource Name (ARN) of the license configuration.
*/ - TotalGpuMemoryInMiB?: number; + LicenseConfigurationArn?: string; } -export namespace GpuInfo { +export namespace LicenseConfiguration { /** * @internal */ - export const filterSensitiveLog = (obj: GpuInfo): any => ({ + export const filterSensitiveLog = (obj: LicenseConfiguration): any => ({ ...obj, }); } -export enum InstanceTypeHypervisor { - NITRO = "nitro", - XEN = "xen", +export type InstanceMetadataEndpointState = "disabled" | "enabled"; + +export enum InstanceMetadataProtocolState { + disabled = "disabled", + enabled = "enabled", +} + +export enum HttpTokensState { + optional = "optional", + required = "required", } +export type InstanceMetadataOptionsState = "applied" | "pending"; + /** - *Describes the Inference accelerators for the instance type.
+ *The metadata options for the instance.
*/ -export interface InferenceDeviceInfo { +export interface InstanceMetadataOptionsResponse { /** - *The number of Inference accelerators for the instance type.
+ *The state of the metadata option changes.
+ *
+ * pending - The metadata options are being updated and the instance is not
+ * ready to process metadata traffic with the new selection.
+ * applied - The metadata options have been successfully applied on the
+ * instance.
The name of the Inference accelerator.
+ *The state of token usage for your instance metadata requests. If the parameter is not
+ * specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata
+ * with or without a signed token header on your request. If you retrieve the IAM role
+ * credentials without a token, the version 1.0 role credentials are returned. If you
+ * retrieve the IAM role credentials using a valid signed token, the version 2.0 role
+ * credentials are returned.
If the state is required, you must send a signed token header with any
+ * instance metadata retrieval requests. In this state, retrieving the IAM role credential
+ * always returns the version 2.0 credentials; the version 1.0 credentials are not
+ * available.
The manufacturer of the Inference accelerator.
+ *The desired HTTP PUT response hop limit for instance metadata requests. The larger the + * number, the further instance metadata requests can travel.
+ *Default: 1
+ *Possible values: Integers from 1 to 64
*/ - Manufacturer?: string; + HttpPutResponseHopLimit?: number; + + /** + *Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
+ */ + HttpEndpoint?: InstanceMetadataEndpointState | string; + + /** + *Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
+ */ + HttpProtocolIpv6?: InstanceMetadataProtocolState | string; } -export namespace InferenceDeviceInfo { +export namespace InstanceMetadataOptionsResponse { /** * @internal */ - export const filterSensitiveLog = (obj: InferenceDeviceInfo): any => ({ + export const filterSensitiveLog = (obj: InstanceMetadataOptionsResponse): any => ({ ...obj, }); } +export type MonitoringState = "disabled" | "disabling" | "enabled" | "pending"; + /** - *Describes the Inference accelerators for the instance type.
+ *Describes the monitoring of an instance.
*/ -export interface InferenceAcceleratorInfo { +export interface Monitoring { /** - *Describes the Inference accelerators for the instance type.
+ *Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is + * enabled.
*/ - Accelerators?: InferenceDeviceInfo[]; + State?: MonitoringState | string; } -export namespace InferenceAcceleratorInfo { +export namespace Monitoring { /** * @internal */ - export const filterSensitiveLog = (obj: InferenceAcceleratorInfo): any => ({ + export const filterSensitiveLog = (obj: Monitoring): any => ({ ...obj, }); } -export type DiskType = "hdd" | "ssd"; - /** - *Describes a disk.
+ *Describes association information for an Elastic IP address (IPv4).
*/ -export interface DiskInfo { +export interface InstanceNetworkInterfaceAssociation { /** - *The size of the disk in GB.
+ *The carrier IP address associated with the network interface.
*/ - SizeInGB?: number; + CarrierIp?: string; /** - *The number of disks with this configuration.
+ *The ID of the owner of the Elastic IP address.
*/ - Count?: number; + IpOwnerId?: string; /** - *The type of disk.
+ *The public DNS name.
*/ - Type?: DiskType | string; + PublicDnsName?: string; + + /** + *The public IP address or Elastic IP address bound to the network interface.
+ */ + PublicIp?: string; } -export namespace DiskInfo { +export namespace InstanceNetworkInterfaceAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: DiskInfo): any => ({ + export const filterSensitiveLog = (obj: InstanceNetworkInterfaceAssociation): any => ({ ...obj, }); } -export enum InstanceStorageEncryptionSupport { - required = "required", - unsupported = "unsupported", -} +/** + *Describes a network interface attachment.
+ */ +export interface InstanceNetworkInterfaceAttachment { + /** + *The time stamp when the attachment initiated.
+ */ + AttachTime?: Date; -export enum EphemeralNvmeSupport { - REQUIRED = "required", - SUPPORTED = "supported", - UNSUPPORTED = "unsupported", -} + /** + *The ID of the network interface attachment.
+ */ + AttachmentId?: string; -/** - *Describes the instance store features that are supported by the instance type.
- */ -export interface InstanceStorageInfo { /** - *The total size of the disks, in GB.
+ *Indicates whether the network interface is deleted when the instance is terminated.
*/ - TotalSizeInGB?: number; + DeleteOnTermination?: boolean; /** - *Describes the disks that are available for the instance type.
+ *The index of the device on the instance for the network interface attachment.
*/ - Disks?: DiskInfo[]; + DeviceIndex?: number; /** - *Indicates whether non-volatile memory express (NVMe) is supported.
+ *The attachment state.
*/ - NvmeSupport?: EphemeralNvmeSupport | string; + Status?: AttachmentStatus | string; /** - *Indicates whether data is encrypted at rest.
+ *The index of the network card.
*/ - EncryptionSupport?: InstanceStorageEncryptionSupport | string; + NetworkCardIndex?: number; } -export namespace InstanceStorageInfo { +export namespace InstanceNetworkInterfaceAttachment { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceStorageInfo): any => ({ + export const filterSensitiveLog = (obj: InstanceNetworkInterfaceAttachment): any => ({ ...obj, }); } /** - *Describes the memory for the instance type.
+ *Information about an IPv4 prefix.
*/ -export interface MemoryInfo { +export interface InstanceIpv4Prefix { /** - *The size of the memory, in MiB.
+ *One or more IPv4 prefixes assigned to the network interface.
*/ - SizeInMiB?: number; + Ipv4Prefix?: string; } -export namespace MemoryInfo { +export namespace InstanceIpv4Prefix { /** * @internal */ - export const filterSensitiveLog = (obj: MemoryInfo): any => ({ + export const filterSensitiveLog = (obj: InstanceIpv4Prefix): any => ({ ...obj, }); } /** - *Describes the Elastic Fabric Adapters for the instance type.
+ *Information about an IPv6 prefix.
*/ -export interface EfaInfo { +export interface InstanceIpv6Prefix { /** - *The maximum number of Elastic Fabric Adapters for the instance type.
+ *One or more IPv6 prefixes assigned to the network interface.
*/ - MaximumEfaInterfaces?: number; + Ipv6Prefix?: string; } -export namespace EfaInfo { +export namespace InstanceIpv6Prefix { /** * @internal */ - export const filterSensitiveLog = (obj: EfaInfo): any => ({ + export const filterSensitiveLog = (obj: InstanceIpv6Prefix): any => ({ ...obj, }); } -export type EnaSupport = "required" | "supported" | "unsupported"; - /** - *Describes the network card support of the instance type.
+ *Describes a private IPv4 address.
*/ -export interface NetworkCardInfo { +export interface InstancePrivateIpAddress { /** - *The index of the network card.
+ *The association information for an Elastic IP address for the network interface.
*/ - NetworkCardIndex?: number; + Association?: InstanceNetworkInterfaceAssociation; /** - *The network performance of the network card.
+ *Indicates whether this IPv4 address is the primary private IP address of the network interface.
*/ - NetworkPerformance?: string; + Primary?: boolean; /** - *The maximum number of network interfaces for the network card.
+ *The private IPv4 DNS name.
*/ - MaximumNetworkInterfaces?: number; + PrivateDnsName?: string; + + /** + *The private IPv4 address of the network interface.
+ */ + PrivateIpAddress?: string; } -export namespace NetworkCardInfo { +export namespace InstancePrivateIpAddress { /** * @internal */ - export const filterSensitiveLog = (obj: NetworkCardInfo): any => ({ + export const filterSensitiveLog = (obj: InstancePrivateIpAddress): any => ({ ...obj, }); } /** - *Describes the networking features of the instance type.
+ *Describes a network interface.
*/ -export interface NetworkInfo { +export interface InstanceNetworkInterface { /** - *The network performance.
+ *The association information for an Elastic IPv4 associated with the network + * interface.
*/ - NetworkPerformance?: string; + Association?: InstanceNetworkInterfaceAssociation; /** - *The maximum number of network interfaces for the instance type.
+ *The network interface attachment.
*/ - MaximumNetworkInterfaces?: number; + Attachment?: InstanceNetworkInterfaceAttachment; /** - *The maximum number of physical network cards that can be allocated to the instance.
+ *The description.
*/ - MaximumNetworkCards?: number; + Description?: string; /** - *The index of the default network card, starting at 0.
+ *One or more security groups.
*/ - DefaultNetworkCardIndex?: number; + Groups?: GroupIdentifier[]; /** - *Describes the network cards for the instance type.
+ *One or more IPv6 addresses associated with the network interface.
*/ - NetworkCards?: NetworkCardInfo[]; + Ipv6Addresses?: InstanceIpv6Address[]; /** - *The maximum number of IPv4 addresses per network interface.
+ *The MAC address.
*/ - Ipv4AddressesPerInterface?: number; + MacAddress?: string; /** - *The maximum number of IPv6 addresses per network interface.
+ *The ID of the network interface.
*/ - Ipv6AddressesPerInterface?: number; + NetworkInterfaceId?: string; /** - *Indicates whether IPv6 is supported.
+ *The ID of the Amazon Web Services account that created the network interface.
*/ - Ipv6Supported?: boolean; + OwnerId?: string; /** - *Indicates whether Elastic Network Adapter (ENA) is supported.
+ *The private DNS name.
*/ - EnaSupport?: EnaSupport | string; + PrivateDnsName?: string; /** - *Indicates whether Elastic Fabric Adapter (EFA) is supported.
+ *The IPv4 address of the network interface within the subnet.
*/ - EfaSupported?: boolean; + PrivateIpAddress?: string; /** - *Describes the Elastic Fabric Adapters for the instance type.
+ *One or more private IPv4 addresses associated with the network interface.
*/ - EfaInfo?: EfaInfo; + PrivateIpAddresses?: InstancePrivateIpAddress[]; /** - *Indicates whether the instance type automatically encrypts in-transit traffic between instances.
+ *Indicates whether source/destination checking is enabled.
*/ - EncryptionInTransitSupported?: boolean; -} + SourceDestCheck?: boolean; -export namespace NetworkInfo { /** - * @internal + *The status of the network interface.
*/ - export const filterSensitiveLog = (obj: NetworkInfo): any => ({ - ...obj, - }); -} + Status?: NetworkInterfaceStatus | string; -export type PlacementGroupStrategy = "cluster" | "partition" | "spread"; + /** + *The ID of the subnet.
+ */ + SubnetId?: string; -/** - *Describes the placement group support of the instance type.
- */ -export interface PlacementGroupInfo { /** - *The supported placement group types.
+ *The ID of the VPC.
*/ - SupportedStrategies?: (PlacementGroupStrategy | string)[]; + VpcId?: string; + + /** + *Describes the type of network interface.
+ *Valid values: interface | efa | trunk
+ *
The IPv4 delegated prefixes that are assigned to the network interface.
+ */ + Ipv4Prefixes?: InstanceIpv4Prefix[]; + + /** + *The IPv6 delegated prefixes that are assigned to the network interface.
+ */ + Ipv6Prefixes?: InstanceIpv6Prefix[]; } -export namespace PlacementGroupInfo { +export namespace InstanceNetworkInterface { /** * @internal */ - export const filterSensitiveLog = (obj: PlacementGroupInfo): any => ({ + export const filterSensitiveLog = (obj: InstanceNetworkInterface): any => ({ ...obj, }); } -export type ArchitectureType = "arm64" | "i386" | "x86_64" | "x86_64_mac"; +export type InstanceStateName = "pending" | "running" | "shutting-down" | "stopped" | "stopping" | "terminated"; /** - *Describes the processor used by the instance type.
+ *Describes the current state of an instance.
*/ -export interface ProcessorInfo { +export interface InstanceState { /** - *The architectures supported by the instance type.
+ *The state of the instance as a 16-bit unsigned integer.
+ *The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values + * between 256 and 65,535. These numerical values are used for internal purposes and should + * be ignored.
+ *The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values + * between 0 and 255.
+ *The valid values for instance-state-code will all be in the range of the low byte and + * they are:
+ *
+ * 0 : pending
+ *
+ * 16 : running
+ *
+ * 32 : shutting-down
+ *
+ * 48 : terminated
+ *
+ * 64 : stopping
+ *
+ * 80 : stopped
+ *
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in + * decimal.
*/ - SupportedArchitectures?: (ArchitectureType | string)[]; + Code?: number; /** - *The speed of the processor, in GHz.
+ *The current state of the instance.
*/ - SustainedClockSpeedInGhz?: number; + Name?: InstanceStateName | string; } -export namespace ProcessorInfo { +export namespace InstanceState { /** * @internal */ - export const filterSensitiveLog = (obj: ProcessorInfo): any => ({ + export const filterSensitiveLog = (obj: InstanceState): any => ({ ...obj, }); } -export type BootModeType = "legacy-bios" | "uefi"; - -export type RootDeviceType = "ebs" | "instance-store"; - -export type UsageClassType = "on-demand" | "spot"; - /** - *Describes the vCPU configurations for the instance type.
+ *Describes an instance.
*/ -export interface VCpuInfo { +export interface Instance { /** - *The default number of vCPUs for the instance type.
+ *The AMI launch index, which can be used to find this instance in the launch + * group.
*/ - DefaultVCpus?: number; + AmiLaunchIndex?: number; + + /** + *The ID of the AMI used to launch the instance.
+ */ + ImageId?: string; + + /** + *The ID of the instance.
+ */ + InstanceId?: string; /** - *The default number of cores for the instance type.
+ *The instance type.
*/ - DefaultCores?: number; + InstanceType?: _InstanceType | string; /** - *The default number of threads per core for the instance type.
+ *The kernel associated with this instance, if applicable.
*/ - DefaultThreadsPerCore?: number; + KernelId?: string; /** - *The valid number of cores that can be configured for the instance type.
+ *The name of the key pair, if this instance was launched with an associated key + * pair.
*/ - ValidCores?: number[]; + KeyName?: string; /** - *The valid number of threads per core that can be configured for the instance type.
+ *The time the instance was launched.
*/ - ValidThreadsPerCore?: number[]; -} + LaunchTime?: Date; -export namespace VCpuInfo { /** - * @internal + *The monitoring for the instance.
*/ - export const filterSensitiveLog = (obj: VCpuInfo): any => ({ - ...obj, - }); -} + Monitoring?: Monitoring; -/** - *Describes the instance type.
- */ -export interface InstanceTypeInfo { /** - *The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
+ *The location where the instance launched, if applicable.
*/ - InstanceType?: _InstanceType | string; + Placement?: Placement; /** - *Indicates whether the instance type is current generation.
+ *The value is Windows for Windows instances; otherwise blank.
Indicates whether the instance type is eligible for the free tier.
+ *(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname
+ * can only be used inside the Amazon EC2 network. This name is not available until the
+ * instance enters the running state.
[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS + * hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not + * using the Amazon-provided DNS server in your VPC, your custom domain name servers must + * resolve the hostname as appropriate.
*/ - FreeTierEligible?: boolean; + PrivateDnsName?: string; /** - *Indicates whether the instance type is offered for spot or On-Demand.
+ *The private IPv4 address assigned to the instance.
*/ - SupportedUsageClasses?: (UsageClassType | string)[]; + PrivateIpAddress?: string; /** - *The supported root device types.
+ *The product codes attached to this instance, if applicable.
*/ - SupportedRootDeviceTypes?: (RootDeviceType | string)[]; + ProductCodes?: ProductCode[]; /** - *The supported virtualization types.
+ *(IPv4 only) The public DNS name assigned to the instance. This name is not available
+ * until the instance enters the running state. For EC2-VPC, this name is only
+ * available if you've enabled DNS hostnames for your VPC.
Indicates whether the instance is a bare metal instance type.
+ *The public IPv4 address, or the Carrier IP address assigned to the instance, if + * applicable.
+ *A Carrier IP address only applies to an instance launched in a subnet associated with + * a Wavelength Zone.
*/ - BareMetal?: boolean; + PublicIpAddress?: string; /** - *The hypervisor for the instance type.
+ *The RAM disk associated with this instance, if applicable.
*/ - Hypervisor?: InstanceTypeHypervisor | string; + RamdiskId?: string; /** - *Describes the processor.
+ *The current state of the instance.
*/ - ProcessorInfo?: ProcessorInfo; + State?: InstanceState; /** - *Describes the vCPU configurations for the instance type.
+ *The reason for the most recent state transition. This might be an empty string.
*/ - VCpuInfo?: VCpuInfo; + StateTransitionReason?: string; /** - *Describes the memory for the instance type.
+ *[EC2-VPC] The ID of the subnet in which the instance is running.
*/ - MemoryInfo?: MemoryInfo; + SubnetId?: string; /** - *Indicates whether instance storage is supported.
+ *[EC2-VPC] The ID of the VPC in which the instance is running.
*/ - InstanceStorageSupported?: boolean; + VpcId?: string; /** - *Describes the instance storage for the instance type.
+ *The architecture of the image.
*/ - InstanceStorageInfo?: InstanceStorageInfo; + Architecture?: ArchitectureValues | string; /** - *Describes the Amazon EBS settings for the instance type.
+ *Any block device mapping entries for the instance.
*/ - EbsInfo?: EbsInfo; + BlockDeviceMappings?: InstanceBlockDeviceMapping[]; /** - *Describes the network settings for the instance type.
+ *The idempotency token you provided when you launched the instance, if + * applicable.
*/ - NetworkInfo?: NetworkInfo; + ClientToken?: string; /** - *Describes the GPU accelerator settings for the instance type.
+ *Indicates whether the instance is optimized for Amazon EBS I/O. This optimization + * provides dedicated throughput to Amazon EBS and an optimized configuration stack to + * provide optimal I/O performance. This optimization isn't available with all instance + * types. Additional usage charges apply when using an EBS Optimized instance.
*/ - GpuInfo?: GpuInfo; + EbsOptimized?: boolean; /** - *Describes the FPGA accelerator settings for the instance type.
+ *Specifies whether enhanced networking with ENA is enabled.
*/ - FpgaInfo?: FpgaInfo; + EnaSupport?: boolean; /** - *Describes the placement group settings for the instance type.
+ *The hypervisor type of the instance. The value xen is used for both Xen and
+ * Nitro hypervisors.
Describes the Inference accelerator settings for the instance type.
+ *The IAM instance profile associated with the instance, if applicable.
*/ - InferenceAcceleratorInfo?: InferenceAcceleratorInfo; + IamInstanceProfile?: IamInstanceProfile; /** - *Indicates whether On-Demand hibernation is supported.
+ *Indicates whether this is a Spot Instance or a Scheduled Instance.
*/ - HibernationSupported?: boolean; + InstanceLifecycle?: InstanceLifecycleType | string; /** - *Indicates whether the instance type is a burstable performance instance type.
+ *The Elastic GPU associated with the instance.
*/ - BurstablePerformanceSupported?: boolean; + ElasticGpuAssociations?: ElasticGpuAssociation[]; /** - *Indicates whether Dedicated Hosts are supported on the instance type.
+ *The elastic inference accelerator associated with the instance.
*/ - DedicatedHostsSupported?: boolean; + ElasticInferenceAcceleratorAssociations?: ElasticInferenceAcceleratorAssociation[]; /** - *Indicates whether auto recovery is supported.
+ *[EC2-VPC] The network interfaces for the instance.
*/ - AutoRecoverySupported?: boolean; + NetworkInterfaces?: InstanceNetworkInterface[]; /** - *The supported boot modes. For more information, see Boot modes in the - * Amazon EC2 User Guide.
+ *The Amazon Resource Name (ARN) of the Outpost.
*/ - SupportedBootModes?: (BootModeType | string)[]; -} + OutpostArn?: string; -export namespace InstanceTypeInfo { /** - * @internal + *The device name of the root device volume (for example,
+ * /dev/sda1).
The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
+ *The root device type used by the AMI. The AMI can use an EBS volume or an instance + * store volume.
*/ - InstanceTypes?: InstanceTypeInfo[]; + RootDeviceType?: DeviceType | string; /** - *The token to use to retrieve the next page of results. This value is null when there
- * are no more results to return.
The security groups for the instance.
*/ - NextToken?: string; -} + SecurityGroups?: GroupIdentifier[]; -export namespace DescribeInstanceTypesResult { /** - * @internal + *Indicates whether source/destination checking is enabled.
*/ - export const filterSensitiveLog = (obj: DescribeInstanceTypesResult): any => ({ - ...obj, - }); -} + SourceDestCheck?: boolean; -export interface DescribeInternetGatewaysRequest { /** - *One or more filters.
- *
- * attachment.state - The current state of the attachment between the gateway
- * and the VPC (available). Present only if a VPC is attached.
- * attachment.vpc-id - The ID of an attached VPC.
- * internet-gateway-id - The ID of the Internet gateway.
- * owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
If the request is a Spot Instance request, the ID of the request.
*/ - Filters?: Filter[]; + SpotInstanceRequestId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface + * is enabled.
*/ - DryRun?: boolean; + SriovNetSupport?: string; /** - *One or more internet gateway IDs.
- *Default: Describes all your internet gateways.
+ *The reason for the most recent state transition.
*/ - InternetGatewayIds?: string[]; + StateReason?: StateReason; /** - *The token for the next page of results.
+ *Any tags assigned to the instance.
*/ - NextToken?: string; + Tags?: Tag[]; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The virtualization type of the instance.
*/ - MaxResults?: number; -} + VirtualizationType?: VirtualizationType | string; -export namespace DescribeInternetGatewaysRequest { /** - * @internal + *The CPU options for the instance.
*/ - export const filterSensitiveLog = (obj: DescribeInternetGatewaysRequest): any => ({ - ...obj, - }); -} + CpuOptions?: CpuOptions; -export interface DescribeInternetGatewaysResult { /** - *Information about one or more internet gateways.
+ *The ID of the Capacity Reservation.
*/ - InternetGateways?: InternetGateway[]; + CapacityReservationId?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the Capacity Reservation targeting option.
*/ - NextToken?: string; -} + CapacityReservationSpecification?: CapacityReservationSpecificationResponse; -export namespace DescribeInternetGatewaysResult { /** - * @internal + *Indicates whether the instance is enabled for hibernation.
*/ - export const filterSensitiveLog = (obj: DescribeInternetGatewaysResult): any => ({ - ...obj, - }); -} + HibernationOptions?: HibernationOptions; -export interface DescribeIpv6PoolsRequest { /** - *The IDs of the IPv6 address pools.
+ *The license configurations for the instance.
*/ - PoolIds?: string[]; + Licenses?: LicenseConfiguration[]; /** - *The token for the next page of results.
+ *The metadata options for the instance.
*/ - NextToken?: string; + MetadataOptions?: InstanceMetadataOptionsResponse; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
*/ - MaxResults?: number; + EnclaveOptions?: EnclaveOptions; /** - *Checks whether you have the required permissions for the action, without 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 boot mode of the instance. For more information, see Boot modes in the + * Amazon EC2 User Guide.
*/ - DryRun?: boolean; + BootMode?: BootModeValues | string; /** - *One or more filters.
- *
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The platform details value for the instance. For more information, see AMI + * billing information fields in the + * Amazon EC2 User Guide.
*/ - Filters?: Filter[]; -} + PlatformDetails?: string; -export namespace DescribeIpv6PoolsRequest { /** - * @internal + *The usage operation value for the instance. For more information, see AMI billing information fields + * in the Amazon EC2 User Guide.
*/ - export const filterSensitiveLog = (obj: DescribeIpv6PoolsRequest): any => ({ - ...obj, - }); -} + UsageOperation?: string; -/** - *Describes a CIDR block for an address pool.
- */ -export interface PoolCidrBlock { /** - *The CIDR block.
+ *The time that the usage operation was last updated.
*/ - Cidr?: string; + UsageOperationUpdateTime?: Date; } -export namespace PoolCidrBlock { +export namespace Instance { /** * @internal */ - export const filterSensitiveLog = (obj: PoolCidrBlock): any => ({ + export const filterSensitiveLog = (obj: Instance): any => ({ ...obj, }); } /** - *Describes an IPv6 address pool.
+ *Describes a launch request for one or more instances, and includes + * owner, requester, and security group information that applies to all + * instances in the launch request.
*/ -export interface Ipv6Pool { +export interface Reservation { /** - *The ID of the address pool.
+ *[EC2-Classic only] The security groups.
*/ - PoolId?: string; + Groups?: GroupIdentifier[]; /** - *The description for the address pool.
+ *The instances.
*/ - Description?: string; + Instances?: Instance[]; /** - *The CIDR blocks for the address pool.
+ *The ID of the Amazon Web Services account that owns the reservation.
*/ - PoolCidrBlocks?: PoolCidrBlock[]; + OwnerId?: string; /** - *Any tags for the address pool.
+ *The ID of the requester that launched the instances on your behalf (for example, + * Amazon Web Services Management Console or Auto Scaling).
*/ - Tags?: Tag[]; + RequesterId?: string; + + /** + *The ID of the reservation.
+ */ + ReservationId?: string; } -export namespace Ipv6Pool { +export namespace Reservation { /** * @internal */ - export const filterSensitiveLog = (obj: Ipv6Pool): any => ({ + export const filterSensitiveLog = (obj: Reservation): any => ({ ...obj, }); } -export interface DescribeIpv6PoolsResult { +export interface DescribeInstancesResult { /** - *Information about the IPv6 address pools.
+ *Information about the reservations.
*/ - Ipv6Pools?: Ipv6Pool[]; + Reservations?: Reservation[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to use to retrieve the next page of results. This value is null
+ * when there are no more results to return.
The filters.
- *
- * key-pair-id - The ID of the key pair.
+ * availability-zone - The Availability Zone of the instance.
- * fingerprint - The fingerprint of the key pair.
+ * event.code - The code for the scheduled event
+ * (instance-reboot | system-reboot |
+ * system-maintenance | instance-retirement |
+ * instance-stop).
- * key-name - The name of the key pair.
+ * event.description - A description of the event.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * event.instance-event-id - The ID of the event whose date and time
+ * you are modifying.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * event.not-after - The latest end time for the scheduled event
+ * (for example, 2014-09-15T17:15:20.000Z).
+ * event.not-before - The earliest start time for the scheduled
+ * event (for example, 2014-09-15T17:15:20.000Z).
+ * event.not-before-deadline - The deadline for starting the event
+ * (for example, 2014-09-15T17:15:20.000Z).
+ * instance-state-code - The code for the instance state, as a
+ * 16-bit unsigned integer. The high byte is used for internal purposes and should
+ * be ignored. The low byte is set based on the state represented. The valid values
+ * are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64
+ * (stopping), and 80 (stopped).
+ * instance-state-name - The state of the instance
+ * (pending | running | shutting-down |
+ * terminated | stopping |
+ * stopped).
+ * instance-status.reachability - Filters on instance status where
+ * the name is reachability (passed | failed
+ * | initializing | insufficient-data).
+ * instance-status.status - The status of the instance
+ * (ok | impaired | initializing |
+ * insufficient-data | not-applicable).
+ * system-status.reachability - Filters on system status where the
+ * name is reachability (passed | failed |
+ * initializing | insufficient-data).
+ * system-status.status - The system status of the instance
+ * (ok | impaired | initializing |
+ * insufficient-data | not-applicable).
The key pair names.
- *Default: Describes all of your key pairs.
+ *The instance IDs.
+ *Default: Describes all your instances.
+ *Constraints: Maximum 100 explicitly specified instance IDs.
*/ - KeyNames?: string[]; + InstanceIds?: string[]; /** - *The IDs of the key pairs.
+ *The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another call with the returned NextToken value. This value
+ * can be between 5 and 1000. You cannot specify this parameter and the instance IDs
+ * parameter in the same call.
The token to retrieve the next page of results.
+ */ + NextToken?: string; /** *Checks whether you have the required permissions for the action, without actually making the request,
@@ -4127,1353 +3586,1369 @@ export interface DescribeKeyPairsRequest {
* Otherwise, it is UnauthorizedOperation.
When true, includes the health status for all instances. When
+ * false, includes the health status for running instances only.
Default: false
+ *
Describes a key pair.
+ *Describes a scheduled event for an instance.
*/ -export interface KeyPairInfo { - /** - *The ID of the key pair.
- */ - KeyPairId?: string; - +export interface InstanceStatusEvent { /** - *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 ID of the event.
*/ - KeyFingerprint?: string; + InstanceEventId?: string; /** - *The name of the key pair.
+ *The event code.
*/ - KeyName?: string; + Code?: EventCode | string; /** - *The type of key pair.
+ *A description of the event.
+ *After a scheduled event is completed, it can still be described for up to a week. If + * the event has been completed, this description starts with the following text: + * [Completed].
*/ - KeyType?: KeyType | string; + Description?: string; /** - *Any tags applied to the key pair.
+ *The latest scheduled end time for the event.
*/ - Tags?: Tag[]; -} + NotAfter?: Date; -export namespace KeyPairInfo { /** - * @internal + *The earliest scheduled start time for the event.
*/ - export const filterSensitiveLog = (obj: KeyPairInfo): any => ({ - ...obj, - }); -} + NotBefore?: Date; -export interface DescribeKeyPairsResult { /** - *Information about the key pairs.
+ *The deadline for starting the event.
*/ - KeyPairs?: KeyPairInfo[]; + NotBeforeDeadline?: Date; } -export namespace DescribeKeyPairsResult { +export namespace InstanceStatusEvent { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeKeyPairsResult): any => ({ + export const filterSensitiveLog = (obj: InstanceStatusEvent): any => ({ ...obj, }); } -export interface DescribeLaunchTemplatesRequest { +export type StatusName = "reachability"; + +export type StatusType = "failed" | "initializing" | "insufficient-data" | "passed"; + +/** + *Describes the instance status.
+ */ +export interface InstanceStatusDetails { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The time when a status check failed. For an instance that was launched and impaired, + * this is the time when the instance was launched.
*/ - DryRun?: boolean; + ImpairedSince?: Date; /** - *One or more launch template IDs.
+ *The type of instance status.
*/ - LaunchTemplateIds?: string[]; + Name?: StatusName | string; /** - *One or more launch template names.
+ *The status.
*/ - LaunchTemplateNames?: string[]; + Status?: StatusType | string; +} +export namespace InstanceStatusDetails { /** - *One or more filters.
- *
- * create-time - The time the launch template was created.
- * launch-template-name - The name of the launch template.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Describes the status of an instance.
+ */ +export interface InstanceStatusSummary { /** - *The token to request the next page of results.
+ *The system instance health or application instance health.
*/ - NextToken?: string; + Details?: InstanceStatusDetails[]; /** - *The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another call with the returned NextToken value. This value
- * can be between 1 and 200.
The status.
*/ - MaxResults?: number; + Status?: SummaryStatus | string; } -export namespace DescribeLaunchTemplatesRequest { +export namespace InstanceStatusSummary { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLaunchTemplatesRequest): any => ({ + export const filterSensitiveLog = (obj: InstanceStatusSummary): any => ({ ...obj, }); } -export interface DescribeLaunchTemplatesResult { +/** + *Describes the status of an instance.
+ */ +export interface InstanceStatus { /** - *Information about the launch templates.
+ *The Availability Zone of the instance.
*/ - LaunchTemplates?: LaunchTemplate[]; + AvailabilityZone?: string; /** - *The token to use to retrieve the next page of results. This value is
- * null when there are no more results to return.
The Amazon Resource Name (ARN) of the Outpost.
*/ - NextToken?: string; -} + OutpostArn?: string; -export namespace DescribeLaunchTemplatesResult { /** - * @internal + *Any scheduled events associated with the instance.
*/ - export const filterSensitiveLog = (obj: DescribeLaunchTemplatesResult): any => ({ - ...obj, - }); -} + Events?: InstanceStatusEvent[]; -export interface DescribeLaunchTemplateVersionsRequest { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The ID of the instance.
*/ - DryRun?: boolean; + InstanceId?: string; /** - *The ID of the launch template. To describe one or more versions of a specified launch - * template, you must specify either the launch template ID or the launch template name in - * the request. To describe all the latest or default launch template versions in your - * account, you must omit this parameter.
+ *The intended state of the instance. DescribeInstanceStatus requires
+ * that an instance be in the running state.
The name of the launch template. To describe one or more versions of a specified - * launch template, you must specify either the launch template ID or the launch template - * name in the request. To describe all the latest or default launch template versions in - * your account, you must omit this parameter.
+ *Reports impaired functionality that stems from issues internal to the instance, such + * as impaired reachability.
*/ - LaunchTemplateName?: string; + InstanceStatus?: InstanceStatusSummary; /** - *One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.
- *To describe one or more versions of a specified launch template, valid values are $Latest, $Default, and numbers.
To describe all launch templates in your account that are defined as the latest
- * version, the valid value is $Latest. To describe all launch templates in
- * your account that are defined as the default version, the valid value is
- * $Default. You can specify $Latest and
- * $Default in the same call. You cannot specify numbers.
Reports impaired functionality that stems from issues related to the systems that + * support an instance, such as hardware failures and network connectivity problems.
*/ - Versions?: string[]; + SystemStatus?: InstanceStatusSummary; +} +export namespace InstanceStatus { /** - *The version number after which to describe launch template versions.
+ * @internal */ - MinVersion?: string; + export const filterSensitiveLog = (obj: InstanceStatus): any => ({ + ...obj, + }); +} +export interface DescribeInstanceStatusResult { /** - *The version number up to which to describe launch template versions.
+ *Information about the status of the instances.
*/ - MaxVersion?: string; + InstanceStatuses?: InstanceStatus[]; /** - *The token to request the next page of results.
+ *The token to use to retrieve the next page of results. This value is null
+ * when there are no more results to return.
The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another call with the returned NextToken value. This value
- * can be between 1 and 200.
One or more filters.
- *Checks whether you have the required permissions for the action, without 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 location type.
+ */ + LocationType?: LocationType | string; + + /** + *One or more filters. Filter names and values are case-sensitive.
+ *
- * create-time - The time the launch template version was created.
- * ebs-optimized - A boolean that indicates whether the instance
- * is optimized for Amazon EBS I/O.
- * iam-instance-profile - The ARN of the IAM instance
- * profile.
- * image-id - The ID of the AMI.
- * instance-type - The instance type.
- * is-default-version - A boolean that indicates whether the
- * launch template version is the default version.
- * kernel-id - The kernel ID.
location - This depends on the location type. For example, if the location type is
+ * region (default), the location is the Region code (for example, us-east-2.)
*
- * ram-disk-id - The RAM disk ID.
+ * instance-type - The instance type. For example,
+ * c5.2xlarge.
The maximum number of results to return for the request in a single page. The remaining results + * can be seen by sending another request with the next token value.
+ */ + MaxResults?: number; + + /** + *The token to retrieve the next page of results.
+ */ + NextToken?: string; } -export namespace DescribeLaunchTemplateVersionsRequest { +export namespace DescribeInstanceTypeOfferingsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLaunchTemplateVersionsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeInstanceTypeOfferingsRequest): any => ({ ...obj, }); } -export interface DescribeLaunchTemplateVersionsResult { +/** + *The instance types offered.
+ */ +export interface InstanceTypeOffering { /** - *Information about the launch template versions.
+ *The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
*/ - LaunchTemplateVersions?: LaunchTemplateVersion[]; + InstanceType?: _InstanceType | string; /** - *The token to use to retrieve the next page of results. This value is
- * null when there are no more results to return.
The location type.
+ */ + LocationType?: LocationType | string; + + /** + *The identifier for the location. This depends on the location type. For example, if the location type is
+ * region, the location is the Region code (for example, us-east-2.)
The instance types offered.
+ */ + InstanceTypeOfferings?: InstanceTypeOffering[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there
+ * are no more results to return.
The IDs of the local gateway route tables.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is
+ * DryRunOperation. Otherwise, it is UnauthorizedOperation.
One or more filters.
+ *The instance types. For more information, see Instance types in the Amazon EC2 User Guide.
+ */ + InstanceTypes?: (_InstanceType | string)[]; + + /** + *One or more filters. Filter names and values are case-sensitive.
*
- * local-gateway-id - The ID of a local gateway.
auto-recovery-supported - Indicates whether auto recovery is supported (true | false).
+ *
+ * bare-metal - Indicates whether it is a bare metal instance type (true | false).
+ * burstable-performance-supported - Indicates whether it is a burstable
+ * performance instance type (true | false).
+ * current-generation - Indicates whether this instance type is the latest
+ * generation instance type of an instance family (true | false).
+ * ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline
+ * bandwidth performance for an EBS-optimized instance type, in Mbps.
+ * ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage
+ * operations per second for an EBS-optimized instance type.
+ * ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline
+ * throughput performance for an EBS-optimized instance type, in MB/s.
+ * ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth
+ * performance for an EBS-optimized instance type, in Mbps.
+ * ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage
+ * operations per second for an EBS-optimized instance type.
+ * ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum
+ * throughput performance for an EBS-optimized instance type, in MB/s.
+ * ebs-info.ebs-optimized-support - Indicates whether the instance type is
+ * EBS-optimized (supported | unsupported |
+ * default).
+ * ebs-info.encryption-support - Indicates whether EBS encryption is supported
+ * (supported | unsupported).
+ * ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe)
+ * is supported for EBS volumes (required | supported | unsupported).
+ * free-tier-eligible - Indicates whether the instance type is eligible to use
+ * in the free tier (true | false).
+ * hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
+ * hypervisor - The hypervisor (nitro | xen).
+ * instance-storage-info.disk.count - The number of local disks.
+ * instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in
+ * GB.
+ * instance-storage-info.disk.type - The storage technology for the local
+ * instance storage disks (hdd | ssd).
+ * instance-storage-info.encryption-supported - Indicates whether data is encrypted at rest
+ * (required | unsupported).
+ * instance-storage-info.nvme-support - Indicates whether non-volatile memory
+ * express (NVMe) is supported for instance store (required | supported |
+ * unsupported).
+ * instance-storage-info.total-size-in-gb - The total amount of storage available from all local
+ * instance storage, in GB.
+ * instance-storage-supported - Indicates whether the instance type has local
+ * instance storage (true | false).
+ * instance-type - The instance type (for example c5.2xlarge or
+ * c5*).
+ * memory-info.size-in-mib - The memory size.
+ * network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic
+ * Fabric Adapters (EFAs) per instance.
+ * network-info.efa-supported - Indicates whether the instance type supports
+ * Elastic Fabric Adapter (EFA) (true | false).
+ * network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is
+ * supported or required (required | supported |
+ * unsupported).
+ * network-info.encryption-in-transit-supported - Indicates whether the instance type
+ * automatically encrypts in-transit traffic between instances (true | false).
+ * network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per
+ * network interface.
+ * network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per
+ * network interface.
+ * network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
+ * network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
+ * network-info.network-performance - The network performance (for example, "25
+ * Gigabit").
+ * processor-info.supported-architecture - The CPU architecture
+ * (arm64 | i386 | x86_64).
+ * processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
+ * supported-boot-mode - The boot mode (legacy-bios |
+ * uefi).
+ * supported-root-device-type - The root device type (ebs |
+ * instance-store).
+ * supported-usage-class - The usage class (on-demand |
+ * spot).
+ * supported-virtualization-type - The virtualization type (hvm |
+ * paravirtual).
- * local-gateway-route-table-id - The ID of a local gateway route table.
vcpu-info.default-cores - The default number of cores for the instance type.
*
- * outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance
+ * type.
*
- * state - The state of the local gateway route table.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
+ *
+ * vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
+ * vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type.
+ * For example, "1" or "1,2".
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of results to return for the request in a single page. The remaining results + * can be seen by sending another request with the next token value.
*/ MaxResults?: number; /** - *The token for the next page of results.
+ *The token to retrieve the next page of results.
*/ NextToken?: string; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes a local gateway route table.
+ *Describes the optimized EBS performance for supported instance types.
*/ -export interface LocalGatewayRouteTable { - /** - *The ID of the local gateway route table.
- */ - LocalGatewayRouteTableId?: string; - - /** - *The Amazon Resource Name (ARN) of the local gateway route table.
- */ - LocalGatewayRouteTableArn?: string; - - /** - *The ID of the local gateway.
- */ - LocalGatewayId?: string; - - /** - *The Amazon Resource Name (ARN) of the Outpost.
- */ - OutpostArn?: string; - +export interface EbsOptimizedInfo { /** - *The ID of the Amazon Web Services account that owns the local gateway route table.
+ *The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
*/ - OwnerId?: string; + BaselineBandwidthInMbps?: number; /** - *The state of the local gateway route table.
+ *The baseline throughput performance for an EBS-optimized instance type, in MB/s.
*/ - State?: string; + BaselineThroughputInMBps?: number; /** - *The tags assigned to the local gateway route table.
+ *The baseline input/output storage operations per seconds for an EBS-optimized instance type.
*/ - Tags?: Tag[]; -} + BaselineIops?: number; -export namespace LocalGatewayRouteTable { /** - * @internal + *The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
*/ - export const filterSensitiveLog = (obj: LocalGatewayRouteTable): any => ({ - ...obj, - }); -} + MaximumBandwidthInMbps?: number; -export interface DescribeLocalGatewayRouteTablesResult { /** - *Information about the local gateway route tables.
+ *The maximum throughput performance for an EBS-optimized instance type, in MB/s.
*/ - LocalGatewayRouteTables?: LocalGatewayRouteTable[]; + MaximumThroughputInMBps?: number; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The maximum input/output storage operations per second for an EBS-optimized instance type.
*/ - NextToken?: string; + MaximumIops?: number; } -export namespace DescribeLocalGatewayRouteTablesResult { +export namespace EbsOptimizedInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTablesResult): any => ({ + export const filterSensitiveLog = (obj: EbsOptimizedInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest { - /** - *The IDs of the associations.
- */ - LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds?: string[]; - - /** - *One or more filters.
- *
- * local-gateway-id - The ID of a local gateway.
- * local-gateway-route-table-id - The ID of the local gateway route table.
- * local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
- * local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
- * state - The state of the association.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
- */ - NextToken?: string; +export type EbsOptimizedSupport = "default" | "supported" | "unsupported"; - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes an association between a local gateway route table and a virtual interface group.
+ *Describes the Amazon EBS features supported by the instance type.
*/ -export interface LocalGatewayRouteTableVirtualInterfaceGroupAssociation { - /** - *The ID of the association.
- */ - LocalGatewayRouteTableVirtualInterfaceGroupAssociationId?: string; - - /** - *The ID of the virtual interface group.
- */ - LocalGatewayVirtualInterfaceGroupId?: string; - - /** - *The ID of the local gateway.
- */ - LocalGatewayId?: string; - - /** - *The ID of the local gateway route table.
- */ - LocalGatewayRouteTableId?: string; - +export interface EbsInfo { /** - *The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
+ *Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized + * instances in Amazon EC2 User Guide.
*/ - LocalGatewayRouteTableArn?: string; + EbsOptimizedSupport?: EbsOptimizedSupport | string; /** - *The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.
+ *Indicates whether Amazon EBS encryption is supported.
*/ - OwnerId?: string; + EncryptionSupport?: EbsEncryptionSupport | string; /** - *The state of the association.
+ *Describes the optimized EBS performance for the instance type.
*/ - State?: string; + EbsOptimizedInfo?: EbsOptimizedInfo; /** - *The tags assigned to the association.
+ *Indicates whether non-volatile memory express (NVMe) is supported.
*/ - Tags?: Tag[]; + NvmeSupport?: EbsNvmeSupport | string; } -export namespace LocalGatewayRouteTableVirtualInterfaceGroupAssociation { +export namespace EbsInfo { /** * @internal */ - export const filterSensitiveLog = (obj: LocalGatewayRouteTableVirtualInterfaceGroupAssociation): any => ({ + export const filterSensitiveLog = (obj: EbsInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult { - /** - *Information about the associations.
- */ - LocalGatewayRouteTableVirtualInterfaceGroupAssociations?: LocalGatewayRouteTableVirtualInterfaceGroupAssociation[]; - +/** + *Describes the memory for the FPGA accelerator for the instance type.
+ */ +export interface FpgaDeviceMemoryInfo { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The size of the memory available to the FPGA accelerator, in MiB.
*/ - NextToken?: string; + SizeInMiB?: number; } -export namespace DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult { +export namespace FpgaDeviceMemoryInfo { /** * @internal */ - export const filterSensitiveLog = ( - obj: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult - ): any => ({ + export const filterSensitiveLog = (obj: FpgaDeviceMemoryInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewayRouteTableVpcAssociationsRequest { - /** - *The IDs of the associations.
- */ - LocalGatewayRouteTableVpcAssociationIds?: string[]; - - /** - *One or more filters.
- *
- * local-gateway-id - The ID of a local gateway.
- * local-gateway-route-table-id - The ID of the local gateway route table.
- * local-gateway-route-table-vpc-association-id - The ID of the association.
- * state - The state of the association.
- * vpc-id - The ID of the VPC.
Describes the FPGA accelerator for the instance type.
+ */ +export interface FpgaDeviceInfo { + /** + *The name of the FPGA accelerator.
*/ - Filters?: Filter[]; + Name?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The manufacturer of the FPGA accelerator.
*/ - MaxResults?: number; + Manufacturer?: string; /** - *The token for the next page of results.
+ *The count of FPGA accelerators for the instance type.
*/ - NextToken?: string; + Count?: number; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes the memory for the FPGA accelerator for the instance type.
*/ - DryRun?: boolean; + MemoryInfo?: FpgaDeviceMemoryInfo; } -export namespace DescribeLocalGatewayRouteTableVpcAssociationsRequest { +export namespace FpgaDeviceInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTableVpcAssociationsRequest): any => ({ + export const filterSensitiveLog = (obj: FpgaDeviceInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewayRouteTableVpcAssociationsResult { +/** + *Describes the FPGAs for the instance type.
+ */ +export interface FpgaInfo { /** - *Information about the associations.
+ *Describes the FPGAs for the instance type.
*/ - LocalGatewayRouteTableVpcAssociations?: LocalGatewayRouteTableVpcAssociation[]; + Fpgas?: FpgaDeviceInfo[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The total memory of all FPGA accelerators for the instance type.
*/ - NextToken?: string; + TotalFpgaMemoryInMiB?: number; } -export namespace DescribeLocalGatewayRouteTableVpcAssociationsResult { +export namespace FpgaInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTableVpcAssociationsResult): any => ({ + export const filterSensitiveLog = (obj: FpgaInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewaysRequest { +/** + *Describes the memory available to the GPU accelerator.
+ */ +export interface GpuDeviceMemoryInfo { /** - *One or more filters.
- *
- * local-gateway-id - The ID of a local gateway.
- * local-gateway-route-table-id - The ID of the local gateway route table.
- * local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
- * local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
- * outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
- * state - The state of the association.
The size of the memory available to the GPU accelerator, in MiB.
*/ - LocalGatewayIds?: string[]; + SizeInMiB?: number; +} +export namespace GpuDeviceMemoryInfo { /** - *One or more filters.
+ * @internal */ - Filters?: Filter[]; + export const filterSensitiveLog = (obj: GpuDeviceMemoryInfo): any => ({ + ...obj, + }); +} +/** + *Describes the GPU accelerators for the instance type.
+ */ +export interface GpuDeviceInfo { /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The name of the GPU accelerator.
*/ - MaxResults?: number; + Name?: string; /** - *The token for the next page of results.
+ *The manufacturer of the GPU accelerator.
*/ - NextToken?: string; + Manufacturer?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The number of GPUs for the instance type.
*/ - DryRun?: boolean; + Count?: number; + + /** + *Describes the memory available to the GPU accelerator.
+ */ + MemoryInfo?: GpuDeviceMemoryInfo; } -export namespace DescribeLocalGatewaysRequest { +export namespace GpuDeviceInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLocalGatewaysRequest): any => ({ + export const filterSensitiveLog = (obj: GpuDeviceInfo): any => ({ ...obj, }); } /** - *Describes a local gateway.
+ *Describes the GPU accelerators for the instance type.
*/ -export interface LocalGateway { +export interface GpuInfo { /** - *The ID of the local gateway.
+ *Describes the GPU accelerators for the instance type.
*/ - LocalGatewayId?: string; + Gpus?: GpuDeviceInfo[]; /** - *The Amazon Resource Name (ARN) of the Outpost.
+ *The total size of the memory for the GPU accelerators for the instance type, in MiB.
*/ - OutpostArn?: string; + TotalGpuMemoryInMiB?: number; +} +export namespace GpuInfo { /** - *The ID of the Amazon Web Services account that owns the local gateway.
+ * @internal */ - OwnerId?: string; + export const filterSensitiveLog = (obj: GpuInfo): any => ({ + ...obj, + }); +} + +export enum InstanceTypeHypervisor { + NITRO = "nitro", + XEN = "xen", +} + +/** + *Describes the Inference accelerators for the instance type.
+ */ +export interface InferenceDeviceInfo { + /** + *The number of Inference accelerators for the instance type.
+ */ + Count?: number; /** - *The state of the local gateway.
+ *The name of the Inference accelerator.
*/ - State?: string; + Name?: string; /** - *The tags assigned to the local gateway.
+ *The manufacturer of the Inference accelerator.
*/ - Tags?: Tag[]; + Manufacturer?: string; } -export namespace LocalGateway { +export namespace InferenceDeviceInfo { /** * @internal */ - export const filterSensitiveLog = (obj: LocalGateway): any => ({ + export const filterSensitiveLog = (obj: InferenceDeviceInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewaysResult { +/** + *Describes the Inference accelerators for the instance type.
+ */ +export interface InferenceAcceleratorInfo { /** - *Information about the local gateways.
+ *Describes the Inference accelerators for the instance type.
*/ - LocalGateways?: LocalGateway[]; + Accelerators?: InferenceDeviceInfo[]; +} +export namespace InferenceAcceleratorInfo { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes a disk.
+ */ +export interface DiskInfo { + /** + *The size of the disk in GB.
+ */ + SizeInGB?: number; + + /** + *The number of disks with this configuration.
+ */ + Count?: number; + + /** + *The type of disk.
+ */ + Type?: DiskType | string; +} + +export namespace DiskInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLocalGatewaysResult): any => ({ + export const filterSensitiveLog = (obj: DiskInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewayVirtualInterfaceGroupsRequest { - /** - *The IDs of the virtual interface groups.
- */ - LocalGatewayVirtualInterfaceGroupIds?: string[]; +export enum InstanceStorageEncryptionSupport { + required = "required", + unsupported = "unsupported", +} + +export enum EphemeralNvmeSupport { + REQUIRED = "required", + SUPPORTED = "supported", + UNSUPPORTED = "unsupported", +} +/** + *Describes the instance store features that are supported by the instance type.
+ */ +export interface InstanceStorageInfo { /** - *One or more filters.
- *
- * local-gateway-id - The ID of a local gateway.
- * local-gateway-virtual-interface-id - The ID of the virtual interface.
- * local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
The total size of the disks, in GB.
*/ - Filters?: Filter[]; + TotalSizeInGB?: number; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Describes the disks that are available for the instance type.
*/ - MaxResults?: number; + Disks?: DiskInfo[]; /** - *The token for the next page of results.
+ *Indicates whether non-volatile memory express (NVMe) is supported.
*/ - NextToken?: string; + NvmeSupport?: EphemeralNvmeSupport | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Indicates whether data is encrypted at rest.
*/ - DryRun?: boolean; + EncryptionSupport?: InstanceStorageEncryptionSupport | string; } -export namespace DescribeLocalGatewayVirtualInterfaceGroupsRequest { +export namespace InstanceStorageInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLocalGatewayVirtualInterfaceGroupsRequest): any => ({ + export const filterSensitiveLog = (obj: InstanceStorageInfo): any => ({ ...obj, }); } /** - *Describes a local gateway virtual interface group.
+ *Describes the memory for the instance type.
*/ -export interface LocalGatewayVirtualInterfaceGroup { - /** - *The ID of the virtual interface group.
- */ - LocalGatewayVirtualInterfaceGroupId?: string; - - /** - *The IDs of the virtual interfaces.
- */ - LocalGatewayVirtualInterfaceIds?: string[]; - +export interface MemoryInfo { /** - *The ID of the local gateway.
+ *The size of the memory, in MiB.
*/ - LocalGatewayId?: string; + SizeInMiB?: number; +} +export namespace MemoryInfo { /** - *The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
+ * @internal */ - OwnerId?: string; + export const filterSensitiveLog = (obj: MemoryInfo): any => ({ + ...obj, + }); +} +/** + *Describes the Elastic Fabric Adapters for the instance type.
+ */ +export interface EfaInfo { /** - *The tags assigned to the virtual interface group.
+ *The maximum number of Elastic Fabric Adapters for the instance type.
*/ - Tags?: Tag[]; + MaximumEfaInterfaces?: number; } -export namespace LocalGatewayVirtualInterfaceGroup { +export namespace EfaInfo { /** * @internal */ - export const filterSensitiveLog = (obj: LocalGatewayVirtualInterfaceGroup): any => ({ + export const filterSensitiveLog = (obj: EfaInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewayVirtualInterfaceGroupsResult { +export type EnaSupport = "required" | "supported" | "unsupported"; + +/** + *Describes the network card support of the instance type.
+ */ +export interface NetworkCardInfo { /** - *The virtual interface groups.
+ *The index of the network card.
*/ - LocalGatewayVirtualInterfaceGroups?: LocalGatewayVirtualInterfaceGroup[]; + NetworkCardIndex?: number; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The network performance of the network card.
*/ - NextToken?: string; + NetworkPerformance?: string; + + /** + *The maximum number of network interfaces for the network card.
+ */ + MaximumNetworkInterfaces?: number; } -export namespace DescribeLocalGatewayVirtualInterfaceGroupsResult { +export namespace NetworkCardInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLocalGatewayVirtualInterfaceGroupsResult): any => ({ + export const filterSensitiveLog = (obj: NetworkCardInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewayVirtualInterfacesRequest { +/** + *Describes the networking features of the instance type.
+ */ +export interface NetworkInfo { /** - *The IDs of the virtual interfaces.
+ *The network performance.
*/ - LocalGatewayVirtualInterfaceIds?: string[]; + NetworkPerformance?: string; /** - *One or more filters.
+ *The maximum number of network interfaces for the instance type.
*/ - Filters?: Filter[]; + MaximumNetworkInterfaces?: number; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of physical network cards that can be allocated to the instance.
*/ - MaxResults?: number; + MaximumNetworkCards?: number; /** - *The token for the next page of results.
+ *The index of the default network card, starting at 0.
*/ - NextToken?: string; + DefaultNetworkCardIndex?: number; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes the network cards for the instance type.
*/ - DryRun?: boolean; -} + NetworkCards?: NetworkCardInfo[]; -export namespace DescribeLocalGatewayVirtualInterfacesRequest { /** - * @internal + *The maximum number of IPv4 addresses per network interface.
*/ - export const filterSensitiveLog = (obj: DescribeLocalGatewayVirtualInterfacesRequest): any => ({ - ...obj, - }); -} + Ipv4AddressesPerInterface?: number; -/** - *Describes a local gateway virtual interface.
- */ -export interface LocalGatewayVirtualInterface { /** - *The ID of the virtual interface.
+ *The maximum number of IPv6 addresses per network interface.
*/ - LocalGatewayVirtualInterfaceId?: string; + Ipv6AddressesPerInterface?: number; /** - *The ID of the local gateway.
+ *Indicates whether IPv6 is supported.
*/ - LocalGatewayId?: string; + Ipv6Supported?: boolean; /** - *The ID of the VLAN.
+ *Indicates whether Elastic Network Adapter (ENA) is supported.
*/ - Vlan?: number; + EnaSupport?: EnaSupport | string; /** - *The local address.
+ *Indicates whether Elastic Fabric Adapter (EFA) is supported.
*/ - LocalAddress?: string; + EfaSupported?: boolean; /** - *The peer address.
+ *Describes the Elastic Fabric Adapters for the instance type.
*/ - PeerAddress?: string; + EfaInfo?: EfaInfo; /** - *The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
+ *Indicates whether the instance type automatically encrypts in-transit traffic between instances.
*/ - LocalBgpAsn?: number; + EncryptionInTransitSupported?: boolean; +} +export namespace NetworkInfo { /** - *The peer BGP ASN.
+ * @internal */ - PeerBgpAsn?: number; + export const filterSensitiveLog = (obj: NetworkInfo): any => ({ + ...obj, + }); +} - /** - *The ID of the Amazon Web Services account that owns the local gateway virtual interface.
- */ - OwnerId?: string; +export type PlacementGroupStrategy = "cluster" | "partition" | "spread"; +/** + *Describes the placement group support of the instance type.
+ */ +export interface PlacementGroupInfo { /** - *The tags assigned to the virtual interface.
+ *The supported placement group types.
*/ - Tags?: Tag[]; + SupportedStrategies?: (PlacementGroupStrategy | string)[]; } -export namespace LocalGatewayVirtualInterface { +export namespace PlacementGroupInfo { /** * @internal */ - export const filterSensitiveLog = (obj: LocalGatewayVirtualInterface): any => ({ + export const filterSensitiveLog = (obj: PlacementGroupInfo): any => ({ ...obj, }); } -export interface DescribeLocalGatewayVirtualInterfacesResult { +export type ArchitectureType = "arm64" | "i386" | "x86_64" | "x86_64_mac"; + +/** + *Describes the processor used by the instance type.
+ */ +export interface ProcessorInfo { /** - *Information about the virtual interfaces.
+ *The architectures supported by the instance type.
*/ - LocalGatewayVirtualInterfaces?: LocalGatewayVirtualInterface[]; + SupportedArchitectures?: (ArchitectureType | string)[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The speed of the processor, in GHz.
*/ - NextToken?: string; + SustainedClockSpeedInGhz?: number; } -export namespace DescribeLocalGatewayVirtualInterfacesResult { +export namespace ProcessorInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeLocalGatewayVirtualInterfacesResult): any => ({ + export const filterSensitiveLog = (obj: ProcessorInfo): any => ({ ...obj, }); } -export interface DescribeManagedPrefixListsRequest { +export type BootModeType = "legacy-bios" | "uefi"; + +export type RootDeviceType = "ebs" | "instance-store"; + +export type UsageClassType = "on-demand" | "spot"; + +/** + *Describes the vCPU configurations for the instance type.
+ */ +export interface VCpuInfo { /** - *Checks whether you have the required permissions for the action, without 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 default number of vCPUs for the instance type.
*/ - DryRun?: boolean; + DefaultVCpus?: number; /** - *One or more filters.
- *
- * owner-id - The ID of the prefix list owner.
- * prefix-list-id - The ID of the prefix list.
- * prefix-list-name - The name of the prefix list.
The default number of cores for the instance type.
*/ - Filters?: Filter[]; + DefaultCores?: number; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The default number of threads per core for the instance type.
*/ - MaxResults?: number; + DefaultThreadsPerCore?: number; /** - *The token for the next page of results.
+ *The valid number of cores that can be configured for the instance type.
*/ - NextToken?: string; + ValidCores?: number[]; /** - *One or more prefix list IDs.
+ *The valid number of threads per core that can be configured for the instance type.
*/ - PrefixListIds?: string[]; + ValidThreadsPerCore?: number[]; } -export namespace DescribeManagedPrefixListsRequest { +export namespace VCpuInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeManagedPrefixListsRequest): any => ({ + export const filterSensitiveLog = (obj: VCpuInfo): any => ({ ...obj, }); } -export interface DescribeManagedPrefixListsResult { +/** + *Describes the instance type.
+ */ +export interface InstanceTypeInfo { + /** + *The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
+ */ + InstanceType?: _InstanceType | string; + + /** + *Indicates whether the instance type is current generation.
+ */ + CurrentGeneration?: boolean; + + /** + *Indicates whether the instance type is eligible for the free tier.
+ */ + FreeTierEligible?: boolean; + + /** + *Indicates whether the instance type is offered for spot or On-Demand.
+ */ + SupportedUsageClasses?: (UsageClassType | string)[]; + /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The supported root device types.
*/ - NextToken?: string; + SupportedRootDeviceTypes?: (RootDeviceType | string)[]; /** - *Information about the prefix lists.
+ *The supported virtualization types.
*/ - PrefixLists?: ManagedPrefixList[]; -} + SupportedVirtualizationTypes?: (VirtualizationType | string)[]; -export namespace DescribeManagedPrefixListsResult { /** - * @internal + *Indicates whether the instance is a bare metal instance type.
*/ - export const filterSensitiveLog = (obj: DescribeManagedPrefixListsResult): any => ({ - ...obj, - }); -} + BareMetal?: boolean; -export interface DescribeMovingAddressesRequest { /** - *One or more filters.
- *
- * moving-status - The status of the Elastic IP address
- * (MovingToVpc | RestoringToClassic).
The hypervisor for the instance type.
*/ - Filters?: Filter[]; + Hypervisor?: InstanceTypeHypervisor | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes the processor.
*/ - DryRun?: boolean; + ProcessorInfo?: ProcessorInfo; /** - *The maximum number of results to return for the request in a single page. The remaining
- * results of the initial request can be seen by sending another request with the returned
- * NextToken value. This value can be between 5 and 1000; if
- * MaxResults is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
+ *Describes the vCPU configurations for the instance type.
*/ - MaxResults?: number; + VCpuInfo?: VCpuInfo; /** - *The token for the next page of results.
+ *Describes the memory for the instance type.
*/ - NextToken?: string; + MemoryInfo?: MemoryInfo; /** - *One or more Elastic IP addresses.
+ *Indicates whether instance storage is supported.
*/ - PublicIps?: string[]; -} + InstanceStorageSupported?: boolean; -export namespace DescribeMovingAddressesRequest { /** - * @internal + *Describes the instance storage for the instance type.
*/ - export const filterSensitiveLog = (obj: DescribeMovingAddressesRequest): any => ({ - ...obj, - }); -} - -export type MoveStatus = "movingToVpc" | "restoringToClassic"; + InstanceStorageInfo?: InstanceStorageInfo; -/** - *Describes the status of a moving Elastic IP address.
- */ -export interface MovingAddressStatus { /** - *The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.
+ *Describes the Amazon EBS settings for the instance type.
*/ - MoveStatus?: MoveStatus | string; + EbsInfo?: EbsInfo; /** - *The Elastic IP address.
+ *Describes the network settings for the instance type.
*/ - PublicIp?: string; -} + NetworkInfo?: NetworkInfo; -export namespace MovingAddressStatus { /** - * @internal + *Describes the GPU accelerator settings for the instance type.
*/ - export const filterSensitiveLog = (obj: MovingAddressStatus): any => ({ - ...obj, - }); -} + GpuInfo?: GpuInfo; -export interface DescribeMovingAddressesResult { /** - *The status for each Elastic IP address.
+ *Describes the FPGA accelerator settings for the instance type.
*/ - MovingAddressStatuses?: MovingAddressStatus[]; + FpgaInfo?: FpgaInfo; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the placement group settings for the instance type.
*/ - NextToken?: string; -} + PlacementGroupInfo?: PlacementGroupInfo; -export namespace DescribeMovingAddressesResult { /** - * @internal + *Describes the Inference accelerator settings for the instance type.
*/ - export const filterSensitiveLog = (obj: DescribeMovingAddressesResult): any => ({ - ...obj, - }); -} + InferenceAcceleratorInfo?: InferenceAcceleratorInfo; -export interface DescribeNatGatewaysRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Indicates whether On-Demand hibernation is supported.
*/ - DryRun?: boolean; + HibernationSupported?: boolean; /** - *One or more filters.
- *
- * nat-gateway-id - The ID of the NAT gateway.
- * state - The state of the NAT gateway (pending |
- * failed | available | deleting | deleted).
- * subnet-id - The ID of the subnet in which the NAT gateway resides.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * vpc-id - The ID of the VPC in which the NAT gateway resides.
Indicates whether the instance type is a burstable performance instance type.
*/ - Filter?: Filter[]; + BurstablePerformanceSupported?: boolean; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Indicates whether Dedicated Hosts are supported on the instance type.
*/ - MaxResults?: number; + DedicatedHostsSupported?: boolean; /** - *One or more NAT gateway IDs.
+ *Indicates whether auto recovery is supported.
*/ - NatGatewayIds?: string[]; + AutoRecoverySupported?: boolean; /** - *The token for the next page of results.
+ *The supported boot modes. For more information, see Boot modes in the + * Amazon EC2 User Guide.
*/ - NextToken?: string; + SupportedBootModes?: (BootModeType | string)[]; } -export namespace DescribeNatGatewaysRequest { +export namespace InstanceTypeInfo { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeNatGatewaysRequest): any => ({ + export const filterSensitiveLog = (obj: InstanceTypeInfo): any => ({ ...obj, }); } -export interface DescribeNatGatewaysResult { +export interface DescribeInstanceTypesResult { /** - *Information about the NAT gateways.
+ *The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
*/ - NatGateways?: NatGateway[]; + InstanceTypes?: InstanceTypeInfo[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to use to retrieve the next page of results. This value is null when there
+ * are no more results to return.
One or more filters.
- *
- * association.association-id - The ID of an association ID for the ACL.
- * association.network-acl-id - The ID of the network ACL involved in the association.
- * association.subnet-id - The ID of the subnet involved in the association.
- * default - Indicates whether the ACL is the default network ACL for the VPC.
- * entry.cidr - The IPv4 CIDR range specified in the entry.
- * entry.icmp.code - The ICMP code specified in the entry, if any.
- * entry.icmp.type - The ICMP type specified in the entry, if any.
- * entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
- * entry.port-range.from - The start of the port range specified in the entry.
- * entry.port-range.to - The end of the port range specified in the entry.
- * entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
- * entry.rule-action - Allows or denies the matching traffic (allow | deny).
+ * attachment.state - The current state of the attachment between the gateway
+ * and the VPC (available). Present only if a VPC is attached.
- * entry.rule-number - The number of an entry (in other words, rule) in
- * the set of ACL entries.
+ * attachment.vpc-id - The ID of an attached VPC.
- * network-acl-id - The ID of the network ACL.
+ * internet-gateway-id - The ID of the Internet gateway.
- * owner-id - The ID of the Amazon Web Services account that owns the network ACL.
+ * owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
+ *
* tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ *
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * vpc-id - The ID of the VPC for the network ACL.
One or more network ACL IDs.
- *Default: Describes all your network ACLs.
+ *One or more internet gateway IDs.
+ *Default: Describes all your internet gateways.
*/ - NetworkAclIds?: string[]; + InternetGatewayIds?: string[]; /** *The token for the next page of results.
@@ -5503,20 +4978,20 @@ export interface DescribeNetworkAclsRequest { MaxResults?: number; } -export namespace DescribeNetworkAclsRequest { +export namespace DescribeInternetGatewaysRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeNetworkAclsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeInternetGatewaysRequest): any => ({ ...obj, }); } -export interface DescribeNetworkAclsResult { +export interface DescribeInternetGatewaysResult { /** - *Information about one or more network ACLs.
+ *Information about one or more internet gateways.
*/ - NetworkAcls?: NetworkAcl[]; + InternetGateways?: InternetGateway[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
- */ - NetworkInsightsAnalysisIds?: string[]; - - /** - *The ID of the path. You must specify either a path ID or analysis IDs.
- */ - NetworkInsightsPathId?: string; - - /** - *The time when the network insights analyses started.
- */ - AnalysisStartTime?: Date; - +export interface DescribeIpv6PoolsRequest { /** - *The time when the network insights analyses ended.
+ *The IDs of the IPv6 address pools.
*/ - AnalysisEndTime?: Date; + PoolIds?: string[]; /** - *The filters. The following are possible values:
- *PathFound - A Boolean value that indicates whether a feasible path is found.
- *Status - The status of the analysis (running | succeeded | failed).
- *The token for the next page of results.
*/ - Filters?: Filter[]; + NextToken?: string; /** *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
nextToken value.
*/
MaxResults?: number;
@@ -5581,718 +5033,914 @@ export interface DescribeNetworkInsightsAnalysesRequest {
DryRun?: boolean;
/**
- * The token for the next page of results.
+ *One or more filters.
+ *
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Describes a path component.
+ *Describes a CIDR block for an address pool.
*/ -export interface AnalysisComponent { - /** - *The ID of the component.
- */ - Id?: string; - +export interface PoolCidrBlock { /** - *The Amazon Resource Name (ARN) of the component.
+ *The CIDR block.
*/ - Arn?: string; + Cidr?: string; } -export namespace AnalysisComponent { +export namespace PoolCidrBlock { /** * @internal */ - export const filterSensitiveLog = (obj: AnalysisComponent): any => ({ + export const filterSensitiveLog = (obj: PoolCidrBlock): any => ({ ...obj, }); } /** - *Describes a network access control (ACL) rule.
+ *Describes an IPv6 address pool.
*/ -export interface AnalysisAclRule { - /** - *The IPv4 address range, in CIDR notation.
- */ - Cidr?: string; - - /** - *Indicates whether the rule is an outbound rule.
- */ - Egress?: boolean; - - /** - *The range of ports.
- */ - PortRange?: PortRange; - - /** - *The protocol.
- */ - Protocol?: string; - - /** - *Indicates whether to allow or deny traffic that matches the rule.
- */ - RuleAction?: string; - +export interface Ipv6Pool { /** - *The rule number.
+ *The ID of the address pool.
*/ - RuleNumber?: number; -} + PoolId?: string; -export namespace AnalysisAclRule { /** - * @internal + *The description for the address pool.
*/ - export const filterSensitiveLog = (obj: AnalysisAclRule): any => ({ - ...obj, - }); -} + Description?: string; -/** - *Describes a load balancer listener.
- */ -export interface AnalysisLoadBalancerListener { /** - *The port on which the load balancer is listening.
+ *The CIDR blocks for the address pool.
*/ - LoadBalancerPort?: number; + PoolCidrBlocks?: PoolCidrBlock[]; /** - *[Classic Load Balancers] The back-end port for the listener.
+ *Any tags for the address pool.
*/ - InstancePort?: number; + Tags?: Tag[]; } -export namespace AnalysisLoadBalancerListener { +export namespace Ipv6Pool { /** * @internal */ - export const filterSensitiveLog = (obj: AnalysisLoadBalancerListener): any => ({ + export const filterSensitiveLog = (obj: Ipv6Pool): any => ({ ...obj, }); } -/** - *Describes a load balancer target.
- */ -export interface AnalysisLoadBalancerTarget { - /** - *The IP address.
- */ - Address?: string; - - /** - *The Availability Zone.
- */ - AvailabilityZone?: string; - +export interface DescribeIpv6PoolsResult { /** - *Information about the instance.
+ *Information about the IPv6 address pools.
*/ - Instance?: AnalysisComponent; + Ipv6Pools?: Ipv6Pool[]; /** - *The port on which the target is listening.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes a route table route.
- */ -export interface AnalysisRouteTableRoute { - /** - *The destination IPv4 address, in CIDR notation.
- */ - DestinationCidr?: string; - - /** - *The prefix of the Amazon Web Service.
- */ - DestinationPrefixListId?: string; - - /** - *The ID of an egress-only internet gateway.
- */ - EgressOnlyInternetGatewayId?: string; - - /** - *The ID of the gateway, such as an internet gateway or virtual private gateway.
- */ - GatewayId?: string; - - /** - *The ID of the instance, such as a NAT instance.
- */ - InstanceId?: string; - - /** - *The ID of a NAT gateway.
- */ - NatGatewayId?: string; - - /** - *The ID of a network interface.
- */ - NetworkInterfaceId?: string; - +export interface DescribeKeyPairsRequest { /** - *Describes how the route was created. The following are possible values:
+ *The filters.
*
- * CreateRouteTable - The route was automatically created when the route table was created.
+ * key-pair-id - The ID of the key pair.
- * CreateRoute - The route was manually added to the route table.
fingerprint - The fingerprint of the key pair.
*
- * EnableVgwRoutePropagation - The route was propagated by route propagation.
key-name - The name of the key pair.
*
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The ID of a transit gateway.
+ *The key pair names.
+ *Default: Describes all of your key pairs.
*/ - TransitGatewayId?: string; + KeyNames?: string[]; /** - *The ID of a VPC peering connection.
+ *The IDs of the key pairs.
*/ - VpcPeeringConnectionId?: string; + KeyPairIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a security group rule.
+ *Describes a key pair.
*/ -export interface AnalysisSecurityGroupRule { +export interface KeyPairInfo { /** - *The IPv4 address range, in CIDR notation.
+ *The ID of the key pair.
*/ - Cidr?: string; + KeyPairId?: string; /** - *The direction. The following are possible values:
+ *If you used CreateKeyPair to create the key pair:
*egress
- *For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key. + *
+ * *ingress
- *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 security group ID.
+ *The name of the key pair.
*/ - SecurityGroupId?: string; + KeyName?: string; /** - *The port range.
+ *The type of key pair.
*/ - PortRange?: PortRange; + KeyType?: KeyType | string; /** - *The prefix list ID.
+ *Any tags applied to the key pair.
*/ - PrefixListId?: string; + Tags?: Tag[]; +} +export namespace KeyPairInfo { /** - *The protocol name.
+ * @internal */ - Protocol?: string; + export const filterSensitiveLog = (obj: KeyPairInfo): any => ({ + ...obj, + }); } -export namespace AnalysisSecurityGroupRule { +export interface DescribeKeyPairsResult { + /** + *Information about the key pairs.
+ */ + KeyPairs?: KeyPairInfo[]; +} + +export namespace DescribeKeyPairsResult { /** * @internal */ - export const filterSensitiveLog = (obj: AnalysisSecurityGroupRule): any => ({ + export const filterSensitiveLog = (obj: DescribeKeyPairsResult): any => ({ ...obj, }); } -/** - *Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes.
- */ -export interface Explanation { +export interface DescribeLaunchTemplatesRequest { /** - *The network ACL.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The network ACL rule.
+ *One or more launch template IDs.
*/ - AclRule?: AnalysisAclRule; + LaunchTemplateIds?: string[]; /** - *The IPv4 address, in CIDR notation.
+ *One or more launch template names.
*/ - Address?: string; + LaunchTemplateNames?: string[]; /** - *The IPv4 addresses, in CIDR notation.
+ *One or more filters.
+ *
+ * create-time - The time the launch template was created.
+ * launch-template-name - The name of the launch template.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The resource to which the component is attached.
+ *The token to request the next page of results.
*/ - AttachedTo?: AnalysisComponent; + NextToken?: string; /** - *The Availability Zones.
+ *The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another call with the returned NextToken value. This value
+ * can be between 1 and 200.
The CIDR ranges.
+ * @internal */ - Cidrs?: string[]; + export const filterSensitiveLog = (obj: DescribeLaunchTemplatesRequest): any => ({ + ...obj, + }); +} +export interface DescribeLaunchTemplatesResult { /** - *The component.
+ *Information about the launch templates.
*/ - Component?: AnalysisComponent; + LaunchTemplates?: LaunchTemplate[]; /** - *The customer gateway.
+ *The token to use to retrieve the next page of results. This value is
+ * null when there are no more results to return.
The destination.
+ * @internal */ - Destination?: AnalysisComponent; + export const filterSensitiveLog = (obj: DescribeLaunchTemplatesResult): any => ({ + ...obj, + }); +} +export interface DescribeLaunchTemplateVersionsRequest { /** - *The destination VPC.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The direction. The following are possible values:
- *egress
- *ingress
- *The ID of the launch template. To describe one or more versions of a specified launch + * template, you must specify either the launch template ID or the launch template name in + * the request. To describe all the latest or default launch template versions in your + * account, you must omit this parameter.
*/ - Direction?: string; + LaunchTemplateId?: string; /** - *The explanation code.
+ *The name of the launch template. To describe one or more versions of a specified + * launch template, you must specify either the launch template ID or the launch template + * name in the request. To describe all the latest or default launch template versions in + * your account, you must omit this parameter.
*/ - ExplanationCode?: string; + LaunchTemplateName?: string; /** - *The route table.
+ *One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.
+ *To describe one or more versions of a specified launch template, valid values are $Latest, $Default, and numbers.
To describe all launch templates in your account that are defined as the latest
+ * version, the valid value is $Latest. To describe all launch templates in
+ * your account that are defined as the default version, the valid value is
+ * $Default. You can specify $Latest and
+ * $Default in the same call. You cannot specify numbers.
The internet gateway.
+ *The version number after which to describe launch template versions.
*/ - InternetGateway?: AnalysisComponent; + MinVersion?: string; /** - *The Amazon Resource Name (ARN) of the load balancer.
+ *The version number up to which to describe launch template versions.
*/ - LoadBalancerArn?: string; + MaxVersion?: string; /** - *The listener for a Classic Load Balancer.
+ *The token to request the next page of results.
*/ - ClassicLoadBalancerListener?: AnalysisLoadBalancerListener; + NextToken?: string; /** - *The listener port of the load balancer.
+ *The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another call with the returned NextToken value. This value
+ * can be between 1 and 200.
The target.
+ *One or more filters.
+ *
+ * create-time - The time the launch template version was created.
+ * ebs-optimized - A boolean that indicates whether the instance
+ * is optimized for Amazon EBS I/O.
+ * iam-instance-profile - The ARN of the IAM instance
+ * profile.
+ * image-id - The ID of the AMI.
+ * instance-type - The instance type.
+ * is-default-version - A boolean that indicates whether the
+ * launch template version is the default version.
+ * kernel-id - The kernel ID.
+ * ram-disk-id - The RAM disk ID.
The target group.
+ * @internal */ - LoadBalancerTargetGroup?: AnalysisComponent; + export const filterSensitiveLog = (obj: DescribeLaunchTemplateVersionsRequest): any => ({ + ...obj, + }); +} +export interface DescribeLaunchTemplateVersionsResult { /** - *The target groups.
+ *Information about the launch template versions.
*/ - LoadBalancerTargetGroups?: AnalysisComponent[]; + LaunchTemplateVersions?: LaunchTemplateVersion[]; /** - *The target port.
+ *The token to use to retrieve the next page of results. This value is
+ * null when there are no more results to return.
The load balancer listener.
+ * @internal */ - ElasticLoadBalancerListener?: AnalysisComponent; + export const filterSensitiveLog = (obj: DescribeLaunchTemplateVersionsResult): any => ({ + ...obj, + }); +} +export interface DescribeLocalGatewayRouteTablesRequest { /** - *The missing component.
+ *The IDs of the local gateway route tables.
*/ - MissingComponent?: string; + LocalGatewayRouteTableIds?: string[]; /** - *The NAT gateway.
+ *One or more filters.
+ *
+ * local-gateway-id - The ID of a local gateway.
+ * local-gateway-route-table-id - The ID of a local gateway route table.
+ * outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
+ * state - The state of the local gateway route table.
The network interface.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The packet field.
+ *The token for the next page of results.
*/ - PacketField?: string; + NextToken?: string; /** - *The VPC peering connection.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The port.
+ * @internal */ - Port?: number; + export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTablesRequest): any => ({ + ...obj, + }); +} +/** + *Describes a local gateway route table.
+ */ +export interface LocalGatewayRouteTable { /** - *The port ranges.
+ *The ID of the local gateway route table.
*/ - PortRanges?: PortRange[]; + LocalGatewayRouteTableId?: string; /** - *The prefix list.
+ *The Amazon Resource Name (ARN) of the local gateway route table.
*/ - PrefixList?: AnalysisComponent; + LocalGatewayRouteTableArn?: string; /** - *The protocols.
+ *The ID of the local gateway.
*/ - Protocols?: string[]; + LocalGatewayId?: string; /** - *The route table route.
+ *The Amazon Resource Name (ARN) of the Outpost.
*/ - RouteTableRoute?: AnalysisRouteTableRoute; + OutpostArn?: string; /** - *The route table.
+ *The ID of the Amazon Web Services account that owns the local gateway route table.
*/ - RouteTable?: AnalysisComponent; + OwnerId?: string; /** - *The security group.
+ *The state of the local gateway route table.
*/ - SecurityGroup?: AnalysisComponent; + State?: string; /** - *The security group rule.
+ *The tags assigned to the local gateway route table.
*/ - SecurityGroupRule?: AnalysisSecurityGroupRule; + Tags?: Tag[]; +} +export namespace LocalGatewayRouteTable { /** - *The security groups.
+ * @internal */ - SecurityGroups?: AnalysisComponent[]; + export const filterSensitiveLog = (obj: LocalGatewayRouteTable): any => ({ + ...obj, + }); +} +export interface DescribeLocalGatewayRouteTablesResult { /** - *The source VPC.
+ *Information about the local gateway route tables.
*/ - SourceVpc?: AnalysisComponent; + LocalGatewayRouteTables?: LocalGatewayRouteTable[]; /** - *The state.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The subnet.
+ * @internal */ - Subnet?: AnalysisComponent; + export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTablesResult): any => ({ + ...obj, + }); +} +export interface DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest { /** - *The route table for the subnet.
+ *The IDs of the associations.
*/ - SubnetRouteTable?: AnalysisComponent; + LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds?: string[]; /** - *The component VPC.
+ *One or more filters.
+ *
+ * local-gateway-id - The ID of a local gateway.
+ * local-gateway-route-table-id - The ID of the local gateway route table.
+ * local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
+ * local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
+ * state - The state of the association.
The VPC endpoint.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The VPN connection.
+ *The token for the next page of results.
*/ - VpnConnection?: AnalysisComponent; + NextToken?: string; /** - *The VPN gateway.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a header. Reflects any changes made by a component as traffic passes through. - * The fields of an inbound header are null except for the first component of a path.
+ *Describes an association between a local gateway route table and a virtual interface group.
*/ -export interface AnalysisPacketHeader { +export interface LocalGatewayRouteTableVirtualInterfaceGroupAssociation { /** - *The destination addresses.
+ *The ID of the association.
*/ - DestinationAddresses?: string[]; + LocalGatewayRouteTableVirtualInterfaceGroupAssociationId?: string; /** - *The destination port ranges.
+ *The ID of the virtual interface group.
*/ - DestinationPortRanges?: PortRange[]; + LocalGatewayVirtualInterfaceGroupId?: string; /** - *The protocol.
+ *The ID of the local gateway.
*/ - Protocol?: string; + LocalGatewayId?: string; /** - *The source addresses.
+ *The ID of the local gateway route table.
*/ - SourceAddresses?: string[]; + LocalGatewayRouteTableId?: string; /** - *The source port ranges.
+ *The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
*/ - SourcePortRanges?: PortRange[]; -} + LocalGatewayRouteTableArn?: string; -export namespace AnalysisPacketHeader { /** - * @internal + *The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.
*/ - export const filterSensitiveLog = (obj: AnalysisPacketHeader): any => ({ - ...obj, - }); -} + OwnerId?: string; -/** - *Describes a path component.
- */ -export interface PathComponent { /** - *The sequence number.
+ *The state of the association.
*/ - SequenceNumber?: number; + State?: string; /** - *The network ACL rule.
+ *The tags assigned to the association.
*/ - AclRule?: AnalysisAclRule; + Tags?: Tag[]; +} +export namespace LocalGatewayRouteTableVirtualInterfaceGroupAssociation { /** - *The component.
+ * @internal */ - Component?: AnalysisComponent; + export const filterSensitiveLog = (obj: LocalGatewayRouteTableVirtualInterfaceGroupAssociation): any => ({ + ...obj, + }); +} +export interface DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult { /** - *The destination VPC.
+ *Information about the associations.
*/ - DestinationVpc?: AnalysisComponent; + LocalGatewayRouteTableVirtualInterfaceGroupAssociations?: LocalGatewayRouteTableVirtualInterfaceGroupAssociation[]; /** - *The outbound header.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The inbound header.
+ * @internal */ - InboundHeader?: AnalysisPacketHeader; + export const filterSensitiveLog = ( + obj: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult + ): any => ({ + ...obj, + }); +} +export interface DescribeLocalGatewayRouteTableVpcAssociationsRequest { /** - *The route table route.
+ *The IDs of the associations.
*/ - RouteTableRoute?: AnalysisRouteTableRoute; + LocalGatewayRouteTableVpcAssociationIds?: string[]; /** - *The security group rule.
+ *One or more filters.
+ *
+ * local-gateway-id - The ID of a local gateway.
+ * local-gateway-route-table-id - The ID of the local gateway route table.
+ * local-gateway-route-table-vpc-association-id - The ID of the association.
+ * state - The state of the association.
+ * vpc-id - The ID of the VPC.
The source VPC.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The subnet.
+ *The token for the next page of results.
*/ - Subnet?: AnalysisComponent; + NextToken?: string; /** - *The component VPC.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the associations.
+ */ + LocalGatewayRouteTableVpcAssociations?: LocalGatewayRouteTableVpcAssociation[]; -/** - *Describes a network insights analysis.
- */ -export interface NetworkInsightsAnalysis { /** - *The ID of the network insights analysis.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The Amazon Resource Name (ARN) of the network insights analysis.
+ * @internal */ - NetworkInsightsAnalysisArn?: string; + export const filterSensitiveLog = (obj: DescribeLocalGatewayRouteTableVpcAssociationsResult): any => ({ + ...obj, + }); +} +export interface DescribeLocalGatewaysRequest { /** - *The ID of the path.
+ *One or more filters.
+ *
+ * local-gateway-id - The ID of a local gateway.
+ * local-gateway-route-table-id - The ID of the local gateway route table.
+ * local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
+ * local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
+ * outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
+ * state - The state of the association.
The Amazon Resource Names (ARN) of the Amazon Web Services resources that the path must traverse.
+ *One or more filters.
*/ - FilterInArns?: string[]; + Filters?: Filter[]; /** - *The time the analysis started.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The status of the network insights analysis.
+ *The token for the next page of results.
*/ - Status?: AnalysisStatus | string; + NextToken?: string; /** - *The status message, if the status is failed.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Indicates whether the destination is reachable from the source.
+ * @internal */ - NetworkPathFound?: boolean; + export const filterSensitiveLog = (obj: DescribeLocalGatewaysRequest): any => ({ + ...obj, + }); +} +/** + *Describes a local gateway.
+ */ +export interface LocalGateway { /** - *The components in the path from source to destination.
+ *The ID of the local gateway.
*/ - ForwardPathComponents?: PathComponent[]; + LocalGatewayId?: string; /** - *The components in the path from destination to source.
+ *The Amazon Resource Name (ARN) of the Outpost.
*/ - ReturnPathComponents?: PathComponent[]; + OutpostArn?: string; /** - *The explanations. For more information, see Reachability Analyzer explanation codes.
+ *The ID of the Amazon Web Services account that owns the local gateway.
*/ - Explanations?: Explanation[]; + OwnerId?: string; /** - *Potential intermediate components.
+ *The state of the local gateway.
*/ - AlternatePathHints?: AlternatePathHint[]; + State?: string; /** - *The tags.
+ *The tags assigned to the local gateway.
*/ Tags?: Tag[]; } -export namespace NetworkInsightsAnalysis { +export namespace LocalGateway { /** * @internal */ - export const filterSensitiveLog = (obj: NetworkInsightsAnalysis): any => ({ + export const filterSensitiveLog = (obj: LocalGateway): any => ({ ...obj, }); } -export interface DescribeNetworkInsightsAnalysesResult { +export interface DescribeLocalGatewaysResult { /** - *Information about the network insights analyses.
+ *Information about the local gateways.
*/ - NetworkInsightsAnalyses?: NetworkInsightsAnalysis[]; + LocalGateways?: LocalGateway[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the paths.
+ *The IDs of the virtual interface groups.
*/ - NetworkInsightsPathIds?: string[]; + LocalGatewayVirtualInterfaceGroupIds?: string[]; /** - *The filters. The following are possible values:
+ *One or more filters.
*Destination - The ID of the resource.
- *DestinationPort - The destination port.
- *Name - The path name.
+ *
+ * local-gateway-id - The ID of a local gateway.
Protocol - The protocol.
+ *
+ * local-gateway-virtual-interface-id - The ID of the virtual interface.
Source - The ID of the resource.
+ *
+ * local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
nextToken value.
*/
MaxResults?: number;
- /**
- * Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
*/ NextToken?: string; -} - -export namespace DescribeNetworkInsightsPathsRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribeNetworkInsightsPathsRequest): any => ({ - ...obj, - }); -} - -export interface DescribeNetworkInsightsPathsResult { - /** - *Information about the paths.
- */ - NetworkInsightsPaths?: NetworkInsightsPath[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Contains the parameters for DescribeNetworkInterfaceAttribute.
+ *Describes a local gateway virtual interface group.
*/ -export interface DescribeNetworkInterfaceAttributeRequest { - /** - *The attribute of the network interface. This parameter is required.
- */ - Attribute?: NetworkInterfaceAttribute | string; - +export interface LocalGatewayVirtualInterfaceGroup { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the virtual interface group.
*/ - DryRun?: boolean; + LocalGatewayVirtualInterfaceGroupId?: string; /** - *The ID of the network interface.
+ *The IDs of the virtual interfaces.
*/ - NetworkInterfaceId: string | undefined; -} + LocalGatewayVirtualInterfaceIds?: string[]; -export namespace DescribeNetworkInterfaceAttributeRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribeNetworkInterfaceAttributeRequest): any => ({ - ...obj, - }); -} + /** + *The ID of the local gateway.
+ */ + LocalGatewayId?: string; -/** - *Contains the output of DescribeNetworkInterfaceAttribute.
- */ -export interface DescribeNetworkInterfaceAttributeResult { /** - *The attachment (if any) of the network interface.
+ *The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
*/ - Attachment?: NetworkInterfaceAttachment; + OwnerId?: string; /** - *The description of the network interface.
+ *The tags assigned to the virtual interface group.
*/ - Description?: AttributeValue; + Tags?: Tag[]; +} +export namespace LocalGatewayVirtualInterfaceGroup { /** - *The security groups associated with the network interface.
+ * @internal */ - Groups?: GroupIdentifier[]; + export const filterSensitiveLog = (obj: LocalGatewayVirtualInterfaceGroup): any => ({ + ...obj, + }); +} +export interface DescribeLocalGatewayVirtualInterfaceGroupsResult { /** - *The ID of the network interface.
+ *The virtual interface groups.
*/ - NetworkInterfaceId?: string; + LocalGatewayVirtualInterfaceGroups?: LocalGatewayVirtualInterfaceGroup[]; /** - *Indicates whether source/destination checking is enabled.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for DescribeNetworkInterfacePermissions.
- */ -export interface DescribeNetworkInterfacePermissionsRequest { +export interface DescribeLocalGatewayVirtualInterfacesRequest { /** - *One or more network interface permission IDs.
+ *The IDs of the virtual interfaces.
*/ - NetworkInterfacePermissionIds?: string[]; + LocalGatewayVirtualInterfaceIds?: string[]; /** *One or more filters.
- *
- * network-interface-permission.network-interface-permission-id - The ID of the
- * permission.
- * network-interface-permission.network-interface-id - The ID of
- * the network interface.
- * network-interface-permission.aws-account-id - The Amazon Web Services account ID.
- * network-interface-permission.aws-service - The Amazon Web Service.
- * network-interface-permission.permission - The type of
- * permission (INSTANCE-ATTACH |
- * EIP-ASSOCIATE).
The token to request the next page of results.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
*/ NextToken?: string; /** - *The maximum number of results to return in a single call. To retrieve the remaining results,
- * make another call with the returned NextToken value. If this parameter is not specified, up to 50 results are returned by default.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Contains the output for DescribeNetworkInterfacePermissions.
+ *Describes a local gateway virtual interface.
*/ -export interface DescribeNetworkInterfacePermissionsResult { - /** - *The network interface permissions.
- */ - NetworkInterfacePermissions?: NetworkInterfacePermission[]; - +export interface LocalGatewayVirtualInterface { /** - *The token to use to retrieve the next page of results.
+ *The ID of the virtual interface.
*/ - NextToken?: string; -} + LocalGatewayVirtualInterfaceId?: string; -export namespace DescribeNetworkInterfacePermissionsResult { /** - * @internal + *The ID of the local gateway.
*/ - export const filterSensitiveLog = (obj: DescribeNetworkInterfacePermissionsResult): any => ({ - ...obj, - }); -} + LocalGatewayId?: string; -/** - *Contains the parameters for DescribeNetworkInterfaces.
- */ -export interface DescribeNetworkInterfacesRequest { /** - *One or more filters.
- *
- * addresses.private-ip-address - The private IPv4 addresses
- * associated with the network interface.
- * addresses.primary - Whether the private IPv4 address is the primary
- * IP address associated with the network interface.
- * addresses.association.public-ip - The association ID returned when
- * the network interface was associated with the Elastic IP address
- * (IPv4).
- * addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
- * association.association-id - The association ID returned when the
- * network interface was associated with an IPv4 address.
- * association.allocation-id - The allocation ID returned when you
- * allocated the Elastic IP address (IPv4) for your network interface.
- * association.ip-owner-id - The owner of the Elastic IP address
- * (IPv4) associated with the network interface.
- * association.public-ip - The address of the Elastic IP address
- * (IPv4) bound to the network interface.
- * association.public-dns-name - The public DNS name for the network
- * interface (IPv4).
- * attachment.attachment-id - The ID of the interface attachment.
- * attachment.attach-time - The time that the network interface was attached to an instance.
- * attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
- * attachment.device-index - The device index to which the network interface is attached.
- * attachment.instance-id - The ID of the instance to which the network interface is attached.
- * attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
- * attachment.status - The status of the attachment (attaching | attached | detaching | detached).
- * availability-zone - The Availability Zone of the network interface.
- * description - The description of the network interface.
- * group-id - The ID of a security group associated with the network interface.
- * group-name - The name of a security group associated with the network interface.
- * ipv6-addresses.ipv6-address - An IPv6 address associated with
- * the network interface.
- * mac-address - The MAC address of the network interface.
- * network-interface-id - The ID of the network interface.
- * owner-id - The Amazon Web Services account ID of the network interface owner.
- * private-ip-address - The private IPv4 address or addresses of the
- * network interface.
- * private-dns-name - The private DNS name of the network interface (IPv4).
- * requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
- * requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service
- * (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
- * source-dest-check - Indicates whether the network interface performs source/destination checking.
- * A value of true means checking is enabled, and false means checking is disabled.
- * The value must be false for the network interface to perform network address translation (NAT) in your VPC.
- * status - The status of the network interface. If the network interface is not attached to an instance, the status is available;
- * if a network interface is attached to an instance the status is in-use.
The ID of the VLAN.
+ */ + Vlan?: number; + + /** + *The local address.
+ */ + LocalAddress?: string; + + /** + *The peer address.
+ */ + PeerAddress?: string; + + /** + *The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
+ */ + LocalBgpAsn?: number; + + /** + *The peer BGP ASN.
+ */ + PeerBgpAsn?: number; + + /** + *The ID of the Amazon Web Services account that owns the local gateway virtual interface.
+ */ + OwnerId?: string; + + /** + *The tags assigned to the virtual interface.
+ */ + Tags?: Tag[]; +} + +export namespace LocalGatewayVirtualInterface { + /** + * @internal + */ + export const filterSensitiveLog = (obj: LocalGatewayVirtualInterface): any => ({ + ...obj, + }); +} + +export interface DescribeLocalGatewayVirtualInterfacesResult { + /** + *Information about the virtual interfaces.
+ */ + LocalGatewayVirtualInterfaces?: LocalGatewayVirtualInterface[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters.
+ *
- * subnet-id - The ID of the subnet for the network interface.
+ * owner-id - The ID of the prefix list owner.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * prefix-list-id - The ID of the prefix list.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * prefix-list-name - The name of the prefix list.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ */ + NextToken?: string; + + /** + *One or more prefix list IDs.
+ */ + PrefixListIds?: string[]; +} + +export namespace DescribeManagedPrefixListsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeManagedPrefixListsRequest): any => ({ + ...obj, + }); +} + +export interface DescribeManagedPrefixListsResult { + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the prefix lists.
+ */ + PrefixLists?: ManagedPrefixList[]; +} + +export namespace DescribeManagedPrefixListsResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeManagedPrefixListsResult): any => ({ + ...obj, + }); +} + +export interface DescribeMovingAddressesRequest { + /** + *One or more filters.
+ *
- * vpc-id - The ID of the VPC for the network interface.
+ * moving-status - The status of the Elastic IP address
+ * (MovingToVpc | RestoringToClassic).
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
/**
- * One or more network interface IDs.
- *Default: Describes all your network interfaces.
+ *The maximum number of results to return for the request in a single page. The remaining
+ * results of the initial request can be seen by sending another request with the returned
+ * NextToken value. This value can be between 5 and 1000; if
+ * MaxResults is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
*/ - NetworkInterfaceIds?: string[]; + MaxResults?: number; /** - *The token to retrieve the next page of results.
+ *The token for the next page of results.
*/ NextToken?: string; /** - *The maximum number of items to return for this request. The request returns a token that you - * can specify in a subsequent call to get the next set of results. You cannot specify this - * parameter and the network interface IDs parameter in the same request.
+ *One or more Elastic IP addresses.
*/ - MaxResults?: number; + PublicIps?: string[]; } -export namespace DescribeNetworkInterfacesRequest { +export namespace DescribeMovingAddressesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeNetworkInterfacesRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeMovingAddressesRequest): any => ({ ...obj, }); } +export type MoveStatus = "movingToVpc" | "restoringToClassic"; + /** - *Contains the output of DescribeNetworkInterfaces.
+ *Describes the status of a moving Elastic IP address.
*/ -export interface DescribeNetworkInterfacesResult { +export interface MovingAddressStatus { /** - *Information about one or more network interfaces.
+ *The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.
*/ - NetworkInterfaces?: NetworkInterface[]; + MoveStatus?: MoveStatus | string; + + /** + *The Elastic IP address.
+ */ + PublicIp?: string; +} + +export namespace MovingAddressStatus { + /** + * @internal + */ + export const filterSensitiveLog = (obj: MovingAddressStatus): any => ({ + ...obj, + }); +} + +export interface DescribeMovingAddressesResult { + /** + *The status for each Elastic IP address.
+ */ + MovingAddressStatuses?: MovingAddressStatus[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
- *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters.
+ *
- * group-name - The name of the placement group.
+ * nat-gateway-id - The ID of the NAT gateway.
- * state - The state of the placement group (pending |
- * available | deleting |
- * deleted).
+ * state - The state of the NAT gateway (pending |
+ * failed | available | deleting | deleted).
- * strategy - The strategy of the placement group
- * (cluster | spread |
- * partition).
+ * subnet-id - The ID of the subnet in which the NAT gateway resides.
- * tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.
+ *
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the NAT gateway resides.
* Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The names of the placement groups.
- *Default: Describes all your placement groups, or only those otherwise - * specified.
+ *One or more NAT gateway IDs.
*/ - GroupNames?: string[]; + NatGatewayIds?: string[]; /** - *The IDs of the placement groups.
+ *The token for the next page of results.
*/ - GroupIds?: string[]; + NextToken?: string; } -export namespace DescribePlacementGroupsRequest { +export namespace DescribeNatGatewaysRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribePlacementGroupsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeNatGatewaysRequest): any => ({ ...obj, }); } -export interface DescribePlacementGroupsResult { +export interface DescribeNatGatewaysResult { /** - *Information about the placement groups.
+ *Information about the NAT gateways.
*/ - PlacementGroups?: PlacementGroup[]; + NatGateways?: NatGateway[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more filters.
- *
- * prefix-list-id: The ID of a prefix list.
+ * association.association-id - The ID of an association ID for the ACL.
- * prefix-list-name: The name of a prefix list.
+ * association.network-acl-id - The ID of the network ACL involved in the association.
+ * association.subnet-id - The ID of the subnet involved in the association.
+ * default - Indicates whether the ACL is the default network ACL for the VPC.
+ * entry.cidr - The IPv4 CIDR range specified in the entry.
+ * entry.icmp.code - The ICMP code specified in the entry, if any.
+ * entry.icmp.type - The ICMP type specified in the entry, if any.
+ * entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
+ * entry.port-range.from - The start of the port range specified in the entry.
+ * entry.port-range.to - The end of the port range specified in the entry.
+ * entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
+ * entry.rule-action - Allows or denies the matching traffic (allow | deny).
+ * entry.rule-number - The number of an entry (in other words, rule) in
+ * the set of ACL entries.
+ * network-acl-id - The ID of the network ACL.
+ * owner-id - The ID of the Amazon Web Services account that owns the network ACL.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * vpc-id - The ID of the VPC for the network ACL.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more network ACL IDs.
+ *Default: Describes all your network ACLs.
+ */ + NetworkAclIds?: string[]; /** *The token for the next page of results.
@@ -6878,1492 +6548,1210 @@ export interface DescribePrefixListsRequest { NextToken?: string; /** - *One or more prefix list IDs.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Describes prefixes for Amazon Web Services services.
- */ -export interface PrefixList { - /** - *The IP address range of the Amazon Web Service.
- */ - Cidrs?: string[]; - +export interface DescribeNetworkAclsResult { /** - *The ID of the prefix.
+ *Information about one or more network ACLs.
*/ - PrefixListId?: string; + NetworkAcls?: NetworkAcl[]; /** - *The name of the prefix.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
*/ - NextToken?: string; + NetworkInsightsAnalysisIds?: string[]; /** - *All available prefix lists.
+ *The ID of the path. You must specify either a path ID or analysis IDs.
*/ - PrefixLists?: PrefixList[]; -} + NetworkInsightsPathId?: string; -export namespace DescribePrefixListsResult { /** - * @internal + *The time when the network insights analyses started.
*/ - export const filterSensitiveLog = (obj: DescribePrefixListsResult): any => ({ - ...obj, - }); -} + AnalysisStartTime?: Date; -export interface DescribePrincipalIdFormatRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The time when the network insights analyses ended.
*/ - DryRun?: boolean; + AnalysisEndTime?: Date; /** - *The type of resource: bundle |
- * conversion-task | customer-gateway | dhcp-options |
- * elastic-ip-allocation | elastic-ip-association |
- * export-task | flow-log | image |
- * import-task | instance | internet-gateway |
- * network-acl | network-acl-association |
- * network-interface | network-interface-attachment |
- * prefix-list | reservation | route-table |
- * route-table-association | security-group |
- * snapshot | subnet |
- * subnet-cidr-block-association | volume | vpc
- * | vpc-cidr-block-association | vpc-endpoint |
- * vpc-peering-connection | vpn-connection | vpn-gateway
- *
The filters. The following are possible values:
+ *PathFound - A Boolean value that indicates whether a feasible path is found.
+ *Status - The status of the analysis (running | succeeded | failed).
+ *The maximum number of results to return in a single call. To retrieve the remaining - * results, make another call with the returned NextToken value.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token to request the next page of results.
- */ - NextToken?: string; -} - -export namespace DescribePrincipalIdFormatRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DescribePrincipalIdFormatRequest): any => ({ - ...obj, - }); -} - -/** - *PrincipalIdFormat description
- */ -export interface PrincipalIdFormat { - /** - *PrincipalIdFormatARN description
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
PrincipalIdFormatStatuses description
+ *The token for the next page of results.
*/ - Statuses?: IdFormat[]; + NextToken?: string; } -export namespace PrincipalIdFormat { +export namespace DescribeNetworkInsightsAnalysesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: PrincipalIdFormat): any => ({ + export const filterSensitiveLog = (obj: DescribeNetworkInsightsAnalysesRequest): any => ({ ...obj, }); } -export interface DescribePrincipalIdFormatResult { +/** + *Describes a path component.
+ */ +export interface AnalysisComponent { /** - *Information about the ID format settings for the ARN.
+ *The ID of the component.
*/ - Principals?: PrincipalIdFormat[]; + Id?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
+ *The Amazon Resource Name (ARN) of the component.
*/ - NextToken?: string; + Arn?: string; } -export namespace DescribePrincipalIdFormatResult { +export namespace AnalysisComponent { /** * @internal */ - export const filterSensitiveLog = (obj: DescribePrincipalIdFormatResult): any => ({ + export const filterSensitiveLog = (obj: AnalysisComponent): any => ({ ...obj, }); } -export interface DescribePublicIpv4PoolsRequest { +/** + *Describes a network access control (ACL) rule.
+ */ +export interface AnalysisAclRule { /** - *The IDs of the address pools.
+ *The IPv4 address range, in CIDR notation.
*/ - PoolIds?: string[]; + Cidr?: string; /** - *The token for the next page of results.
+ *Indicates whether the rule is an outbound rule.
*/ - NextToken?: string; + Egress?: boolean; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The range of ports.
*/ - MaxResults?: number; + PortRange?: PortRange; /** - *One or more filters.
- *
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The protocol.
*/ - Filters?: Filter[]; + Protocol?: string; + + /** + *Indicates whether to allow or deny traffic that matches the rule.
+ */ + RuleAction?: string; + + /** + *The rule number.
+ */ + RuleNumber?: number; } -export namespace DescribePublicIpv4PoolsRequest { +export namespace AnalysisAclRule { /** * @internal */ - export const filterSensitiveLog = (obj: DescribePublicIpv4PoolsRequest): any => ({ + export const filterSensitiveLog = (obj: AnalysisAclRule): any => ({ ...obj, }); } /** - *Describes an address range of an IPv4 address pool.
+ *Describes a load balancer listener.
*/ -export interface PublicIpv4PoolRange { - /** - *The first IP address in the range.
- */ - FirstAddress?: string; - - /** - *The last IP address in the range.
- */ - LastAddress?: string; - +export interface AnalysisLoadBalancerListener { /** - *The number of addresses in the range.
+ *The port on which the load balancer is listening.
*/ - AddressCount?: number; + LoadBalancerPort?: number; /** - *The number of available addresses in the range.
+ *[Classic Load Balancers] The back-end port for the listener.
*/ - AvailableAddressCount?: number; + InstancePort?: number; } -export namespace PublicIpv4PoolRange { +export namespace AnalysisLoadBalancerListener { /** * @internal */ - export const filterSensitiveLog = (obj: PublicIpv4PoolRange): any => ({ + export const filterSensitiveLog = (obj: AnalysisLoadBalancerListener): any => ({ ...obj, }); } /** - *Describes an IPv4 address pool.
+ *Describes a load balancer target.
*/ -export interface PublicIpv4Pool { +export interface AnalysisLoadBalancerTarget { /** - *The ID of the address pool.
+ *The IP address.
*/ - PoolId?: string; + Address?: string; /** - *A description of the address pool.
+ *The Availability Zone.
*/ - Description?: string; + AvailabilityZone?: string; /** - *The address ranges.
+ *Information about the instance.
*/ - PoolAddressRanges?: PublicIpv4PoolRange[]; + Instance?: AnalysisComponent; /** - *The total number of addresses.
+ *The port on which the target is listening.
*/ - TotalAddressCount?: number; + Port?: number; +} +export namespace AnalysisLoadBalancerTarget { /** - *The total number of available addresses.
+ * @internal */ - TotalAvailableAddressCount?: number; + export const filterSensitiveLog = (obj: AnalysisLoadBalancerTarget): any => ({ + ...obj, + }); +} + +/** + *Describes a route table route.
+ */ +export interface AnalysisRouteTableRoute { + /** + *The destination IPv4 address, in CIDR notation.
+ */ + DestinationCidr?: string; /** - *The name of the location from which the address pool is advertised. - * A network border group is a unique set of Availability Zones or Local Zones - * from where Amazon Web Services advertises public IP addresses.
+ *The prefix of the Amazon Web Service.
*/ - NetworkBorderGroup?: string; + DestinationPrefixListId?: string; /** - *Any tags for the address pool.
+ *The ID of an egress-only internet gateway.
*/ - Tags?: Tag[]; -} + EgressOnlyInternetGatewayId?: string; -export namespace PublicIpv4Pool { /** - * @internal + *The ID of the gateway, such as an internet gateway or virtual private gateway.
*/ - export const filterSensitiveLog = (obj: PublicIpv4Pool): any => ({ - ...obj, - }); -} + GatewayId?: string; -export interface DescribePublicIpv4PoolsResult { /** - *Information about the address pools.
+ *The ID of the instance, such as a NAT instance.
*/ - PublicIpv4Pools?: PublicIpv4Pool[]; + InstanceId?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of a NAT gateway.
*/ - NextToken?: string; -} + NatGatewayId?: string; -export namespace DescribePublicIpv4PoolsResult { /** - * @internal + *The ID of a network interface.
*/ - export const filterSensitiveLog = (obj: DescribePublicIpv4PoolsResult): any => ({ - ...obj, - }); -} + NetworkInterfaceId?: string; -export interface DescribeRegionsRequest { /** - *The filters.
+ *Describes how the route was created. The following are possible values:
*
- * endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
CreateRouteTable - The route was automatically created when the route table was created.
*
- * opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in |
- * not-opted-in).
CreateRoute - The route was manually added to the route table.
*
- * region-name - The name of the Region (for example, us-east-1).
EnableVgwRoutePropagation - The route was propagated by route propagation.
* The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.
- */ - RegionNames?: string[]; + Origin?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of a transit gateway.
*/ - DryRun?: boolean; + TransitGatewayId?: string; /** - *Indicates whether to display all Regions, including Regions that are disabled for your account.
+ *The ID of a VPC peering connection.
*/ - AllRegions?: boolean; + VpcPeeringConnectionId?: string; } -export namespace DescribeRegionsRequest { +export namespace AnalysisRouteTableRoute { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeRegionsRequest): any => ({ + export const filterSensitiveLog = (obj: AnalysisRouteTableRoute): any => ({ ...obj, }); } /** - *Describes a Region.
+ *Describes a security group rule.
*/ -export interface Region { +export interface AnalysisSecurityGroupRule { /** - *The Region service endpoint.
+ *The IPv4 address range, in CIDR notation.
*/ - Endpoint?: string; + Cidr?: string; /** - *The name of the Region.
+ *The direction. The following are possible values:
+ *egress
+ *ingress
+ *The Region opt-in status. The possible values are opt-in-not-required, opted-in, and
- * not-opted-in.
The security group ID.
*/ - OptInStatus?: string; + SecurityGroupId?: string; + + /** + *The port range.
+ */ + PortRange?: PortRange; + + /** + *The prefix list ID.
+ */ + PrefixListId?: string; + + /** + *The protocol name.
+ */ + Protocol?: string; } -export namespace Region { +export namespace AnalysisSecurityGroupRule { /** * @internal */ - export const filterSensitiveLog = (obj: Region): any => ({ + export const filterSensitiveLog = (obj: AnalysisSecurityGroupRule): any => ({ ...obj, }); } -export interface DescribeRegionsResult { +/** + *Describes an explanation code for an unreachable path. For more information, see Reachability Analyzer explanation codes.
+ */ +export interface Explanation { /** - *Information about the Regions.
+ *The network ACL.
*/ - Regions?: Region[]; -} + Acl?: AnalysisComponent; -export namespace DescribeRegionsResult { /** - * @internal + *The network ACL rule.
*/ - export const filterSensitiveLog = (obj: DescribeRegionsResult): any => ({ - ...obj, - }); -} + AclRule?: AnalysisAclRule; -export interface DescribeReplaceRootVolumeTasksRequest { /** - *The ID of the root volume replacement task to view.
+ *The IPv4 address, in CIDR notation.
*/ - ReplaceRootVolumeTaskIds?: string[]; + Address?: string; /** - *Filter to use:
- *
- * instance-id - The ID of the instance for which the root volume replacement task was created.
The IPv4 addresses, in CIDR notation.
*/ - Filters?: Filter[]; + Addresses?: string[]; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The resource to which the component is attached.
*/ - MaxResults?: number; + AttachedTo?: AnalysisComponent; /** - *The token for the next page of results.
+ *The Availability Zones.
*/ - NextToken?: string; + AvailabilityZones?: string[]; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The CIDR ranges.
*/ - DryRun?: boolean; -} + Cidrs?: string[]; -export namespace DescribeReplaceRootVolumeTasksRequest { /** - * @internal + *The component.
*/ - export const filterSensitiveLog = (obj: DescribeReplaceRootVolumeTasksRequest): any => ({ - ...obj, - }); -} + Component?: AnalysisComponent; -export interface DescribeReplaceRootVolumeTasksResult { /** - *Information about the root volume replacement task.
+ *The customer gateway.
*/ - ReplaceRootVolumeTasks?: ReplaceRootVolumeTask[]; + CustomerGateway?: AnalysisComponent; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The destination.
*/ - NextToken?: string; -} + Destination?: AnalysisComponent; -export namespace DescribeReplaceRootVolumeTasksResult { /** - * @internal + *The destination VPC.
*/ - export const filterSensitiveLog = (obj: DescribeReplaceRootVolumeTasksResult): any => ({ - ...obj, - }); -} - -export enum OfferingClassType { - CONVERTIBLE = "convertible", - STANDARD = "standard", -} - -export type OfferingTypeValues = - | "All Upfront" - | "Heavy Utilization" - | "Light Utilization" - | "Medium Utilization" - | "No Upfront" - | "Partial Upfront"; + DestinationVpc?: AnalysisComponent; -/** - *Contains the parameters for DescribeReservedInstances.
- */ -export interface DescribeReservedInstancesRequest { /** - *One or more filters.
+ *The direction. The following are possible values:
*
- * availability-zone - The Availability Zone where the Reserved Instance can be used.
- * duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
- * end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
- * fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
- * instance-type - The instance type that is covered by the reservation.
- * scope - The scope of the Reserved Instance (Region or Availability Zone).
- * product-description - The Reserved Instance product platform
- * description. Instances that include (Amazon VPC) in the product platform
- * description will only be displayed to EC2-Classic account holders and are for use with
- * Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE
- * Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise
- * Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat
- * Enterprise Linux with HA (Amazon VPC) | Windows | Windows
- * (Amazon VPC) | Windows with SQL Server Standard | Windows with
- * SQL Server Standard (Amazon VPC) | Windows with SQL Server Web |
- * Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server
- * Enterprise | Windows with SQL Server Enterprise (Amazon
- * VPC)).
- * reserved-instances-id - The ID of the Reserved Instance.
- * start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
- * state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
- * tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.
- * For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
egress
*
- * usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
ingress
*Describes whether the Reserved Instance is Standard or Convertible.
+ *The explanation code.
*/ - OfferingClass?: OfferingClassType | string; + ExplanationCode?: string; /** - *One or more Reserved Instance IDs.
- *Default: Describes all your Reserved Instances, or only those otherwise specified.
+ *The route table.
*/ - ReservedInstancesIds?: string[]; + IngressRouteTable?: AnalysisComponent; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The internet gateway.
*/ - DryRun?: boolean; + InternetGateway?: AnalysisComponent; /** - *The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API
- * version, you only have access to the Medium Utilization Reserved Instance
- * offering type.
The Amazon Resource Name (ARN) of the load balancer.
*/ - OfferingType?: OfferingTypeValues | string; -} + LoadBalancerArn?: string; -export namespace DescribeReservedInstancesRequest { /** - * @internal + *The listener for a Classic Load Balancer.
*/ - export const filterSensitiveLog = (obj: DescribeReservedInstancesRequest): any => ({ - ...obj, - }); -} + ClassicLoadBalancerListener?: AnalysisLoadBalancerListener; -export type RIProductDescription = "Linux/UNIX" | "Linux/UNIX (Amazon VPC)" | "Windows" | "Windows (Amazon VPC)"; + /** + *The listener port of the load balancer.
+ */ + LoadBalancerListenerPort?: number; -export type RecurringChargeFrequency = "Hourly"; + /** + *The target.
+ */ + LoadBalancerTarget?: AnalysisLoadBalancerTarget; -/** - *Describes a recurring charge.
- */ -export interface RecurringCharge { /** - *The amount of the recurring charge.
+ *The target group.
*/ - Amount?: number; + LoadBalancerTargetGroup?: AnalysisComponent; /** - *The frequency of the recurring charge.
+ *The target groups.
*/ - Frequency?: RecurringChargeFrequency | string; -} + LoadBalancerTargetGroups?: AnalysisComponent[]; -export namespace RecurringCharge { /** - * @internal + *The target port.
*/ - export const filterSensitiveLog = (obj: RecurringCharge): any => ({ - ...obj, - }); -} + LoadBalancerTargetPort?: number; -export enum Scope { - AVAILABILITY_ZONE = "Availability Zone", - REGIONAL = "Region", -} + /** + *The load balancer listener.
+ */ + ElasticLoadBalancerListener?: AnalysisComponent; -export type ReservedInstanceState = - | "active" - | "payment-failed" - | "payment-pending" - | "queued" - | "queued-deleted" - | "retired"; + /** + *The missing component.
+ */ + MissingComponent?: string; -/** - *Describes a Reserved Instance.
- */ -export interface ReservedInstances { /** - *The Availability Zone in which the Reserved Instance can be used.
+ *The NAT gateway.
*/ - AvailabilityZone?: string; + NatGateway?: AnalysisComponent; /** - *The duration of the Reserved Instance, in seconds.
+ *The network interface.
*/ - Duration?: number; + NetworkInterface?: AnalysisComponent; /** - *The time when the Reserved Instance expires.
+ *The packet field.
*/ - End?: Date; + PacketField?: string; /** - *The purchase price of the Reserved Instance.
+ *The VPC peering connection.
*/ - FixedPrice?: number; + VpcPeeringConnection?: AnalysisComponent; /** - *The number of reservations purchased.
+ *The port.
*/ - InstanceCount?: number; + Port?: number; + + /** + *The port ranges.
+ */ + PortRanges?: PortRange[]; /** - *The instance type on which the Reserved Instance can be used.
+ *The prefix list.
*/ - InstanceType?: _InstanceType | string; + PrefixList?: AnalysisComponent; /** - *The Reserved Instance product platform description.
+ *The protocols.
*/ - ProductDescription?: RIProductDescription | string; + Protocols?: string[]; /** - *The ID of the Reserved Instance.
+ *The route table route.
*/ - ReservedInstancesId?: string; + RouteTableRoute?: AnalysisRouteTableRoute; /** - *The date and time the Reserved Instance started.
+ *The route table.
*/ - Start?: Date; + RouteTable?: AnalysisComponent; /** - *The state of the Reserved Instance purchase.
+ *The security group.
*/ - State?: ReservedInstanceState | string; + SecurityGroup?: AnalysisComponent; /** - *The usage price of the Reserved Instance, per hour.
+ *The security group rule.
*/ - UsagePrice?: number; + SecurityGroupRule?: AnalysisSecurityGroupRule; /** - *The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.
- * At this time, the only supported currency is USD.
The security groups.
*/ - CurrencyCode?: CurrencyCodeValues | string; + SecurityGroups?: AnalysisComponent[]; /** - *The tenancy of the instance.
+ *The source VPC.
*/ - InstanceTenancy?: Tenancy | string; + SourceVpc?: AnalysisComponent; /** - *The offering class of the Reserved Instance.
+ *The state.
*/ - OfferingClass?: OfferingClassType | string; + State?: string; /** - *The Reserved Instance offering type.
+ *The subnet.
*/ - OfferingType?: OfferingTypeValues | string; + Subnet?: AnalysisComponent; /** - *The recurring charge tag assigned to the resource.
+ *The route table for the subnet.
*/ - RecurringCharges?: RecurringCharge[]; + SubnetRouteTable?: AnalysisComponent; /** - *The scope of the Reserved Instance.
+ *The component VPC.
*/ - Scope?: Scope | string; + Vpc?: AnalysisComponent; /** - *Any tags assigned to the resource.
+ *The VPC endpoint.
*/ - Tags?: Tag[]; -} + VpcEndpoint?: AnalysisComponent; -export namespace ReservedInstances { /** - * @internal + *The VPN connection.
*/ - export const filterSensitiveLog = (obj: ReservedInstances): any => ({ - ...obj, - }); -} + VpnConnection?: AnalysisComponent; -/** - *Contains the output for DescribeReservedInstances.
- */ -export interface DescribeReservedInstancesResult { /** - *A list of Reserved Instances.
+ *The VPN gateway.
*/ - ReservedInstances?: ReservedInstances[]; + VpnGateway?: AnalysisComponent; } -export namespace DescribeReservedInstancesResult { +export namespace Explanation { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeReservedInstancesResult): any => ({ + export const filterSensitiveLog = (obj: Explanation): any => ({ ...obj, }); } /** - *Contains the parameters for DescribeReservedInstancesListings.
+ *Describes a header. Reflects any changes made by a component as traffic passes through. + * The fields of an inbound header are null except for the first component of a path.
*/ -export interface DescribeReservedInstancesListingsRequest { +export interface AnalysisPacketHeader { /** - *One or more filters.
- *
- * reserved-instances-id - The ID of the Reserved Instances.
- * reserved-instances-listing-id - The ID of the Reserved Instances listing.
- * status - The status of the Reserved Instance listing (pending | active |
- * cancelled | closed).
- * status-message - The reason for the status.
The destination addresses.
*/ - Filters?: Filter[]; + DestinationAddresses?: string[]; /** - *One or more Reserved Instance IDs.
+ *The destination port ranges.
*/ - ReservedInstancesId?: string; + DestinationPortRanges?: PortRange[]; /** - *One or more Reserved Instance listing IDs.
+ *The protocol.
*/ - ReservedInstancesListingId?: string; -} + Protocol?: string; -export namespace DescribeReservedInstancesListingsRequest { /** - * @internal + *The source addresses.
*/ - export const filterSensitiveLog = (obj: DescribeReservedInstancesListingsRequest): any => ({ - ...obj, - }); -} + SourceAddresses?: string[]; -/** - *Contains the output of DescribeReservedInstancesListings.
- */ -export interface DescribeReservedInstancesListingsResult { /** - *Information about the Reserved Instance listing.
+ *The source port ranges.
*/ - ReservedInstancesListings?: ReservedInstancesListing[]; + SourcePortRanges?: PortRange[]; } -export namespace DescribeReservedInstancesListingsResult { +export namespace AnalysisPacketHeader { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeReservedInstancesListingsResult): any => ({ + export const filterSensitiveLog = (obj: AnalysisPacketHeader): any => ({ ...obj, }); } /** - *Contains the parameters for DescribeReservedInstancesModifications.
+ *Describes a path component.
*/ -export interface DescribeReservedInstancesModificationsRequest { - /** - *One or more filters.
- *
- * client-token - The idempotency token for the modification request.
- * create-date - The time when the modification request was created.
- * effective-date - The time when the modification becomes effective.
- * modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
- * modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
- * modification-result.target-configuration.instance-count - The number of new Reserved Instances.
- * modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
- * modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
- * reserved-instances-id - The ID of the Reserved Instances modified.
- * reserved-instances-modification-id - The ID of the modification request.
- * status - The status of the Reserved Instances modification request
- * (processing | fulfilled | failed).
- * status-message - The reason for the status.
- * update-date - The time when the modification request was last updated.
IDs for the submitted modification request.
+ *The sequence number.
*/ - ReservedInstancesModificationIds?: string[]; + SequenceNumber?: number; /** - *The token to retrieve the next page of results.
+ *The network ACL rule.
*/ - NextToken?: string; -} + AclRule?: AnalysisAclRule; -export namespace DescribeReservedInstancesModificationsRequest { /** - * @internal + *The component.
*/ - export const filterSensitiveLog = (obj: DescribeReservedInstancesModificationsRequest): any => ({ - ...obj, - }); -} + Component?: AnalysisComponent; -/** - *Describes the configuration settings for the modified Reserved Instances.
- */ -export interface ReservedInstancesConfiguration { /** - *The Availability Zone for the modified Reserved Instances.
+ *The destination VPC.
*/ - AvailabilityZone?: string; + DestinationVpc?: AnalysisComponent; /** - *The number of modified Reserved Instances.
- *This is a required field for a request.
- *The outbound header.
*/ - InstanceCount?: number; + OutboundHeader?: AnalysisPacketHeader; /** - *The instance type for the modified Reserved Instances.
+ *The inbound header.
*/ - InstanceType?: _InstanceType | string; + InboundHeader?: AnalysisPacketHeader; /** - *The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
+ *The route table route.
*/ - Platform?: string; + RouteTableRoute?: AnalysisRouteTableRoute; /** - *Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.
+ *The security group rule.
*/ - Scope?: Scope | string; -} + SecurityGroupRule?: AnalysisSecurityGroupRule; -export namespace ReservedInstancesConfiguration { /** - * @internal + *The source VPC.
*/ - export const filterSensitiveLog = (obj: ReservedInstancesConfiguration): any => ({ - ...obj, - }); -} + SourceVpc?: AnalysisComponent; -/** - *Describes the modification request/s.
- */ -export interface ReservedInstancesModificationResult { /** - *The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
+ *The subnet.
*/ - ReservedInstancesId?: string; + Subnet?: AnalysisComponent; /** - *The target Reserved Instances configurations supplied as part of the modification request.
+ *The component VPC.
*/ - TargetConfiguration?: ReservedInstancesConfiguration; + Vpc?: AnalysisComponent; } -export namespace ReservedInstancesModificationResult { +export namespace PathComponent { /** * @internal */ - export const filterSensitiveLog = (obj: ReservedInstancesModificationResult): any => ({ + export const filterSensitiveLog = (obj: PathComponent): any => ({ ...obj, }); } +export type AnalysisStatus = "failed" | "running" | "succeeded"; + /** - *Describes the ID of a Reserved Instance.
+ *Describes a network insights analysis.
*/ -export interface ReservedInstancesId { +export interface NetworkInsightsAnalysis { /** - *The ID of the Reserved Instance.
+ *The ID of the network insights analysis.
*/ - ReservedInstancesId?: string; -} + NetworkInsightsAnalysisId?: string; -export namespace ReservedInstancesId { /** - * @internal + *The Amazon Resource Name (ARN) of the network insights analysis.
*/ - export const filterSensitiveLog = (obj: ReservedInstancesId): any => ({ - ...obj, - }); -} + NetworkInsightsAnalysisArn?: string; -/** - *Describes a Reserved Instance modification.
- */ -export interface ReservedInstancesModification { /** - *A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. - * For more information, see Ensuring - * Idempotency.
+ *The ID of the path.
*/ - ClientToken?: string; + NetworkInsightsPathId?: string; /** - *The time when the modification request was created.
+ *The Amazon Resource Names (ARN) of the Amazon Web Services resources that the path must traverse.
*/ - CreateDate?: Date; + FilterInArns?: string[]; /** - *The time for the modification to become effective.
+ *The time the analysis started.
*/ - EffectiveDate?: Date; + StartDate?: Date; /** - *Contains target configurations along with their corresponding new Reserved Instance IDs.
+ *The status of the network insights analysis.
*/ - ModificationResults?: ReservedInstancesModificationResult[]; + Status?: AnalysisStatus | string; /** - *The IDs of one or more Reserved Instances.
+ *The status message, if the status is failed.
A unique ID for the Reserved Instance modification.
+ *Indicates whether the destination is reachable from the source.
*/ - ReservedInstancesModificationId?: string; + NetworkPathFound?: boolean; /** - *The status of the Reserved Instances modification request.
+ *The components in the path from source to destination.
*/ - Status?: string; + ForwardPathComponents?: PathComponent[]; /** - *The reason for the status.
+ *The components in the path from destination to source.
*/ - StatusMessage?: string; + ReturnPathComponents?: PathComponent[]; /** - *The time when the modification request was last updated.
+ *The explanations. For more information, see Reachability Analyzer explanation codes.
*/ - UpdateDate?: Date; + Explanations?: Explanation[]; + + /** + *Potential intermediate components.
+ */ + AlternatePathHints?: AlternatePathHint[]; + + /** + *The tags.
+ */ + Tags?: Tag[]; } -export namespace ReservedInstancesModification { +export namespace NetworkInsightsAnalysis { /** * @internal */ - export const filterSensitiveLog = (obj: ReservedInstancesModification): any => ({ + export const filterSensitiveLog = (obj: NetworkInsightsAnalysis): any => ({ ...obj, }); } -/** - *Contains the output of DescribeReservedInstancesModifications.
- */ -export interface DescribeReservedInstancesModificationsResult { +export interface DescribeNetworkInsightsAnalysesResult { /** - *The token to use to retrieve the next page of results. This value is null when
- * there are no more results to return.
Information about the network insights analyses.
*/ - NextToken?: string; + NetworkInsightsAnalyses?: NetworkInsightsAnalysis[]; /** - *The Reserved Instance modification information.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for DescribeReservedInstancesOfferings.
- */ -export interface DescribeReservedInstancesOfferingsRequest { +export interface DescribeNetworkInsightsPathsRequest { /** - *The Availability Zone in which the Reserved Instance can be used.
+ *The IDs of the paths.
*/ - AvailabilityZone?: string; + NetworkInsightsPathIds?: string[]; /** - *One or more filters.
+ *The filters. The following are possible values:
*
- * availability-zone - The Availability Zone where the Reserved Instance can be
- * used.
- * duration - The duration of the Reserved Instance (for example, one year or
- * three years), in seconds (31536000 | 94608000).
- * fixed-price - The purchase price of the Reserved Instance (for example,
- * 9800.0).
- * instance-type - The instance type that is covered by the
- * reservation.
- * marketplace - Set to true to show only Reserved Instance
- * Marketplace offerings. When this filter is not used, which is the default behavior, all
- * offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
Destination - The ID of the resource.
*
- * product-description - The Reserved Instance product platform description.
- * Instances that include (Amazon VPC) in the product platform description will
- * only be displayed to EC2-Classic account holders and are for use with Amazon VPC.
- * (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE
- * Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise
- * Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat
- * Enterprise Linux with HA (Amazon VPC) | Windows | Windows
- * (Amazon VPC) | Windows with SQL Server Standard | Windows with
- * SQL Server Standard (Amazon VPC) | Windows with SQL Server Web |
- * Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server
- * Enterprise | Windows with SQL Server Enterprise (Amazon VPC))
DestinationPort - The destination port.
*
- * reserved-instances-offering-id - The Reserved Instances offering
- * ID.
Name - The path name.
*
- * scope - The scope of the Reserved Instance (Availability Zone or
- * Region).
Protocol - The protocol.
*
- * usage-price - The usage price of the Reserved Instance, per hour (for
- * example, 0.84).
Source - The ID of the resource.
*Include Reserved Instance Marketplace offerings in the response.
- */ - IncludeMarketplace?: boolean; - - /** - *The instance type that the reservation will cover (for example, m1.small). For more information, see
- * Instance types in the
- * Amazon EC2 User Guide.
The maximum duration (in seconds) to filter when searching for offerings.
- *Default: 94608000 (3 years)
- */ - MaxDuration?: number; - - /** - *The maximum number of instances to filter when searching for offerings.
- *Default: 20
- */ - MaxInstanceCount?: number; - - /** - *The minimum duration (in seconds) to filter when searching for offerings.
- *Default: 2592000 (1 month)
- */ - MinDuration?: number; - - /** - *The offering class of the Reserved Instance. Can be standard or convertible.
The Reserved Instance product platform description. Instances that include (Amazon
- * VPC) in the description are for use with Amazon VPC.
One or more Reserved Instances offering IDs.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
/**
- * The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy
- * of dedicated is applied to instances that run in a VPC on single-tenant hardware
- * (i.e., Dedicated Instances).
- * Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
- *
The maximum number of results to return for the request in a single page. The remaining
- * results of the initial request can be seen by sending another request with the returned
- * NextToken value. The maximum is 100.
Default: 100
- */ - MaxResults?: number; - - /** - *The token to retrieve the next page of results.
+ *The token for the next page of results.
*/ NextToken?: string; - - /** - *The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API
- * version, you only have access to the Medium Utilization Reserved Instance
- * offering type.
Describes a Reserved Instance offering.
- */ -export interface PricingDetail { +export interface DescribeNetworkInsightsPathsResult { /** - *The number of reservations available for the price.
+ *Information about the paths.
*/ - Count?: number; + NetworkInsightsPaths?: NetworkInsightsPath[]; /** - *The price per instance.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes a Reserved Instance offering.
+ *Contains the parameters for DescribeNetworkInterfaceAttribute.
*/ -export interface ReservedInstancesOffering { - /** - *The Availability Zone in which the Reserved Instance can be used.
- */ - AvailabilityZone?: string; - +export interface DescribeNetworkInterfaceAttributeRequest { /** - *The duration of the Reserved Instance, in seconds.
+ *The attribute of the network interface. This parameter is required.
*/ - Duration?: number; + Attribute?: NetworkInterfaceAttribute | string; /** - *The purchase price of the Reserved Instance.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The instance type on which the Reserved Instance can be used.
+ *The ID of the network interface.
*/ - InstanceType?: _InstanceType | string; + NetworkInterfaceId: string | undefined; +} +export namespace DescribeNetworkInterfaceAttributeRequest { /** - *The Reserved Instance product platform description.
+ * @internal */ - ProductDescription?: RIProductDescription | string; + export const filterSensitiveLog = (obj: DescribeNetworkInterfaceAttributeRequest): any => ({ + ...obj, + }); +} +/** + *Contains the output of DescribeNetworkInterfaceAttribute.
+ */ +export interface DescribeNetworkInterfaceAttributeResult { /** - *The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote - * to confirm that an exchange can be made.
+ *The attachment (if any) of the network interface.
*/ - ReservedInstancesOfferingId?: string; + Attachment?: NetworkInterfaceAttachment; /** - *The usage price of the Reserved Instance, per hour.
+ *The description of the network interface.
*/ - UsagePrice?: number; + Description?: AttributeValue; /** - *The currency of the Reserved Instance offering you are purchasing. It's
- * specified using ISO 4217 standard currency codes. At this time,
- * the only supported currency is USD.
The security groups associated with the network interface.
*/ - CurrencyCode?: CurrencyCodeValues | string; + Groups?: GroupIdentifier[]; /** - *The tenancy of the instance.
+ *The ID of the network interface.
*/ - InstanceTenancy?: Tenancy | string; + NetworkInterfaceId?: string; /** - *Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services.
- * If it's a Reserved Instance Marketplace offering, this is true.
Indicates whether source/destination checking is enabled.
*/ - Marketplace?: boolean; + SourceDestCheck?: AttributeBooleanValue; +} +export namespace DescribeNetworkInterfaceAttributeResult { /** - *If convertible it can be exchanged for Reserved Instances of
- * the same or higher monetary value, with different configurations. If standard, it is not
- * possible to perform an exchange.
Contains the parameters for DescribeNetworkInterfacePermissions.
+ */ +export interface DescribeNetworkInterfacePermissionsRequest { /** - *The Reserved Instance offering type.
+ *One or more network interface permission IDs.
*/ - OfferingType?: OfferingTypeValues | string; + NetworkInterfacePermissionIds?: string[]; /** - *The pricing details of the Reserved Instance offering.
+ *One or more filters.
+ *
+ * network-interface-permission.network-interface-permission-id - The ID of the
+ * permission.
+ * network-interface-permission.network-interface-id - The ID of
+ * the network interface.
+ * network-interface-permission.aws-account-id - The Amazon Web Services account ID.
+ * network-interface-permission.aws-service - The Amazon Web Service.
+ * network-interface-permission.permission - The type of
+ * permission (INSTANCE-ATTACH |
+ * EIP-ASSOCIATE).
The recurring charge tag assigned to the resource.
+ *The token to request the next page of results.
*/ - RecurringCharges?: RecurringCharge[]; + NextToken?: string; /** - *Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
+ *The maximum number of results to return in a single call. To retrieve the remaining results,
+ * make another call with the returned NextToken value. If this parameter is not specified, up to 50 results are returned by default.
Contains the output of DescribeReservedInstancesOfferings.
+ *Contains the output for DescribeNetworkInterfacePermissions.
*/ -export interface DescribeReservedInstancesOfferingsResult { +export interface DescribeNetworkInterfacePermissionsResult { /** - *A list of Reserved Instances offerings.
+ *The network interface permissions.
*/ - ReservedInstancesOfferings?: ReservedInstancesOffering[]; + NetworkInterfacePermissions?: NetworkInterfacePermission[]; /** - *The token to use to retrieve the next page of results. This value is null when
- * there are no more results to return.
The token to use to retrieve the next page of results.
*/ NextToken?: string; } -export namespace DescribeReservedInstancesOfferingsResult { +export namespace DescribeNetworkInterfacePermissionsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeReservedInstancesOfferingsResult): any => ({ + export const filterSensitiveLog = (obj: DescribeNetworkInterfacePermissionsResult): any => ({ ...obj, }); } -export interface DescribeRouteTablesRequest { +/** + *Contains the parameters for DescribeNetworkInterfaces.
+ */ +export interface DescribeNetworkInterfacesRequest { /** *One or more filters.
*
- * association.route-table-association-id - The ID of an association
- * ID for the route table.
addresses.private-ip-address - The private IPv4 addresses
+ * associated with the network interface.
*
- * association.route-table-id - The ID of the route table involved in
- * the association.
addresses.primary - Whether the private IPv4 address is the primary
+ * IP address associated with the network interface.
*
- * association.subnet-id - The ID of the subnet involved in the
- * association.
addresses.association.public-ip - The association ID returned when
+ * the network interface was associated with the Elastic IP address
+ * (IPv4).
*
- * association.main - Indicates whether the route table is the main
- * route table for the VPC (true | false). Route tables
- * that do not have an association ID are not returned in the response.
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
+ *
+ * association.association-id - The association ID returned when the
+ * network interface was associated with an IPv4 address.
+ * association.allocation-id - The allocation ID returned when you
+ * allocated the Elastic IP address (IPv4) for your network interface.
+ * association.ip-owner-id - The owner of the Elastic IP address
+ * (IPv4) associated with the network interface.
+ * association.public-ip - The address of the Elastic IP address
+ * (IPv4) bound to the network interface.
+ * association.public-dns-name - The public DNS name for the network
+ * interface (IPv4).
+ * attachment.attachment-id - The ID of the interface attachment.
+ * attachment.attach-time - The time that the network interface was attached to an instance.
+ * attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
+ * attachment.device-index - The device index to which the network interface is attached.
+ * attachment.instance-id - The ID of the instance to which the network interface is attached.
+ * attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
+ * attachment.status - The status of the attachment (attaching | attached | detaching | detached).
+ * availability-zone - The Availability Zone of the network interface.
+ * description - The description of the network interface.
+ * group-id - The ID of a security group associated with the network interface.
+ * group-name - The name of a security group associated with the network interface.
+ * ipv6-addresses.ipv6-address - An IPv6 address associated with
+ * the network interface.
+ * mac-address - The MAC address of the network interface.
+ * network-interface-id - The ID of the network interface.
+ * owner-id - The Amazon Web Services account ID of the network interface owner.
+ * private-ip-address - The private IPv4 address or addresses of the
+ * network interface.
- * owner-id - The ID of the Amazon Web Services account that owns the route table.
private-dns-name - The private DNS name of the network interface (IPv4).
*
- * route-table-id - The ID of the route table.
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
*
- * route.destination-cidr-block - The IPv4 CIDR range specified in a
- * route in the table.
- * route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
- * route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Service
- * specified in a route in the table.
- * route.egress-only-internet-gateway-id - The ID of an
- * egress-only Internet gateway specified in a route in the route table.
- * route.gateway-id - The ID of a gateway specified in a route in the table.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service
+ * (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
*
- * route.instance-id - The ID of an instance specified in a route in the table.
- * route.nat-gateway-id - The ID of a NAT gateway.
- * route.transit-gateway-id - The ID of a transit gateway.
source-dest-check - Indicates whether the network interface performs source/destination checking.
+ * A value of true means checking is enabled, and false means checking is disabled.
+ * The value must be false for the network interface to perform network address translation (NAT) in your VPC.
*
- * route.origin - Describes how the route was created.
- * CreateRouteTable indicates that the route was automatically
- * created when the route table was created; CreateRoute indicates
- * that the route was manually added to the route table;
- * EnableVgwRoutePropagation indicates that the route was
- * propagated by route propagation.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available;
+ * if a network interface is attached to an instance the status is in-use.
*
- * route.state - The state of a route in the route table
- * (active | blackhole). The blackhole state
- * indicates that the route's target isn't available (for example, the specified
- * gateway isn't attached to the VPC, the specified NAT instance has been
- * terminated, and so on).
- * route.vpc-peering-connection-id - The ID of a VPC peering
- * connection specified in a route in the table.
+ * subnet-id - The ID of the subnet for the network interface.
+ *
* tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ *
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * vpc-id - The ID of the VPC for the route table.
+ * vpc-id - The ID of the VPC for the network interface.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
/**
- * One or more route table IDs.
- *Default: Describes all your route tables.
+ *One or more network interface IDs.
+ *Default: Describes all your network interfaces.
*/ - RouteTableIds?: string[]; + NetworkInterfaceIds?: string[]; /** - *The token for the next page of results.
+ *The token to retrieve the next page of results.
*/ NextToken?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of items to return for this request. The request returns a token that you + * can specify in a subsequent call to get the next set of results. You cannot specify this + * parameter and the network interface IDs parameter in the same request.
*/ MaxResults?: number; } -export namespace DescribeRouteTablesRequest { +export namespace DescribeNetworkInterfacesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeRouteTablesRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeNetworkInterfacesRequest): any => ({ ...obj, }); } /** - *Contains the output of DescribeRouteTables.
+ *Contains the output of DescribeNetworkInterfaces.
*/ -export interface DescribeRouteTablesResult { +export interface DescribeNetworkInterfacesResult { /** - *Information about one or more route tables.
+ *Information about one or more network interfaces.
*/ - RouteTables?: RouteTable[]; + NetworkInterfaces?: NetworkInterface[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.
- */ -export interface SlotDateTimeRangeRequest { - /** - *The earliest date and time, in UTC, for the Scheduled Instance to start.
- */ - EarliestTime: Date | undefined; - - /** - *The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.
- */ - LatestTime: Date | undefined; -} - -export namespace SlotDateTimeRangeRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: SlotDateTimeRangeRequest): any => ({ - ...obj, - }); -} - -/** - *Describes the recurring schedule for a Scheduled Instance.
- */ -export interface ScheduledInstanceRecurrenceRequest { - /** - *The frequency (Daily, Weekly, or Monthly).
The interval quantity. The interval unit depends on the value of Frequency. For example, every 2
- * weeks or every 2 months.
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
- */ - OccurrenceDays?: number[]; - - /** - *Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
- */ - OccurrenceRelativeToEnd?: boolean; - - /** - *The unit for OccurrenceDays (DayOfWeek or DayOfMonth).
- * This value is required for a monthly schedule.
- * You can't specify DayOfWeek with a weekly schedule.
- * You can't specify this value with a daily schedule.
Contains the parameters for DescribeScheduledInstanceAvailability.
- */ -export interface DescribeScheduledInstanceAvailabilityRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The filters.
- *
- * availability-zone - The Availability Zone (for example, us-west-2a).
+ * group-name - The name of the placement group.
- * instance-type - The instance type (for example, c4.large).
+ * state - The state of the placement group (pending |
+ * available | deleting |
+ * deleted).
+ * strategy - The strategy of the placement group
+ * (cluster | spread |
+ * partition).
- * network-platform - The network platform (EC2-Classic or EC2-VPC).
tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.
+ * For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
*
- * platform - The platform (Linux/UNIX or Windows).
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
* The time period for the first schedule to start.
- */ - FirstSlotStartTimeRange: SlotDateTimeRangeRequest | undefined; - - /** - *The maximum number of results to return in a single call.
- * This value can be between 5 and 300. The default value is 300.
- * To retrieve the remaining results, make another call with the returned
- * NextToken value.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours
- * and less than 1,720.
The names of the placement groups.
+ *Default: Describes all your placement groups, or only those otherwise + * specified.
*/ - MaxSlotDurationInHours?: number; + GroupNames?: string[]; /** - *The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
+ *The IDs of the placement groups.
*/ - MinSlotDurationInHours?: number; + GroupIds?: string[]; +} +export namespace DescribePlacementGroupsRequest { /** - *The token for the next set of results.
+ * @internal */ - NextToken?: string; + export const filterSensitiveLog = (obj: DescribePlacementGroupsRequest): any => ({ + ...obj, + }); +} +export interface DescribePlacementGroupsResult { /** - *The schedule recurrence.
+ *Information about the placement groups.
*/ - Recurrence: ScheduledInstanceRecurrenceRequest | undefined; + PlacementGroups?: PlacementGroup[]; } -export namespace DescribeScheduledInstanceAvailabilityRequest { +export namespace DescribePlacementGroupsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeScheduledInstanceAvailabilityRequest): any => ({ + export const filterSensitiveLog = (obj: DescribePlacementGroupsResult): any => ({ ...obj, }); } -/** - *Describes the recurring schedule for a Scheduled Instance.
- */ -export interface ScheduledInstanceRecurrence { +export interface DescribePrefixListsRequest { /** - *The frequency (Daily, Weekly, or Monthly).
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The interval quantity. The interval unit depends on the value of frequency. For example, every 2
- * weeks or every 2 months.
One or more filters.
+ *
+ * prefix-list-id: The ID of a prefix list.
+ * prefix-list-name: The name of a prefix list.
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Indicates whether the occurrence is relative to the end of the specified week or month.
+ *The token for the next page of results.
*/ - OccurrenceRelativeToEnd?: boolean; + NextToken?: string; /** - *The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).
One or more prefix list IDs.
*/ - OccurrenceUnit?: string; + PrefixListIds?: string[]; } -export namespace ScheduledInstanceRecurrence { +export namespace DescribePrefixListsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ScheduledInstanceRecurrence): any => ({ + export const filterSensitiveLog = (obj: DescribePrefixListsRequest): any => ({ ...obj, }); } /** - *Describes a schedule that is available for your Scheduled Instances.
+ *Describes prefixes for Amazon Web Services services.
*/ -export interface ScheduledInstanceAvailability { - /** - *The Availability Zone.
- */ - AvailabilityZone?: string; - - /** - *The number of available instances.
- */ - AvailableInstanceCount?: number; - +export interface PrefixList { /** - *The time period for the first schedule to start.
+ *The IP address range of the Amazon Web Service.
*/ - FirstSlotStartTime?: Date; + Cidrs?: string[]; /** - *The hourly price for a single instance.
+ *The ID of the prefix.
*/ - HourlyPrice?: string; + PrefixListId?: string; /** - *The instance type. You can specify one of the C3, C4, M4, or R3 instance types.
+ *The name of the prefix.
*/ - InstanceType?: string; + PrefixListName?: string; +} +export namespace PrefixList { /** - *The maximum term. The only possible value is 365 days.
+ * @internal */ - MaxTermDurationInDays?: number; + export const filterSensitiveLog = (obj: PrefixList): any => ({ + ...obj, + }); +} +export interface DescribePrefixListsResult { /** - *The minimum term. The only possible value is 365 days.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The network platform (EC2-Classic or EC2-VPC).
All available prefix lists.
*/ - NetworkPlatform?: string; + PrefixLists?: PrefixList[]; +} +export namespace DescribePrefixListsResult { /** - *The platform (Linux/UNIX or Windows).
The purchase token. This token expires in two hours.
+ *Checks whether you have the required permissions for the action, without 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 schedule recurrence.
+ *The type of resource: bundle |
+ * conversion-task | customer-gateway | dhcp-options |
+ * elastic-ip-allocation | elastic-ip-association |
+ * export-task | flow-log | image |
+ * import-task | instance | internet-gateway |
+ * network-acl | network-acl-association |
+ * network-interface | network-interface-attachment |
+ * prefix-list | reservation | route-table |
+ * route-table-association | security-group |
+ * snapshot | subnet |
+ * subnet-cidr-block-association | volume | vpc
+ * | vpc-cidr-block-association | vpc-endpoint |
+ * vpc-peering-connection | vpn-connection | vpn-gateway
+ *
The number of hours in the schedule.
+ *The maximum number of results to return in a single call. To retrieve the remaining + * results, make another call with the returned NextToken value.
*/ - SlotDurationInHours?: number; + MaxResults?: number; /** - *The total number of hours for a single instance for the entire term.
+ *The token to request the next page of results.
*/ - TotalScheduledInstanceHours?: number; + NextToken?: string; } -export namespace ScheduledInstanceAvailability { +export namespace DescribePrincipalIdFormatRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ScheduledInstanceAvailability): any => ({ + export const filterSensitiveLog = (obj: DescribePrincipalIdFormatRequest): any => ({ ...obj, }); } /** - *Contains the output of DescribeScheduledInstanceAvailability.
+ *PrincipalIdFormat description
*/ -export interface DescribeScheduledInstanceAvailabilityResult { +export interface PrincipalIdFormat { /** - *The token required to retrieve the next set of results. This value is null when there are no more results to return.
PrincipalIdFormatARN description
*/ - NextToken?: string; + Arn?: string; /** - *Information about the available Scheduled Instances.
+ *PrincipalIdFormatStatuses description
*/ - ScheduledInstanceAvailabilitySet?: ScheduledInstanceAvailability[]; + Statuses?: IdFormat[]; } -export namespace DescribeScheduledInstanceAvailabilityResult { +export namespace PrincipalIdFormat { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeScheduledInstanceAvailabilityResult): any => ({ + export const filterSensitiveLog = (obj: PrincipalIdFormat): any => ({ ...obj, }); } -/** - *Describes the time period for a Scheduled Instance to start its first schedule.
- */ -export interface SlotStartTimeRangeRequest { +export interface DescribePrincipalIdFormatResult { /** - *The earliest date and time, in UTC, for the Scheduled Instance to start.
+ *Information about the ID format settings for the ARN.
*/ - EarliestTime?: Date; + Principals?: PrincipalIdFormat[]; /** - *The latest date and time, in UTC, for the Scheduled Instance to start.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
*/ - LatestTime?: Date; + NextToken?: string; } -export namespace SlotStartTimeRangeRequest { +export namespace DescribePrincipalIdFormatResult { /** * @internal */ - export const filterSensitiveLog = (obj: SlotStartTimeRangeRequest): any => ({ + export const filterSensitiveLog = (obj: DescribePrincipalIdFormatResult): any => ({ ...obj, }); } -/** - *Contains the parameters for DescribeScheduledInstances.
- */ -export interface DescribeScheduledInstancesRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The filters.
- *
- * availability-zone - The Availability Zone (for example, us-west-2a).
- * instance-type - The instance type (for example, c4.large).
- * network-platform - The network platform (EC2-Classic or EC2-VPC).
- * platform - The platform (Linux/UNIX or Windows).
The maximum number of results to return in a single call.
- * This value can be between 5 and 300. The default value is 100.
- * To retrieve the remaining results, make another call with the returned
- * NextToken value.
The IDs of the address pools.
*/ - MaxResults?: number; + PoolIds?: string[]; /** - *The token for the next set of results.
+ *The token for the next page of results.
*/ NextToken?: string; /** - *The Scheduled Instance IDs.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The time period for the first schedule to start.
+ *One or more filters.
+ *
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Describes a Scheduled Instance.
+ *Describes an address range of an IPv4 address pool.
*/ -export interface ScheduledInstance { - /** - *The Availability Zone.
- */ - AvailabilityZone?: string; - - /** - *The date when the Scheduled Instance was purchased.
- */ - CreateDate?: Date; - - /** - *The hourly price for a single instance.
- */ - HourlyPrice?: string; - +export interface PublicIpv4PoolRange { /** - *The number of instances.
+ *The first IP address in the range.
*/ - InstanceCount?: number; + FirstAddress?: string; /** - *The instance type.
+ *The last IP address in the range.
*/ - InstanceType?: string; + LastAddress?: string; /** - *The network platform (EC2-Classic or EC2-VPC).
The number of addresses in the range.
*/ - NetworkPlatform?: string; + AddressCount?: number; /** - *The time for the next schedule to start.
+ *The number of available addresses in the range.
*/ - NextSlotStartTime?: Date; + AvailableAddressCount?: number; +} +export namespace PublicIpv4PoolRange { /** - *The platform (Linux/UNIX or Windows).
Describes an IPv4 address pool.
+ */ +export interface PublicIpv4Pool { /** - *The time that the previous schedule ended or will end.
+ *The ID of the address pool.
*/ - PreviousSlotEndTime?: Date; + PoolId?: string; /** - *The schedule recurrence.
+ *A description of the address pool.
*/ - Recurrence?: ScheduledInstanceRecurrence; + Description?: string; /** - *The Scheduled Instance ID.
+ *The address ranges.
*/ - ScheduledInstanceId?: string; + PoolAddressRanges?: PublicIpv4PoolRange[]; /** - *The number of hours in the schedule.
+ *The total number of addresses.
*/ - SlotDurationInHours?: number; + TotalAddressCount?: number; /** - *The end date for the Scheduled Instance.
+ *The total number of available addresses.
*/ - TermEndDate?: Date; + TotalAvailableAddressCount?: number; /** - *The start date for the Scheduled Instance.
+ *The name of the location from which the address pool is advertised. + * A network border group is a unique set of Availability Zones or Local Zones + * from where Amazon Web Services advertises public IP addresses.
*/ - TermStartDate?: Date; + NetworkBorderGroup?: string; /** - *The total number of hours for a single instance for the entire term.
+ *Any tags for the address pool.
*/ - TotalScheduledInstanceHours?: number; + Tags?: Tag[]; } -export namespace ScheduledInstance { +export namespace PublicIpv4Pool { /** * @internal */ - export const filterSensitiveLog = (obj: ScheduledInstance): any => ({ + export const filterSensitiveLog = (obj: PublicIpv4Pool): any => ({ ...obj, }); } -/** - *Contains the output of DescribeScheduledInstances.
- */ -export interface DescribeScheduledInstancesResult { +export interface DescribePublicIpv4PoolsResult { /** - *The token required to retrieve the next set of results. This value is null when there are no more results to return.
Information about the address pools.
*/ - NextToken?: string; + PublicIpv4Pools?: PublicIpv4Pool[]; /** - *Information about the Scheduled Instances.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
+ *
+ * endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
+ * opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in |
+ * not-opted-in).
+ * region-name - The name of the Region (for example, us-east-1).
The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.
+ */ + RegionNames?: string[]; + /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -8928,97 +8268,88 @@ export interface DescribeSecurityGroupReferencesRequest {
DryRun?: boolean;
/**
- *
The IDs of the security groups in your account.
+ *Indicates whether to display all Regions, including Regions that are disabled for your account.
*/ - GroupId: string[] | undefined; + AllRegions?: boolean; } -export namespace DescribeSecurityGroupReferencesRequest { +export namespace DescribeRegionsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSecurityGroupReferencesRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeRegionsRequest): any => ({ ...obj, }); } /** - *Describes a VPC with a security group that references your security group.
+ *Describes a Region.
*/ -export interface SecurityGroupReference { +export interface Region { /** - *The ID of your security group.
+ *The Region service endpoint.
*/ - GroupId?: string; + Endpoint?: string; /** - *The ID of the VPC with the referencing security group.
+ *The name of the Region.
*/ - ReferencingVpcId?: string; + RegionName?: string; /** - *The ID of the VPC peering connection.
+ *The Region opt-in status. The possible values are opt-in-not-required, opted-in, and
+ * not-opted-in.
Information about the VPCs with the referencing security groups.
+ *Information about the Regions.
*/ - SecurityGroupReferenceSet?: SecurityGroupReference[]; + Regions?: Region[]; } -export namespace DescribeSecurityGroupReferencesResult { +export namespace DescribeRegionsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSecurityGroupReferencesResult): any => ({ + export const filterSensitiveLog = (obj: DescribeRegionsResult): any => ({ ...obj, }); } -export interface DescribeSecurityGroupRulesRequest { +export interface DescribeReplaceRootVolumeTasksRequest { /** - *One or more filters.
- *
- * group-id - The ID of the security group.
- * security-group-rule-id - The ID of the security group rule.
The ID of the root volume replacement task to view.
+ */ + ReplaceRootVolumeTaskIds?: string[]; + + /** + *Filter to use:
+ *
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
instance-id - The ID of the instance for which the root volume replacement task was created.
* The IDs of the security group rules.
- */ - SecurityGroupRuleIds?: string[]; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
@@ -9026,158 +8357,117 @@ export interface DescribeSecurityGroupRulesRequest { NextToken?: string; /** - *The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another request with the returned NextToken value. This value
- * can be between 5 and 1000. If this parameter is not specified, then all results are
- * returned.
Information about security group rules.
- */ - SecurityGroupRules?: SecurityGroupRule[]; - - /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
- *
- * description - The description of the security group.
- * egress.ip-permission.cidr - An IPv4 CIDR block for an outbound
- * security group rule.
- * egress.ip-permission.from-port - For an outbound rule, the
- * start of port range for the TCP and UDP protocols, or an ICMP type
- * number.
- * egress.ip-permission.group-id - The ID of a security group
- * that has been referenced in an outbound security group rule.
- * egress.ip-permission.group-name - The name of a security group
- * that is referenced in an outbound security group rule.
- * egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an
- * outbound security group rule.
- * egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
- * egress.ip-permission.protocol - The IP protocol for an
- * outbound security group rule (tcp | udp |
- * icmp, a protocol number, or -1 for all protocols).
- * egress.ip-permission.to-port - For an outbound rule, the end
- * of port range for the TCP and UDP protocols, or an ICMP code.
- * egress.ip-permission.user-id - The ID of an Amazon Web Services account that
- * has been referenced in an outbound security group rule.
Information about the root volume replacement task.
+ */ + ReplaceRootVolumeTasks?: ReplaceRootVolumeTask[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for DescribeReservedInstances.
+ */ +export interface DescribeReservedInstancesRequest { + /** + *One or more filters.
+ *
- * group-id - The ID of the security group.
availability-zone - The Availability Zone where the Reserved Instance can be used.
*
- * group-name - The name of the security group.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
*
- * ip-permission.cidr - An IPv4 CIDR block for an inbound security
- * group rule.
end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
*
- * ip-permission.from-port - For an inbound rule, the start of port
- * range for the TCP and UDP protocols, or an ICMP type number.
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
*
- * ip-permission.group-id - The ID of a security group that has been
- * referenced in an inbound security group rule.
instance-type - The instance type that is covered by the reservation.
*
- * ip-permission.group-name - The name of a security group that is
- * referenced in an inbound security group rule.
- * ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security
- * group rule.
- * ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
scope - The scope of the Reserved Instance (Region or Availability Zone).
*
- * ip-permission.protocol - The IP protocol for an inbound security
- * group rule (tcp | udp | icmp, a
- * protocol number, or -1 for all protocols).
product-description - The Reserved Instance product platform
+ * description. Instances that include (Amazon VPC) in the product platform
+ * description will only be displayed to EC2-Classic account holders and are for use with
+ * Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE
+ * Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise
+ * Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat
+ * Enterprise Linux with HA (Amazon VPC) | Windows | Windows
+ * (Amazon VPC) | Windows with SQL Server Standard | Windows with
+ * SQL Server Standard (Amazon VPC) | Windows with SQL Server Web |
+ * Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server
+ * Enterprise | Windows with SQL Server Enterprise (Amazon
+ * VPC)).
*
- * ip-permission.to-port - For an inbound rule, the end of port range
- * for the TCP and UDP protocols, or an ICMP code.
reserved-instances-id - The ID of the Reserved Instance.
*
- * ip-permission.user-id - The ID of an Amazon Web Services account that has been
- * referenced in an inbound security group rule.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
*
- * owner-id - The Amazon Web Services account ID of the owner of the security group.
state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
*
- * tag:tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.
* For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * vpc-id - The ID of the VPC specified when the security group was created.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
* The IDs of the security groups. Required for security groups in a nondefault VPC.
- *Default: Describes all of your security groups.
+ *Describes whether the Reserved Instance is Standard or Convertible.
*/ - GroupIds?: string[]; + OfferingClass?: OfferingClassType | string; /** - *[EC2-Classic and default VPC only] The names of the security groups. You can specify either
- * the security group name or the security group ID. For security groups in a nondefault VPC, use
- * the group-name filter to describe security groups by name.
Default: Describes all of your security groups.
+ *One or more Reserved Instance IDs.
+ *Default: Describes all your Reserved Instances, or only those otherwise specified.
*/ - GroupNames?: string[]; + ReservedInstancesIds?: string[]; /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
/**
- * The token to request the next page of results.
+ *The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API
+ * version, you only have access to the Medium Utilization Reserved Instance
+ * offering type.
The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another request with the returned NextToken value. This value
- * can be between 5 and 1000. If this parameter is not specified, then all results are
- * returned.
Describes a recurring charge.
+ */ +export interface RecurringCharge { + /** + *The amount of the recurring charge.
+ */ + Amount?: number; + + /** + *The frequency of the recurring charge.
+ */ + Frequency?: RecurringChargeFrequency | string; +} + +export namespace RecurringCharge { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSecurityGroupsRequest): any => ({ + export const filterSensitiveLog = (obj: RecurringCharge): any => ({ ...obj, }); } +export enum Scope { + AVAILABILITY_ZONE = "Availability Zone", + REGIONAL = "Region", +} + +export type ReservedInstanceState = + | "active" + | "payment-failed" + | "payment-pending" + | "queued" + | "queued-deleted" + | "retired"; + /** - *Describes a security group.
+ *Describes a Reserved Instance.
*/ -export interface SecurityGroup { +export interface ReservedInstances { /** - *A description of the security group.
+ *The Availability Zone in which the Reserved Instance can be used.
*/ - Description?: string; + AvailabilityZone?: string; /** - *The name of the security group.
+ *The duration of the Reserved Instance, in seconds.
*/ - GroupName?: string; + Duration?: number; /** - *The inbound rules associated with the security group.
+ *The time when the Reserved Instance expires.
*/ - IpPermissions?: IpPermission[]; + End?: Date; /** - *The Amazon Web Services account ID of the owner of the security group.
+ *The purchase price of the Reserved Instance.
*/ - OwnerId?: string; + FixedPrice?: number; /** - *The ID of the security group.
+ *The number of reservations purchased.
*/ - GroupId?: string; + InstanceCount?: number; /** - *[VPC only] The outbound rules associated with the security group.
+ *The instance type on which the Reserved Instance can be used.
*/ - IpPermissionsEgress?: IpPermission[]; + InstanceType?: _InstanceType | string; /** - *Any tags assigned to the security group.
+ *The Reserved Instance product platform description.
*/ - Tags?: Tag[]; + ProductDescription?: RIProductDescription | string; /** - *[VPC only] The ID of the VPC for the security group.
+ *The ID of the Reserved Instance.
*/ - VpcId?: string; -} + ReservedInstancesId?: string; -export namespace SecurityGroup { /** - * @internal + *The date and time the Reserved Instance started.
*/ - export const filterSensitiveLog = (obj: SecurityGroup): any => ({ - ...obj, - }); -} + Start?: Date; -export interface DescribeSecurityGroupsResult { /** - *Information about the security groups.
+ *The state of the Reserved Instance purchase.
*/ - SecurityGroups?: SecurityGroup[]; + State?: ReservedInstanceState | string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The usage price of the Reserved Instance, per hour.
*/ - NextToken?: string; -} + UsagePrice?: number; -export namespace DescribeSecurityGroupsResult { /** - * @internal + *The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.
+ * At this time, the only supported currency is USD.
The tenancy of the instance.
+ */ + InstanceTenancy?: Tenancy | string; -export interface DescribeSnapshotAttributeRequest { /** - *The snapshot attribute you would like to view.
+ *The offering class of the Reserved Instance.
*/ - Attribute: SnapshotAttributeName | string | undefined; + OfferingClass?: OfferingClassType | string; + + /** + *The Reserved Instance offering type.
+ */ + OfferingType?: OfferingTypeValues | string; + + /** + *The recurring charge tag assigned to the resource.
+ */ + RecurringCharges?: RecurringCharge[]; + + /** + *The scope of the Reserved Instance.
+ */ + Scope?: Scope | string; + + /** + *Any tags assigned to the resource.
+ */ + Tags?: Tag[]; +} +export namespace ReservedInstances { /** - *The ID of the EBS snapshot.
+ * @internal */ - SnapshotId: string | undefined; + export const filterSensitiveLog = (obj: ReservedInstances): any => ({ + ...obj, + }); +} +/** + *Contains the output for DescribeReservedInstances.
+ */ +export interface DescribeReservedInstancesResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
A list of Reserved Instances.
*/ - DryRun?: boolean; + ReservedInstances?: ReservedInstances[]; } -export namespace DescribeSnapshotAttributeRequest { +export namespace DescribeReservedInstancesResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSnapshotAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeReservedInstancesResult): any => ({ ...obj, }); } /** - *Describes the user or group to be added or removed from the list of create volume - * permissions for a volume.
+ *Contains the parameters for DescribeReservedInstancesListings.
*/ -export interface CreateVolumePermission { +export interface DescribeReservedInstancesListingsRequest { /** - *The group to be added or removed. The possible value is all.
One or more filters.
+ *
+ * reserved-instances-id - The ID of the Reserved Instances.
+ * reserved-instances-listing-id - The ID of the Reserved Instances listing.
+ * status - The status of the Reserved Instance listing (pending | active |
+ * cancelled | closed).
+ * status-message - The reason for the status.
The ID of the Amazon Web Services account to be added or removed.
+ *One or more Reserved Instance IDs.
*/ - UserId?: string; + ReservedInstancesId?: string; + + /** + *One or more Reserved Instance listing IDs.
+ */ + ReservedInstancesListingId?: string; } -export namespace CreateVolumePermission { +export namespace DescribeReservedInstancesListingsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: CreateVolumePermission): any => ({ + export const filterSensitiveLog = (obj: DescribeReservedInstancesListingsRequest): any => ({ ...obj, }); } -export interface DescribeSnapshotAttributeResult { - /** - *The users and groups that have the permissions for creating volumes from the - * snapshot.
- */ - CreateVolumePermissions?: CreateVolumePermission[]; - - /** - *The product codes.
- */ - ProductCodes?: ProductCode[]; - +/** + *Contains the output of DescribeReservedInstancesListings.
+ */ +export interface DescribeReservedInstancesListingsResult { /** - *The ID of the EBS snapshot.
+ *Information about the Reserved Instance listing.
*/ - SnapshotId?: string; + ReservedInstancesListings?: ReservedInstancesListing[]; } -export namespace DescribeSnapshotAttributeResult { +export namespace DescribeReservedInstancesListingsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSnapshotAttributeResult): any => ({ + export const filterSensitiveLog = (obj: DescribeReservedInstancesListingsResult): any => ({ ...obj, }); } -export interface DescribeSnapshotsRequest { +/** + *Contains the parameters for DescribeReservedInstancesModifications.
+ */ +export interface DescribeReservedInstancesModificationsRequest { /** - *The filters.
+ *One or more filters.
*
- * description - A description of the snapshot.
client-token - The idempotency token for the modification request.
*
- * encrypted - Indicates whether the snapshot is encrypted
- * (true | false)
create-date - The time when the modification request was created.
*
- * owner-alias - The owner alias, from an Amazon-maintained list
- * (amazon).
- * This is not the user-configured Amazon Web Services account alias set using the IAM console.
- * We recommend that you use the related parameter instead of this filter.
effective-date - The time when the modification becomes effective.
*
- * owner-id - The Amazon Web Services account ID of the owner. We recommend that
- * you use the related parameter instead of this filter.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
*
- * progress - The progress of the snapshot, as a percentage (for example,
- * 80%).
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
*
- * snapshot-id - The snapshot ID.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
*
- * start-time - The time stamp when the snapshot was initiated.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
*
- * status - The status of the snapshot (pending |
- * completed | error).
modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
*
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
reserved-instances-id - The ID of the Reserved Instances modified.
*
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
reserved-instances-modification-id - The ID of the modification request.
*
- * volume-id - The ID of the volume the snapshot is for.
status - The status of the Reserved Instances modification request
+ * (processing | fulfilled | failed).
*
- * volume-size - The size of the volume, in GiB.
status-message - The reason for the status.
+ *
+ * update-date - The time when the modification request was last updated.
The maximum number of snapshot results returned by DescribeSnapshots in
- * paginated output. When this parameter is used, DescribeSnapshots only returns
- * MaxResults results in a single page along with a NextToken
- * response element. The remaining results of the initial request can be seen by sending another
- * DescribeSnapshots request with the returned NextToken value. This
- * value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000,
- * only 1,000 results are returned. If this parameter is not used, then
- * DescribeSnapshots returns all results. You cannot specify this parameter and
- * the snapshot IDs parameter in the same request.
IDs for the submitted modification request.
*/ - MaxResults?: number; + ReservedInstancesModificationIds?: string[]; /** - *The NextToken value returned from a previous paginated
- * DescribeSnapshots request where MaxResults was used and the
- * results exceeded the value of that parameter. Pagination continues from the end of the
- * previous results that returned the NextToken value. This value is
- * null when there are no more results to return.
The token to retrieve the next page of results.
*/ NextToken?: string; +} +export namespace DescribeReservedInstancesModificationsRequest { /** - *Scopes the results to snapshots with the specified owners. You can specify a combination of
- * Amazon Web Services account IDs, self, and amazon.
The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
+ * @internal */ - RestorableByUserIds?: string[]; + export const filterSensitiveLog = (obj: DescribeReservedInstancesModificationsRequest): any => ({ + ...obj, + }); +} +/** + *Describes the configuration settings for the modified Reserved Instances.
+ */ +export interface ReservedInstancesConfiguration { /** - *The snapshot IDs.
- *Default: Describes the snapshots for which you have create volume permissions.
+ *The Availability Zone for the modified Reserved Instances.
*/ - SnapshotIds?: string[]; + AvailabilityZone?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The number of modified Reserved Instances.
+ *This is a required field for a request.
+ *The instance type for the modified Reserved Instances.
*/ - export const filterSensitiveLog = (obj: DescribeSnapshotsRequest): any => ({ - ...obj, - }); -} + InstanceType?: _InstanceType | string; -export interface DescribeSnapshotsResult { /** - *Information about the snapshots.
+ *The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
*/ - Snapshots?: Snapshot[]; + Platform?: string; /** - *The NextToken value to include in a future DescribeSnapshots
- * request. When the results of a DescribeSnapshots request exceed
- * MaxResults, this value can be used to retrieve the next page of results. This
- * value is null when there are no more results to return.
Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.
*/ - NextToken?: string; + Scope?: Scope | string; } -export namespace DescribeSnapshotsResult { +export namespace ReservedInstancesConfiguration { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSnapshotsResult): any => ({ + export const filterSensitiveLog = (obj: ReservedInstancesConfiguration): any => ({ ...obj, }); } /** - *Contains the parameters for DescribeSpotDatafeedSubscription.
+ *Describes the modification request/s.
*/ -export interface DescribeSpotDatafeedSubscriptionRequest { +export interface ReservedInstancesModificationResult { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
*/ - DryRun?: boolean; + ReservedInstancesId?: string; + + /** + *The target Reserved Instances configurations supplied as part of the modification request.
+ */ + TargetConfiguration?: ReservedInstancesConfiguration; } -export namespace DescribeSpotDatafeedSubscriptionRequest { +export namespace ReservedInstancesModificationResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSpotDatafeedSubscriptionRequest): any => ({ + export const filterSensitiveLog = (obj: ReservedInstancesModificationResult): any => ({ ...obj, }); } /** - *Contains the output of DescribeSpotDatafeedSubscription.
+ *Describes the ID of a Reserved Instance.
*/ -export interface DescribeSpotDatafeedSubscriptionResult { +export interface ReservedInstancesId { /** - *The Spot Instance data feed subscription.
+ *The ID of the Reserved Instance.
*/ - SpotDatafeedSubscription?: SpotDatafeedSubscription; + ReservedInstancesId?: string; } -export namespace DescribeSpotDatafeedSubscriptionResult { +export namespace ReservedInstancesId { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSpotDatafeedSubscriptionResult): any => ({ + export const filterSensitiveLog = (obj: ReservedInstancesId): any => ({ ...obj, }); } /** - *Contains the parameters for DescribeSpotFleetInstances.
+ *Describes a Reserved Instance modification.
*/ -export interface DescribeSpotFleetInstancesRequest { +export interface ReservedInstancesModification { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. + * For more information, see Ensuring + * Idempotency.
*/ - DryRun?: boolean; + ClientToken?: string; + + /** + *The time when the modification request was created.
+ */ + CreateDate?: Date; /** - *The maximum number of results to return in a single call. Specify a value between 1
- * and 1000. The default value is 1000. To retrieve the remaining results, make another
- * call with the returned NextToken value.
The time for the modification to become effective.
*/ - MaxResults?: number; + EffectiveDate?: Date; /** - *The token for the next set of results.
+ *Contains target configurations along with their corresponding new Reserved Instance IDs.
*/ - NextToken?: string; + ModificationResults?: ReservedInstancesModificationResult[]; /** - *The ID of the Spot Fleet request.
+ *The IDs of one or more Reserved Instances.
*/ - SpotFleetRequestId: string | undefined; -} + ReservedInstancesIds?: ReservedInstancesId[]; -export namespace DescribeSpotFleetInstancesRequest { /** - * @internal + *A unique ID for the Reserved Instance modification.
*/ - export const filterSensitiveLog = (obj: DescribeSpotFleetInstancesRequest): any => ({ - ...obj, - }); -} + ReservedInstancesModificationId?: string; -/** - *Contains the output of DescribeSpotFleetInstances.
- */ -export interface DescribeSpotFleetInstancesResponse { /** - *The running instances. This list is refreshed periodically and might be out of - * date.
+ *The status of the Reserved Instances modification request.
*/ - ActiveInstances?: ActiveInstance[]; + Status?: string; /** - *The token required to retrieve the next set of results. This value is
- * null when there are no more results to return.
The reason for the status.
*/ - NextToken?: string; + StatusMessage?: string; /** - *The ID of the Spot Fleet request.
+ *The time when the modification request was last updated.
*/ - SpotFleetRequestId?: string; + UpdateDate?: Date; } -export namespace DescribeSpotFleetInstancesResponse { +export namespace ReservedInstancesModification { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSpotFleetInstancesResponse): any => ({ + export const filterSensitiveLog = (obj: ReservedInstancesModification): any => ({ ...obj, }); } -export enum EventType { - BATCH_CHANGE = "fleetRequestChange", - ERROR = "error", - INFORMATION = "information", - INSTANCE_CHANGE = "instanceChange", -} - /** - *Contains the parameters for DescribeSpotFleetRequestHistory.
+ *Contains the output of DescribeReservedInstancesModifications.
*/ -export interface DescribeSpotFleetRequestHistoryRequest { - /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The type of events to describe. By default, all events are described.
- */ - EventType?: EventType | string; - - /** - *The maximum number of results to return in a single call. Specify a value between 1
- * and 1000. The default value is 1000. To retrieve the remaining results, make another
- * call with the returned NextToken value.
The token for the next set of results.
+ *The token to use to retrieve the next page of results. This value is null when
+ * there are no more results to return.
The ID of the Spot Fleet request.
- */ - SpotFleetRequestId: string | undefined; - - /** - *The starting date and time for the events, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *The Reserved Instance modification information.
*/ - StartTime: Date | undefined; + ReservedInstancesModifications?: ReservedInstancesModification[]; } -export namespace DescribeSpotFleetRequestHistoryRequest { +export namespace DescribeReservedInstancesModificationsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSpotFleetRequestHistoryRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeReservedInstancesModificationsResult): any => ({ ...obj, }); } /** - *Describes an event in the history of the Spot Fleet request.
+ *Contains the parameters for DescribeReservedInstancesOfferings.
*/ -export interface HistoryRecord { +export interface DescribeReservedInstancesOfferingsRequest { /** - *Information about the event.
+ *The Availability Zone in which the Reserved Instance can be used.
*/ - EventInformation?: EventInformation; + AvailabilityZone?: string; /** - *The event type.
- *One or more filters.
+ *
- * error - An error with the Spot Fleet request.
+ * availability-zone - The Availability Zone where the Reserved Instance can be
+ * used.
- * fleetRequestChange - A change in the status or configuration of
- * the Spot Fleet request.
+ * duration - The duration of the Reserved Instance (for example, one year or
+ * three years), in seconds (31536000 | 94608000).
- * instanceChange - An instance was launched or terminated.
+ * fixed-price - The purchase price of the Reserved Instance (for example,
+ * 9800.0).
- * Information - An informational event.
+ * instance-type - The instance type that is covered by the
+ * reservation.
+ * marketplace - Set to true to show only Reserved Instance
+ * Marketplace offerings. When this filter is not used, which is the default behavior, all
+ * offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
+ * product-description - The Reserved Instance product platform description.
+ * Instances that include (Amazon VPC) in the product platform description will
+ * only be displayed to EC2-Classic account holders and are for use with Amazon VPC.
+ * (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE
+ * Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise
+ * Linux | Red Hat Enterprise Linux (Amazon VPC) | Red Hat
+ * Enterprise Linux with HA (Amazon VPC) | Windows | Windows
+ * (Amazon VPC) | Windows with SQL Server Standard | Windows with
+ * SQL Server Standard (Amazon VPC) | Windows with SQL Server Web |
+ * Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server
+ * Enterprise | Windows with SQL Server Enterprise (Amazon VPC))
+ * reserved-instances-offering-id - The Reserved Instances offering
+ * ID.
+ * scope - The scope of the Reserved Instance (Availability Zone or
+ * Region).
+ * usage-price - The usage price of the Reserved Instance, per hour (for
+ * example, 0.84).
The date and time of the event, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *Include Reserved Instance Marketplace offerings in the response.
*/ - Timestamp?: Date; -} + IncludeMarketplace?: boolean; -export namespace HistoryRecord { /** - * @internal + *The instance type that the reservation will cover (for example, m1.small). For more information, see
+ * Instance types in the
+ * Amazon EC2 User Guide.
Contains the output of DescribeSpotFleetRequestHistory.
- */ -export interface DescribeSpotFleetRequestHistoryResponse { /** - *Information about the events in the history of the Spot Fleet request.
+ *The maximum duration (in seconds) to filter when searching for offerings.
+ *Default: 94608000 (3 years)
*/ - HistoryRecords?: HistoryRecord[]; + MaxDuration?: number; /** - *The last date and time for the events, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ). - * All records up to this time were retrieved.
- *If nextToken indicates that there are more results, this value is not
- * present.
The maximum number of instances to filter when searching for offerings.
+ *Default: 20
*/ - LastEvaluatedTime?: Date; + MaxInstanceCount?: number; /** - *The token required to retrieve the next set of results. This value is
- * null when there are no more results to return.
The minimum duration (in seconds) to filter when searching for offerings.
+ *Default: 2592000 (1 month)
*/ - NextToken?: string; + MinDuration?: number; /** - *The ID of the Spot Fleet request.
+ *The offering class of the Reserved Instance. Can be standard or convertible.
The starting date and time for the events, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *The Reserved Instance product platform description. Instances that include (Amazon
+ * VPC) in the description are for use with Amazon VPC.
One or more Reserved Instances offering IDs.
*/ - export const filterSensitiveLog = (obj: DescribeSpotFleetRequestHistoryResponse): any => ({ - ...obj, - }); -} + ReservedInstancesOfferingIds?: string[]; -/** - *Contains the parameters for DescribeSpotFleetRequests.
- */ -export interface DescribeSpotFleetRequestsRequest { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return in a single call. Specify a value between 1
- * and 1000. The default value is 1000. To retrieve the remaining results, make another
- * call with the returned NextToken value.
The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy
+ * of dedicated is applied to instances that run in a VPC on single-tenant hardware
+ * (i.e., Dedicated Instances).
+ * Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
+ *
The maximum number of results to return for the request in a single page. The remaining
+ * results of the initial request can be seen by sending another request with the returned
+ * NextToken value. The maximum is 100.
Default: 100
*/ MaxResults?: number; /** - *The token for the next set of results.
+ *The token to retrieve the next page of results.
*/ NextToken?: string; /** - *The IDs of the Spot Fleet requests.
+ *The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API
+ * version, you only have access to the Medium Utilization Reserved Instance
+ * offering type.
Describes whether monitoring is enabled.
+ *Describes a Reserved Instance offering.
*/ -export interface SpotFleetMonitoring { +export interface PricingDetail { /** - *Enables monitoring for the instance.
- *Default: false
- *
The number of reservations available for the price.
*/ - Enabled?: boolean; + Count?: number; + + /** + *The price per instance.
+ */ + Price?: number; } -export namespace SpotFleetMonitoring { +export namespace PricingDetail { /** * @internal */ - export const filterSensitiveLog = (obj: SpotFleetMonitoring): any => ({ + export const filterSensitiveLog = (obj: PricingDetail): any => ({ ...obj, }); } /** - *Describes a network interface.
+ *Describes a Reserved Instance offering.
*/ -export interface InstanceNetworkInterfaceSpecification { +export interface ReservedInstancesOffering { /** - *Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The
- * public IP address can only be assigned to a network interface for eth0, and can only be
- * assigned to a new network interface, not an existing one. You cannot specify more than one
- * network interface in the request. If launching into a default subnet, the default value is
- * true.
The Availability Zone in which the Reserved Instance can be used.
*/ - AssociatePublicIpAddress?: boolean; + AvailabilityZone?: string; /** - *If set to true, the interface is deleted when the instance is terminated. You can
- * specify true only if creating a new network interface when launching an
- * instance.
The duration of the Reserved Instance, in seconds.
*/ - DeleteOnTermination?: boolean; + Duration?: number; /** - *The description of the network interface. Applies only if creating a network interface when launching an instance.
+ *The purchase price of the Reserved Instance.
*/ - Description?: string; + FixedPrice?: number; /** - *The position of the network interface in the attachment order. - * A primary network interface has a device index of 0.
- *If you specify a network interface when launching an instance, - * you must specify the device index.
+ *The instance type on which the Reserved Instance can be used.
*/ - DeviceIndex?: number; + InstanceType?: _InstanceType | string; /** - *The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
+ *The Reserved Instance product platform description.
*/ - Groups?: string[]; + ProductDescription?: RIProductDescription | string; /** - *A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses - * the IPv6 addresses from the range of the subnet. You cannot specify this option and the - * option to assign specific IPv6 addresses in the same request. You can specify this - * option if you've specified a minimum number of instances to launch.
+ *The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote + * to confirm that an exchange can be made.
*/ - Ipv6AddressCount?: number; + ReservedInstancesOfferingId?: string; /** - *One or more IPv6 addresses to assign to the network interface. You cannot specify - * this option and the option to assign a number of IPv6 addresses in the same request. You - * cannot specify this option if you've specified a minimum number of instances to - * launch.
+ *The usage price of the Reserved Instance, per hour.
*/ - Ipv6Addresses?: InstanceIpv6Address[]; + UsagePrice?: number; /** - *The ID of the network interface.
- *If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
+ *The currency of the Reserved Instance offering you are purchasing. It's
+ * specified using ISO 4217 standard currency codes. At this time,
+ * the only supported currency is USD.
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching - * more than one instance in a RunInstances request.
+ *The tenancy of the instance.
*/ - PrivateIpAddress?: string; + InstanceTenancy?: Tenancy | string; /** - *One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're - * launching more than one instance in a RunInstances request.
+ *Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services.
+ * If it's a Reserved Instance Marketplace offering, this is true.
The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're - * launching more than one instance in a RunInstances request.
+ *If convertible it can be exchanged for Reserved Instances of
+ * the same or higher monetary value, with different configurations. If standard, it is not
+ * possible to perform an exchange.
The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
+ *The Reserved Instance offering type.
*/ - SubnetId?: string; + OfferingType?: OfferingTypeValues | string; /** - *Indicates whether to assign a carrier IP address to the network interface.
- *You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. - * For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.
+ *The pricing details of the Reserved Instance offering.
*/ - AssociateCarrierIpAddress?: boolean; + PricingDetails?: PricingDetail[]; /** - *The type of network interface.
- *To create an Elastic Fabric Adapter (EFA), specify
- * efa. For more information, see Elastic Fabric Adapter in the
- * Amazon Elastic Compute Cloud User Guide.
Valid values: interface | efa
- *
The recurring charge tag assigned to the resource.
*/ - InterfaceType?: string; + RecurringCharges?: RecurringCharge[]; /** - *The index of the network card. Some instance types support multiple network cards. - * The primary network interface must be assigned to network card index 0. - * The default is network card index 0.
- *If you are using RequestSpotInstances to create Spot Instances, omit this parameter because - * you can’t specify the network card index when using this API. To specify the network - * card index, use RunInstances.
+ *Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
+ */ + Scope?: Scope | string; +} + +export namespace ReservedInstancesOffering { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ReservedInstancesOffering): any => ({ + ...obj, + }); +} + +/** + *Contains the output of DescribeReservedInstancesOfferings.
+ */ +export interface DescribeReservedInstancesOfferingsResult { + /** + *A list of Reserved Instances offerings.
+ */ + ReservedInstancesOfferings?: ReservedInstancesOffering[]; + + /** + *The token to use to retrieve the next page of results. This value is null when
+ * there are no more results to return.
One or more filters.
+ *
+ * association.route-table-association-id - The ID of an association
+ * ID for the route table.
+ * association.route-table-id - The ID of the route table involved in
+ * the association.
+ * association.subnet-id - The ID of the subnet involved in the
+ * association.
+ * association.main - Indicates whether the route table is the main
+ * route table for the VPC (true | false). Route tables
+ * that do not have an association ID are not returned in the response.
+ * owner-id - The ID of the Amazon Web Services account that owns the route table.
+ * route-table-id - The ID of the route table.
+ * route.destination-cidr-block - The IPv4 CIDR range specified in a
+ * route in the table.
+ * route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
+ * route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Service
+ * specified in a route in the table.
+ * route.egress-only-internet-gateway-id - The ID of an
+ * egress-only Internet gateway specified in a route in the route table.
+ * route.gateway-id - The ID of a gateway specified in a route in the table.
+ * route.instance-id - The ID of an instance specified in a route in the table.
+ * route.nat-gateway-id - The ID of a NAT gateway.
+ * route.transit-gateway-id - The ID of a transit gateway.
+ * route.origin - Describes how the route was created.
+ * CreateRouteTable indicates that the route was automatically
+ * created when the route table was created; CreateRoute indicates
+ * that the route was manually added to the route table;
+ * EnableVgwRoutePropagation indicates that the route was
+ * propagated by route propagation.
+ * route.state - The state of a route in the route table
+ * (active | blackhole). The blackhole state
+ * indicates that the route's target isn't available (for example, the specified
+ * gateway isn't attached to the VPC, the specified NAT instance has been
+ * terminated, and so on).
+ * route.vpc-peering-connection-id - The ID of a VPC peering
+ * connection specified in a route in the table.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * vpc-id - The ID of the VPC for the route table.
One or more IPv4 delegated prefixes to be assigned to the network interface. You cannot
- * use this option if you use the Ipv4PrefixCount option.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The number of IPv4 delegated prefixes to be automatically assigned to the network interface.
- * You cannot use this option if you use the Ipv4Prefix option.
One or more route table IDs.
+ *Default: Describes all your route tables.
*/ - Ipv4PrefixCount?: number; + RouteTableIds?: string[]; /** - *One or more IPv6 delegated prefixes to be assigned to the network interface. You cannot
- * use this option if you use the Ipv6PrefixCount option.
The token for the next page of results.
*/ - Ipv6Prefixes?: Ipv6PrefixSpecificationRequest[]; + NextToken?: string; /** - *The number of IPv6 delegated prefixes to be automatically assigned to the network interface.
- * You cannot use this option if you use the Ipv6Prefix option.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Describes Spot Instance placement.
+ *Contains the output of DescribeRouteTables.
*/ -export interface SpotPlacement { - /** - *The Availability Zone.
- *[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; - * for example, "us-west-2a, us-west-2b".
- */ - AvailabilityZone?: string; - +export interface DescribeRouteTablesResult { /** - *The name of the placement group.
+ *Information about one or more route tables.
*/ - GroupName?: string; + RouteTables?: RouteTable[]; /** - *The tenancy of the instance (if the instance is running in a VPC). An instance with a
- * tenancy of dedicated runs on single-tenant hardware. The host
- * tenancy is not supported for Spot Instances.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The tags for a Spot Fleet resource.
+ *Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.
*/ -export interface SpotFleetTagSpecification { +export interface SlotDateTimeRangeRequest { /** - *The type of resource. Currently, the only resource type that is supported is
- * instance. To tag the Spot Fleet request on creation, use the
- * TagSpecifications parameter in
- * SpotFleetRequestConfigData
- * .
The earliest date and time, in UTC, for the Scheduled Instance to start.
*/ - ResourceType?: ResourceType | string; + EarliestTime: Date | undefined; /** - *The tags.
+ *The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.
*/ - Tags?: Tag[]; + LatestTime: Date | undefined; } -export namespace SpotFleetTagSpecification { +export namespace SlotDateTimeRangeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: SpotFleetTagSpecification): any => ({ + export const filterSensitiveLog = (obj: SlotDateTimeRangeRequest): any => ({ ...obj, }); } /** - *Describes the launch specification for one or more Spot Instances. If you include
- * On-Demand capacity in your fleet request or want to specify an EFA network device, you
- * can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.
Describes the recurring schedule for a Scheduled Instance.
*/ -export interface SpotFleetLaunchSpecification { +export interface ScheduledInstanceRecurrenceRequest { /** - *One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
+ *The frequency (Daily, Weekly, or Monthly).
Deprecated.
+ *The interval quantity. The interval unit depends on the value of Frequency. For example, every 2
+ * weeks or every 2 months.
One or more block devices that are mapped to the Spot Instances. You can't specify both - * a snapshot ID and an encryption value. This is because only blank volumes can be - * encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its - * encryption status is used for the volume encryption status.
+ *The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
*/ - BlockDeviceMappings?: BlockDeviceMapping[]; + OccurrenceDays?: number[]; /** - *Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
- *Default: false
- *
Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
*/ - EbsOptimized?: boolean; + OccurrenceRelativeToEnd?: boolean; /** - *The IAM instance profile.
+ *The unit for OccurrenceDays (DayOfWeek or DayOfMonth).
+ * This value is required for a monthly schedule.
+ * You can't specify DayOfWeek with a weekly schedule.
+ * You can't specify this value with a daily schedule.
The ID of the AMI.
+ * @internal */ - ImageId?: string; + export const filterSensitiveLog = (obj: ScheduledInstanceRecurrenceRequest): any => ({ + ...obj, + }); +} +/** + *Contains the parameters for DescribeScheduledInstanceAvailability.
+ */ +export interface DescribeScheduledInstanceAvailabilityRequest { /** - *The instance type.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the kernel.
+ *The filters.
+ *
+ * availability-zone - The Availability Zone (for example, us-west-2a).
+ * instance-type - The instance type (for example, c4.large).
+ * network-platform - The network platform (EC2-Classic or EC2-VPC).
+ * platform - The platform (Linux/UNIX or Windows).
The name of the key pair.
+ *The time period for the first schedule to start.
*/ - KeyName?: string; + FirstSlotStartTimeRange: SlotDateTimeRangeRequest | undefined; /** - *Enable or disable monitoring for the instances.
+ *The maximum number of results to return in a single call.
+ * This value can be between 5 and 300. The default value is 300.
+ * To retrieve the remaining results, make another call with the returned
+ * NextToken value.
One or more network interfaces. If you specify a network interface, you must specify - * subnet IDs and security group IDs using the network interface.
- *
- * SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.
The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours
+ * and less than 1,720.
The placement information.
+ *The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
*/ - Placement?: SpotPlacement; + MinSlotDurationInHours?: number; /** - *The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel - * requirements for information about whether you need to specify a RAM disk. To find kernel - * requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.
+ *The token for the next set of results.
*/ - RamdiskId?: string; + NextToken?: string; /** - *The maximum price per unit hour that you are willing to pay for a Spot Instance.
- * If this value is not specified, the default is the Spot price specified for the fleet.
- * To determine the Spot price per unit hour, divide the Spot price by the
- * value of WeightedCapacity.
The schedule recurrence.
*/ - SpotPrice?: string; + Recurrence: ScheduledInstanceRecurrenceRequest | undefined; +} +export namespace DescribeScheduledInstanceAvailabilityRequest { /** - *The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate - * them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".
+ * @internal */ - SubnetId?: string; + export const filterSensitiveLog = (obj: DescribeScheduledInstanceAvailabilityRequest): any => ({ + ...obj, + }); +} +/** + *Describes the recurring schedule for a Scheduled Instance.
+ */ +export interface ScheduledInstanceRecurrence { /** - *The Base64-encoded user data that instances use when starting up.
+ *The frequency (Daily, Weekly, or Monthly).
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
- *If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
+ *The interval quantity. The interval unit depends on the value of frequency. For example, every 2
+ * weeks or every 2 months.
The tags to apply during creation.
+ *The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
*/ - TagSpecifications?: SpotFleetTagSpecification[]; + OccurrenceDaySet?: number[]; + + /** + *Indicates whether the occurrence is relative to the end of the specified week or month.
+ */ + OccurrenceRelativeToEnd?: boolean; + + /** + *The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).
Describes overrides for a launch template.
+ *Describes a schedule that is available for your Scheduled Instances.
*/ -export interface LaunchTemplateOverrides { +export interface ScheduledInstanceAvailability { /** - *The instance type.
+ *The Availability Zone.
*/ - InstanceType?: _InstanceType | string; + AvailabilityZone?: string; /** - *The maximum price per unit hour that you are willing to pay for a Spot - * Instance.
+ *The number of available instances.
*/ - SpotPrice?: string; + AvailableInstanceCount?: number; /** - *The ID of the subnet in which to launch the instances.
+ *The time period for the first schedule to start.
*/ - SubnetId?: string; + FirstSlotStartTime?: Date; /** - *The Availability Zone in which to launch the instances.
+ *The hourly price for a single instance.
*/ - AvailabilityZone?: string; + HourlyPrice?: string; /** - *The number of units provided by the specified instance type.
+ *The instance type. You can specify one of the C3, C4, M4, or R3 instance types.
*/ - WeightedCapacity?: number; + InstanceType?: string; /** - *The priority for the launch template override. The highest priority is launched - * first.
- *If OnDemandAllocationStrategy is set to prioritized, Spot Fleet
- * uses priority to determine which launch template override to use first in fulfilling
- * On-Demand capacity.
If the Spot AllocationStrategy is set to
- * capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis
- * to determine which launch template override to use in fulfilling Spot capacity, but
- * optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the
- * higher the priority. If no number is set, the launch template override has the lowest
- * priority. You can set the same priority for different launch template overrides.
The maximum term. The only possible value is 365 days.
*/ - Priority?: number; -} + MaxTermDurationInDays?: number; -export namespace LaunchTemplateOverrides { /** - * @internal + *The minimum term. The only possible value is 365 days.
*/ - export const filterSensitiveLog = (obj: LaunchTemplateOverrides): any => ({ - ...obj, - }); -} + MinTermDurationInDays?: number; -/** - *Describes a launch template and overrides.
- */ -export interface LaunchTemplateConfig { /** - *The launch template.
+ *The network platform (EC2-Classic or EC2-VPC).
Any parameters that you specify override the same parameters in the launch - * template.
+ *The platform (Linux/UNIX or Windows).
The purchase token. This token expires in two hours.
*/ - export const filterSensitiveLog = (obj: LaunchTemplateConfig): any => ({ - ...obj, - }); -} + PurchaseToken?: string; -/** - *Describes a Classic Load Balancer.
- */ -export interface ClassicLoadBalancer { /** - *The name of the load balancer.
+ *The schedule recurrence.
*/ - Name?: string; -} + Recurrence?: ScheduledInstanceRecurrence; -export namespace ClassicLoadBalancer { /** - * @internal + *The number of hours in the schedule.
*/ - export const filterSensitiveLog = (obj: ClassicLoadBalancer): any => ({ - ...obj, - }); -} + SlotDurationInHours?: number; -/** - *Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers - * the running Spot Instances with these Classic Load Balancers.
- */ -export interface ClassicLoadBalancersConfig { /** - *One or more Classic Load Balancers.
+ *The total number of hours for a single instance for the entire term.
*/ - ClassicLoadBalancers?: ClassicLoadBalancer[]; + TotalScheduledInstanceHours?: number; } -export namespace ClassicLoadBalancersConfig { +export namespace ScheduledInstanceAvailability { /** * @internal */ - export const filterSensitiveLog = (obj: ClassicLoadBalancersConfig): any => ({ + export const filterSensitiveLog = (obj: ScheduledInstanceAvailability): any => ({ ...obj, }); } /** - *Describes a load balancer target group.
+ *Contains the output of DescribeScheduledInstanceAvailability.
*/ -export interface TargetGroup { +export interface DescribeScheduledInstanceAvailabilityResult { /** - *The Amazon Resource Name (ARN) of the target group.
+ *The token required to retrieve the next set of results. This value is null when there are no more results to return.
Information about the available Scheduled Instances.
+ */ + ScheduledInstanceAvailabilitySet?: ScheduledInstanceAvailability[]; } -export namespace TargetGroup { +export namespace DescribeScheduledInstanceAvailabilityResult { /** * @internal */ - export const filterSensitiveLog = (obj: TargetGroup): any => ({ + export const filterSensitiveLog = (obj: DescribeScheduledInstanceAvailabilityResult): any => ({ ...obj, }); } /** - *Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the - * running Spot Instances with these target groups.
+ *Describes the time period for a Scheduled Instance to start its first schedule.
*/ -export interface TargetGroupsConfig { +export interface SlotStartTimeRangeRequest { /** - *One or more target groups.
+ *The earliest date and time, in UTC, for the Scheduled Instance to start.
*/ - TargetGroups?: TargetGroup[]; + EarliestTime?: Date; + + /** + *The latest date and time, in UTC, for the Scheduled Instance to start.
+ */ + LatestTime?: Date; } -export namespace TargetGroupsConfig { +export namespace SlotStartTimeRangeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: TargetGroupsConfig): any => ({ + export const filterSensitiveLog = (obj: SlotStartTimeRangeRequest): any => ({ ...obj, }); } /** - *Describes the Classic Load Balancers and target groups to attach to a Spot Fleet - * request.
+ *Contains the parameters for DescribeScheduledInstances.
*/ -export interface LoadBalancersConfig { +export interface DescribeScheduledInstancesRequest { /** - *The Classic Load Balancers.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The target groups.
+ *The filters.
+ *
+ * availability-zone - The Availability Zone (for example, us-west-2a).
+ * instance-type - The instance type (for example, c4.large).
+ * network-platform - The network platform (EC2-Classic or EC2-VPC).
+ * platform - The platform (Linux/UNIX or Windows).
The maximum number of results to return in a single call.
+ * This value can be between 5 and 300. The default value is 100.
+ * To retrieve the remaining results, make another call with the returned
+ * NextToken value.
The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your - * Spot Instance is at an elevated risk of being interrupted. For more information, see - * Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.
- */ -export interface SpotCapacityRebalance { /** - *The replacement strategy to use. Only available for fleets of type
- * maintain. You must specify a value, otherwise you get an error.
To allow Spot Fleet to launch a replacement Spot Instance when an instance rebalance
- * notification is emitted for a Spot Instance in the fleet, specify
- * launch.
When a replacement instance is launched, the instance marked for rebalance is not - * automatically terminated. You can terminate it, or you can leave it running. You are - * charged for all instances while they are running.
- *The token for the next set of results.
*/ - ReplacementStrategy?: ReplacementStrategy | string; -} + NextToken?: string; -export namespace SpotCapacityRebalance { /** - * @internal + *The Scheduled Instance IDs.
*/ - export const filterSensitiveLog = (obj: SpotCapacityRebalance): any => ({ - ...obj, - }); -} + ScheduledInstanceIds?: string[]; -/** - *The strategies for managing your Spot Instances that are at an elevated risk of being - * interrupted.
- */ -export interface SpotMaintenanceStrategies { /** - *The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an - * elevated risk of being interrupted.
+ *The time period for the first schedule to start.
*/ - CapacityRebalance?: SpotCapacityRebalance; + SlotStartTimeRange?: SlotStartTimeRangeRequest; } -export namespace SpotMaintenanceStrategies { +export namespace DescribeScheduledInstancesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: SpotMaintenanceStrategies): any => ({ + export const filterSensitiveLog = (obj: DescribeScheduledInstancesRequest): any => ({ ...obj, }); } /** - *Describes the configuration of a Spot Fleet request.
+ *Describes a Scheduled Instance.
*/ -export interface SpotFleetRequestConfigData { +export interface ScheduledInstance { /** - *Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by - * the Spot Fleet request.
- *If the allocation strategy is lowestPrice, Spot Fleet launches instances from
- * the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified, Spot Fleet launches instances from
- * all the Spot Instance pools that you specify.
If the allocation strategy is capacityOptimized (recommended), Spot Fleet
- * launches instances from Spot Instance pools with optimal capacity for the number of instances
- * that are launching. To give certain instance types a higher chance of launching first,
- * use capacityOptimizedPrioritized. Set a priority for each instance type by
- * using the Priority parameter for LaunchTemplateOverrides. You
- * can assign the same priority to different LaunchTemplateOverrides. EC2
- * implements the priorities on a best-effort basis, but optimizes for capacity first.
- * capacityOptimizedPrioritized is supported only if your Spot Fleet uses a
- * launch template. Note that if the OnDemandAllocationStrategy is set to
- * prioritized, the same priority is applied when fulfilling On-Demand
- * capacity.
The Availability Zone.
*/ - AllocationStrategy?: AllocationStrategy | string; + AvailabilityZone?: string; /** - *The order of the launch template overrides to use in fulfilling On-Demand capacity. If
- * you specify lowestPrice, Spot Fleet uses price to determine the order, launching
- * the lowest price first. If you specify prioritized, Spot Fleet uses the priority
- * that you assign to each Spot Fleet launch template override, launching the highest priority
- * first. If you do not specify a value, Spot Fleet defaults to lowestPrice.
The date when the Scheduled Instance was purchased.
*/ - OnDemandAllocationStrategy?: OnDemandAllocationStrategy | string; + CreateDate?: Date; /** - *The strategies for managing your Spot Instances that are at an elevated risk of being - * interrupted.
+ *The hourly price for a single instance.
*/ - SpotMaintenanceStrategies?: SpotMaintenanceStrategies; + HourlyPrice?: string; /** - *A unique, case-sensitive identifier that you provide to ensure the idempotency of your - * listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.
+ *The number of instances.
*/ - ClientToken?: string; + InstanceCount?: number; /** - *Indicates whether running Spot Instances should be terminated if you decrease the - * target capacity of the Spot Fleet request below the current size of the Spot - * Fleet.
+ *The instance type.
*/ - ExcessCapacityTerminationPolicy?: ExcessCapacityTerminationPolicy | string; + InstanceType?: string; /** - *The number of units fulfilled by this request compared to the set target capacity. You - * cannot set this value.
+ *The network platform (EC2-Classic or EC2-VPC).
The number of On-Demand units fulfilled by this request compared to the set target - * On-Demand capacity.
+ *The time for the next schedule to start.
*/ - OnDemandFulfilledCapacity?: number; + NextSlotStartTime?: Date; /** - *The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that
- * grants the Spot Fleet the permission to request, launch, terminate, and tag instances on
- * your behalf. For more information, see Spot
- * Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet
- * can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using
- * CancelSpotFleetRequests or when the Spot Fleet request expires, if you set
- * TerminateInstancesWithExpiration.
The platform (Linux/UNIX or Windows).
The launch specifications for the Spot Fleet request. If you specify
- * LaunchSpecifications, you can't specify
- * LaunchTemplateConfigs. If you include On-Demand capacity in your
- * request, you must use LaunchTemplateConfigs.
The time that the previous schedule ended or will end.
*/ - LaunchSpecifications?: SpotFleetLaunchSpecification[]; + PreviousSlotEndTime?: Date; /** - *The launch template and overrides. If you specify LaunchTemplateConfigs,
- * you can't specify LaunchSpecifications. If you include On-Demand capacity
- * in your request, you must use LaunchTemplateConfigs.
The schedule recurrence.
*/ - LaunchTemplateConfigs?: LaunchTemplateConfig[]; + Recurrence?: ScheduledInstanceRecurrence; /** - *The maximum price per unit hour that you are willing to pay for a Spot Instance. The - * default is the On-Demand price.
+ *The Scheduled Instance ID.
*/ - SpotPrice?: string; + ScheduledInstanceId?: string; /** - *The number of units to request for the Spot Fleet. You can choose to set the target
- * capacity in terms of instances or a performance characteristic that is important to your
- * application workload, such as vCPUs, memory, or I/O. If the request type is
- * maintain, you can specify a target capacity of 0 and add capacity
- * later.
The number of hours in the schedule.
*/ - TargetCapacity: number | undefined; + SlotDurationInHours?: number; /** - *The number of On-Demand units to request. You can choose to set the target capacity in
- * terms of instances or a performance characteristic that is important to your application
- * workload, such as vCPUs, memory, or I/O. If the request type is maintain,
- * you can specify a target capacity of 0 and add capacity later.
The end date for the Scheduled Instance.
*/ - OnDemandTargetCapacity?: number; + TermEndDate?: Date; /** - *The maximum amount per hour for On-Demand Instances that you're willing to pay. You
- * can use the onDemandMaxTotalPrice parameter, the
- * spotMaxTotalPrice parameter, or both parameters to ensure that your
- * fleet cost does not exceed your budget. If you set a maximum price per hour for the
- * On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the
- * maximum amount you're willing to pay. When the maximum amount you're willing to pay is
- * reached, the fleet stops launching instances even if it hasn’t met the target
- * capacity.
The start date for the Scheduled Instance.
*/ - OnDemandMaxTotalPrice?: string; + TermStartDate?: Date; /** - *The maximum amount per hour for Spot Instances that you're willing to pay. You can use
- * the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice
- * parameter, or both parameters to ensure that your fleet cost does not exceed your
- * budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request,
- * Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay.
- * When the maximum amount you're willing to pay is reached, the fleet stops launching
- * instances even if it hasn’t met the target capacity.
The total number of hours for a single instance for the entire term.
*/ - SpotMaxTotalPrice?: string; + TotalScheduledInstanceHours?: number; +} +export namespace ScheduledInstance { /** - *Indicates whether running Spot Instances are terminated when the Spot Fleet request - * expires.
+ * @internal */ - TerminateInstancesWithExpiration?: boolean; + export const filterSensitiveLog = (obj: ScheduledInstance): any => ({ + ...obj, + }); +} +/** + *Contains the output of DescribeScheduledInstances.
+ */ +export interface DescribeScheduledInstancesResult { /** - *The type of request. Indicates whether the Spot Fleet only requests the target
- * capacity or also attempts to maintain it. When this value is request, the
- * Spot Fleet only places the required requests. It does not attempt to replenish Spot
- * Instances if capacity is diminished, nor does it submit requests in alternative Spot
- * pools if capacity is not available. When this value is maintain, the Spot
- * Fleet maintains the target capacity. The Spot Fleet places the required requests to meet
- * capacity and automatically replenishes any interrupted instances. Default:
- * maintain. instant is listed but is not used by Spot
- * Fleet.
The token required to retrieve the next set of results. This value is null when there are no more results to return.
The start date and time of the request, in UTC format - * (YYYY-MM-DDTHH:MM:SSZ). - * By default, Amazon EC2 starts fulfilling the request immediately.
+ *Information about the Scheduled Instances.
*/ - ValidFrom?: Date; + ScheduledInstanceSet?: ScheduledInstance[]; +} +export namespace DescribeScheduledInstancesResult { /** - *The end date and time of the request, in UTC format - * (YYYY-MM-DDTHH:MM:SSZ). - * After the end date and time, no new Spot Instance requests are placed or able to fulfill - * the request. If no value is specified, the Spot Fleet request remains until you cancel - * it.
+ * @internal */ - ValidUntil?: Date; + export const filterSensitiveLog = (obj: DescribeScheduledInstancesResult): any => ({ + ...obj, + }); +} +export interface DescribeSecurityGroupReferencesRequest { /** - *Indicates whether Spot Fleet should replace unhealthy instances.
+ *Checks whether you have the required permissions for the action, without 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 behavior when a Spot Instance is interrupted. The default is
- * terminate.
The IDs of the security groups in your account.
*/ - InstanceInterruptionBehavior?: InstanceInterruptionBehavior | string; + GroupId: string[] | undefined; +} +export namespace DescribeSecurityGroupReferencesRequest { /** - *One or more Classic Load Balancers and target groups to attach to the Spot Fleet - * request. Spot Fleet registers the running Spot Instances with the specified Classic Load - * Balancers and target groups.
- *With Network Load Balancers, Spot Fleet cannot register instances that have the - * following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, - * M3, and T1.
+ * @internal */ - LoadBalancersConfig?: LoadBalancersConfig; + export const filterSensitiveLog = (obj: DescribeSecurityGroupReferencesRequest): any => ({ + ...obj, + }); +} +/** + *Describes a VPC with a security group that references your security group.
+ */ +export interface SecurityGroupReference { /** - *The number of Spot pools across which to allocate your target Spot capacity. Valid
- * only when Spot AllocationStrategy is set to
- * lowest-price. Spot Fleet selects the cheapest Spot pools and evenly
- * allocates your target Spot capacity across the number of Spot pools that you
- * specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a - * best effort basis. If a pool runs out of Spot capacity before fulfilling your target - * capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest - * pool. To ensure that your target capacity is met, you might receive Spot Instances from more than - * the number of pools that you specified. Similarly, if most of the pools have no Spot - * capacity, you might receive your full target capacity from fewer than the number of - * pools that you specified.
+ *The ID of your security group.
*/ - InstancePoolsToUseCount?: number; + GroupId?: string; /** - *Reserved.
+ *The ID of the VPC with the referencing security group.
*/ - Context?: string; + ReferencingVpcId?: string; /** - *The key-value pair for tagging the Spot Fleet request on creation. The value for
- * ResourceType must be spot-fleet-request, otherwise the
- * Spot Fleet request fails. To tag instances at launch, specify the tags in the launch
- * template (valid only if you use LaunchTemplateConfigs) or in
- * the
- * SpotFleetTagSpecification
- * (valid only if you use
- * LaunchSpecifications). For information about tagging after launch, see
- * Tagging Your Resources.
The ID of the VPC peering connection.
*/ - TagSpecifications?: TagSpecification[]; + VpcPeeringConnectionId?: string; } -export namespace SpotFleetRequestConfigData { +export namespace SecurityGroupReference { /** * @internal */ - export const filterSensitiveLog = (obj: SpotFleetRequestConfigData): any => ({ + export const filterSensitiveLog = (obj: SecurityGroupReference): any => ({ ...obj, }); } -/** - *Describes a Spot Fleet request.
- */ -export interface SpotFleetRequestConfig { +export interface DescribeSecurityGroupReferencesResult { /** - *The progress of the Spot Fleet request.
- * If there is an error, the status is error.
- * After all requests are placed, the status is pending_fulfillment.
- * If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled.
- * If the size of the fleet is decreased, the status is pending_termination
- * while Spot Instances are terminating.
Information about the VPCs with the referencing security groups.
*/ - ActivityStatus?: ActivityStatus | string; + SecurityGroupReferenceSet?: SecurityGroupReference[]; +} +export namespace DescribeSecurityGroupReferencesResult { /** - *The creation date and time of the request.
+ * @internal */ - CreateTime?: Date; + export const filterSensitiveLog = (obj: DescribeSecurityGroupReferencesResult): any => ({ + ...obj, + }); +} + +export interface DescribeSecurityGroupRulesRequest { + /** + *One or more filters.
+ *
+ * group-id - The ID of the security group.
+ * security-group-rule-id - The ID of the security group rule.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The configuration of the Spot Fleet request.
+ *The IDs of the security group rules.
*/ - SpotFleetRequestConfig?: SpotFleetRequestConfigData; + SecurityGroupRuleIds?: string[]; /** - *The ID of the Spot Fleet request.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The state of the Spot Fleet request.
+ *The token for the next page of results.
*/ - SpotFleetRequestState?: BatchState | string; + NextToken?: string; /** - *The tags for a Spot Fleet resource.
+ *The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another request with the returned NextToken value. This value
+ * can be between 5 and 1000. If this parameter is not specified, then all results are
+ * returned.
Contains the output of DescribeSpotFleetRequests.
- */ -export interface DescribeSpotFleetRequestsResponse { +export interface DescribeSecurityGroupRulesResult { /** - *The token required to retrieve the next set of results. This value is
- * null when there are no more results to return.
Information about security group rules.
*/ - NextToken?: string; + SecurityGroupRules?: SecurityGroupRule[]; /** - *Information about the configuration of your Spot Fleet.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for DescribeSpotInstanceRequests.
- */ -export interface DescribeSpotInstanceRequestsRequest { +export interface DescribeSecurityGroupsRequest { /** - *One or more filters.
- *
- * availability-zone-group - The Availability Zone group.
The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
+ *
- * create-time - The time stamp when the Spot Instance request was
- * created.
+ * description - The description of the security group.
- * fault-code - The fault code related to the request.
egress.ip-permission.cidr - An IPv4 CIDR block for an outbound
+ * security group rule.
*
- * fault-message - The fault message related to the request.
egress.ip-permission.from-port - For an outbound rule, the
+ * start of port range for the TCP and UDP protocols, or an ICMP type
+ * number.
*
- * instance-id - The ID of the instance that fulfilled the
- * request.
egress.ip-permission.group-id - The ID of a security group
+ * that has been referenced in an outbound security group rule.
*
- * launch-group - The Spot Instance launch group.
egress.ip-permission.group-name - The name of a security group
+ * that is referenced in an outbound security group rule.
*
- * launch.block-device-mapping.delete-on-termination - Indicates
- * whether the EBS volume is deleted on instance termination.
egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an
+ * outbound security group rule.
*
- * launch.block-device-mapping.device-name - The device name for the
- * volume in the block device mapping (for example, /dev/sdh or
- * xvdh).
+ * egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
- * launch.block-device-mapping.snapshot-id - The ID of the snapshot
- * for the EBS volume.
egress.ip-permission.protocol - The IP protocol for an
+ * outbound security group rule (tcp | udp |
+ * icmp, a protocol number, or -1 for all protocols).
*
- * launch.block-device-mapping.volume-size - The size of the EBS
- * volume, in GiB.
egress.ip-permission.to-port - For an outbound rule, the end
+ * of port range for the TCP and UDP protocols, or an ICMP code.
*
- * launch.block-device-mapping.volume-type - The type of EBS volume:
- * gp2 for General Purpose SSD, io1 or
- * io2 for Provisioned IOPS SSD, st1 for Throughput
- * Optimized HDD, sc1for Cold HDD, or standard for
- * Magnetic.
egress.ip-permission.user-id - The ID of an Amazon Web Services account that
+ * has been referenced in an outbound security group rule.
*
- * launch.group-id - The ID of the security group for the
- * instance.
+ * group-id - The ID of the security group.
- * launch.group-name - The name of the security group for the
- * instance.
+ * group-name - The name of the security group.
- * launch.image-id - The ID of the AMI.
+ * ip-permission.cidr - An IPv4 CIDR block for an inbound security
+ * group rule.
- * launch.instance-type - The type of instance (for example,
- * m3.medium).
+ * ip-permission.from-port - For an inbound rule, the start of port
+ * range for the TCP and UDP protocols, or an ICMP type number.
- * launch.kernel-id - The kernel ID.
+ * ip-permission.group-id - The ID of a security group that has been
+ * referenced in an inbound security group rule.
- * launch.key-name - The name of the key pair the instance launched
- * with.
+ * ip-permission.group-name - The name of a security group that is
+ * referenced in an inbound security group rule.
- * launch.monitoring-enabled - Whether detailed monitoring is
- * enabled for the Spot Instance.
+ * ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security
+ * group rule.
- * launch.ramdisk-id - The RAM disk ID.
ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
*
- * launched-availability-zone - The Availability Zone in which the
- * request is launched.
+ * ip-permission.protocol - The IP protocol for an inbound security
+ * group rule (tcp | udp | icmp, a
+ * protocol number, or -1 for all protocols).
- * network-interface.addresses.primary - Indicates whether the IP
- * address is the primary private IP address.
+ * ip-permission.to-port - For an inbound rule, the end of port range
+ * for the TCP and UDP protocols, or an ICMP code.
- * network-interface.delete-on-termination - Indicates whether the
- * network interface is deleted when the instance is terminated.
+ * ip-permission.user-id - The ID of an Amazon Web Services account that has been
+ * referenced in an inbound security group rule.
- * network-interface.description - A description of the network
- * interface.
+ * owner-id - The Amazon Web Services account ID of the owner of the security group.
- * network-interface.device-index - The index of the device for the
- * network interface attachment on the instance.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * network-interface.group-id - The ID of the security group
- * associated with the network interface.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * network-interface.network-interface-id - The ID of the network
- * interface.
+ * vpc-id - The ID of the VPC specified when the security group was created.
The IDs of the security groups. Required for security groups in a nondefault VPC.
+ *Default: Describes all of your security groups.
+ */ + GroupIds?: string[]; + + /** + *[EC2-Classic and default VPC only] The names of the security groups. You can specify either
+ * the security group name or the security group ID. For security groups in a nondefault VPC, use
+ * the group-name filter to describe security groups by name.
Default: Describes all of your security groups.
+ */ + GroupNames?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token to request the next page of results.
+ */ + NextToken?: string; + + /** + *The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another request with the returned NextToken value. This value
+ * can be between 5 and 1000. If this parameter is not specified, then all results are
+ * returned.
Describes a security group.
+ */ +export interface SecurityGroup { + /** + *A description of the security group.
+ */ + Description?: string; + + /** + *The name of the security group.
+ */ + GroupName?: string; + + /** + *The inbound rules associated with the security group.
+ */ + IpPermissions?: IpPermission[]; + + /** + *The Amazon Web Services account ID of the owner of the security group.
+ */ + OwnerId?: string; + + /** + *The ID of the security group.
+ */ + GroupId?: string; + + /** + *[VPC only] The outbound rules associated with the security group.
+ */ + IpPermissionsEgress?: IpPermission[]; + + /** + *Any tags assigned to the security group.
+ */ + Tags?: Tag[]; + + /** + *[VPC only] The ID of the VPC for the security group.
+ */ + VpcId?: string; +} + +export namespace SecurityGroup { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SecurityGroup): any => ({ + ...obj, + }); +} + +export interface DescribeSecurityGroupsResult { + /** + *Information about the security groups.
+ */ + SecurityGroups?: SecurityGroup[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The snapshot attribute you would like to view.
+ */ + Attribute: SnapshotAttributeName | string | undefined; + + /** + *The ID of the EBS snapshot.
+ */ + SnapshotId: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the user or group to be added or removed from the list of create volume + * permissions for a volume.
+ */ +export interface CreateVolumePermission { + /** + *The group to be added or removed. The possible value is all.
The ID of the Amazon Web Services account to be added or removed.
+ */ + UserId?: string; +} + +export namespace CreateVolumePermission { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateVolumePermission): any => ({ + ...obj, + }); +} + +export interface DescribeSnapshotAttributeResult { + /** + *The users and groups that have the permissions for creating volumes from the + * snapshot.
+ */ + CreateVolumePermissions?: CreateVolumePermission[]; + + /** + *The product codes.
+ */ + ProductCodes?: ProductCode[]; + + /** + *The ID of the EBS snapshot.
+ */ + SnapshotId?: string; +} + +export namespace DescribeSnapshotAttributeResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeSnapshotAttributeResult): any => ({ + ...obj, + }); +} + +export interface DescribeSnapshotsRequest { + /** + *The filters.
+ *
- * network-interface.private-ip-address - The primary private IP
- * address of the network interface.
+ * description - A description of the snapshot.
- * network-interface.subnet-id - The ID of the subnet for the
- * instance.
+ * encrypted - Indicates whether the snapshot is encrypted
+ * (true | false)
- * product-description - The product description associated with the
- * instance (Linux/UNIX | Windows).
+ * owner-alias - The owner alias, from an Amazon-maintained list
+ * (amazon).
+ * This is not the user-configured Amazon Web Services account alias set using the IAM console.
+ * We recommend that you use the related parameter instead of this filter.
- * spot-instance-request-id - The Spot Instance request ID.
+ * owner-id - The Amazon Web Services account ID of the owner. We recommend that
+ * you use the related parameter instead of this filter.
- * spot-price - The maximum hourly price for any Spot Instance
- * launched to fulfill the request.
+ * progress - The progress of the snapshot, as a percentage (for example,
+ * 80%).
- * state - The state of the Spot Instance request (open
- * | active | closed | cancelled |
- * failed). Spot request status information can help you track
- * your Amazon EC2 Spot Instance requests. For more information, see Spot
- * request status in the Amazon EC2 User Guide for Linux Instances.
+ * snapshot-id - The snapshot ID.
- * status-code - The short code describing the most recent
- * evaluation of your Spot Instance request.
+ * start-time - The time stamp when the snapshot was initiated.
- * status-message - The message explaining the status of the Spot
- * Instance request.
+ * status - The status of the snapshot (pending |
+ * completed | error).
- * tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
*
- * type - The type of Spot Instance request (one-time |
- * persistent).
- * valid-from - The start date of the request.
+ * volume-id - The ID of the volume the snapshot is for.
- * valid-until - The end date of the request.
+ * volume-size - The size of the volume, in GiB.
The maximum number of snapshot results returned by DescribeSnapshots in
+ * paginated output. When this parameter is used, DescribeSnapshots only returns
+ * MaxResults results in a single page along with a NextToken
+ * response element. The remaining results of the initial request can be seen by sending another
+ * DescribeSnapshots request with the returned NextToken value. This
+ * value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000,
+ * only 1,000 results are returned. If this parameter is not used, then
+ * DescribeSnapshots returns all results. You cannot specify this parameter and
+ * the snapshot IDs parameter in the same request.
The NextToken value returned from a previous paginated
+ * DescribeSnapshots request where MaxResults was used and the
+ * results exceeded the value of that parameter. Pagination continues from the end of the
+ * previous results that returned the NextToken value. This value is
+ * null when there are no more results to return.
Scopes the results to snapshots with the specified owners. You can specify a combination of
+ * Amazon Web Services account IDs, self, and amazon.
The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
+ */ + RestorableByUserIds?: string[]; + + /** + *The snapshot IDs.
+ *Default: Describes the snapshots for which you have create volume permissions.
+ */ + SnapshotIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the snapshots.
+ */ + Snapshots?: Snapshot[]; + + /** + *The NextToken value to include in a future DescribeSnapshots
+ * request. When the results of a DescribeSnapshots request exceed
+ * MaxResults, this value can be used to retrieve the next page of results. This
+ * value is null when there are no more results to return.
Contains the parameters for DescribeSpotDatafeedSubscription.
+ */ +export interface DescribeSpotDatafeedSubscriptionRequest { /** *Checks whether you have the required permissions for the action, without actually
* making the request, and provides an error response. If you have the required
@@ -10957,2087 +10599,2301 @@ export interface DescribeSpotInstanceRequestsRequest {
* UnauthorizedOperation.
One or more Spot Instance request IDs.
+ * @internal */ - SpotInstanceRequestIds?: string[]; + export const filterSensitiveLog = (obj: DescribeSpotDatafeedSubscriptionRequest): any => ({ + ...obj, + }); +} + +/** + *Contains the output of DescribeSpotDatafeedSubscription.
+ */ +export interface DescribeSpotDatafeedSubscriptionResult { + /** + *The Spot Instance data feed subscription.
+ */ + SpotDatafeedSubscription?: SpotDatafeedSubscription; +} +export namespace DescribeSpotDatafeedSubscriptionResult { /** - *The token to request the next set of results. This value is null when
- * there are no more results to return.
Contains the parameters for DescribeSpotFleetInstances.
+ */ +export interface DescribeSpotFleetInstancesRequest { /** - *The maximum number of results to return in a single call. Specify a value between 5
- * and 1000. To retrieve the remaining results, make another call with the returned
- * NextToken value.
Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The maximum number of results to return in a single call. Specify a value between 1
+ * and 1000. The default value is 1000. To retrieve the remaining results, make another
+ * call with the returned NextToken value.
The token for the next set of results.
+ */ + NextToken?: string; + + /** + *The ID of the Spot Fleet request.
+ */ + SpotFleetRequestId: string | undefined; } -export namespace DescribeSpotInstanceRequestsRequest { +export namespace DescribeSpotFleetInstancesRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSpotInstanceRequestsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeSpotFleetInstancesRequest): any => ({ ...obj, }); } /** - *Describes the monitoring of an instance.
+ *Contains the output of DescribeSpotFleetInstances.
*/ -export interface RunInstancesMonitoringEnabled { +export interface DescribeSpotFleetInstancesResponse { /** - *Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is - * enabled.
+ *The running instances. This list is refreshed periodically and might be out of + * date.
*/ - Enabled: boolean | undefined; + ActiveInstances?: ActiveInstance[]; + + /** + *The token required to retrieve the next set of results. This value is
+ * null when there are no more results to return.
The ID of the Spot Fleet request.
+ */ + SpotFleetRequestId?: string; } -export namespace RunInstancesMonitoringEnabled { +export namespace DescribeSpotFleetInstancesResponse { /** * @internal */ - export const filterSensitiveLog = (obj: RunInstancesMonitoringEnabled): any => ({ + export const filterSensitiveLog = (obj: DescribeSpotFleetInstancesResponse): any => ({ ...obj, }); } +export enum EventType { + BATCH_CHANGE = "fleetRequestChange", + ERROR = "error", + INFORMATION = "information", + INSTANCE_CHANGE = "instanceChange", +} + /** - *Describes the launch specification for an instance.
+ *Contains the parameters for DescribeSpotFleetRequestHistory.
*/ -export interface LaunchSpecification { +export interface DescribeSpotFleetRequestHistoryRequest { /** - *The Base64-encoded user data for the instance.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
+ *The type of events to describe. By default, all events are described.
*/ - SecurityGroups?: GroupIdentifier[]; + EventType?: EventType | string; /** - *Deprecated.
+ *The maximum number of results to return in a single call. Specify a value between 1
+ * and 1000. The default value is 1000. To retrieve the remaining results, make another
+ * call with the returned NextToken value.
One or more block device mapping entries.
+ *The token for the next set of results.
*/ - BlockDeviceMappings?: BlockDeviceMapping[]; + NextToken?: string; /** - *Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
- *Default: false
- *
The ID of the Spot Fleet request.
*/ - EbsOptimized?: boolean; + SpotFleetRequestId: string | undefined; /** - *The IAM instance profile.
+ *The starting date and time for the events, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
*/ - IamInstanceProfile?: IamInstanceProfileSpecification; + StartTime: Date | undefined; +} +export namespace DescribeSpotFleetRequestHistoryRequest { /** - *The ID of the AMI.
+ * @internal */ - ImageId?: string; + export const filterSensitiveLog = (obj: DescribeSpotFleetRequestHistoryRequest): any => ({ + ...obj, + }); +} +/** + *Describes an event in the history of the Spot Fleet request.
+ */ +export interface HistoryRecord { /** - *The instance type.
+ *Information about the event.
*/ - InstanceType?: _InstanceType | string; + EventInformation?: EventInformation; /** - *The ID of the kernel.
+ *The event type.
+ *
+ * error - An error with the Spot Fleet request.
+ * fleetRequestChange - A change in the status or configuration of
+ * the Spot Fleet request.
+ * instanceChange - An instance was launched or terminated.
+ * Information - An informational event.
The name of the key pair.
+ *The date and time of the event, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
*/ - KeyName?: string; + Timestamp?: Date; +} +export namespace HistoryRecord { /** - *One or more network interfaces. If you specify a network interface, you must specify - * subnet IDs and security group IDs using the network interface.
+ * @internal */ - NetworkInterfaces?: InstanceNetworkInterfaceSpecification[]; + export const filterSensitiveLog = (obj: HistoryRecord): any => ({ + ...obj, + }); +} +/** + *Contains the output of DescribeSpotFleetRequestHistory.
+ */ +export interface DescribeSpotFleetRequestHistoryResponse { /** - *The placement information for the instance.
+ *Information about the events in the history of the Spot Fleet request.
*/ - Placement?: SpotPlacement; + HistoryRecords?: HistoryRecord[]; /** - *The ID of the RAM disk.
+ *The last date and time for the events, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ). + * All records up to this time were retrieved.
+ *If nextToken indicates that there are more results, this value is not
+ * present.
The ID of the subnet in which to launch the instance.
+ *The token required to retrieve the next set of results. This value is
+ * null when there are no more results to return.
Describes the monitoring of an instance.
+ *The ID of the Spot Fleet request.
*/ - Monitoring?: RunInstancesMonitoringEnabled; + SpotFleetRequestId?: string; + + /** + *The starting date and time for the events, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
+ */ + StartTime?: Date; } -export namespace LaunchSpecification { +export namespace DescribeSpotFleetRequestHistoryResponse { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchSpecification): any => ({ + export const filterSensitiveLog = (obj: DescribeSpotFleetRequestHistoryResponse): any => ({ ...obj, }); } -export type SpotInstanceState = "active" | "cancelled" | "closed" | "failed" | "open"; - /** - *Describes the status of a Spot Instance request.
+ *Contains the parameters for DescribeSpotFleetRequests.
*/ -export interface SpotInstanceStatus { +export interface DescribeSpotFleetRequestsRequest { /** - *The status code. For a list of status codes, see Spot status codes in the Amazon EC2 User Guide for Linux Instances.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The maximum number of results to return in a single call. Specify a value between 1
+ * and 1000. The default value is 1000. To retrieve the remaining results, make another
+ * call with the returned NextToken value.
The description for the status code.
+ *The token for the next set of results.
*/ - Message?: string; + NextToken?: string; /** - *The date and time of the most recent status update, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *The IDs of the Spot Fleet requests.
*/ - UpdateTime?: Date; + SpotFleetRequestIds?: string[]; } -export namespace SpotInstanceStatus { +export namespace DescribeSpotFleetRequestsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: SpotInstanceStatus): any => ({ + export const filterSensitiveLog = (obj: DescribeSpotFleetRequestsRequest): any => ({ ...obj, }); } +export enum ExcessCapacityTerminationPolicy { + DEFAULT = "default", + NO_TERMINATION = "noTermination", +} + /** - *Describes a Spot Instance request.
+ *Describes whether monitoring is enabled.
*/ -export interface SpotInstanceRequest { - /** - *Deprecated.
- */ - ActualBlockHourlyPrice?: string; - +export interface SpotFleetMonitoring { /** - *The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
+ *Enables monitoring for the instance.
+ *Default: false
+ *
Deprecated.
+ * @internal */ - BlockDurationMinutes?: number; + export const filterSensitiveLog = (obj: SpotFleetMonitoring): any => ({ + ...obj, + }); +} +/** + *Describes a network interface.
+ */ +export interface InstanceNetworkInterfaceSpecification { /** - *The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
+ *Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The
+ * public IP address can only be assigned to a network interface for eth0, and can only be
+ * assigned to a new network interface, not an existing one. You cannot specify more than one
+ * network interface in the request. If launching into a default subnet, the default value is
+ * true.
The fault codes for the Spot Instance request, if any.
+ *If set to true, the interface is deleted when the instance is terminated. You can
+ * specify true only if creating a new network interface when launching an
+ * instance.
The instance ID, if an instance has been launched to fulfill the Spot Instance request.
+ *The description of the network interface. Applies only if creating a network interface when launching an instance.
*/ - InstanceId?: string; + Description?: string; /** - *The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
+ *The position of the network interface in the attachment order. + * A primary network interface has a device index of 0.
+ *If you specify a network interface when launching an instance, + * you must specify the device index.
*/ - LaunchGroup?: string; + DeviceIndex?: number; /** - *Additional information for launching instances.
+ *The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
*/ - LaunchSpecification?: LaunchSpecification; + Groups?: string[]; /** - *The Availability Zone in which the request is launched.
+ *A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses + * the IPv6 addresses from the range of the subnet. You cannot specify this option and the + * option to assign specific IPv6 addresses in the same request. You can specify this + * option if you've specified a minimum number of instances to launch.
*/ - LaunchedAvailabilityZone?: string; + Ipv6AddressCount?: number; /** - *The product description associated with the Spot Instance.
+ *One or more IPv6 addresses to assign to the network interface. You cannot specify + * this option and the option to assign a number of IPv6 addresses in the same request. You + * cannot specify this option if you've specified a minimum number of instances to + * launch.
*/ - ProductDescription?: RIProductDescription | string; + Ipv6Addresses?: InstanceIpv6Address[]; /** - *The ID of the Spot Instance request.
+ *The ID of the network interface.
+ *If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
*/ - SpotInstanceRequestId?: string; + NetworkInterfaceId?: string; /** - *The maximum price per hour that you are willing to pay for a Spot Instance.
+ *The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching + * more than one instance in a RunInstances request.
*/ - SpotPrice?: string; + PrivateIpAddress?: string; /** - *The state of the Spot Instance request. Spot status information helps track your Spot - * Instance requests. For more information, see Spot status in the - * Amazon EC2 User Guide for Linux Instances.
+ *One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're + * launching more than one instance in a RunInstances request.
*/ - State?: SpotInstanceState | string; + PrivateIpAddresses?: PrivateIpAddressSpecification[]; /** - *The status code and status message describing the Spot Instance request.
+ *The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're + * launching more than one instance in a RunInstances request.
*/ - Status?: SpotInstanceStatus; + SecondaryPrivateIpAddressCount?: number; /** - *Any tags assigned to the resource.
+ *The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
*/ - Tags?: Tag[]; + SubnetId?: string; /** - *The Spot Instance request type.
+ *Indicates whether to assign a carrier IP address to the network interface.
+ *You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. + * For more information about carrier IP addresses, see Carrier IP addresses in the Amazon Web Services Wavelength Developer Guide.
*/ - Type?: SpotInstanceType | string; + AssociateCarrierIpAddress?: boolean; /** - *The start date of the request, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ). - * The request becomes active at this date and time.
+ *The type of network interface.
+ *To create an Elastic Fabric Adapter (EFA), specify
+ * efa. For more information, see Elastic Fabric Adapter in the
+ * Amazon Elastic Compute Cloud User Guide.
Valid values: interface | efa
+ *
The end date of the request, in UTC format - * (YYYY-MM-DDTHH:MM:SSZ).
- *For a persistent request, the request remains active until the validUntil date
- * and time is reached. Otherwise, the request remains active until you cancel it.
- *
For a one-time request, the request remains active until all instances launch,
- * the request is canceled, or the validUntil date and time is reached. By default, the
- * request is valid for 7 days from the date the request was created.
The index of the network card. Some instance types support multiple network cards. + * The primary network interface must be assigned to network card index 0. + * The default is network card index 0.
+ *If you are using RequestSpotInstances to create Spot Instances, omit this parameter because + * you can’t specify the network card index when using this API. To specify the network + * card index, use RunInstances.
*/ - ValidUntil?: Date; + NetworkCardIndex?: number; /** - *The behavior when a Spot Instance is interrupted.
+ *One or more IPv4 delegated prefixes to be assigned to the network interface. You cannot
+ * use this option if you use the Ipv4PrefixCount option.
The number of IPv4 delegated prefixes to be automatically assigned to the network interface.
+ * You cannot use this option if you use the Ipv4Prefix option.
Contains the output of DescribeSpotInstanceRequests.
- */ -export interface DescribeSpotInstanceRequestsResult { /** - *One or more Spot Instance requests.
+ *One or more IPv6 delegated prefixes to be assigned to the network interface. You cannot
+ * use this option if you use the Ipv6PrefixCount option.
The token to use to retrieve the next set of results. This value is null
- * when there are no more results to return.
The number of IPv6 delegated prefixes to be automatically assigned to the network interface.
+ * You cannot use this option if you use the Ipv6Prefix option.
Contains the parameters for DescribeSpotPriceHistory.
+ *Describes Spot Instance placement.
*/ -export interface DescribeSpotPriceHistoryRequest { - /** - *One or more filters.
- *
- * availability-zone - The Availability Zone for which prices should
- * be returned.
- * instance-type - The type of instance (for example,
- * m3.medium).
- * product-description - The product description for the Spot price
- * (Linux/UNIX | Red Hat Enterprise Linux |
- * SUSE Linux | Windows | Linux/UNIX (Amazon
- * VPC) | Red Hat Enterprise Linux (Amazon VPC) |
- * SUSE Linux (Amazon VPC) | Windows (Amazon
- * VPC)).
- * spot-price - The Spot price. The value must match exactly (or use
- * wildcards; greater than or less than comparison is not supported).
- * timestamp - The time stamp of the Spot price history, in UTC format
- * (for example,
- * YYYY-MM-DDTHH:MM:SSZ).
- * You can use wildcards (* and ?). Greater than or less than comparison is not
- * supported.
Filters the results by the specified Availability Zone.
+ *The Availability Zone.
+ *[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; + * for example, "us-west-2a, us-west-2b".
*/ AvailabilityZone?: string; /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The date and time, up to the current date, from which to stop retrieving the price - * history data, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
- */ - EndTime?: Date; - - /** - *Filters the results by the specified instance types.
+ *The name of the placement group.
*/ - InstanceTypes?: (_InstanceType | string)[]; + GroupName?: string; /** - *The maximum number of results to return in a single call. Specify a value between 1
- * and 1000. The default value is 1000. To retrieve the remaining results, make another
- * call with the returned NextToken value.
The tenancy of the instance (if the instance is running in a VPC). An instance with a
+ * tenancy of dedicated runs on single-tenant hardware. The host
+ * tenancy is not supported for Spot Instances.
The token for the next set of results.
+ * @internal */ - NextToken?: string; + export const filterSensitiveLog = (obj: SpotPlacement): any => ({ + ...obj, + }); +} +/** + *The tags for a Spot Fleet resource.
+ */ +export interface SpotFleetTagSpecification { /** - *Filters the results by the specified basic product descriptions.
+ *The type of resource. Currently, the only resource type that is supported is
+ * instance. To tag the Spot Fleet request on creation, use the
+ * TagSpecifications parameter in
+ * SpotFleetRequestConfigData
+ * .
The date and time, up to the past 90 days, from which to start retrieving the price - * history data, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *The tags.
*/ - StartTime?: Date; + Tags?: Tag[]; } -export namespace DescribeSpotPriceHistoryRequest { +export namespace SpotFleetTagSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeSpotPriceHistoryRequest): any => ({ + export const filterSensitiveLog = (obj: SpotFleetTagSpecification): any => ({ ...obj, }); } /** - *Describes the maximum price per hour that you are willing to pay for a Spot - * Instance.
+ *Describes the launch specification for one or more Spot Instances. If you include
+ * On-Demand capacity in your fleet request or want to specify an EFA network device, you
+ * can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.
The Availability Zone.
- */ - AvailabilityZone?: string; - +export interface SpotFleetLaunchSpecification { /** - *The instance type.
+ *One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
*/ - InstanceType?: _InstanceType | string; + SecurityGroups?: GroupIdentifier[]; /** - *A general description of the AMI.
+ *Deprecated.
*/ - ProductDescription?: RIProductDescription | string; + AddressingType?: string; /** - *The maximum price per hour that you are willing to pay for a Spot Instance.
+ *One or more block devices that are mapped to the Spot Instances. You can't specify both + * a snapshot ID and an encryption value. This is because only blank volumes can be + * encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its + * encryption status is used for the volume encryption status.
*/ - SpotPrice?: string; + BlockDeviceMappings?: BlockDeviceMapping[]; /** - *The date and time the request was created, in UTC format (for example, - * YYYY-MM-DDTHH:MM:SSZ).
+ *Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
+ *Default: false
+ *
The IAM instance profile.
*/ - export const filterSensitiveLog = (obj: SpotPrice): any => ({ - ...obj, - }); -} + IamInstanceProfile?: IamInstanceProfileSpecification; -/** - *Contains the output of DescribeSpotPriceHistory.
- */ -export interface DescribeSpotPriceHistoryResult { /** - *The token required to retrieve the next set of results. This value is null or an empty - * string when there are no more results to return.
+ *The ID of the AMI.
*/ - NextToken?: string; + ImageId?: string; /** - *The historical Spot prices.
+ *The instance type.
*/ - SpotPriceHistory?: SpotPrice[]; -} + InstanceType?: _InstanceType | string; -export namespace DescribeSpotPriceHistoryResult { /** - * @internal + *The ID of the kernel.
*/ - export const filterSensitiveLog = (obj: DescribeSpotPriceHistoryResult): any => ({ - ...obj, - }); -} + KernelId?: string; -export interface DescribeStaleSecurityGroupsRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The name of the key pair.
*/ - DryRun?: boolean; + KeyName?: string; /** - *The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
+ *Enable or disable monitoring for the instances.
*/ - MaxResults?: number; + Monitoring?: SpotFleetMonitoring; /** - *The token for the next set of items to return. (You received this token from a prior call.)
+ *One or more network interfaces. If you specify a network interface, you must specify + * subnet IDs and security group IDs using the network interface.
+ *
+ * SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.
The ID of the VPC.
+ *The placement information.
*/ - VpcId: string | undefined; -} + Placement?: SpotPlacement; -export namespace DescribeStaleSecurityGroupsRequest { /** - * @internal + *The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel + * requirements for information about whether you need to specify a RAM disk. To find kernel + * requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.
*/ - export const filterSensitiveLog = (obj: DescribeStaleSecurityGroupsRequest): any => ({ - ...obj, - }); -} + RamdiskId?: string; -/** - *Describes a stale rule in a security group.
- */ -export interface StaleIpPermission { /** - *The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of
- * -1 indicates all ICMP types.
The maximum price per unit hour that you are willing to pay for a Spot Instance.
+ * If this value is not specified, the default is the Spot price specified for the fleet.
+ * To determine the Spot price per unit hour, divide the Spot price by the
+ * value of WeightedCapacity.
The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).
The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate + * them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".
*/ - IpProtocol?: string; + SubnetId?: string; /** - *The IP ranges. Not applicable for stale security group rules.
+ *The Base64-encoded user data that instances use when starting up.
*/ - IpRanges?: string[]; + UserData?: string; /** - *The prefix list IDs. Not applicable for stale security group rules.
+ *The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
+ *If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
*/ - PrefixListIds?: string[]; + WeightedCapacity?: number; /** - *The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of
- * -1 indicates all ICMP types.
The tags to apply during creation.
*/ - ToPort?: number; + TagSpecifications?: SpotFleetTagSpecification[]; /** - *The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.
+ *The attributes for the instance types. When you specify instance attributes, Amazon EC2 will + * identify instance types with those attributes.
+ *If you specify InstanceRequirements, you can't specify
+ * InstanceTypes.
Describes a stale security group (a security group that contains stale rules).
+ *Describes overrides for a launch template.
*/ -export interface StaleSecurityGroup { +export interface LaunchTemplateOverrides { /** - *The description of the security group.
+ *The instance type.
*/ - Description?: string; + InstanceType?: _InstanceType | string; /** - *The ID of the security group.
+ *The maximum price per unit hour that you are willing to pay for a Spot + * Instance.
*/ - GroupId?: string; + SpotPrice?: string; /** - *The name of the security group.
+ *The ID of the subnet in which to launch the instances.
*/ - GroupName?: string; + SubnetId?: string; /** - *Information about the stale inbound rules in the security group.
+ *The Availability Zone in which to launch the instances.
*/ - StaleIpPermissions?: StaleIpPermission[]; + AvailabilityZone?: string; /** - *Information about the stale outbound rules in the security group.
+ *The number of units provided by the specified instance type.
*/ - StaleIpPermissionsEgress?: StaleIpPermission[]; + WeightedCapacity?: number; /** - *The ID of the VPC for the security group.
+ *The priority for the launch template override. The highest priority is launched + * first.
+ *If OnDemandAllocationStrategy is set to prioritized, Spot Fleet
+ * uses priority to determine which launch template override to use first in fulfilling
+ * On-Demand capacity.
If the Spot AllocationStrategy is set to
+ * capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis
+ * to determine which launch template override to use in fulfilling Spot capacity, but
+ * optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the
+ * higher the priority. If no number is set, the launch template override has the lowest
+ * priority. You can set the same priority for different launch template overrides.
The instance requirements. When you specify instance requirements, Amazon EC2 will identify + * instance types with the provided requirements, and then use your On-Demand and Spot + * allocation strategies to launch instances from these instance types, in the same way as + * when you specify a list of instance types.
+ *If you specify InstanceRequirements, you can't specify
+ * InstanceTypes.
Describes a launch template and overrides.
+ */ +export interface LaunchTemplateConfig { /** - *The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
+ *The launch template.
*/ - NextToken?: string; + LaunchTemplateSpecification?: FleetLaunchTemplateSpecification; + + /** + *Any parameters that you specify override the same parameters in the launch + * template.
+ */ + Overrides?: LaunchTemplateOverrides[]; +} + +export namespace LaunchTemplateConfig { + /** + * @internal + */ + export const filterSensitiveLog = (obj: LaunchTemplateConfig): any => ({ + ...obj, + }); +} +/** + *Describes a Classic Load Balancer.
+ */ +export interface ClassicLoadBalancer { /** - *Information about the stale security groups.
+ *The name of the load balancer.
*/ - StaleSecurityGroupSet?: StaleSecurityGroup[]; + Name?: string; } -export namespace DescribeStaleSecurityGroupsResult { +export namespace ClassicLoadBalancer { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeStaleSecurityGroupsResult): any => ({ + export const filterSensitiveLog = (obj: ClassicLoadBalancer): any => ({ ...obj, }); } -export interface DescribeStoreImageTasksRequest { +/** + *Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers + * the running Spot Instances with these Classic Load Balancers.
+ */ +export interface ClassicLoadBalancersConfig { /** - *The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.
+ *One or more Classic Load Balancers.
*/ - ImageIds?: string[]; + ClassicLoadBalancers?: ClassicLoadBalancer[]; +} +export namespace ClassicLoadBalancersConfig { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes a load balancer target group.
+ */ +export interface TargetGroup { /** - *The filters.
- *
- * task-state - Returns tasks in a certain state (InProgress |
- * Completed | Failed)
- * bucket - Returns task information for tasks that targeted a specific
- * bucket. For the filter value, specify the bucket name.
The Amazon Resource Name (ARN) of the target group.
*/ - Filters?: Filter[]; + Arn?: string; +} +export namespace TargetGroup { /** - *The token for the next page of results.
+ * @internal */ - NextToken?: string; + export const filterSensitiveLog = (obj: TargetGroup): any => ({ + ...obj, + }); +} +/** + *Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the + * running Spot Instances with these target groups.
+ */ +export interface TargetGroupsConfig { /** - *The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another call with the returned NextToken value. This value can be
- * between 1 and 200. You cannot specify this parameter and the ImageIDs parameter
- * in the same call.
One or more target groups.
*/ - MaxResults?: number; + TargetGroups?: TargetGroup[]; } -export namespace DescribeStoreImageTasksRequest { +export namespace TargetGroupsConfig { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeStoreImageTasksRequest): any => ({ + export const filterSensitiveLog = (obj: TargetGroupsConfig): any => ({ ...obj, }); } /** - *The information about the AMI store task, including the progress of the task.
+ *Describes the Classic Load Balancers and target groups to attach to a Spot Fleet + * request.
*/ -export interface StoreImageTaskResult { - /** - *The ID of the AMI that is being stored.
- */ - AmiId?: string; - +export interface LoadBalancersConfig { /** - *The time the task started.
+ *The Classic Load Balancers.
*/ - TaskStartTime?: Date; + ClassicLoadBalancersConfig?: ClassicLoadBalancersConfig; /** - *The name of the Amazon S3 bucket that contains the stored AMI object.
+ *The target groups.
*/ - Bucket?: string; + TargetGroupsConfig?: TargetGroupsConfig; +} +export namespace LoadBalancersConfig { /** - *The name of the stored AMI object in the bucket.
+ * @internal */ - S3objectKey?: string; + export const filterSensitiveLog = (obj: LoadBalancersConfig): any => ({ + ...obj, + }); +} - /** - *The progress of the task as a percentage.
- */ - ProgressPercentage?: number; +export enum OnDemandAllocationStrategy { + LOWEST_PRICE = "lowestPrice", + PRIORITIZED = "prioritized", +} - /** - *The state of the store task (InProgress, Completed, or
- * Failed).
The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your + * Spot Instance is at an elevated risk of being interrupted. For more information, see + * Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.
+ */ +export interface SpotCapacityRebalance { /** - *If the tasks fails, the reason for the failure is returned. If the task succeeds,
- * null is returned.
The replacement strategy to use. Only available for fleets of type
+ * maintain. You must specify a value, otherwise you get an error.
To allow Spot Fleet to launch a replacement Spot Instance when an instance rebalance
+ * notification is emitted for a Spot Instance in the fleet, specify
+ * launch.
When a replacement instance is launched, the instance marked for rebalance is not + * automatically terminated. You can terminate it, or you can leave it running. You are + * charged for all instances while they are running.
+ *The information about the AMI store tasks.
- */ - StoreImageTaskResults?: StoreImageTaskResult[]; - +/** + *The strategies for managing your Spot Instances that are at an elevated risk of being + * interrupted.
+ */ +export interface SpotMaintenanceStrategies { /** - *The token to use to retrieve the next page of results. This value is null
- * when there are no more results to return.
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an + * elevated risk of being interrupted.
*/ - NextToken?: string; + CapacityRebalance?: SpotCapacityRebalance; } -export namespace DescribeStoreImageTasksResult { +export namespace SpotMaintenanceStrategies { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeStoreImageTasksResult): any => ({ + export const filterSensitiveLog = (obj: SpotMaintenanceStrategies): any => ({ ...obj, }); } -export interface DescribeSubnetsRequest { +/** + *Describes the configuration of a Spot Fleet request.
+ */ +export interface SpotFleetRequestConfigData { /** - *One or more filters.
- *
- * availability-zone - The Availability Zone for the subnet. You can also use
- * availabilityZone as the filter name.
- * availability-zone-id - The ID of the Availability Zone for the subnet.
- * You can also use availabilityZoneId as the filter name.
- * available-ip-address-count - The number of IPv4 addresses in the
- * subnet that are available.
- * cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you
- * specify must exactly match the subnet's CIDR block for information to be
- * returned for the subnet. You can also use cidr or
- * cidrBlock as the filter names.
- * default-for-az - Indicates whether this is the default subnet for the
- * Availability Zone. You can also use defaultForAz as the filter name.
- * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR
- * block associated with the subnet.
- * ipv6-cidr-block-association.association-id - An association ID
- * for an IPv6 CIDR block associated with the subnet.
- * ipv6-cidr-block-association.state - The state of an IPv6 CIDR
- * block associated with the subnet.
- * outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
- * owner-id - The ID of the Amazon Web Services account that owns the subnet.
- * state - The state of the subnet (pending | available).
- * subnet-arn - The Amazon Resource Name (ARN) of the subnet.
- * subnet-id - The ID of the subnet.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * vpc-id - The ID of the VPC for the subnet.
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by + * the Spot Fleet request.
+ *If the allocation strategy is lowestPrice, Spot Fleet launches instances from
+ * the Spot Instance pools with the lowest price. This is the default allocation strategy.
If the allocation strategy is diversified, Spot Fleet launches instances from
+ * all the Spot Instance pools that you specify.
If the allocation strategy is capacityOptimized (recommended), Spot Fleet
+ * launches instances from Spot Instance pools with optimal capacity for the number of instances
+ * that are launching. To give certain instance types a higher chance of launching first,
+ * use capacityOptimizedPrioritized. Set a priority for each instance type by
+ * using the Priority parameter for LaunchTemplateOverrides. You
+ * can assign the same priority to different LaunchTemplateOverrides. EC2
+ * implements the priorities on a best-effort basis, but optimizes for capacity first.
+ * capacityOptimizedPrioritized is supported only if your Spot Fleet uses a
+ * launch template. Note that if the OnDemandAllocationStrategy is set to
+ * prioritized, the same priority is applied when fulfilling On-Demand
+ * capacity.
One or more subnet IDs.
- *Default: Describes all your subnets.
+ *The order of the launch template overrides to use in fulfilling On-Demand capacity. If
+ * you specify lowestPrice, Spot Fleet uses price to determine the order, launching
+ * the lowest price first. If you specify prioritized, Spot Fleet uses the priority
+ * that you assign to each Spot Fleet launch template override, launching the highest priority
+ * first. If you do not specify a value, Spot Fleet defaults to lowestPrice.
Checks whether you have the required permissions for the action, without 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 strategies for managing your Spot Instances that are at an elevated risk of being + * interrupted.
*/ - DryRun?: boolean; + SpotMaintenanceStrategies?: SpotMaintenanceStrategies; /** - *The token for the next page of results.
+ *A unique, case-sensitive identifier that you provide to ensure the idempotency of your + * listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.
*/ - NextToken?: string; + ClientToken?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Indicates whether running Spot Instances should be terminated if you decrease the + * target capacity of the Spot Fleet request below the current size of the Spot + * Fleet.
*/ - MaxResults?: number; -} + ExcessCapacityTerminationPolicy?: ExcessCapacityTerminationPolicy | string; -export namespace DescribeSubnetsRequest { /** - * @internal + *The number of units fulfilled by this request compared to the set target capacity. You + * cannot set this value.
*/ - export const filterSensitiveLog = (obj: DescribeSubnetsRequest): any => ({ - ...obj, - }); -} + FulfilledCapacity?: number; -export interface DescribeSubnetsResult { /** - *Information about one or more subnets.
+ *The number of On-Demand units fulfilled by this request compared to the set target + * On-Demand capacity.
*/ - Subnets?: Subnet[]; + OnDemandFulfilledCapacity?: number; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that
+ * grants the Spot Fleet the permission to request, launch, terminate, and tag instances on
+ * your behalf. For more information, see Spot
+ * Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet
+ * can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using
+ * CancelSpotFleetRequests or when the Spot Fleet request expires, if you set
+ * TerminateInstancesWithExpiration.
The launch specifications for the Spot Fleet request. If you specify
+ * LaunchSpecifications, you can't specify
+ * LaunchTemplateConfigs. If you include On-Demand capacity in your
+ * request, you must use LaunchTemplateConfigs.
Checks whether you have the required permissions for the action, without 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 launch template and overrides. If you specify LaunchTemplateConfigs,
+ * you can't specify LaunchSpecifications. If you include On-Demand capacity
+ * in your request, you must use LaunchTemplateConfigs.
The filters.
- *
- * key - The tag key.
- * resource-id - The ID of the resource.
- * resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).
- * tag:
- * value - The tag value.
The maximum price per unit hour that you are willing to pay for a Spot Instance. The + * default is the On-Demand price.
*/ - Filters?: Filter[]; + SpotPrice?: string; /** - *The maximum number of results to return in a single call.
- * This value can be between 5 and 1000.
- * To retrieve the remaining results, make another call with the returned NextToken value.
The number of units to request for the Spot Fleet. You can choose to set the target
+ * capacity in terms of instances or a performance characteristic that is important to your
+ * application workload, such as vCPUs, memory, or I/O. If the request type is
+ * maintain, you can specify a target capacity of 0 and add capacity
+ * later.
The token to retrieve the next page of results.
+ *The number of On-Demand units to request. You can choose to set the target capacity in
+ * terms of instances or a performance characteristic that is important to your application
+ * workload, such as vCPUs, memory, or I/O. If the request type is maintain,
+ * you can specify a target capacity of 0 and add capacity later.
The maximum amount per hour for On-Demand Instances that you're willing to pay. You
+ * can use the onDemandMaxTotalPrice parameter, the
+ * spotMaxTotalPrice parameter, or both parameters to ensure that your
+ * fleet cost does not exceed your budget. If you set a maximum price per hour for the
+ * On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the
+ * maximum amount you're willing to pay. When the maximum amount you're willing to pay is
+ * reached, the fleet stops launching instances even if it hasn’t met the target
+ * capacity.
Describes a tag.
- */ -export interface TagDescription { /** - *The tag key.
+ *The maximum amount per hour for Spot Instances that you're willing to pay. You can use
+ * the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice
+ * parameter, or both parameters to ensure that your fleet cost does not exceed your
+ * budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request,
+ * Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay.
+ * When the maximum amount you're willing to pay is reached, the fleet stops launching
+ * instances even if it hasn’t met the target capacity.
The ID of the resource.
+ *Indicates whether running Spot Instances are terminated when the Spot Fleet request + * expires.
*/ - ResourceId?: string; + TerminateInstancesWithExpiration?: boolean; /** - *The resource type.
+ *The type of request. Indicates whether the Spot Fleet only requests the target
+ * capacity or also attempts to maintain it. When this value is request, the
+ * Spot Fleet only places the required requests. It does not attempt to replenish Spot
+ * Instances if capacity is diminished, nor does it submit requests in alternative Spot
+ * pools if capacity is not available. When this value is maintain, the Spot
+ * Fleet maintains the target capacity. The Spot Fleet places the required requests to meet
+ * capacity and automatically replenishes any interrupted instances. Default:
+ * maintain. instant is listed but is not used by Spot
+ * Fleet.
The start date and time of the request, in UTC format + * (YYYY-MM-DDTHH:MM:SSZ). + * By default, Amazon EC2 starts fulfilling the request immediately.
+ */ + ValidFrom?: Date; /** - *The tag value.
+ *The end date and time of the request, in UTC format + * (YYYY-MM-DDTHH:MM:SSZ). + * After the end date and time, no new Spot Instance requests are placed or able to fulfill + * the request. If no value is specified, the Spot Fleet request remains until you cancel + * it.
*/ - Value?: string; -} + ValidUntil?: Date; -export namespace TagDescription { /** - * @internal + *Indicates whether Spot Fleet should replace unhealthy instances.
*/ - export const filterSensitiveLog = (obj: TagDescription): any => ({ - ...obj, - }); -} + ReplaceUnhealthyInstances?: boolean; -export interface DescribeTagsResult { /** - *The token to use to retrieve the next page of results. This value is
- * null when there are no more results to return.
The behavior when a Spot Instance is interrupted. The default is
+ * terminate.
The tags.
+ *One or more Classic Load Balancers and target groups to attach to the Spot Fleet + * request. Spot Fleet registers the running Spot Instances with the specified Classic Load + * Balancers and target groups.
+ *With Network Load Balancers, Spot Fleet cannot register instances that have the + * following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, + * M3, and T1.
+ */ + LoadBalancersConfig?: LoadBalancersConfig; + + /** + *The number of Spot pools across which to allocate your target Spot capacity. Valid
+ * only when Spot AllocationStrategy is set to
+ * lowest-price. Spot Fleet selects the cheapest Spot pools and evenly
+ * allocates your target Spot capacity across the number of Spot pools that you
+ * specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a + * best effort basis. If a pool runs out of Spot capacity before fulfilling your target + * capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest + * pool. To ensure that your target capacity is met, you might receive Spot Instances from more than + * the number of pools that you specified. Similarly, if most of the pools have no Spot + * capacity, you might receive your full target capacity from fewer than the number of + * pools that you specified.
+ */ + InstancePoolsToUseCount?: number; + + /** + *Reserved.
+ */ + Context?: string; + + /** + *The unit for the target capacity.
+ *Default: units (translates to number of instances)
The key-value pair for tagging the Spot Fleet request on creation. The value for
+ * ResourceType must be spot-fleet-request, otherwise the
+ * Spot Fleet request fails. To tag instances at launch, specify the tags in the launch
+ * template (valid only if you use LaunchTemplateConfigs) or in
+ * the
+ * SpotFleetTagSpecification
+ * (valid only if you use
+ * LaunchSpecifications). For information about tagging after launch, see
+ * Tagging Your Resources.
Describes a Spot Fleet request.
+ */ +export interface SpotFleetRequestConfig { /** - *The ID of the Traffic Mirror filter.
+ *The progress of the Spot Fleet request.
+ * If there is an error, the status is error.
+ * After all requests are placed, the status is pending_fulfillment.
+ * If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled.
+ * If the size of the fleet is decreased, the status is pending_termination
+ * while Spot Instances are terminating.
Checks whether you have the required permissions for the action, without 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 creation date and time of the request.
*/ - DryRun?: boolean; + CreateTime?: Date; - /** - *One or more filters. The possible values are:
- *
- * description: The Traffic Mirror filter description.
- * traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
The configuration of the Spot Fleet request.
*/ - Filters?: Filter[]; + SpotFleetRequestConfig?: SpotFleetRequestConfigData; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The ID of the Spot Fleet request.
*/ - MaxResults?: number; + SpotFleetRequestId?: string; /** - *The token for the next page of results.
+ *The state of the Spot Fleet request.
*/ - NextToken?: string; + SpotFleetRequestState?: BatchState | string; + + /** + *The tags for a Spot Fleet resource.
+ */ + Tags?: Tag[]; } -export namespace DescribeTrafficMirrorFiltersRequest { +export namespace SpotFleetRequestConfig { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTrafficMirrorFiltersRequest): any => ({ + export const filterSensitiveLog = (obj: SpotFleetRequestConfig): any => ({ ...obj, }); } -export interface DescribeTrafficMirrorFiltersResult { +/** + *Contains the output of DescribeSpotFleetRequests.
+ */ +export interface DescribeSpotFleetRequestsResponse { /** - *Information about one or more Traffic Mirror filters.
+ *The token required to retrieve the next set of results. This value is
+ * null when there are no more results to return.
The token to use to retrieve the next page of results. The value is null when there are no more results to return.
Information about the configuration of your Spot Fleet.
*/ - NextToken?: string; + SpotFleetRequestConfigs?: SpotFleetRequestConfig[]; } -export namespace DescribeTrafficMirrorFiltersResult { +export namespace DescribeSpotFleetRequestsResponse { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTrafficMirrorFiltersResult): any => ({ + export const filterSensitiveLog = (obj: DescribeSpotFleetRequestsResponse): any => ({ ...obj, }); } -export interface DescribeTrafficMirrorSessionsRequest { - /** - *The ID of the Traffic Mirror session.
- */ - TrafficMirrorSessionIds?: string[]; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Contains the parameters for DescribeSpotInstanceRequests.
+ */ +export interface DescribeSpotInstanceRequestsRequest { /** - *One or more filters. The possible values are:
- *One or more filters.
+ *
- * description: The Traffic Mirror session description.
+ * availability-zone-group - The Availability Zone group.
- * network-interface-id: The ID of the Traffic Mirror session network interface.
+ * create-time - The time stamp when the Spot Instance request was
+ * created.
- * owner-id: The ID of the account that owns the Traffic Mirror session.
+ * fault-code - The fault code related to the request.
- * packet-length: The assigned number of packets to mirror.
+ * fault-message - The fault message related to the request.
- * session-number: The assigned session number.
+ * instance-id - The ID of the instance that fulfilled the
+ * request.
- * traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
+ * launch-group - The Spot Instance launch group.
- * traffic-mirror-session-id: The ID of the Traffic Mirror session.
+ * launch.block-device-mapping.delete-on-termination - Indicates
+ * whether the EBS volume is deleted on instance termination.
+ * launch.block-device-mapping.device-name - The device name for the
+ * volume in the block device mapping (for example, /dev/sdh or
+ * xvdh).
+ * launch.block-device-mapping.snapshot-id - The ID of the snapshot
+ * for the EBS volume.
+ * launch.block-device-mapping.volume-size - The size of the EBS
+ * volume, in GiB.
+ * launch.block-device-mapping.volume-type - The type of EBS volume:
+ * gp2 for General Purpose SSD, io1 or
+ * io2 for Provisioned IOPS SSD, st1 for Throughput
+ * Optimized HDD, sc1for Cold HDD, or standard for
+ * Magnetic.
+ * launch.group-id - The ID of the security group for the
+ * instance.
+ * launch.group-name - The name of the security group for the
+ * instance.
+ * launch.image-id - The ID of the AMI.
+ * launch.instance-type - The type of instance (for example,
+ * m3.medium).
+ * launch.kernel-id - The kernel ID.
+ * launch.key-name - The name of the key pair the instance launched
+ * with.
+ * launch.monitoring-enabled - Whether detailed monitoring is
+ * enabled for the Spot Instance.
+ * launch.ramdisk-id - The RAM disk ID.
+ * launched-availability-zone - The Availability Zone in which the
+ * request is launched.
+ * network-interface.addresses.primary - Indicates whether the IP
+ * address is the primary private IP address.
+ * network-interface.delete-on-termination - Indicates whether the
+ * network interface is deleted when the instance is terminated.
+ * network-interface.description - A description of the network
+ * interface.
+ * network-interface.device-index - The index of the device for the
+ * network interface attachment on the instance.
+ * network-interface.group-id - The ID of the security group
+ * associated with the network interface.
+ * network-interface.network-interface-id - The ID of the network
+ * interface.
+ * network-interface.private-ip-address - The primary private IP
+ * address of the network interface.
+ * network-interface.subnet-id - The ID of the subnet for the
+ * instance.
+ * product-description - The product description associated with the
+ * instance (Linux/UNIX | Windows).
+ * spot-instance-request-id - The Spot Instance request ID.
+ * spot-price - The maximum hourly price for any Spot Instance
+ * launched to fulfill the request.
+ * state - The state of the Spot Instance request (open
+ * | active | closed | cancelled |
+ * failed). Spot request status information can help you track
+ * your Amazon EC2 Spot Instance requests. For more information, see Spot
+ * request status in the Amazon EC2 User Guide for Linux Instances.
+ * status-code - The short code describing the most recent
+ * evaluation of your Spot Instance request.
+ * status-message - The message explaining the status of the Spot
+ * Instance request.
- * traffic-mirror-target-id: The ID of the Traffic Mirror target.
tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.
+ * For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
*
- * virtual-network-id: The virtual network ID of the Traffic Mirror session.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ *
+ * type - The type of Spot Instance request (one-time |
+ * persistent).
+ * valid-from - The start date of the request.
+ * valid-until - The end date of the request.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The token for the next page of results.
+ *One or more Spot Instance request IDs.
+ */ + SpotInstanceRequestIds?: string[]; + + /** + *The token to request the next set of results. This value is null when
+ * there are no more results to return.
The maximum number of results to return in a single call. Specify a value between 5
+ * and 1000. To retrieve the remaining results, make another call with the returned
+ * NextToken value.
Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
- */ - TrafficMirrorSessions?: TrafficMirrorSession[]; - +/** + *Describes the monitoring of an instance.
+ */ +export interface RunInstancesMonitoringEnabled { /** - *The token to use to retrieve the next page of results. The value is null when there are no more results to return.
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is + * enabled.
*/ - NextToken?: string; + Enabled: boolean | undefined; } -export namespace DescribeTrafficMirrorSessionsResult { +export namespace RunInstancesMonitoringEnabled { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTrafficMirrorSessionsResult): any => ({ + export const filterSensitiveLog = (obj: RunInstancesMonitoringEnabled): any => ({ ...obj, }); } -export interface DescribeTrafficMirrorTargetsRequest { +/** + *Describes the launch specification for an instance.
+ */ +export interface LaunchSpecification { /** - *The ID of the Traffic Mirror targets.
+ *The Base64-encoded user data for the instance.
*/ - TrafficMirrorTargetIds?: string[]; + UserData?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
*/ - DryRun?: boolean; + SecurityGroups?: GroupIdentifier[]; /** - *One or more filters. The possible values are:
- *
- * description: The Traffic Mirror target description.
- * network-interface-id: The ID of the Traffic Mirror session network interface.
- * network-load-balancer-arn: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session.
- * owner-id: The ID of the account that owns the Traffic Mirror session.
- * traffic-mirror-target-id: The ID of the Traffic Mirror target.
Deprecated.
*/ - Filters?: Filter[]; + AddressingType?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
One or more block device mapping entries.
*/ - MaxResults?: number; + BlockDeviceMappings?: BlockDeviceMapping[]; /** - *The token for the next page of results.
+ *Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
+ *Default: false
+ *
The IAM instance profile.
*/ - export const filterSensitiveLog = (obj: DescribeTrafficMirrorTargetsRequest): any => ({ - ...obj, - }); -} + IamInstanceProfile?: IamInstanceProfileSpecification; -export interface DescribeTrafficMirrorTargetsResult { /** - *Information about one or more Traffic Mirror targets.
+ *The ID of the AMI.
*/ - TrafficMirrorTargets?: TrafficMirrorTarget[]; + ImageId?: string; /** - *The token to use to retrieve the next page of results. The value is null when there are no more results to return.
The instance type.
*/ - NextToken?: string; -} + InstanceType?: _InstanceType | string; -export namespace DescribeTrafficMirrorTargetsResult { /** - * @internal + *The ID of the kernel.
*/ - export const filterSensitiveLog = (obj: DescribeTrafficMirrorTargetsResult): any => ({ - ...obj, - }); -} + KernelId?: string; -export interface DescribeTransitGatewayAttachmentsRequest { /** - *The IDs of the attachments.
+ *The name of the key pair.
*/ - TransitGatewayAttachmentIds?: string[]; + KeyName?: string; /** - *One or more filters. The possible values are:
- *
- * association.state - The state of the association (associating | associated |
- * disassociating).
- * association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
- * resource-id - The ID of the resource.
- * resource-owner-id - The ID of the Amazon Web Services account that owns the resource.
- * resource-type - The resource type. Valid values are vpc
- * | vpn | direct-connect-gateway | peering
- * | connect.
- * state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
- * transit-gateway-attachment-id - The ID of the attachment.
- * transit-gateway-id - The ID of the transit gateway.
- * transit-gateway-owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
One or more network interfaces. If you specify a network interface, you must specify + * subnet IDs and security group IDs using the network interface.
*/ - Filters?: Filter[]; + NetworkInterfaces?: InstanceNetworkInterfaceSpecification[]; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The placement information for the instance.
*/ - MaxResults?: number; + Placement?: SpotPlacement; /** - *The token for the next page of results.
+ *The ID of the RAM disk.
*/ - NextToken?: string; + RamdiskId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the subnet in which to launch the instance.
*/ - DryRun?: boolean; + SubnetId?: string; + + /** + *Describes the monitoring of an instance.
+ */ + Monitoring?: RunInstancesMonitoringEnabled; } -export namespace DescribeTransitGatewayAttachmentsRequest { +export namespace LaunchSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewayAttachmentsRequest): any => ({ + export const filterSensitiveLog = (obj: LaunchSpecification): any => ({ ...obj, }); } +export type SpotInstanceState = "active" | "cancelled" | "closed" | "failed" | "open"; + /** - *Describes an association.
+ *Describes the status of a Spot Instance request.
*/ -export interface TransitGatewayAttachmentAssociation { +export interface SpotInstanceStatus { /** - *The ID of the route table for the transit gateway.
+ *The status code. For a list of status codes, see Spot status codes in the Amazon EC2 User Guide for Linux Instances.
*/ - TransitGatewayRouteTableId?: string; + Code?: string; /** - *The state of the association.
+ *The description for the status code.
*/ - State?: TransitGatewayAssociationState | string; + Message?: string; + + /** + *The date and time of the most recent status update, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
+ */ + UpdateTime?: Date; } -export namespace TransitGatewayAttachmentAssociation { +export namespace SpotInstanceStatus { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayAttachmentAssociation): any => ({ + export const filterSensitiveLog = (obj: SpotInstanceStatus): any => ({ ...obj, }); } /** - *Describes an attachment between a resource and a transit gateway.
+ *Describes a Spot Instance request.
*/ -export interface TransitGatewayAttachment { +export interface SpotInstanceRequest { /** - *The ID of the attachment.
+ *Deprecated.
*/ - TransitGatewayAttachmentId?: string; + ActualBlockHourlyPrice?: string; /** - *The ID of the transit gateway.
+ *The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
*/ - TransitGatewayId?: string; + AvailabilityZoneGroup?: string; /** - *The ID of the Amazon Web Services account that owns the transit gateway.
+ *Deprecated.
*/ - TransitGatewayOwnerId?: string; + BlockDurationMinutes?: number; /** - *The ID of the Amazon Web Services account that owns the resource.
+ *The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
*/ - ResourceOwnerId?: string; + CreateTime?: Date; /** - *The resource type. Note that the tgw-peering resource type has been deprecated.
The fault codes for the Spot Instance request, if any.
*/ - ResourceType?: TransitGatewayAttachmentResourceType | string; + Fault?: SpotInstanceStateFault; /** - *The ID of the resource.
+ *The instance ID, if an instance has been launched to fulfill the Spot Instance request.
*/ - ResourceId?: string; + InstanceId?: string; /** - *The attachment state. Note that the initiating state has been deprecated.
The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
*/ - State?: TransitGatewayAttachmentState | string; + LaunchGroup?: string; /** - *The association.
+ *Additional information for launching instances.
*/ - Association?: TransitGatewayAttachmentAssociation; + LaunchSpecification?: LaunchSpecification; /** - *The creation time.
+ *The Availability Zone in which the request is launched.
*/ - CreationTime?: Date; + LaunchedAvailabilityZone?: string; /** - *The tags for the attachment.
+ *The product description associated with the Spot Instance.
*/ - Tags?: Tag[]; -} + ProductDescription?: RIProductDescription | string; -export namespace TransitGatewayAttachment { /** - * @internal + *The ID of the Spot Instance request.
*/ - export const filterSensitiveLog = (obj: TransitGatewayAttachment): any => ({ - ...obj, - }); -} + SpotInstanceRequestId?: string; -export interface DescribeTransitGatewayAttachmentsResult { /** - *Information about the attachments.
+ *The maximum price per hour that you are willing to pay for a Spot Instance.
*/ - TransitGatewayAttachments?: TransitGatewayAttachment[]; + SpotPrice?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The state of the Spot Instance request. Spot status information helps track your Spot + * Instance requests. For more information, see Spot status in the + * Amazon EC2 User Guide for Linux Instances.
*/ - NextToken?: string; -} + State?: SpotInstanceState | string; -export namespace DescribeTransitGatewayAttachmentsResult { /** - * @internal + *The status code and status message describing the Spot Instance request.
*/ - export const filterSensitiveLog = (obj: DescribeTransitGatewayAttachmentsResult): any => ({ - ...obj, - }); -} + Status?: SpotInstanceStatus; -export interface DescribeTransitGatewayConnectPeersRequest { /** - *The IDs of the Connect peers.
+ *Any tags assigned to the resource.
*/ - TransitGatewayConnectPeerIds?: string[]; + Tags?: Tag[]; /** - *One or more filters. The possible values are:
- *
- * state - The state of the Connect peer (pending |
- * available | deleting |
- * deleted).
- * transit-gateway-attachment-id - The ID of the attachment.
- * transit-gateway-connect-peer-id - The ID of the Connect peer.
The Spot Instance request type.
*/ - Filters?: Filter[]; + Type?: SpotInstanceType | string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The start date of the request, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ). + * The request becomes active at this date and time.
*/ - MaxResults?: number; + ValidFrom?: Date; /** - *The token for the next page of results.
+ *The end date of the request, in UTC format + * (YYYY-MM-DDTHH:MM:SSZ).
+ *For a persistent request, the request remains active until the validUntil date
+ * and time is reached. Otherwise, the request remains active until you cancel it.
+ *
For a one-time request, the request remains active until all instances launch,
+ * the request is canceled, or the validUntil date and time is reached. By default, the
+ * request is valid for 7 days from the date the request was created.
Checks whether you have the required permissions for the action, without 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 behavior when a Spot Instance is interrupted.
*/ - DryRun?: boolean; + InstanceInterruptionBehavior?: InstanceInterruptionBehavior | string; } -export namespace DescribeTransitGatewayConnectPeersRequest { +export namespace SpotInstanceRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewayConnectPeersRequest): any => ({ + export const filterSensitiveLog = (obj: SpotInstanceRequest): any => ({ ...obj, }); } -export interface DescribeTransitGatewayConnectPeersResult { +/** + *Contains the output of DescribeSpotInstanceRequests.
+ */ +export interface DescribeSpotInstanceRequestsResult { /** - *Information about the Connect peers.
+ *One or more Spot Instance requests.
*/ - TransitGatewayConnectPeers?: TransitGatewayConnectPeer[]; + SpotInstanceRequests?: SpotInstanceRequest[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to use to retrieve the next set of results. This value is null
+ * when there are no more results to return.
The IDs of the attachments.
- */ - TransitGatewayAttachmentIds?: string[]; +} +/** + *Contains the parameters for DescribeSpotPriceHistory.
+ */ +export interface DescribeSpotPriceHistoryRequest { /** - *One or more filters. The possible values are:
+ *One or more filters.
*
- * options.protocol - The tunnel protocol (gre).
+ * availability-zone - The Availability Zone for which prices should
+ * be returned.
- * state - The state of the attachment (initiating |
- * initiatingRequest | pendingAcceptance |
- * rollingBack | pending | available |
- * modifying | deleting | deleted |
- * failed | rejected | rejecting |
- * failing).
+ * instance-type - The type of instance (for example,
+ * m3.medium).
- * transit-gateway-attachment-id - The ID of the
- * Connect attachment.
product-description - The product description for the Spot price
+ * (Linux/UNIX | Red Hat Enterprise Linux |
+ * SUSE Linux | Windows | Linux/UNIX (Amazon
+ * VPC) | Red Hat Enterprise Linux (Amazon VPC) |
+ * SUSE Linux (Amazon VPC) | Windows (Amazon
+ * VPC)).
*
- * transit-gateway-id - The ID of the transit gateway.
+ * spot-price - The Spot price. The value must match exactly (or use
+ * wildcards; greater than or less than comparison is not supported).
- * transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.
+ * timestamp - The time stamp of the Spot price history, in UTC format
+ * (for example,
+ * YYYY-MM-DDTHH:MM:SSZ).
+ * You can use wildcards (* and ?). Greater than or less than comparison is not
+ * supported.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Filters the results by the specified Availability Zone.
*/ - MaxResults?: number; + AvailabilityZone?: string; /** - *The token for the next page of results.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The date and time, up to the current date, from which to stop retrieving the price + * history data, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
*/ - DryRun?: boolean; -} + EndTime?: Date; -export namespace DescribeTransitGatewayConnectsRequest { /** - * @internal + *Filters the results by the specified instance types.
*/ - export const filterSensitiveLog = (obj: DescribeTransitGatewayConnectsRequest): any => ({ - ...obj, - }); -} + InstanceTypes?: (_InstanceType | string)[]; -export interface DescribeTransitGatewayConnectsResult { /** - *Information about the Connect attachments.
+ *The maximum number of results to return in a single call. Specify a value between 1
+ * and 1000. The default value is 1000. To retrieve the remaining results, make another
+ * call with the returned NextToken value.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token for the next set of results.
*/ NextToken?: string; + + /** + *Filters the results by the specified basic product descriptions.
+ */ + ProductDescriptions?: string[]; + + /** + *The date and time, up to the past 90 days, from which to start retrieving the price + * history data, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
+ */ + StartTime?: Date; } -export namespace DescribeTransitGatewayConnectsResult { +export namespace DescribeSpotPriceHistoryRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewayConnectsResult): any => ({ + export const filterSensitiveLog = (obj: DescribeSpotPriceHistoryRequest): any => ({ ...obj, }); } -export interface DescribeTransitGatewayMulticastDomainsRequest { +/** + *Describes the maximum price per hour that you are willing to pay for a Spot + * Instance.
+ */ +export interface SpotPrice { /** - *The ID of the transit gateway multicast domain.
+ *The Availability Zone.
*/ - TransitGatewayMulticastDomainIds?: string[]; + AvailabilityZone?: string; /** - *One or more filters. The possible values are:
- *
- * state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.
- * transit-gateway-id - The ID of the transit gateway.
- * transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.
The instance type.
*/ - Filters?: Filter[]; + InstanceType?: _InstanceType | string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
A general description of the AMI.
*/ - MaxResults?: number; + ProductDescription?: RIProductDescription | string; /** - *The token for the next page of results.
+ *The maximum price per hour that you are willing to pay for a Spot Instance.
*/ - NextToken?: string; + SpotPrice?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The date and time the request was created, in UTC format (for example, + * YYYY-MM-DDTHH:MM:SSZ).
*/ - DryRun?: boolean; + Timestamp?: Date; } -export namespace DescribeTransitGatewayMulticastDomainsRequest { +export namespace SpotPrice { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewayMulticastDomainsRequest): any => ({ + export const filterSensitiveLog = (obj: SpotPrice): any => ({ ...obj, }); } -export interface DescribeTransitGatewayMulticastDomainsResult { +/** + *Contains the output of DescribeSpotPriceHistory.
+ */ +export interface DescribeSpotPriceHistoryResult { /** - *Information about the transit gateway multicast domains.
+ *The token required to retrieve the next set of results. This value is null or an empty + * string when there are no more results to return.
*/ - TransitGatewayMulticastDomains?: TransitGatewayMulticastDomain[]; + NextToken?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The historical Spot prices.
*/ - NextToken?: string; + SpotPriceHistory?: SpotPrice[]; } -export namespace DescribeTransitGatewayMulticastDomainsResult { +export namespace DescribeSpotPriceHistoryResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewayMulticastDomainsResult): any => ({ + export const filterSensitiveLog = (obj: DescribeSpotPriceHistoryResult): any => ({ ...obj, }); } -export interface DescribeTransitGatewayPeeringAttachmentsRequest { - /** - *One or more IDs of the transit gateway peering attachments.
- */ - TransitGatewayAttachmentIds?: string[]; - +export interface DescribeStaleSecurityGroupsRequest { /** - *One or more filters. The possible values are:
- *
- * transit-gateway-attachment-id - The ID of the transit gateway attachment.
- * local-owner-id - The ID of your Amazon Web Services account.
- * remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.
- * state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
- * transit-gateway-id - The ID of the transit gateway.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
*/ MaxResults?: number; /** - *The token for the next page of results.
+ *The token for the next set of items to return. (You received this token from a prior call.)
*/ NextToken?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the VPC.
*/ - DryRun?: boolean; + VpcId: string | undefined; } -export namespace DescribeTransitGatewayPeeringAttachmentsRequest { +export namespace DescribeStaleSecurityGroupsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewayPeeringAttachmentsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeStaleSecurityGroupsRequest): any => ({ ...obj, }); } -export interface DescribeTransitGatewayPeeringAttachmentsResult { +/** + *Describes a stale rule in a security group.
+ */ +export interface StaleIpPermission { /** - *The transit gateway peering attachments.
+ *The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of
+ * -1 indicates all ICMP types.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).
The IP ranges. Not applicable for stale security group rules.
+ */ + IpRanges?: string[]; + + /** + *The prefix list IDs. Not applicable for stale security group rules.
+ */ + PrefixListIds?: string[]; + + /** + *The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of
+ * -1 indicates all ICMP types.
The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.
+ */ + UserIdGroupPairs?: UserIdGroupPair[]; } -export namespace DescribeTransitGatewayPeeringAttachmentsResult { +export namespace StaleIpPermission { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewayPeeringAttachmentsResult): any => ({ + export const filterSensitiveLog = (obj: StaleIpPermission): any => ({ ...obj, }); } -export interface DescribeTransitGatewayRouteTablesRequest { +/** + *Describes a stale security group (a security group that contains stale rules).
+ */ +export interface StaleSecurityGroup { /** - *The IDs of the transit gateway route tables.
+ *The description of the security group.
*/ - TransitGatewayRouteTableIds?: string[]; + Description?: string; /** - *One or more filters. The possible values are:
- *
- * default-association-route-table - Indicates whether this is the default
- * association route table for the transit gateway (true | false).
- * default-propagation-route-table - Indicates whether this is the default
- * propagation route table for the transit gateway (true | false).
- * state - The state of the route table (available | deleting | deleted | pending).
- * transit-gateway-id - The ID of the transit gateway.
- * transit-gateway-route-table-id - The ID of the transit gateway route table.
The ID of the security group.
*/ - Filters?: Filter[]; + GroupId?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The name of the security group.
*/ - MaxResults?: number; + GroupName?: string; /** - *The token for the next page of results.
+ *Information about the stale inbound rules in the security group.
*/ - NextToken?: string; + StaleIpPermissions?: StaleIpPermission[]; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the stale outbound rules in the security group.
+ */ + StaleIpPermissionsEgress?: StaleIpPermission[]; + + /** + *The ID of the VPC for the security group.
*/ - DryRun?: boolean; + VpcId?: string; } -export namespace DescribeTransitGatewayRouteTablesRequest { +export namespace StaleSecurityGroup { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewayRouteTablesRequest): any => ({ + export const filterSensitiveLog = (obj: StaleSecurityGroup): any => ({ ...obj, }); } -export interface DescribeTransitGatewayRouteTablesResult { +export interface DescribeStaleSecurityGroupsResult { /** - *Information about the transit gateway route tables.
+ *The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
*/ - TransitGatewayRouteTables?: TransitGatewayRouteTable[]; + NextToken?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the stale security groups.
*/ - NextToken?: string; + StaleSecurityGroupSet?: StaleSecurityGroup[]; } -export namespace DescribeTransitGatewayRouteTablesResult { +export namespace DescribeStaleSecurityGroupsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTransitGatewayRouteTablesResult): any => ({ + export const filterSensitiveLog = (obj: DescribeStaleSecurityGroupsResult): any => ({ ...obj, }); } -export interface DescribeTransitGatewaysRequest { +export interface DescribeStoreImageTasksRequest { + /** + *The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.
+ */ + ImageIds?: string[]; + /** - *The IDs of the transit gateways.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters. The possible values are:
+ *The filters.
*
- * options.propagation-default-route-table-id - The ID of the default propagation route table.
- * options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
- * options.association-default-route-table-id - The ID of the default association route table.
- * options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
- * options.default-route-table-association - Indicates whether resource attachments are automatically
- * associated with the default association route table (enable | disable).
- * options.default-route-table-propagation - Indicates whether resource attachments automatically propagate
- * routes to the default propagation route table (enable | disable).
- * options.dns-support - Indicates whether DNS support is enabled (enable | disable).
- * options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
- * owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
- * state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
task-state - Returns tasks in a certain state (InProgress |
+ * Completed | Failed)
*
- * transit-gateway-id - The ID of the transit gateway.
bucket - Returns task information for tasks that targeted a specific
+ * bucket. For the filter value, specify the bucket name.
* The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
*/ NextToken?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another call with the returned NextToken value. This value can be
+ * between 1 and 200. You cannot specify this parameter and the ImageIDs parameter
+ * in the same call.
Information about the transit gateways.
- */ - TransitGateways?: TransitGateway[]; - +/** + *The information about the AMI store task, including the progress of the task.
+ */ +export interface StoreImageTaskResult { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the AMI that is being stored.
*/ - NextToken?: string; -} + AmiId?: string; -export namespace DescribeTransitGatewaysResult { /** - * @internal + *The time the task started.
*/ - export const filterSensitiveLog = (obj: DescribeTransitGatewaysResult): any => ({ - ...obj, - }); -} + TaskStartTime?: Date; -export interface DescribeTransitGatewayVpcAttachmentsRequest { /** - *The IDs of the attachments.
+ *The name of the Amazon S3 bucket that contains the stored AMI object.
*/ - TransitGatewayAttachmentIds?: string[]; + Bucket?: string; /** - *One or more filters. The possible values are:
- *
- * state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
- * transit-gateway-attachment-id - The ID of the attachment.
- * transit-gateway-id - The ID of the transit gateway.
- * vpc-id - The ID of the VPC.
The name of the stored AMI object in the bucket.
*/ - Filters?: Filter[]; + S3objectKey?: string; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The progress of the task as a percentage.
*/ - MaxResults?: number; + ProgressPercentage?: number; /** - *The token for the next page of results.
+ *The state of the store task (InProgress, Completed, or
+ * Failed).
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
If the tasks fails, the reason for the failure is returned. If the task succeeds,
+ * null is returned.
Information about the VPC attachments.
+ *The information about the AMI store tasks.
*/ - TransitGatewayVpcAttachments?: TransitGatewayVpcAttachment[]; + StoreImageTaskResults?: StoreImageTaskResult[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to use to retrieve the next page of results. This value is null
+ * when there are no more results to return.
The IDs of the associations.
- */ - AssociationIds?: string[]; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more filters.
*
- * gre-key - The ID of a trunk interface association.
availability-zone - The Availability Zone for the subnet. You can also use
+ * availabilityZone as the filter name.
+ *
+ * availability-zone-id - The ID of the Availability Zone for the subnet.
+ * You can also use availabilityZoneId as the filter name.
+ * available-ip-address-count - The number of IPv4 addresses in the
+ * subnet that are available.
+ * cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you
+ * specify must exactly match the subnet's CIDR block for information to be
+ * returned for the subnet. You can also use cidr or
+ * cidrBlock as the filter names.
+ * default-for-az - Indicates whether this is the default subnet for the
+ * Availability Zone. You can also use defaultForAz as the filter name.
+ * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR
+ * block associated with the subnet.
+ * ipv6-cidr-block-association.association-id - An association ID
+ * for an IPv6 CIDR block associated with the subnet.
+ * ipv6-cidr-block-association.state - The state of an IPv6 CIDR
+ * block associated with the subnet.
+ * outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
+ * owner-id - The ID of the Amazon Web Services account that owns the subnet.
+ * state - The state of the subnet (pending | available).
+ * subnet-arn - The Amazon Resource Name (ARN) of the subnet.
+ * subnet-id - The ID of the subnet.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * interface-protocol - The interface protocol. Valid values are VLAN and GRE.
vpc-id - The ID of the VPC for the subnet.
* One or more subnet IDs.
+ *Default: Describes all your subnets.
+ */ + SubnetIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
*/ @@ -13045,16 +12901,37 @@ export interface DescribeTrunkInterfaceAssociationsRequest { /** *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
nextToken value.
*/
MaxResults?: number;
}
-export namespace DescribeTrunkInterfaceAssociationsRequest {
+export namespace DescribeSubnetsRequest {
+ /**
+ * @internal
+ */
+ export const filterSensitiveLog = (obj: DescribeSubnetsRequest): any => ({
+ ...obj,
+ });
+}
+
+export interface DescribeSubnetsResult {
+ /**
+ * Information about one or more subnets.
+ */ + Subnets?: Subnet[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the trunk associations.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
+ *
+ * key - The tag key.
+ * resource-id - The ID of the resource.
+ * resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).
+ * tag:
+ * value - The tag value.
The maximum number of results to return in a single call.
+ * This value can be between 5 and 1000.
+ * To retrieve the remaining results, make another call with the returned NextToken value.
The token to retrieve the next page of results.
*/ NextToken?: string; } -export namespace DescribeTrunkInterfaceAssociationsResult { +export namespace DescribeTagsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeTrunkInterfaceAssociationsResult): any => ({ + export const filterSensitiveLog = (obj: DescribeTagsRequest): any => ({ ...obj, }); } -export type VolumeAttributeName = "autoEnableIO" | "productCodes"; +/** + *Describes a tag.
+ */ +export interface TagDescription { + /** + *The tag key.
+ */ + Key?: string; -export interface DescribeVolumeAttributeRequest { /** - *The attribute of the volume. This parameter is required.
+ *The ID of the resource.
*/ - Attribute: VolumeAttributeName | string | undefined; + ResourceId?: string; /** - *The ID of the volume.
+ *The resource type.
*/ - VolumeId: string | undefined; + ResourceType?: ResourceType | string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The tag value.
*/ - DryRun?: boolean; + Value?: string; } -export namespace DescribeVolumeAttributeRequest { +export namespace TagDescription { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVolumeAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: TagDescription): any => ({ ...obj, }); } -export interface DescribeVolumeAttributeResult { - /** - *The state of autoEnableIO attribute.
A list of product codes.
+ *The token to use to retrieve the next page of results. This value is
+ * null when there are no more results to return.
The ID of the volume.
+ *The tags.
*/ - VolumeId?: string; + Tags?: TagDescription[]; } -export namespace DescribeVolumeAttributeResult { +export namespace DescribeTagsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVolumeAttributeResult): any => ({ + export const filterSensitiveLog = (obj: DescribeTagsResult): any => ({ ...obj, }); } -export interface DescribeVolumesRequest { +export interface DescribeTrafficMirrorFiltersRequest { /** - *The filters.
+ *The ID of the Traffic Mirror filter.
+ */ + TrafficMirrorFilterIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters. The possible values are:
*
- * attachment.attach-time - The time stamp when the attachment
- * initiated.
- * attachment.delete-on-termination - Whether the volume is deleted on
- * instance termination.
- * attachment.device - The device name specified in the block device mapping
- * (for example, /dev/sda1).
- * attachment.instance-id - The ID of the instance the volume is attached
- * to.
- * attachment.status - The attachment state (attaching |
- * attached | detaching).
- * availability-zone - The Availability Zone in which the volume was
- * created.
- * create-time - The time stamp when the volume was created.
- * encrypted - Indicates whether the volume is encrypted (true
- * | false)
- * multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true
- * | false)
- * fast-restored - Indicates whether the volume was created from a
- * snapshot that is enabled for fast snapshot restore (true |
- * false).
- * size - The size of the volume, in GiB.
- * snapshot-id - The snapshot from which the volume was created.
- * status - The state of the volume (creating |
- * available | in-use | deleting |
- * deleted | error).
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * volume-id - The volume ID.
description: The Traffic Mirror filter description.
*
- * volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 |
- * st1 | sc1| standard)
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
* The volume IDs.
- */ - VolumeIds?: string[]; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of volume results returned by DescribeVolumes in paginated
- * output. When this parameter is used, DescribeVolumes only returns
- * MaxResults results in a single page along with a NextToken
- * response element. The remaining results of the initial request can be seen by sending another
- * DescribeVolumes request with the returned NextToken value. This
- * value can be between 5 and 500; if MaxResults is given a value larger than 500,
- * only 500 results are returned. If this parameter is not used, then
- * DescribeVolumes returns all results. You cannot specify this parameter and the
- * volume IDs parameter in the same request.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The NextToken value returned from a previous paginated
- * DescribeVolumes request where MaxResults was used and the results
- * exceeded the value of that parameter. Pagination continues from the end of the previous
- * results that returned the NextToken value. This value is null when
- * there are no more results to return.
The token for the next page of results.
*/ NextToken?: string; } -export namespace DescribeVolumesRequest { +export namespace DescribeTrafficMirrorFiltersRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVolumesRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeTrafficMirrorFiltersRequest): any => ({ ...obj, }); } -export interface DescribeVolumesResult { +export interface DescribeTrafficMirrorFiltersResult { /** - *Information about the volumes.
+ *Information about one or more Traffic Mirror filters.
*/ - Volumes?: Volume[]; + TrafficMirrorFilters?: TrafficMirrorFilter[]; /** - *The NextToken value to include in a future DescribeVolumes
- * request. When the results of a DescribeVolumes request exceed
- * MaxResults, this value can be used to retrieve the next page of results. This
- * value is null when there are no more results to return.
The token to use to retrieve the next page of results. The value is null when there are no more results to return.
The ID of the Traffic Mirror session.
+ */ + TrafficMirrorSessionIds?: string[]; + /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -340,297 +294,235 @@ export interface DescribeVolumesModificationsRequest {
DryRun?: boolean;
/**
- *
The IDs of the volumes.
- */ - VolumeIds?: string[]; - - /** - *The filters.
+ *One or more filters. The possible values are:
*
- * modification-state - The current modification state (modifying |
- * optimizing | completed | failed).
- * original-iops - The original IOPS rate of the volume.
- * original-size - The original size of the volume, in GiB.
description: The Traffic Mirror session description.
*
- * original-volume-type - The original volume type of the volume (standard |
- * io1 | io2 | gp2 | sc1 | st1).
network-interface-id: The ID of the Traffic Mirror session network interface.
*
- * originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).
owner-id: The ID of the account that owns the Traffic Mirror session.
*
- * start-time - The modification start time.
packet-length: The assigned number of packets to mirror.
*
- * target-iops - The target IOPS rate of the volume.
session-number: The assigned session number.
*
- * target-size - The target size of the volume, in GiB.
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
*
- * target-volume-type - The target volume type of the volume (standard |
- * io1 | io2 | gp2 | sc1 | st1).
traffic-mirror-session-id: The ID of the Traffic Mirror session.
*
- * targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).
traffic-mirror-target-id: The ID of the Traffic Mirror target.
*
- * volume-id - The ID of the volume.
virtual-network-id: The virtual network ID of the Traffic Mirror session.
* The nextToken value returned by a previous paginated request.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of results (up to a limit of 500) to be returned in a paginated - * request.
+ *The token for the next page of results.
*/ - MaxResults?: number; + NextToken?: string; } -export namespace DescribeVolumesModificationsRequest { +export namespace DescribeTrafficMirrorSessionsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVolumesModificationsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeTrafficMirrorSessionsRequest): any => ({ ...obj, }); } -export type VolumeModificationState = "completed" | "failed" | "modifying" | "optimizing"; - -/** - *Describes the modification status of an EBS volume.
- *If the volume has never been modified, some element values will be null.
- */ -export interface VolumeModification { - /** - *The ID of the volume.
- */ - VolumeId?: string; - - /** - *The current modification state. The modification state is null for unmodified - * volumes.
- */ - ModificationState?: VolumeModificationState | string; - - /** - *A status message about the modification progress or failure.
- */ - StatusMessage?: string; - - /** - *The target size of the volume, in GiB.
- */ - TargetSize?: number; - - /** - *The target IOPS rate of the volume.
- */ - TargetIops?: number; - - /** - *The target EBS volume type of the volume.
- */ - TargetVolumeType?: VolumeType | string; - - /** - *The target throughput of the volume, in MiB/s.
- */ - TargetThroughput?: number; - - /** - *The target setting for Amazon EBS Multi-Attach.
- */ - TargetMultiAttachEnabled?: boolean; - +export interface DescribeTrafficMirrorSessionsResult { /** - *The original size of the volume, in GiB.
+ *Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.
*/ - OriginalSize?: number; + TrafficMirrorSessions?: TrafficMirrorSession[]; /** - *The original IOPS rate of the volume.
+ *The token to use to retrieve the next page of results. The value is null when there are no more results to return.
The original EBS volume type of the volume.
+ * @internal */ - OriginalVolumeType?: VolumeType | string; + export const filterSensitiveLog = (obj: DescribeTrafficMirrorSessionsResult): any => ({ + ...obj, + }); +} +export interface DescribeTrafficMirrorTargetsRequest { /** - *The original throughput of the volume, in MiB/s.
+ *The ID of the Traffic Mirror targets.
*/ - OriginalThroughput?: number; + TrafficMirrorTargetIds?: string[]; /** - *The original setting for Amazon EBS Multi-Attach.
+ *Checks whether you have the required permissions for the action, without 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 modification progress, from 0 to 100 percent complete.
+ *One or more filters. The possible values are:
+ *
+ * description: The Traffic Mirror target description.
+ * network-interface-id: The ID of the Traffic Mirror session network interface.
+ * network-load-balancer-arn: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session.
+ * owner-id: The ID of the account that owns the Traffic Mirror session.
+ * traffic-mirror-target-id: The ID of the Traffic Mirror target.
The modification start time.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The modification completion or failure time.
+ *The token for the next page of results.
*/ - EndTime?: Date; + NextToken?: string; } -export namespace VolumeModification { +export namespace DescribeTrafficMirrorTargetsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: VolumeModification): any => ({ + export const filterSensitiveLog = (obj: DescribeTrafficMirrorTargetsRequest): any => ({ ...obj, }); } -export interface DescribeVolumesModificationsResult { +export interface DescribeTrafficMirrorTargetsResult { /** - *Information about the volume modifications.
+ *Information about one or more Traffic Mirror targets.
*/ - VolumesModifications?: VolumeModification[]; + TrafficMirrorTargets?: TrafficMirrorTarget[]; /** - *Token for pagination, null if there are no more results
+ *The token to use to retrieve the next page of results. The value is null when there are no more results to return.
The filters.
+ *The IDs of the attachments.
+ */ + TransitGatewayAttachmentIds?: string[]; + + /** + *One or more filters. The possible values are:
*
- * action.code - The action code for the event (for example,
- * enable-volume-io).
- * action.description - A description of the action.
- * action.event-id - The event ID associated with the action.
- * availability-zone - The Availability Zone of the instance.
association.state - The state of the association (associating | associated |
+ * disassociating).
*
- * event.description - A description of the event.
association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
*
- * event.event-id - The event ID.
resource-id - The ID of the resource.
*
- * event.event-type - The event type (for io-enabled:
- * passed | failed; for io-performance:
- * io-performance:degraded | io-performance:severely-degraded |
- * io-performance:stalled).
resource-owner-id - The ID of the Amazon Web Services account that owns the resource.
*
- * event.not-after - The latest end time for the event.
resource-type - The resource type. Valid values are vpc
+ * | vpn | direct-connect-gateway | peering
+ * | connect.
*
- * event.not-before - The earliest start time for the event.
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
*
- * volume-status.details-name - The cause for
- * volume-status.status (io-enabled |
- * io-performance).
transit-gateway-attachment-id - The ID of the attachment.
*
- * volume-status.details-status - The status of
- * volume-status.details-name (for io-enabled:
- * passed | failed; for io-performance:
- * normal | degraded | severely-degraded |
- * stalled).
transit-gateway-id - The ID of the transit gateway.
*
- * volume-status.status - The status of the volume (ok |
- * impaired | warning | insufficient-data).
transit-gateway-owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
* The maximum number of volume results returned by DescribeVolumeStatus in
- * paginated output. When this parameter is used, the request only returns
- * MaxResults results in a single page along with a NextToken
- * response element. The remaining results of the initial request can be seen by sending another
- * request with the returned NextToken value. This value can be between 5 and 1,000;
- * if MaxResults is given a value larger than 1,000, only 1,000 results are returned.
- * If this parameter is not used, then DescribeVolumeStatus returns all results. You
- * cannot specify this parameter and the volume IDs parameter in the same request.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The NextToken value to include in a future DescribeVolumeStatus
- * request. When the results of the request exceed MaxResults, this value can be
- * used to retrieve the next page of results. This value is null when there are no
- * more results to return.
The token for the next page of results.
*/ NextToken?: string; - /** - *The IDs of the volumes.
- *Default: Describes all your volumes.
- */ - VolumeIds?: string[]; - /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -639,252 +531,249 @@ export interface DescribeVolumeStatusRequest {
DryRun?: boolean;
}
-export namespace DescribeVolumeStatusRequest {
+export namespace DescribeTransitGatewayAttachmentsRequest {
/**
* @internal
*/
- export const filterSensitiveLog = (obj: DescribeVolumeStatusRequest): any => ({
+ export const filterSensitiveLog = (obj: DescribeTransitGatewayAttachmentsRequest): any => ({
...obj,
});
}
/**
- *
Describes a volume status operation code.
+ *Describes an association.
*/ -export interface VolumeStatusAction { - /** - *The code identifying the operation, for example, enable-volume-io.
A description of the operation.
- */ - Description?: string; - +export interface TransitGatewayAttachmentAssociation { /** - *The ID of the event associated with this operation.
+ *The ID of the route table for the transit gateway.
*/ - EventId?: string; + TransitGatewayRouteTableId?: string; /** - *The event type associated with this operation.
+ *The state of the association.
*/ - EventType?: string; + State?: TransitGatewayAssociationState | string; } -export namespace VolumeStatusAction { +export namespace TransitGatewayAttachmentAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: VolumeStatusAction): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayAttachmentAssociation): any => ({ ...obj, }); } /** - *Information about the instances to which the volume is attached.
+ *Describes an attachment between a resource and a transit gateway.
*/ -export interface VolumeStatusAttachmentStatus { +export interface TransitGatewayAttachment { /** - *The maximum IOPS supported by the attached instance.
+ *The ID of the attachment.
*/ - IoPerformance?: string; + TransitGatewayAttachmentId?: string; /** - *The ID of the attached instance.
+ *The ID of the transit gateway.
*/ - InstanceId?: string; -} + TransitGatewayId?: string; -export namespace VolumeStatusAttachmentStatus { /** - * @internal + *The ID of the Amazon Web Services account that owns the transit gateway.
*/ - export const filterSensitiveLog = (obj: VolumeStatusAttachmentStatus): any => ({ - ...obj, - }); -} + TransitGatewayOwnerId?: string; -/** - *Describes a volume status event.
- */ -export interface VolumeStatusEvent { /** - *A description of the event.
+ *The ID of the Amazon Web Services account that owns the resource.
*/ - Description?: string; + ResourceOwnerId?: string; /** - *The ID of this event.
+ *The resource type. Note that the tgw-peering resource type has been deprecated.
The type of this event.
+ *The ID of the resource.
*/ - EventType?: string; + ResourceId?: string; /** - *The latest end time of the event.
+ *The attachment state. Note that the initiating state has been deprecated.
The earliest start time of the event.
+ *The association.
*/ - NotBefore?: Date; + Association?: TransitGatewayAttachmentAssociation; /** - *The ID of the instance associated with the event.
+ *The creation time.
*/ - InstanceId?: string; + CreationTime?: Date; + + /** + *The tags for the attachment.
+ */ + Tags?: Tag[]; } -export namespace VolumeStatusEvent { +export namespace TransitGatewayAttachment { /** * @internal */ - export const filterSensitiveLog = (obj: VolumeStatusEvent): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayAttachment): any => ({ ...obj, }); } -export type VolumeStatusName = "io-enabled" | "io-performance"; - -/** - *Describes a volume status.
- */ -export interface VolumeStatusDetails { +export interface DescribeTransitGatewayAttachmentsResult { /** - *The name of the volume status.
+ *Information about the attachments.
*/ - Name?: VolumeStatusName | string; + TransitGatewayAttachments?: TransitGatewayAttachment[]; /** - *The intended status of the volume status.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the status of a volume.
- */ -export interface VolumeStatusInfo { - /** - *The details of the volume status.
- */ - Details?: VolumeStatusDetails[]; - - /** - *The status of the volume.
- */ - Status?: VolumeStatusInfoStatus | string; -} - -export namespace VolumeStatusInfo { - /** - * @internal - */ - export const filterSensitiveLog = (obj: VolumeStatusInfo): any => ({ - ...obj, - }); -} - -/** - *Describes the volume status.
- */ -export interface VolumeStatusItem { - /** - *The details of the operation.
- */ - Actions?: VolumeStatusAction[]; - - /** - *The Availability Zone of the volume.
- */ - AvailabilityZone?: string; - +export interface DescribeTransitGatewayConnectPeersRequest { /** - *The Amazon Resource Name (ARN) of the Outpost.
+ *The IDs of the Connect peers.
*/ - OutpostArn?: string; + TransitGatewayConnectPeerIds?: string[]; /** - *A list of events associated with the volume.
+ *One or more filters. The possible values are:
+ *
+ * state - The state of the Connect peer (pending |
+ * available | deleting |
+ * deleted).
+ * transit-gateway-attachment-id - The ID of the attachment.
+ * transit-gateway-connect-peer-id - The ID of the Connect peer.
The volume ID.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The volume status.
+ *The token for the next page of results.
*/ - VolumeStatus?: VolumeStatusInfo; + NextToken?: string; /** - *Information about the instances to which the volume is attached.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token to use to retrieve the next page of results. This value is null
- * when there are no more results to return.
Information about the Connect peers.
*/ - NextToken?: string; + TransitGatewayConnectPeers?: TransitGatewayConnectPeer[]; /** - *Information about the status of the volumes.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the attachments.
+ */ + TransitGatewayAttachmentIds?: string[]; -export interface DescribeVpcAttributeRequest { /** - *The VPC attribute.
+ *One or more filters. The possible values are:
+ *
+ * options.protocol - The tunnel protocol (gre).
+ * state - The state of the attachment (initiating |
+ * initiatingRequest | pendingAcceptance |
+ * rollingBack | pending | available |
+ * modifying | deleting | deleted |
+ * failed | rejected | rejecting |
+ * failing).
+ * transit-gateway-attachment-id - The ID of the
+ * Connect attachment.
+ * transit-gateway-id - The ID of the transit gateway.
+ * transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.
The ID of the VPC.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ */ + NextToken?: string; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -894,136 +783,152 @@ export interface DescribeVpcAttributeRequest { DryRun?: boolean; } -export namespace DescribeVpcAttributeRequest { +export namespace DescribeTransitGatewayConnectsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeTransitGatewayConnectsRequest): any => ({ ...obj, }); } -export interface DescribeVpcAttributeResult { - /** - *
The ID of the VPC.
- */ - VpcId?: string; - +export interface DescribeTransitGatewayConnectsResult { /** - *Indicates whether the instances launched in the VPC get DNS hostnames.
- * If this attribute is true, instances in the VPC get DNS hostnames;
- * otherwise, they do not.
Information about the Connect attachments.
*/ - EnableDnsHostnames?: AttributeBooleanValue; + TransitGatewayConnects?: TransitGatewayConnect[]; /** - *Indicates whether DNS resolution is enabled for
- * the VPC. If this attribute is true, the Amazon DNS server
- * resolves DNS hostnames for your instances to their corresponding
- * IP addresses; otherwise, it does not.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
One or more filters.
- *The ID of the transit gateway multicast domain.
+ */ + TransitGatewayMulticastDomainIds?: string[]; + + /** + *One or more filters. The possible values are:
+ *
- * is-classic-link-enabled - Whether the VPC is enabled for ClassicLink
- * (true | false).
+ * state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * transit-gateway-id - The ID of the transit gateway.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ */ + NextToken?: string; + /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
One or more VPCs for which you want to describe the ClassicLink status.
- */ - VpcIds?: string[]; } -export namespace DescribeVpcClassicLinkRequest { +export namespace DescribeTransitGatewayMulticastDomainsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcClassicLinkRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeTransitGatewayMulticastDomainsRequest): any => ({ ...obj, }); } -/** - *Describes whether a VPC is enabled for ClassicLink.
- */ -export interface VpcClassicLink { - /** - *Indicates whether the VPC is enabled for ClassicLink.
- */ - ClassicLinkEnabled?: boolean; - +export interface DescribeTransitGatewayMulticastDomainsResult { /** - *Any tags assigned to the VPC.
+ *Information about the transit gateway multicast domains.
*/ - Tags?: Tag[]; + TransitGatewayMulticastDomains?: TransitGatewayMulticastDomain[]; /** - *The ID of the VPC.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ClassicLink status of one or more VPCs.
+ *One or more IDs of the transit gateway peering attachments.
*/ - Vpcs?: VpcClassicLink[]; -} + TransitGatewayAttachmentIds?: string[]; -export namespace DescribeVpcClassicLinkResult { /** - * @internal + *One or more filters. The possible values are:
+ *
+ * transit-gateway-attachment-id - The ID of the transit gateway attachment.
+ * local-owner-id - The ID of your Amazon Web Services account.
+ * remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.
+ * state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
+ * transit-gateway-id - The ID of the transit gateway.
The maximum number of results to return with a single call.
* To retrieve the remaining results, make another call with the returned nextToken value.
One or more VPC IDs.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the ClassicLink DNS support status of a VPC.
- */ -export interface ClassicLinkDnsSupport { +export interface DescribeTransitGatewayPeeringAttachmentsResult { /** - *Indicates whether ClassicLink DNS support is enabled for the VPC.
+ *The transit gateway peering attachments.
*/ - ClassicLinkDnsSupported?: boolean; + TransitGatewayPeeringAttachments?: TransitGatewayPeeringAttachment[]; - /** - *The ID of the VPC.
- */ - VpcId?: string; -} - -export namespace ClassicLinkDnsSupport { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ClassicLinkDnsSupport): any => ({ - ...obj, - }); -} - -export interface DescribeVpcClassicLinkDnsSupportResult { /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the ClassicLink DNS support status of the VPCs.
- */ - Vpcs?: ClassicLinkDnsSupport[]; } -export namespace DescribeVpcClassicLinkDnsSupportResult { +export namespace DescribeTransitGatewayPeeringAttachmentsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcClassicLinkDnsSupportResult): any => ({ + export const filterSensitiveLog = (obj: DescribeTransitGatewayPeeringAttachmentsResult): any => ({ ...obj, }); } -export interface DescribeVpcEndpointConnectionNotificationsRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the notification.
+ *The IDs of the transit gateway route tables.
*/ - ConnectionNotificationId?: string; + TransitGatewayRouteTableIds?: string[]; /** - *One or more filters.
- *
- * connection-notification-arn - The ARN of the SNS topic for the
- * notification.
One or more filters. The possible values are:
+ *
- * connection-notification-id - The ID of the
- * notification.
+ * default-association-route-table - Indicates whether this is the default
+ * association route table for the transit gateway (true | false).
- * connection-notification-state - The state of the notification
- * (Enabled | Disabled).
+ * default-propagation-route-table - Indicates whether this is the default
+ * propagation route table for the transit gateway (true | false).
- * connection-notification-type - The type of notification
- * (Topic).
+ * state - The state of the route table (available | deleting | deleted | pending).
- * service-id - The ID of the endpoint service.
+ * transit-gateway-id - The ID of the transit gateway.
- * vpc-endpoint-id - The ID of the VPC endpoint.
+ * transit-gateway-route-table-id - The ID of the transit gateway route table.
The maximum number of results to return in a single call. To retrieve the remaining
- * results, make another request with the returned NextToken value.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token to request the next page of results.
+ *The token for the next page of results.
*/ NextToken?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more notifications.
+ *Information about the transit gateway route tables.
*/ - ConnectionNotificationSet?: ConnectionNotification[]; + TransitGatewayRouteTables?: TransitGatewayRouteTable[]; /** - *The token to use to retrieve the next page of results. This value is
- * null when there are no more results to return.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The IDs of the transit gateways.
*/ - DryRun?: boolean; + TransitGatewayIds?: string[]; /** - *One or more filters.
- *One or more filters. The possible values are:
+ *
- * service-id - The ID of the service.
+ * options.propagation-default-route-table-id - The ID of the default propagation route table.
- * vpc-endpoint-owner - The ID of the Amazon Web Services account ID
- * that owns the endpoint.
options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
*
- * vpc-endpoint-state - The state of the endpoint
- * (pendingAcceptance | pending |
- * available | deleting | deleted |
- * rejected | failed).
+ * options.association-default-route-table-id - The ID of the default association route table.
- * vpc-endpoint-id - The ID of the endpoint.
+ * options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
+ * options.default-route-table-association - Indicates whether resource attachments are automatically
+ * associated with the default association route table (enable | disable).
+ * options.default-route-table-propagation - Indicates whether resource attachments automatically propagate
+ * routes to the default propagation route table (enable | disable).
+ * options.dns-support - Indicates whether DNS support is enabled (enable | disable).
+ * options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
+ * owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
+ * state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
+ * transit-gateway-id - The ID of the transit gateway.
The maximum number of results to return for the request in a single page. The remaining
- * results of the initial request can be seen by sending another request with the returned
- * NextToken value. This value can be between 5 and 1,000; if
- * MaxResults is given a value larger than 1,000, only 1,000 results are
- * returned.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The token to retrieve the next page of results.
+ *The token for the next page of results.
*/ NextToken?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a VPC endpoint connection to a service.
- */ -export interface VpcEndpointConnection { +export interface DescribeTransitGatewaysResult { /** - *The ID of the service to which the endpoint is connected.
+ *Information about the transit gateways.
*/ - ServiceId?: string; + TransitGateways?: TransitGateway[]; /** - *The ID of the VPC endpoint.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Amazon Web Services account that owns the VPC endpoint.
+ * @internal */ - VpcEndpointOwner?: string; + export const filterSensitiveLog = (obj: DescribeTransitGatewaysResult): any => ({ + ...obj, + }); +} +export interface DescribeTransitGatewayVpcAttachmentsRequest { /** - *The state of the VPC endpoint.
+ *The IDs of the attachments.
*/ - VpcEndpointState?: State | string; + TransitGatewayAttachmentIds?: string[]; /** - *The date and time that the VPC endpoint was created.
+ *One or more filters. The possible values are:
+ *
+ * state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
+ * transit-gateway-attachment-id - The ID of the attachment.
+ * transit-gateway-id - The ID of the transit gateway.
+ * vpc-id - The ID of the VPC.
The DNS entries for the VPC endpoint.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The Amazon Resource Names (ARNs) of the network load balancers for the service.
+ *The token for the next page of results.
*/ - NetworkLoadBalancerArns?: string[]; + NextToken?: string; /** - *The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about one or more VPC endpoint connections.
+ *Information about the VPC attachments.
*/ - VpcEndpointConnections?: VpcEndpointConnection[]; + TransitGatewayVpcAttachments?: TransitGatewayVpcAttachment[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for DescribeVpcEndpoints.
- */ -export interface DescribeVpcEndpointsRequest { +export interface DescribeTrunkInterfaceAssociationsRequest { + /** + *The IDs of the associations.
+ */ + AssociationIds?: string[]; + /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -1331,260 +1261,278 @@ export interface DescribeVpcEndpointsRequest {
*/
DryRun?: boolean;
- /**
- *
One or more endpoint IDs.
- */ - VpcEndpointIds?: string[]; - /** *One or more filters.
*
- * service-name - The name of the service.
- * vpc-id - The ID of the VPC in which the endpoint resides.
- * vpc-endpoint-id - The ID of the endpoint.
- * vpc-endpoint-state - The state of the endpoint
- * (pendingAcceptance | pending |
- * available | deleting | deleted |
- * rejected | failed).
gre-key - The ID of a trunk interface association.
*
- * vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
interface-protocol - The interface protocol. Valid values are VLAN and GRE.
*
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
- *Constraint: If the value is greater than 1,000, we return only 1,000 items.
+ *The token for the next page of results.
*/ - MaxResults?: number; + NextToken?: string; /** - *The token for the next set of items to return. (You received this token from a prior call.)
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Contains the output of DescribeVpcEndpoints.
- */ -export interface DescribeVpcEndpointsResult { +export interface DescribeTrunkInterfaceAssociationsResult { /** - *Information about the endpoints.
+ *Information about the trunk associations.
*/ - VpcEndpoints?: VpcEndpoint[]; + InterfaceAssociations?: TrunkInterfaceAssociation[]; /** - *The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The IDs of one or more services.
- */ - ServiceIds?: string[]; +export type VolumeAttributeName = "autoEnableIO" | "productCodes"; +export interface DescribeVolumeAttributeRequest { /** - *One or more filters.
- *
- * service-name - The name of the service.
- * service-id - The ID of the service.
- * service-state - The state of the service (Pending |
- * Available | Deleting | Deleted |
- * Failed).
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The attribute of the volume. This parameter is required.
*/ - Filters?: Filter[]; + Attribute: VolumeAttributeName | string | undefined; /** - *The maximum number of results to return for the request in a single page. The remaining
- * results of the initial request can be seen by sending another request with the returned
- * NextToken value. This value can be between 5 and 1,000; if
- * MaxResults is given a value larger than 1,000, only 1,000 results are
- * returned.
The ID of the volume.
*/ - MaxResults?: number; + VolumeId: string | undefined; /** - *The token to retrieve the next page of results.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about one or more services.
+ *The state of autoEnableIO attribute.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
A list of product codes.
*/ - NextToken?: string; + ProductCodes?: ProductCode[]; + + /** + *The ID of the volume.
+ */ + VolumeId?: string; } -export namespace DescribeVpcEndpointServiceConfigurationsResult { +export namespace DescribeVolumeAttributeResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcEndpointServiceConfigurationsResult): any => ({ + export const filterSensitiveLog = (obj: DescribeVolumeAttributeResult): any => ({ ...obj, }); } -export interface DescribeVpcEndpointServicePermissionsRequest { +export interface DescribeVolumesRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The filters.
+ *
+ * attachment.attach-time - The time stamp when the attachment
+ * initiated.
+ * attachment.delete-on-termination - Whether the volume is deleted on
+ * instance termination.
+ * attachment.device - The device name specified in the block device mapping
+ * (for example, /dev/sda1).
+ * attachment.instance-id - The ID of the instance the volume is attached
+ * to.
+ * attachment.status - The attachment state (attaching |
+ * attached | detaching).
+ * availability-zone - The Availability Zone in which the volume was
+ * created.
+ * create-time - The time stamp when the volume was created.
+ * encrypted - Indicates whether the volume is encrypted (true
+ * | false)
+ * multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true
+ * | false)
+ * fast-restored - Indicates whether the volume was created from a
+ * snapshot that is enabled for fast snapshot restore (true |
+ * false).
+ * size - The size of the volume, in GiB.
+ * snapshot-id - The snapshot from which the volume was created.
+ * status - The state of the volume (creating |
+ * available | in-use | deleting |
+ * deleted | error).
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * volume-id - The volume ID.
+ * volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 |
+ * st1 | sc1| standard)
The ID of the service.
+ *The volume IDs.
*/ - ServiceId: string | undefined; + VolumeIds?: string[]; /** - *One or more filters.
- *
- * principal - The ARN of the principal.
- * principal-type - The principal type (All |
- * Service | OrganizationUnit | Account
- * | User | Role).
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return for the request in a single page. The remaining
- * results of the initial request can be seen by sending another request with the returned
- * NextToken value. This value can be between 5 and 1,000; if
- * MaxResults is given a value larger than 1,000, only 1,000 results are
- * returned.
The maximum number of volume results returned by DescribeVolumes in paginated
+ * output. When this parameter is used, DescribeVolumes only returns
+ * MaxResults results in a single page along with a NextToken
+ * response element. The remaining results of the initial request can be seen by sending another
+ * DescribeVolumes request with the returned NextToken value. This
+ * value can be between 5 and 500; if MaxResults is given a value larger than 500,
+ * only 500 results are returned. If this parameter is not used, then
+ * DescribeVolumes returns all results. You cannot specify this parameter and the
+ * volume IDs parameter in the same request.
The token to retrieve the next page of results.
+ *The NextToken value returned from a previous paginated
+ * DescribeVolumes request where MaxResults was used and the results
+ * exceeded the value of that parameter. Pagination continues from the end of the previous
+ * results that returned the NextToken value. This value is null when
+ * there are no more results to return.
Information about one or more allowed principals.
+ *Information about the volumes.
*/ - AllowedPrincipals?: AllowedPrincipal[]; + Volumes?: Volume[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The NextToken value to include in a future DescribeVolumes
+ * request. When the results of a DescribeVolumes request exceed
+ * MaxResults, this value can be used to retrieve the next page of results. This
+ * value is null when there are no more results to return.
Contains the parameters for DescribeVpcEndpointServices.
- */ -export interface DescribeVpcEndpointServicesRequest { +export interface DescribeVolumesModificationsRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -1593,652 +1541,1086 @@ export interface DescribeVpcEndpointServicesRequest {
DryRun?: boolean;
/**
- *
One or more service names.
+ *The IDs of the volumes.
*/ - ServiceNames?: string[]; + VolumeIds?: string[]; /** - *One or more filters.
- *The filters.
+ *
- * service-name - The name of the service.
+ * modification-state - The current modification state (modifying |
+ * optimizing | completed | failed).
- * service-type - The type of service (Interface |
- * Gateway).
+ * original-iops - The original IOPS rate of the volume.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * original-size - The original size of the volume, in GiB.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * original-volume-type - The original volume type of the volume (standard |
+ * io1 | io2 | gp2 | sc1 | st1).
+ * originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).
+ * start-time - The modification start time.
+ * target-iops - The target IOPS rate of the volume.
+ * target-size - The target size of the volume, in GiB.
+ * target-volume-type - The target volume type of the volume (standard |
+ * io1 | io2 | gp2 | sc1 | st1).
+ * targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).
+ * volume-id - The ID of the volume.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
- *Constraint: If the value is greater than 1,000, we return only 1,000 items.
+ *The nextToken value returned by a previous paginated request.
The token for the next set of items to return. (You received this token from a prior call.)
+ *The maximum number of results (up to a limit of 500) to be returned in a paginated + * request.
*/ - NextToken?: string; + MaxResults?: number; } -export namespace DescribeVpcEndpointServicesRequest { +export namespace DescribeVolumesModificationsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcEndpointServicesRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeVolumesModificationsRequest): any => ({ ...obj, }); } +export type VolumeModificationState = "completed" | "failed" | "modifying" | "optimizing"; + /** - *Information about the Private DNS name for interface endpoints.
+ *Describes the modification status of an EBS volume.
+ *If the volume has never been modified, some element values will be null.
*/ -export interface PrivateDnsDetails { +export interface VolumeModification { /** - *The private DNS name assigned to the VPC endpoint service.
+ *The ID of the volume.
*/ - PrivateDnsName?: string; -} + VolumeId?: string; -export namespace PrivateDnsDetails { /** - * @internal + *The current modification state. The modification state is null for unmodified + * volumes.
*/ - export const filterSensitiveLog = (obj: PrivateDnsDetails): any => ({ - ...obj, - }); -} + ModificationState?: VolumeModificationState | string; -/** - *Describes a VPC endpoint service.
- */ -export interface ServiceDetail { /** - *The Amazon Resource Name (ARN) of the service.
+ *A status message about the modification progress or failure.
*/ - ServiceName?: string; + StatusMessage?: string; /** - *The ID of the endpoint service.
+ *The target size of the volume, in GiB.
*/ - ServiceId?: string; + TargetSize?: number; /** - *The type of service.
+ *The target IOPS rate of the volume.
*/ - ServiceType?: ServiceTypeDetail[]; + TargetIops?: number; /** - *The Availability Zones in which the service is available.
+ *The target EBS volume type of the volume.
*/ - AvailabilityZones?: string[]; + TargetVolumeType?: VolumeType | string; /** - *The Amazon Web Services account ID of the service owner.
+ *The target throughput of the volume, in MiB/s.
*/ - Owner?: string; + TargetThroughput?: number; /** - *The DNS names for the service.
+ *The target setting for Amazon EBS Multi-Attach.
*/ - BaseEndpointDnsNames?: string[]; + TargetMultiAttachEnabled?: boolean; /** - *The private DNS name for the service.
+ *The original size of the volume, in GiB.
*/ - PrivateDnsName?: string; + OriginalSize?: number; /** - *The private DNS names assigned to the VPC endpoint service.
+ *The original IOPS rate of the volume.
*/ - PrivateDnsNames?: PrivateDnsDetails[]; + OriginalIops?: number; /** - *Indicates whether the service supports endpoint policies.
+ *The original EBS volume type of the volume.
*/ - VpcEndpointPolicySupported?: boolean; + OriginalVolumeType?: VolumeType | string; /** - *Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.
+ *The original throughput of the volume, in MiB/s.
*/ - AcceptanceRequired?: boolean; + OriginalThroughput?: number; /** - *Indicates whether the service manages its VPC endpoints. Management of the service VPC - * endpoints using the VPC endpoint API is restricted.
+ *The original setting for Amazon EBS Multi-Attach.
*/ - ManagesVpcEndpoints?: boolean; + OriginalMultiAttachEnabled?: boolean; /** - *Any tags assigned to the service.
+ *The modification progress, from 0 to 100 percent complete.
*/ - Tags?: Tag[]; + Progress?: number; /** - *The verification state of the VPC endpoint service.
- *Consumers of the endpoint service cannot use the private name when the state is not verified.
The modification start time.
*/ - PrivateDnsNameVerificationState?: DnsNameState | string; + StartTime?: Date; + + /** + *The modification completion or failure time.
+ */ + EndTime?: Date; } -export namespace ServiceDetail { +export namespace VolumeModification { /** * @internal */ - export const filterSensitiveLog = (obj: ServiceDetail): any => ({ + export const filterSensitiveLog = (obj: VolumeModification): any => ({ ...obj, }); } -/** - *Contains the output of DescribeVpcEndpointServices.
- */ -export interface DescribeVpcEndpointServicesResult { - /** - *A list of supported services.
- */ - ServiceNames?: string[]; - +export interface DescribeVolumesModificationsResult { /** - *Information about the service.
+ *Information about the volume modifications.
*/ - ServiceDetails?: ServiceDetail[]; + VolumesModifications?: VolumeModification[]; /** - *The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
+ *Token for pagination, null if there are no more results
*/ NextToken?: string; } -export namespace DescribeVpcEndpointServicesResult { +export namespace DescribeVolumesModificationsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcEndpointServicesResult): any => ({ + export const filterSensitiveLog = (obj: DescribeVolumesModificationsResult): any => ({ ...obj, }); } -export interface DescribeVpcPeeringConnectionsRequest { +export interface DescribeVolumeStatusRequest { /** - *One or more filters.
+ *The filters.
*
- * accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter
- * VPC.
action.code - The action code for the event (for example,
+ * enable-volume-io).
*
- * accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the
- * accepter VPC.
action.description - A description of the action.
*
- * accepter-vpc-info.vpc-id - The ID of the accepter VPC.
action.event-id - The event ID associated with the action.
*
- * expiration-time - The expiration date and time for the VPC peering
- * connection.
availability-zone - The Availability Zone of the instance.
*
- * requester-vpc-info.cidr-block - The IPv4 CIDR block of the
- * requester's VPC.
event.description - A description of the event.
*
- * requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the
- * requester VPC.
event.event-id - The event ID.
*
- * requester-vpc-info.vpc-id - The ID of the requester VPC.
event.event-type - The event type (for io-enabled:
+ * passed | failed; for io-performance:
+ * io-performance:degraded | io-performance:severely-degraded |
+ * io-performance:stalled).
*
- * status-code - The status of the VPC peering connection
- * (pending-acceptance | failed |
- * expired | provisioning | active |
- * deleting | deleted |
- * rejected).
event.not-after - The latest end time for the event.
*
- * status-message - A message that provides more information about the status
- * of the VPC peering connection, if applicable.
event.not-before - The earliest start time for the event.
*
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
volume-status.details-name - The cause for
+ * volume-status.status (io-enabled |
+ * io-performance).
*
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-status.details-status - The status of
+ * volume-status.details-name (for io-enabled:
+ * passed | failed; for io-performance:
+ * normal | degraded | severely-degraded |
+ * stalled).
*
- * vpc-peering-connection-id - The ID of the VPC peering connection.
volume-status.status - The status of the volume (ok |
+ * impaired | warning | insufficient-data).
* Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of volume results returned by DescribeVolumeStatus in
+ * paginated output. When this parameter is used, the request only returns
+ * MaxResults results in a single page along with a NextToken
+ * response element. The remaining results of the initial request can be seen by sending another
+ * request with the returned NextToken value. This value can be between 5 and 1,000;
+ * if MaxResults is given a value larger than 1,000, only 1,000 results are returned.
+ * If this parameter is not used, then DescribeVolumeStatus returns all results. You
+ * cannot specify this parameter and the volume IDs parameter in the same request.
One or more VPC peering connection IDs.
- *Default: Describes all your VPC peering connections.
+ *The NextToken value to include in a future DescribeVolumeStatus
+ * request. When the results of the request exceed MaxResults, this value can be
+ * used to retrieve the next page of results. This value is null when there are no
+ * more results to return.
The token for the next page of results.
+ *The IDs of the volumes.
+ *Default: Describes all your volumes.
*/ - NextToken?: string; + VolumeIds?: string[]; + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a volume status operation code.
+ */ +export interface VolumeStatusAction { + /** + *The code identifying the operation, for example, enable-volume-io.
A description of the operation.
+ */ + Description?: string; + + /** + *The ID of the event associated with this operation.
+ */ + EventId?: string; + + /** + *The event type associated with this operation.
+ */ + EventType?: string; +} + +export namespace VolumeStatusAction { + /** + * @internal + */ + export const filterSensitiveLog = (obj: VolumeStatusAction): any => ({ + ...obj, + }); +} + +/** + *Information about the instances to which the volume is attached.
+ */ +export interface VolumeStatusAttachmentStatus { + /** + *The maximum IOPS supported by the attached instance.
+ */ + IoPerformance?: string; + + /** + *The ID of the attached instance.
+ */ + InstanceId?: string; +} + +export namespace VolumeStatusAttachmentStatus { + /** + * @internal + */ + export const filterSensitiveLog = (obj: VolumeStatusAttachmentStatus): any => ({ + ...obj, + }); +} + +/** + *Describes a volume status event.
+ */ +export interface VolumeStatusEvent { + /** + *A description of the event.
+ */ + Description?: string; + + /** + *The ID of this event.
+ */ + EventId?: string; + + /** + *The type of this event.
+ */ + EventType?: string; + + /** + *The latest end time of the event.
+ */ + NotAfter?: Date; + + /** + *The earliest start time of the event.
+ */ + NotBefore?: Date; + + /** + *The ID of the instance associated with the event.
+ */ + InstanceId?: string; +} + +export namespace VolumeStatusEvent { + /** + * @internal + */ + export const filterSensitiveLog = (obj: VolumeStatusEvent): any => ({ + ...obj, + }); +} + +export type VolumeStatusName = "io-enabled" | "io-performance"; + +/** + *Describes a volume status.
+ */ +export interface VolumeStatusDetails { + /** + *The name of the volume status.
+ */ + Name?: VolumeStatusName | string; + + /** + *The intended status of the volume status.
+ */ + Status?: string; +} + +export namespace VolumeStatusDetails { + /** + * @internal + */ + export const filterSensitiveLog = (obj: VolumeStatusDetails): any => ({ + ...obj, + }); +} + +export type VolumeStatusInfoStatus = "impaired" | "insufficient-data" | "ok"; + +/** + *Describes the status of a volume.
+ */ +export interface VolumeStatusInfo { + /** + *The details of the volume status.
+ */ + Details?: VolumeStatusDetails[]; + + /** + *The status of the volume.
+ */ + Status?: VolumeStatusInfoStatus | string; +} + +export namespace VolumeStatusInfo { + /** + * @internal + */ + export const filterSensitiveLog = (obj: VolumeStatusInfo): any => ({ + ...obj, + }); +} + +/** + *Describes the volume status.
+ */ +export interface VolumeStatusItem { + /** + *The details of the operation.
+ */ + Actions?: VolumeStatusAction[]; + + /** + *The Availability Zone of the volume.
+ */ + AvailabilityZone?: string; + + /** + *The Amazon Resource Name (ARN) of the Outpost.
+ */ + OutpostArn?: string; + + /** + *A list of events associated with the volume.
+ */ + Events?: VolumeStatusEvent[]; + + /** + *The volume ID.
+ */ + VolumeId?: string; + + /** + *The volume status.
+ */ + VolumeStatus?: VolumeStatusInfo; + + /** + *Information about the instances to which the volume is attached.
+ */ + AttachmentStatuses?: VolumeStatusAttachmentStatus[]; +} + +export namespace VolumeStatusItem { + /** + * @internal + */ + export const filterSensitiveLog = (obj: VolumeStatusItem): any => ({ + ...obj, + }); +} + +export interface DescribeVolumeStatusResult { + /** + *The token to use to retrieve the next page of results. This value is null
+ * when there are no more results to return.
Information about the status of the volumes.
+ */ + VolumeStatuses?: VolumeStatusItem[]; +} + +export namespace DescribeVolumeStatusResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeVolumeStatusResult): any => ({ + ...obj, + }); +} + +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 ID of the VPC.
+ */ + VpcId?: string; + + /** + *Indicates whether the instances launched in the VPC get DNS hostnames.
+ * If this attribute is true, instances in the VPC get DNS hostnames;
+ * otherwise, they do not.
Indicates whether DNS resolution is enabled for
+ * the VPC. If this attribute is true, the Amazon DNS server
+ * resolves DNS hostnames for your instances to their corresponding
+ * IP addresses; otherwise, it does not.
One or more filters.
+ *
+ * is-classic-link-enabled - Whether the VPC is enabled for ClassicLink
+ * (true | false).
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more VPCs for which you want to describe the ClassicLink status.
+ */ + VpcIds?: string[]; +} + +export namespace DescribeVpcClassicLinkRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeVpcClassicLinkRequest): any => ({ + ...obj, + }); +} + +/** + *Describes whether a VPC is enabled for ClassicLink.
+ */ +export interface VpcClassicLink { + /** + *Indicates whether the VPC is enabled for ClassicLink.
+ */ + ClassicLinkEnabled?: boolean; + + /** + *Any tags assigned to the VPC.
+ */ + Tags?: Tag[]; + + /** + *The ID of the VPC.
+ */ + VpcId?: string; +} + +export namespace VpcClassicLink { + /** + * @internal + */ + export const filterSensitiveLog = (obj: VpcClassicLink): any => ({ + ...obj, + }); +} + +export interface DescribeVpcClassicLinkResult { + /** + *The ClassicLink status of one or more VPCs.
+ */ + Vpcs?: VpcClassicLink[]; +} + +export namespace DescribeVpcClassicLinkResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: DescribeVpcClassicLinkResult): any => ({ + ...obj, + }); +} + +export interface DescribeVpcClassicLinkDnsSupportRequest { /** *The maximum number of results to return with a single call.
* To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ */ + NextToken?: string; + + /** + *One or more VPC IDs.
+ */ + VpcIds?: string[]; } -export namespace DescribeVpcPeeringConnectionsRequest { +export namespace DescribeVpcClassicLinkDnsSupportRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcPeeringConnectionsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeVpcClassicLinkDnsSupportRequest): any => ({ ...obj, }); } -export interface DescribeVpcPeeringConnectionsResult { +/** + *Describes the ClassicLink DNS support status of a VPC.
+ */ +export interface ClassicLinkDnsSupport { /** - *Information about the VPC peering connections.
+ *Indicates whether ClassicLink DNS support is enabled for the VPC.
*/ - VpcPeeringConnections?: VpcPeeringConnection[]; + ClassicLinkDnsSupported?: boolean; + + /** + *The ID of the VPC.
+ */ + VpcId?: string; +} + +export namespace ClassicLinkDnsSupport { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ClassicLinkDnsSupport): any => ({ + ...obj, + }); +} +export interface DescribeVpcClassicLinkDnsSupportResult { /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the ClassicLink DNS support status of the VPCs.
+ */ + Vpcs?: ClassicLinkDnsSupport[]; } -export namespace DescribeVpcPeeringConnectionsResult { +export namespace DescribeVpcClassicLinkDnsSupportResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpcPeeringConnectionsResult): any => ({ + export const filterSensitiveLog = (obj: DescribeVpcClassicLinkDnsSupportResult): any => ({ ...obj, }); } -export interface DescribeVpcsRequest { +export interface DescribeVpcEndpointConnectionNotificationsRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the notification.
+ */ + ConnectionNotificationId?: string; + /** *One or more filters.
*
- * cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you
- * specify must exactly match the VPC's CIDR block for information to be returned
- * for the VPC. Must contain the slash followed by one or two digits (for example,
- * /28).
- * cidr-block-association.cidr-block - An IPv4 CIDR block associated with the
- * VPC.
- * cidr-block-association.association-id - The association ID for
- * an IPv4 CIDR block associated with the VPC.
- * cidr-block-association.state - The state of an IPv4 CIDR block
- * associated with the VPC.
- * dhcp-options-id - The ID of a set of DHCP options.
- * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR
- * block associated with the VPC.
- * ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
- * ipv6-cidr-block-association.association-id - The association
- * ID for an IPv6 CIDR block associated with the VPC.
- * ipv6-cidr-block-association.state - The state of an IPv6 CIDR
- * block associated with the VPC.
- * is-default - Indicates whether the VPC is the default VPC.
connection-notification-arn - The ARN of the SNS topic for the
+ * notification.
*
- * owner-id - The ID of the Amazon Web Services account that owns the VPC.
connection-notification-id - The ID of the
+ * notification.
*
- * state - The state of the VPC (pending | available).
connection-notification-state - The state of the notification
+ * (Enabled | Disabled).
*
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
connection-notification-type - The type of notification
+ * (Topic).
*
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
service-id - The ID of the endpoint service.
*
- * vpc-id - The ID of the VPC.
vpc-endpoint-id - The ID of the VPC endpoint.
* One or more VPC IDs.
- *Default: Describes all your VPCs.
- */ - VpcIds?: string[]; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The maximum number of results to return in a single call. To retrieve the remaining
+ * results, make another request with the returned NextToken value.
The token for the next page of results.
+ *The token to request the next page of results.
*/ NextToken?: string; - - /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Information about one or more VPCs.
+ *One or more notifications.
*/ - Vpcs?: Vpc[]; + ConnectionNotificationSet?: ConnectionNotification[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The token to use to retrieve the next page of results. This value is
+ * null when there are no more results to return.
Contains the parameters for DescribeVpnConnections.
- */ -export interface DescribeVpnConnectionsRequest { +export interface DescribeVpcEndpointConnectionsRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters.
- *
- * customer-gateway-configuration - The configuration information
- * for the customer gateway.
- * customer-gateway-id - The ID of a customer gateway associated
- * with the VPN connection.
- * state - The state of the VPN connection (pending |
- * available | deleting |
- * deleted).
- * option.static-routes-only - Indicates whether the connection has
- * static routes only. Used for devices that do not support Border Gateway Protocol
- * (BGP).
- * route.destination-cidr-block - The destination CIDR block. This
- * corresponds to the subnet used in a customer data center.
- * bgp-asn - The BGP Autonomous System Number (ASN) associated with
- * a BGP device.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * type - The type of VPN connection. Currently the only supported
- * type is ipsec.1.
service-id - The ID of the service.
*
- * vpn-connection-id - The ID of the VPN connection.
+ * vpc-endpoint-owner - The ID of the Amazon Web Services account ID
+ * that owns the endpoint.
- * vpn-gateway-id - The ID of a virtual private gateway associated
- * with the VPN connection.
+ * vpc-endpoint-state - The state of the endpoint
+ * (pendingAcceptance | pending |
+ * available | deleting | deleted |
+ * rejected | failed).
- * transit-gateway-id - The ID of a transit gateway associated with
- * the VPN connection.
+ * vpc-endpoint-id - The ID of the endpoint.
One or more VPN connection IDs.
- *Default: Describes your VPN connections.
+ *The maximum number of results to return for the request in a single page. The remaining
+ * results of the initial request can be seen by sending another request with the returned
+ * NextToken value. This value can be between 5 and 1,000; if
+ * MaxResults is given a value larger than 1,000, only 1,000 results are
+ * returned.
Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The token to retrieve the next page of results.
*/ - DryRun?: boolean; + NextToken?: string; } -export namespace DescribeVpnConnectionsRequest { +export namespace DescribeVpcEndpointConnectionsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpnConnectionsRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeVpcEndpointConnectionsRequest): any => ({ ...obj, }); } /** - *Contains the output of DescribeVpnConnections.
+ *Describes a VPC endpoint connection to a service.
*/ -export interface DescribeVpnConnectionsResult { +export interface VpcEndpointConnection { /** - *Information about one or more VPN connections.
+ *The ID of the service to which the endpoint is connected.
*/ - VpnConnections?: VpnConnection[]; + ServiceId?: string; + + /** + *The ID of the VPC endpoint.
+ */ + VpcEndpointId?: string; + + /** + *The ID of the Amazon Web Services account that owns the VPC endpoint.
+ */ + VpcEndpointOwner?: string; + + /** + *The state of the VPC endpoint.
+ */ + VpcEndpointState?: State | string; + + /** + *The date and time that the VPC endpoint was created.
+ */ + CreationTimestamp?: Date; + + /** + *The DNS entries for the VPC endpoint.
+ */ + DnsEntries?: DnsEntry[]; + + /** + *The Amazon Resource Names (ARNs) of the network load balancers for the service.
+ */ + NetworkLoadBalancerArns?: string[]; + + /** + *The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
+ */ + GatewayLoadBalancerArns?: string[]; } -export namespace DescribeVpnConnectionsResult { +export namespace VpcEndpointConnection { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpnConnectionsResult): any => ({ + export const filterSensitiveLog = (obj: VpcEndpointConnection): any => ({ + ...obj, + }); +} + +export interface DescribeVpcEndpointConnectionsResult { + /** + *Information about one or more VPC endpoint connections.
+ */ + VpcEndpointConnections?: VpcEndpointConnection[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for DescribeVpnGateways.
+ *Contains the parameters for DescribeVpcEndpoints.
*/ -export interface DescribeVpnGatewaysRequest { +export interface DescribeVpcEndpointsRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more endpoint IDs.
+ */ + VpcEndpointIds?: string[]; + /** *One or more filters.
*
- * amazon-side-asn - The Autonomous System Number (ASN) for the
- * Amazon side of the gateway.
service-name - The name of the service.
*
- * attachment.state - The current state of the attachment between
- * the gateway and the VPC (attaching | attached |
- * detaching | detached).
vpc-id - The ID of the VPC in which the endpoint resides.
*
- * attachment.vpc-id - The ID of an attached VPC.
vpc-endpoint-id - The ID of the endpoint.
*
- * availability-zone - The Availability Zone for the virtual private
- * gateway (if applicable).
vpc-endpoint-state - The state of the endpoint
+ * (pendingAcceptance | pending |
+ * available | deleting | deleted |
+ * rejected | failed).
*
- * state - The state of the virtual private gateway
- * (pending | available | deleting |
- * deleted).
vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
*
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ *
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
- * type - The type of virtual private gateway. Currently the only
- * supported type is ipsec.1.
- * vpn-gateway-id - The ID of the virtual private gateway.
One or more virtual private gateway IDs.
- *Default: Describes all your virtual private gateways.
+ *The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
+ *Constraint: If the value is greater than 1,000, we return only 1,000 items.
*/ - VpnGatewayIds?: string[]; + MaxResults?: number; /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The token for the next set of items to return. (You received this token from a prior call.)
*/ - DryRun?: boolean; + NextToken?: string; } -export namespace DescribeVpnGatewaysRequest { +export namespace DescribeVpcEndpointsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpnGatewaysRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeVpcEndpointsRequest): any => ({ ...obj, }); } /** - *Contains the output of DescribeVpnGateways.
+ *Contains the output of DescribeVpcEndpoints.
*/ -export interface DescribeVpnGatewaysResult { +export interface DescribeVpcEndpointsResult { /** - *Information about one or more virtual private gateways.
+ *Information about the endpoints.
*/ - VpnGateways?: VpnGateway[]; + VpcEndpoints?: VpcEndpoint[]; + + /** + *The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
+ */ + NextToken?: string; } -export namespace DescribeVpnGatewaysResult { +export namespace DescribeVpcEndpointsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DescribeVpnGatewaysResult): any => ({ + export const filterSensitiveLog = (obj: DescribeVpcEndpointsResult): any => ({ ...obj, }); } -export interface DetachClassicLinkVpcRequest { +export interface DescribeVpcEndpointServiceConfigurationsRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -2247,599 +2629,778 @@ export interface DetachClassicLinkVpcRequest {
DryRun?: boolean;
/**
- *
The ID of the instance to unlink from the VPC.
- */ - InstanceId: string | undefined; - - /** - *The ID of the VPC to which the instance is linked.
- */ - VpcId: string | undefined; -} - -export namespace DetachClassicLinkVpcRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: DetachClassicLinkVpcRequest): any => ({ - ...obj, - }); -} - -export interface DetachClassicLinkVpcResult { - /** - *Returns true if the request succeeds; otherwise, it returns an error.
The IDs of one or more services.
*/ - export const filterSensitiveLog = (obj: DetachClassicLinkVpcResult): any => ({ - ...obj, - }); -} + ServiceIds?: string[]; -export interface DetachInternetGatewayRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
One or more filters.
+ *
+ * service-name - The name of the service.
+ * service-id - The ID of the service.
+ * service-state - The state of the service (Pending |
+ * Available | Deleting | Deleted |
+ * Failed).
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The ID of the internet gateway.
+ *The maximum number of results to return for the request in a single page. The remaining
+ * results of the initial request can be seen by sending another request with the returned
+ * NextToken value. This value can be between 5 and 1,000; if
+ * MaxResults is given a value larger than 1,000, only 1,000 results are
+ * returned.
The ID of the VPC.
+ *The token to retrieve the next page of results.
*/ - VpcId: string | undefined; + NextToken?: string; } -export namespace DetachInternetGatewayRequest { +export namespace DescribeVpcEndpointServiceConfigurationsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DetachInternetGatewayRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeVpcEndpointServiceConfigurationsRequest): any => ({ ...obj, }); } -/** - *Contains the parameters for DetachNetworkInterface.
- */ -export interface DetachNetworkInterfaceRequest { - /** - *The ID of the attachment.
- */ - AttachmentId: string | undefined; - +export interface DescribeVpcEndpointServiceConfigurationsResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about one or more services.
*/ - DryRun?: boolean; + ServiceConfigurations?: ServiceConfiguration[]; /** - *Specifies whether to force a detachment.
- *Use the Force parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata - * might not get updated. This means that the attributes associated - * with the detached network interface might still be visible. The - * instance metadata will get updated when you stop and start the - * instance.
- *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The device name.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Forces detachment if the previous detachment attempt did not occur cleanly (for example, - * logging into an instance, unmounting the volume, and detaching normally). This option can lead - * to data loss or a corrupted file system. Use this option only as a last resort to detach a - * volume from a failed instance. The instance won't have an opportunity to flush file system - * caches or file system metadata. If you use this option, you must perform file system check and - * repair procedures.
+ *The ID of the service.
*/ - Force?: boolean; + ServiceId: string | undefined; /** - *The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.
+ *One or more filters.
+ *
+ * principal - The ARN of the principal.
+ * principal-type - The principal type (All |
+ * Service | OrganizationUnit | Account
+ * | User | Role).
The ID of the volume.
+ *The maximum number of results to return for the request in a single page. The remaining
+ * results of the initial request can be seen by sending another request with the returned
+ * NextToken value. This value can be between 5 and 1,000; if
+ * MaxResults is given a value larger than 1,000, only 1,000 results are
+ * returned.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The token to retrieve the next page of results.
*/ - DryRun?: boolean; + NextToken?: string; } -export namespace DetachVolumeRequest { +export namespace DescribeVpcEndpointServicePermissionsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DetachVolumeRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeVpcEndpointServicePermissionsRequest): any => ({ ...obj, }); } -/** - *Contains the parameters for DetachVpnGateway.
- */ -export interface DetachVpnGatewayRequest { - /** - *The ID of the VPC.
- */ - VpcId: string | undefined; - +export interface DescribeVpcEndpointServicePermissionsResult { /** - *The ID of the virtual private gateway.
+ *Information about one or more allowed principals.
*/ - VpnGatewayId: string | undefined; + AllowedPrincipals?: AllowedPrincipal[]; /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for DescribeVpcEndpointServices.
+ */ +export interface DescribeVpcEndpointServicesRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
One or more service names.
*/ - export const filterSensitiveLog = (obj: DisableEbsEncryptionByDefaultRequest): any => ({ - ...obj, - }); -} + ServiceNames?: string[]; -export interface DisableEbsEncryptionByDefaultResult { /** - *The updated status of encryption by default.
+ *One or more filters.
+ *
+ * service-name - The name of the service.
+ * service-type - The type of service (Interface |
+ * Gateway).
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
+ *Constraint: If the value is greater than 1,000, we return only 1,000 items.
*/ - export const filterSensitiveLog = (obj: DisableEbsEncryptionByDefaultResult): any => ({ - ...obj, - }); -} + MaxResults?: number; -export interface DisableFastSnapshotRestoresRequest { /** - *One or more Availability Zones. For example, us-east-2a.
The token for the next set of items to return. (You received this token from a prior call.)
*/ - AvailabilityZones: string[] | undefined; + NextToken?: string; +} +export namespace DescribeVpcEndpointServicesRequest { /** - *The IDs of one or more snapshots. For example, snap-1234567890abcdef0.
Information about the Private DNS name for interface endpoints.
+ */ +export interface PrivateDnsDetails { /** - *Checks whether you have the required permissions for the action, without 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 private DNS name assigned to the VPC endpoint service.
*/ - DryRun?: boolean; + PrivateDnsName?: string; } -export namespace DisableFastSnapshotRestoresRequest { +export namespace PrivateDnsDetails { /** * @internal */ - export const filterSensitiveLog = (obj: DisableFastSnapshotRestoresRequest): any => ({ + export const filterSensitiveLog = (obj: PrivateDnsDetails): any => ({ ...obj, }); } /** - *Describes fast snapshot restores that were successfully disabled.
+ *Describes a VPC endpoint service.
*/ -export interface DisableFastSnapshotRestoreSuccessItem { +export interface ServiceDetail { /** - *The ID of the snapshot.
+ *The Amazon Resource Name (ARN) of the service.
*/ - SnapshotId?: string; + ServiceName?: string; /** - *The Availability Zone.
+ *The ID of the endpoint service.
*/ - AvailabilityZone?: string; + ServiceId?: string; /** - *The state of fast snapshot restores for the snapshot.
+ *The type of service.
*/ - State?: FastSnapshotRestoreStateCode | string; + ServiceType?: ServiceTypeDetail[]; /** - *The reason for the state transition. The possible values are as follows:
- *
- * Client.UserInitiated - The state successfully transitioned to enabling or
- * disabling.
- * Client.UserInitiated - Lifecycle state transition - The state successfully transitioned
- * to optimizing, enabled, or disabled.
The Availability Zones in which the service is available.
+ */ + AvailabilityZones?: string[]; + + /** + *The Amazon Web Services account ID of the service owner.
*/ - StateTransitionReason?: string; + Owner?: string; /** - *The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.
+ *The DNS names for the service.
*/ - OwnerId?: string; + BaseEndpointDnsNames?: string[]; /** - *The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
+ *The private DNS name for the service.
*/ - OwnerAlias?: string; + PrivateDnsName?: string; /** - *The time at which fast snapshot restores entered the enabling state.
The private DNS names assigned to the VPC endpoint service.
*/ - EnablingTime?: Date; + PrivateDnsNames?: PrivateDnsDetails[]; /** - *The time at which fast snapshot restores entered the optimizing state.
Indicates whether the service supports endpoint policies.
*/ - OptimizingTime?: Date; + VpcEndpointPolicySupported?: boolean; /** - *The time at which fast snapshot restores entered the enabled state.
Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.
*/ - EnabledTime?: Date; + AcceptanceRequired?: boolean; /** - *The time at which fast snapshot restores entered the disabling state.
Indicates whether the service manages its VPC endpoints. Management of the service VPC + * endpoints using the VPC endpoint API is restricted.
*/ - DisablingTime?: Date; + ManagesVpcEndpoints?: boolean; /** - *The time at which fast snapshot restores entered the disabled state.
Any tags assigned to the service.
*/ - DisabledTime?: Date; + Tags?: Tag[]; + + /** + *The verification state of the VPC endpoint service.
+ *Consumers of the endpoint service cannot use the private name when the state is not verified.
Describes an error that occurred when disabling fast snapshot restores.
+ *Contains the output of DescribeVpcEndpointServices.
*/ -export interface DisableFastSnapshotRestoreStateError { +export interface DescribeVpcEndpointServicesResult { /** - *The error code.
+ *A list of supported services.
*/ - Code?: string; + ServiceNames?: string[]; /** - *The error message.
+ *Information about the service.
*/ - Message?: string; + ServiceDetails?: ServiceDetail[]; + + /** + *The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
+ */ + NextToken?: string; } -export namespace DisableFastSnapshotRestoreStateError { +export namespace DescribeVpcEndpointServicesResult { /** * @internal */ - export const filterSensitiveLog = (obj: DisableFastSnapshotRestoreStateError): any => ({ + export const filterSensitiveLog = (obj: DescribeVpcEndpointServicesResult): any => ({ ...obj, }); } -/** - *Contains information about an error that occurred when disabling fast snapshot restores.
- */ -export interface DisableFastSnapshotRestoreStateErrorItem { +export interface DescribeVpcPeeringConnectionsRequest { /** - *The Availability Zone.
+ *One or more filters.
+ *
+ * accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter
+ * VPC.
+ * accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the
+ * accepter VPC.
+ * accepter-vpc-info.vpc-id - The ID of the accepter VPC.
+ * expiration-time - The expiration date and time for the VPC peering
+ * connection.
+ * requester-vpc-info.cidr-block - The IPv4 CIDR block of the
+ * requester's VPC.
+ * requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the
+ * requester VPC.
+ * requester-vpc-info.vpc-id - The ID of the requester VPC.
+ * status-code - The status of the VPC peering connection
+ * (pending-acceptance | failed |
+ * expired | provisioning | active |
+ * deleting | deleted |
+ * rejected).
+ * status-message - A message that provides more information about the status
+ * of the VPC peering connection, if applicable.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * vpc-peering-connection-id - The ID of the VPC peering connection.
The error.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more VPC peering connection IDs.
+ *Default: Describes all your VPC peering connections.
*/ - export const filterSensitiveLog = (obj: DisableFastSnapshotRestoreStateErrorItem): any => ({ - ...obj, - }); -} + VpcPeeringConnectionIds?: string[]; -/** - *Contains information about the errors that occurred when disabling fast snapshot restores.
- */ -export interface DisableFastSnapshotRestoreErrorItem { /** - *The ID of the snapshot.
+ *The token for the next page of results.
*/ - SnapshotId?: string; + NextToken?: string; /** - *The errors.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Information about the snapshots for which fast snapshot restores were successfully disabled.
+ *Information about the VPC peering connections.
*/ - Successful?: DisableFastSnapshotRestoreSuccessItem[]; + VpcPeeringConnections?: VpcPeeringConnection[]; /** - *Information about the snapshots for which fast snapshot restores could not be disabled.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
One or more filters.
+ *
+ * cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you
+ * specify must exactly match the VPC's CIDR block for information to be returned
+ * for the VPC. Must contain the slash followed by one or two digits (for example,
+ * /28).
+ * cidr-block-association.cidr-block - An IPv4 CIDR block associated with the
+ * VPC.
+ * cidr-block-association.association-id - The association ID for
+ * an IPv4 CIDR block associated with the VPC.
+ * cidr-block-association.state - The state of an IPv4 CIDR block
+ * associated with the VPC.
+ * dhcp-options-id - The ID of a set of DHCP options.
+ * ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR
+ * block associated with the VPC.
+ * ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
+ * ipv6-cidr-block-association.association-id - The association
+ * ID for an IPv6 CIDR block associated with the VPC.
+ * ipv6-cidr-block-association.state - The state of an IPv6 CIDR
+ * block associated with the VPC.
+ * is-default - Indicates whether the VPC is the default VPC.
+ * owner-id - The ID of the Amazon Web Services account that owns the VPC.
+ * state - The state of the VPC (pending | available).
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * vpc-id - The ID of the VPC.
The ID of the AMI.
+ *One or more VPC IDs.
+ *Default: Describes all your VPCs.
*/ - ImageId: string | undefined; + VpcIds?: string[]; /** *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
*/
DryRun?: boolean;
-}
-export namespace DisableImageDeprecationRequest {
/**
- * @internal
+ * The token for the next page of results.
*/ - export const filterSensitiveLog = (obj: DisableImageDeprecationRequest): any => ({ - ...obj, - }); -} + NextToken?: string; -export interface DisableImageDeprecationResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about one or more VPCs.
*/ - export const filterSensitiveLog = (obj: DisableSerialConsoleAccessRequest): any => ({ - ...obj, - }); -} + Vpcs?: Vpc[]; -export interface DisableSerialConsoleAccessResult { /** - *If true, access to the EC2 serial console of all instances is enabled for
- * your account. If false, access to the EC2 serial console of all instances
- * is disabled for your account.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for DescribeVpnConnections.
+ */ +export interface DescribeVpnConnectionsRequest { /** - *The ID of the propagation route table.
+ *One or more filters.
+ *
+ * customer-gateway-configuration - The configuration information
+ * for the customer gateway.
+ * customer-gateway-id - The ID of a customer gateway associated
+ * with the VPN connection.
+ * state - The state of the VPN connection (pending |
+ * available | deleting |
+ * deleted).
+ * option.static-routes-only - Indicates whether the connection has
+ * static routes only. Used for devices that do not support Border Gateway Protocol
+ * (BGP).
+ * route.destination-cidr-block - The destination CIDR block. This
+ * corresponds to the subnet used in a customer data center.
+ * bgp-asn - The BGP Autonomous System Number (ASN) associated with
+ * a BGP device.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * type - The type of VPN connection. Currently the only supported
+ * type is ipsec.1.
+ * vpn-connection-id - The ID of the VPN connection.
+ * vpn-gateway-id - The ID of a virtual private gateway associated
+ * with the VPN connection.
+ * transit-gateway-id - The ID of a transit gateway associated with
+ * the VPN connection.
The ID of the attachment.
+ *One or more VPN connection IDs.
+ *Default: Describes your VPN connections.
*/ - TransitGatewayAttachmentId: string | undefined; + VpnConnectionIds?: string[]; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Describes route propagation.
+ *Contains the output of DescribeVpnConnections.
*/ -export interface TransitGatewayPropagation { - /** - *The ID of the attachment.
- */ - TransitGatewayAttachmentId?: string; - - /** - *The ID of the resource.
- */ - ResourceId?: string; - - /** - *The resource type. Note that the tgw-peering resource type has been deprecated.
The ID of the transit gateway route table.
- */ - TransitGatewayRouteTableId?: string; - - /** - *The state.
- */ - State?: TransitGatewayPropagationState | string; -} - -export namespace TransitGatewayPropagation { - /** - * @internal - */ - export const filterSensitiveLog = (obj: TransitGatewayPropagation): any => ({ - ...obj, - }); -} - -export interface DisableTransitGatewayRouteTablePropagationResult { +export interface DescribeVpnConnectionsResult { /** - *Information about route propagation.
+ *Information about one or more VPN connections.
*/ - Propagation?: TransitGatewayPropagation; + VpnConnections?: VpnConnection[]; } -export namespace DisableTransitGatewayRouteTablePropagationResult { +export namespace DescribeVpnConnectionsResult { /** * @internal */ - export const filterSensitiveLog = (obj: DisableTransitGatewayRouteTablePropagationResult): any => ({ + export const filterSensitiveLog = (obj: DescribeVpnConnectionsResult): any => ({ ...obj, }); } /** - *Contains the parameters for DisableVgwRoutePropagation.
+ *Contains the parameters for DescribeVpnGateways.
*/ -export interface DisableVgwRoutePropagationRequest { +export interface DescribeVpnGatewaysRequest { /** - *The ID of the virtual private gateway.
+ *One or more filters.
+ *
+ * amazon-side-asn - The Autonomous System Number (ASN) for the
+ * Amazon side of the gateway.
+ * attachment.state - The current state of the attachment between
+ * the gateway and the VPC (attaching | attached |
+ * detaching | detached).
+ * attachment.vpc-id - The ID of an attached VPC.
+ * availability-zone - The Availability Zone for the virtual private
+ * gateway (if applicable).
+ * state - The state of the virtual private gateway
+ * (pending | available | deleting |
+ * deleted).
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
+ * type - The type of virtual private gateway. Currently the only
+ * supported type is ipsec.1.
+ * vpn-gateway-id - The ID of the virtual private gateway.
The ID of the route table.
+ *One or more virtual private gateway IDs.
+ *Default: Describes all your virtual private gateways.
*/ - RouteTableId: string | undefined; + VpnGatewayIds?: string[]; /** *Checks whether you have the required permissions for the action, without actually @@ -2850,314 +3411,273 @@ export interface DisableVgwRoutePropagationRequest { DryRun?: boolean; } -export namespace DisableVgwRoutePropagationRequest { +export namespace DescribeVpnGatewaysRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DisableVgwRoutePropagationRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeVpnGatewaysRequest): any => ({ ...obj, }); } -export interface DisableVpcClassicLinkRequest { - /** - *
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Contains the output of DescribeVpnGateways.
+ */ +export interface DescribeVpnGatewaysResult { /** - *The ID of the VPC.
+ *Information about one or more virtual private gateways.
*/ - VpcId: string | undefined; + VpnGateways?: VpnGateway[]; } -export namespace DisableVpcClassicLinkRequest { +export namespace DescribeVpnGatewaysResult { /** * @internal */ - export const filterSensitiveLog = (obj: DisableVpcClassicLinkRequest): any => ({ + export const filterSensitiveLog = (obj: DescribeVpnGatewaysResult): any => ({ ...obj, }); } -export interface DisableVpcClassicLinkResult { +export interface DetachClassicLinkVpcRequest { /** - *Returns true if the request succeeds; otherwise, it returns an error.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the instance to unlink from the VPC.
*/ - export const filterSensitiveLog = (obj: DisableVpcClassicLinkResult): any => ({ - ...obj, - }); -} + InstanceId: string | undefined; -export interface DisableVpcClassicLinkDnsSupportRequest { /** - *The ID of the VPC.
+ *The ID of the VPC to which the instance is linked.
*/ - VpcId?: string; + VpcId: string | undefined; } -export namespace DisableVpcClassicLinkDnsSupportRequest { +export namespace DetachClassicLinkVpcRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DisableVpcClassicLinkDnsSupportRequest): any => ({ + export const filterSensitiveLog = (obj: DetachClassicLinkVpcRequest): any => ({ ...obj, }); } -export interface DisableVpcClassicLinkDnsSupportResult { +export interface DetachClassicLinkVpcResult { /** *Returns true if the request succeeds; otherwise, it returns an error.
[EC2-VPC] The association ID. Required for EC2-VPC.
- */ - AssociationId?: string; - - /** - *[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
- */ - PublicIp?: string; - +export interface DetachInternetGatewayRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the Client VPN endpoint from which to disassociate the target network.
- */ - ClientVpnEndpointId: string | undefined; - - /** - *The ID of the target network association.
- */ - AssociationId: string | undefined; - - /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the target network association.
+ *The ID of the internet gateway.
*/ - AssociationId?: string; + InternetGatewayId: string | undefined; /** - *The current state of the target network association.
+ *The ID of the VPC.
*/ - Status?: AssociationStatus; + VpcId: string | undefined; } -export namespace DisassociateClientVpnTargetNetworkResult { +export namespace DetachInternetGatewayRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DisassociateClientVpnTargetNetworkResult): any => ({ + export const filterSensitiveLog = (obj: DetachInternetGatewayRequest): any => ({ ...obj, }); } -export interface DisassociateEnclaveCertificateIamRoleRequest { +/** + *Contains the parameters for DetachNetworkInterface.
+ */ +export interface DetachNetworkInterfaceRequest { /** - *The ARN of the ACM certificate from which to disassociate the IAM role.
+ *The ID of the attachment.
*/ - CertificateArn?: string; + AttachmentId: string | undefined; /** - *The ARN of the IAM role to disassociate.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Specifies whether to force a detachment.
+ *Use the Force parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata + * might not get updated. This means that the attributes associated + * with the detached network interface might still be visible. The + * instance metadata will get updated when you stop and start the + * instance.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The device name.
*/ - Return?: boolean; -} + Device?: string; -export namespace DisassociateEnclaveCertificateIamRoleResult { /** - * @internal + *Forces detachment if the previous detachment attempt did not occur cleanly (for example, + * logging into an instance, unmounting the volume, and detaching normally). This option can lead + * to data loss or a corrupted file system. Use this option only as a last resort to detach a + * volume from a failed instance. The instance won't have an opportunity to flush file system + * caches or file system metadata. If you use this option, you must perform file system check and + * repair procedures.
*/ - export const filterSensitiveLog = (obj: DisassociateEnclaveCertificateIamRoleResult): any => ({ - ...obj, - }); -} + Force?: boolean; -export interface DisassociateIamInstanceProfileRequest { /** - *The ID of the IAM instance profile association.
+ *The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.
*/ - AssociationId: string | undefined; -} + InstanceId?: string; -export namespace DisassociateIamInstanceProfileRequest { /** - * @internal + *The ID of the volume.
*/ - export const filterSensitiveLog = (obj: DisassociateIamInstanceProfileRequest): any => ({ - ...obj, - }); -} + VolumeId: string | undefined; -export interface DisassociateIamInstanceProfileResult { /** - *Information about the IAM instance profile association.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The targets to disassociate from the specified event window.
+ *Contains the parameters for DetachVpnGateway.
*/ -export interface InstanceEventWindowDisassociationRequest { +export interface DetachVpnGatewayRequest { /** - *The IDs of the instances to disassociate from the event window.
+ *The ID of the VPC.
*/ - InstanceIds?: string[]; + VpcId: string | undefined; /** - *The instance tags to disassociate from the event window. Any instances associated with - * the tags will be disassociated from the event window.
+ *The ID of the virtual private gateway.
*/ - InstanceTags?: Tag[]; + VpnGatewayId: string | undefined; /** - *The IDs of the Dedicated Hosts to disassociate from the event window.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the event window.
- */ - InstanceEventWindowId: string | undefined; - - /** - *One or more targets to disassociate from the specified event window.
- */ - AssociationTarget: InstanceEventWindowDisassociationRequest | undefined; } -export namespace DisassociateInstanceEventWindowRequest { +export namespace DisableEbsEncryptionByDefaultRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DisassociateInstanceEventWindowRequest): any => ({ + export const filterSensitiveLog = (obj: DisableEbsEncryptionByDefaultRequest): any => ({ ...obj, }); } -export interface DisassociateInstanceEventWindowResult { +export interface DisableEbsEncryptionByDefaultResult { /** - *Information about the event window.
+ *The updated status of encryption by default.
*/ - InstanceEventWindow?: InstanceEventWindow; + EbsEncryptionByDefault?: boolean; } -export namespace DisassociateInstanceEventWindowResult { +export namespace DisableEbsEncryptionByDefaultResult { /** * @internal */ - export const filterSensitiveLog = (obj: DisassociateInstanceEventWindowResult): any => ({ + export const filterSensitiveLog = (obj: DisableEbsEncryptionByDefaultResult): any => ({ ...obj, }); } -export interface DisassociateRouteTableRequest { +export interface DisableFastSnapshotRestoresRequest { /** - *The association ID representing the current association between the route table and subnet or gateway.
+ *One or more Availability Zones. For example, us-east-2a.
The IDs of one or more snapshots. For example, snap-1234567890abcdef0.
Checks whether you have the required permissions for the action, without actually making the request, @@ -3167,285 +3687,272 @@ export interface DisassociateRouteTableRequest { DryRun?: boolean; } -export namespace DisassociateRouteTableRequest { +export namespace DisableFastSnapshotRestoresRequest { /** * @internal */ - export const filterSensitiveLog = (obj: DisassociateRouteTableRequest): any => ({ + export const filterSensitiveLog = (obj: DisableFastSnapshotRestoresRequest): any => ({ ...obj, }); } -export interface DisassociateSubnetCidrBlockRequest { +/** + *
Describes fast snapshot restores that were successfully disabled.
+ */ +export interface DisableFastSnapshotRestoreSuccessItem { /** - *The association ID for the CIDR block.
+ *The ID of the snapshot.
*/ - AssociationId: string | undefined; -} + SnapshotId?: string; -export namespace DisassociateSubnetCidrBlockRequest { /** - * @internal + *The Availability Zone.
*/ - export const filterSensitiveLog = (obj: DisassociateSubnetCidrBlockRequest): any => ({ - ...obj, - }); -} + AvailabilityZone?: string; -export interface DisassociateSubnetCidrBlockResult { /** - *Information about the IPv6 CIDR block association.
+ *The state of fast snapshot restores for the snapshot.
*/ - Ipv6CidrBlockAssociation?: SubnetIpv6CidrBlockAssociation; + State?: FastSnapshotRestoreStateCode | string; /** - *The ID of the subnet.
+ *The reason for the state transition. The possible values are as follows:
+ *
+ * Client.UserInitiated - The state successfully transitioned to enabling or
+ * disabling.
+ * Client.UserInitiated - Lifecycle state transition - The state successfully transitioned
+ * to optimizing, enabled, or disabled.
The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.
*/ - export const filterSensitiveLog = (obj: DisassociateSubnetCidrBlockResult): any => ({ - ...obj, - }); -} + OwnerId?: string; -export interface DisassociateTransitGatewayMulticastDomainRequest { /** - *The ID of the transit gateway multicast domain.
+ *The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
*/ - TransitGatewayMulticastDomainId?: string; + OwnerAlias?: string; /** - *The ID of the attachment.
+ *The time at which fast snapshot restores entered the enabling state.
The IDs of the subnets;
+ *The time at which fast snapshot restores entered the optimizing state.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The time at which fast snapshot restores entered the enabled state.
The time at which fast snapshot restores entered the disabling state.
Information about the association.
+ *The time at which fast snapshot restores entered the disabled state.
The ID of the transit gateway route table.
- */ - TransitGatewayRouteTableId: string | undefined; - +/** + *Describes an error that occurred when disabling fast snapshot restores.
+ */ +export interface DisableFastSnapshotRestoreStateError { /** - *The ID of the attachment.
+ *The error code.
*/ - TransitGatewayAttachmentId: string | undefined; + Code?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The error message.
*/ - DryRun?: boolean; + Message?: string; } -export namespace DisassociateTransitGatewayRouteTableRequest { +export namespace DisableFastSnapshotRestoreStateError { /** * @internal */ - export const filterSensitiveLog = (obj: DisassociateTransitGatewayRouteTableRequest): any => ({ + export const filterSensitiveLog = (obj: DisableFastSnapshotRestoreStateError): any => ({ ...obj, }); } -export interface DisassociateTransitGatewayRouteTableResult { +/** + *Contains information about an error that occurred when disabling fast snapshot restores.
+ */ +export interface DisableFastSnapshotRestoreStateErrorItem { /** - *Information about the association.
+ *The Availability Zone.
*/ - Association?: TransitGatewayAssociation; + AvailabilityZone?: string; + + /** + *The error.
+ */ + Error?: DisableFastSnapshotRestoreStateError; } -export namespace DisassociateTransitGatewayRouteTableResult { +export namespace DisableFastSnapshotRestoreStateErrorItem { /** * @internal */ - export const filterSensitiveLog = (obj: DisassociateTransitGatewayRouteTableResult): any => ({ + export const filterSensitiveLog = (obj: DisableFastSnapshotRestoreStateErrorItem): any => ({ ...obj, }); } -export interface DisassociateTrunkInterfaceRequest { - /** - *The ID of the association
- */ - AssociationId: string | undefined; - +/** + *Contains information about the errors that occurred when disabling fast snapshot restores.
+ */ +export interface DisableFastSnapshotRestoreErrorItem { /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to Ensure - * Idempotency.
+ *The ID of the snapshot.
*/ - ClientToken?: string; + SnapshotId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The errors.
*/ - DryRun?: boolean; + FastSnapshotRestoreStateErrors?: DisableFastSnapshotRestoreStateErrorItem[]; } -export namespace DisassociateTrunkInterfaceRequest { +export namespace DisableFastSnapshotRestoreErrorItem { /** * @internal */ - export const filterSensitiveLog = (obj: DisassociateTrunkInterfaceRequest): any => ({ + export const filterSensitiveLog = (obj: DisableFastSnapshotRestoreErrorItem): any => ({ ...obj, }); } -export interface DisassociateTrunkInterfaceResult { +export interface DisableFastSnapshotRestoresResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
Information about the snapshots for which fast snapshot restores were successfully disabled.
*/ - Return?: boolean; + Successful?: DisableFastSnapshotRestoreSuccessItem[]; /** - *Unique, case-sensitive identifier that you provide to ensure the idempotency of the - * request. For more information, see How to Ensure - * Idempotency.
+ *Information about the snapshots for which fast snapshot restores could not be disabled.
*/ - ClientToken?: string; + Unsuccessful?: DisableFastSnapshotRestoreErrorItem[]; } -export namespace DisassociateTrunkInterfaceResult { +export namespace DisableFastSnapshotRestoresResult { /** * @internal */ - export const filterSensitiveLog = (obj: DisassociateTrunkInterfaceResult): any => ({ + export const filterSensitiveLog = (obj: DisableFastSnapshotRestoresResult): any => ({ ...obj, }); } -export interface DisassociateVpcCidrBlockRequest { +export interface DisableImageDeprecationRequest { /** - *The association ID for the CIDR block.
+ *The ID of the AMI.
*/ - AssociationId: string | undefined; + ImageId: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the IPv6 CIDR block association.
- */ - Ipv6CidrBlockAssociation?: VpcIpv6CidrBlockAssociation; - - /** - *Information about the IPv4 CIDR block association.
- */ - CidrBlockAssociation?: VpcCidrBlockAssociation; - +export interface DisableImageDeprecationResult { /** - *The ID of the VPC.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The updated status of encryption by default.
+ *If true, access to the EC2 serial console of all instances is enabled for
+ * your account. If false, access to the EC2 serial console of all instances
+ * is disabled for your account.
One or more Availability Zones. For example, us-east-2a.
The ID of the propagation route table.
*/ - AvailabilityZones: string[] | undefined; + TransitGatewayRouteTableId: string | undefined; /** - *The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify
- * a snapshot that was shared with you from another Amazon Web Services account.
The ID of the attachment.
*/ - SourceSnapshotIds: string[] | undefined; + TransitGatewayAttachmentId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -3455,352 +3962,355 @@ export interface EnableFastSnapshotRestoresRequest { DryRun?: boolean; } -export namespace EnableFastSnapshotRestoresRequest { +export namespace DisableTransitGatewayRouteTablePropagationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EnableFastSnapshotRestoresRequest): any => ({ + export const filterSensitiveLog = (obj: DisableTransitGatewayRouteTablePropagationRequest): any => ({ ...obj, }); } +export type TransitGatewayPropagationState = "disabled" | "disabling" | "enabled" | "enabling"; + /** - *
Describes fast snapshot restores that were successfully enabled.
+ *Describes route propagation.
*/ -export interface EnableFastSnapshotRestoreSuccessItem { +export interface TransitGatewayPropagation { /** - *The ID of the snapshot.
+ *The ID of the attachment.
*/ - SnapshotId?: string; + TransitGatewayAttachmentId?: string; /** - *The Availability Zone.
+ *The ID of the resource.
*/ - AvailabilityZone?: string; + ResourceId?: string; /** - *The state of fast snapshot restores.
+ *The resource type. Note that the tgw-peering resource type has been deprecated.
The reason for the state transition. The possible values are as follows:
- *
- * Client.UserInitiated - The state successfully transitioned to enabling or
- * disabling.
- * Client.UserInitiated - Lifecycle state transition - The state successfully transitioned
- * to optimizing, enabled, or disabled.
The ID of the transit gateway route table.
*/ - StateTransitionReason?: string; + TransitGatewayRouteTableId?: string; /** - *The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.
+ *The state.
*/ - OwnerId?: string; + State?: TransitGatewayPropagationState | string; +} +export namespace TransitGatewayPropagation { /** - *The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
+ * @internal */ - OwnerAlias?: string; + export const filterSensitiveLog = (obj: TransitGatewayPropagation): any => ({ + ...obj, + }); +} +export interface DisableTransitGatewayRouteTablePropagationResult { /** - *The time at which fast snapshot restores entered the enabling state.
Information about route propagation.
*/ - EnablingTime?: Date; + Propagation?: TransitGatewayPropagation; +} +export namespace DisableTransitGatewayRouteTablePropagationResult { /** - *The time at which fast snapshot restores entered the optimizing state.
Contains the parameters for DisableVgwRoutePropagation.
+ */ +export interface DisableVgwRoutePropagationRequest { /** - *The time at which fast snapshot restores entered the enabled state.
The ID of the virtual private gateway.
*/ - EnabledTime?: Date; + GatewayId: string | undefined; /** - *The time at which fast snapshot restores entered the disabling state.
The ID of the route table.
*/ - DisablingTime?: Date; + RouteTableId: string | undefined; /** - *The time at which fast snapshot restores entered the disabled state.
Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Describes an error that occurred when enabling fast snapshot restores.
- */ -export interface EnableFastSnapshotRestoreStateError { +export interface DisableVpcClassicLinkRequest { /** - *The error code.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The error message.
+ *The ID of the VPC.
*/ - Message?: string; + VpcId: string | undefined; } -export namespace EnableFastSnapshotRestoreStateError { +export namespace DisableVpcClassicLinkRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreStateError): any => ({ + export const filterSensitiveLog = (obj: DisableVpcClassicLinkRequest): any => ({ ...obj, }); } -/** - *Contains information about an error that occurred when enabling fast snapshot restores.
- */ -export interface EnableFastSnapshotRestoreStateErrorItem { - /** - *The Availability Zone.
- */ - AvailabilityZone?: string; - +export interface DisableVpcClassicLinkResult { /** - *The error.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Contains information about the errors that occurred when enabling fast snapshot restores.
- */ -export interface EnableFastSnapshotRestoreErrorItem { +export interface DisableVpcClassicLinkDnsSupportRequest { /** - *The ID of the snapshot.
+ *The ID of the VPC.
*/ - SnapshotId?: string; + VpcId?: string; +} +export namespace DisableVpcClassicLinkDnsSupportRequest { /** - *The errors.
+ * @internal */ - FastSnapshotRestoreStateErrors?: EnableFastSnapshotRestoreStateErrorItem[]; + export const filterSensitiveLog = (obj: DisableVpcClassicLinkDnsSupportRequest): any => ({ + ...obj, + }); } -export namespace EnableFastSnapshotRestoreErrorItem { +export interface DisableVpcClassicLinkDnsSupportResult { + /** + *Returns true if the request succeeds; otherwise, it returns an error.
Information about the snapshots for which fast snapshot restores were successfully enabled.
+ *[EC2-VPC] The association ID. Required for EC2-VPC.
*/ - Successful?: EnableFastSnapshotRestoreSuccessItem[]; + AssociationId?: string; /** - *Information about the snapshots for which fast snapshot restores could not be enabled.
+ *[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
*/ - Unsuccessful?: EnableFastSnapshotRestoreErrorItem[]; + PublicIp?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the AMI.
+ *The ID of the Client VPN endpoint from which to disassociate the target network.
*/ - ImageId: string | undefined; + ClientVpnEndpointId: string | undefined; /** - *The date and time to deprecate the AMI, in UTC, in the following format: - * YYYY-MM-DDTHH:MM:SSZ. - * If you specify a value for seconds, Amazon EC2 rounds the seconds to the - * nearest minute.
- *You can’t specify a date in the past. The upper limit for DeprecateAt is 10
- * years from now.
The ID of the target network association.
*/ - DeprecateAt: Date | undefined; + AssociationId: string | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
The ID of the target network association.
*/ - Return?: boolean; + AssociationId?: string; + + /** + *The current state of the target network association.
+ */ + Status?: AssociationStatus; } -export namespace EnableImageDeprecationResult { +export namespace DisassociateClientVpnTargetNetworkResult { /** * @internal */ - export const filterSensitiveLog = (obj: EnableImageDeprecationResult): any => ({ + export const filterSensitiveLog = (obj: DisassociateClientVpnTargetNetworkResult): any => ({ ...obj, }); } -export interface EnableSerialConsoleAccessRequest { +export interface DisassociateEnclaveCertificateIamRoleRequest { + /** + *The ARN of the ACM certificate from which to disassociate the IAM role.
+ */ + CertificateArn?: string; + + /** + *The ARN of the IAM role to disassociate.
+ */ + RoleArn?: string; + /** *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
If true, access to the EC2 serial console of all instances is enabled for
- * your account. If false, access to the EC2 serial console of all instances
- * is disabled for your account.
Returns true if the request succeeds; otherwise, it returns an error.
The ID of the propagation route table.
- */ - TransitGatewayRouteTableId: string | undefined; - - /** - *The ID of the attachment.
- */ - TransitGatewayAttachmentId: string | undefined; - +export interface DisassociateIamInstanceProfileRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the IAM instance profile association.
*/ - DryRun?: boolean; + AssociationId: string | undefined; } -export namespace EnableTransitGatewayRouteTablePropagationRequest { +export namespace DisassociateIamInstanceProfileRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EnableTransitGatewayRouteTablePropagationRequest): any => ({ + export const filterSensitiveLog = (obj: DisassociateIamInstanceProfileRequest): any => ({ ...obj, }); } -export interface EnableTransitGatewayRouteTablePropagationResult { +export interface DisassociateIamInstanceProfileResult { /** - *Information about route propagation.
+ *Information about the IAM instance profile association.
*/ - Propagation?: TransitGatewayPropagation; + IamInstanceProfileAssociation?: IamInstanceProfileAssociation; } -export namespace EnableTransitGatewayRouteTablePropagationResult { +export namespace DisassociateIamInstanceProfileResult { /** * @internal */ - export const filterSensitiveLog = (obj: EnableTransitGatewayRouteTablePropagationResult): any => ({ + export const filterSensitiveLog = (obj: DisassociateIamInstanceProfileResult): any => ({ ...obj, }); } /** - *Contains the parameters for EnableVgwRoutePropagation.
+ *The targets to disassociate from the specified event window.
*/ -export interface EnableVgwRoutePropagationRequest { +export interface InstanceEventWindowDisassociationRequest { /** - *The ID of the virtual private gateway that is attached to a VPC. The virtual private - * gateway must be attached to the same VPC that the routing tables are associated with. - *
+ *The IDs of the instances to disassociate from the event window.
*/ - GatewayId: string | undefined; + InstanceIds?: string[]; /** - *The ID of the route table. The routing table must be associated with the same VPC that - * the virtual private gateway is attached to.
+ *The instance tags to disassociate from the event window. Any instances associated with + * the tags will be disassociated from the event window.
*/ - RouteTableId: string | undefined; + InstanceTags?: Tag[]; /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The IDs of the Dedicated Hosts to disassociate from the event window.
*/ - DryRun?: boolean; + DedicatedHostIds?: string[]; } -export namespace EnableVgwRoutePropagationRequest { +export namespace InstanceEventWindowDisassociationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EnableVgwRoutePropagationRequest): any => ({ + export const filterSensitiveLog = (obj: InstanceEventWindowDisassociationRequest): any => ({ ...obj, }); } -export interface EnableVolumeIORequest { +export interface DisassociateInstanceEventWindowRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -3809,235 +4319,206 @@ export interface EnableVolumeIORequest {
DryRun?: boolean;
/**
- *
The ID of the volume.
- */ - VolumeId: string | undefined; -} - -export namespace EnableVolumeIORequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: EnableVolumeIORequest): any => ({ - ...obj, - }); -} - -export interface EnableVpcClassicLinkRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the event window.
*/ - DryRun?: boolean; + InstanceEventWindowId: string | undefined; /** - *The ID of the VPC.
+ *One or more targets to disassociate from the specified event window.
*/ - VpcId: string | undefined; + AssociationTarget: InstanceEventWindowDisassociationRequest | undefined; } -export namespace EnableVpcClassicLinkRequest { +export namespace DisassociateInstanceEventWindowRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EnableVpcClassicLinkRequest): any => ({ + export const filterSensitiveLog = (obj: DisassociateInstanceEventWindowRequest): any => ({ ...obj, }); } -export interface EnableVpcClassicLinkResult { +export interface DisassociateInstanceEventWindowResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
Information about the event window.
*/ - Return?: boolean; + InstanceEventWindow?: InstanceEventWindow; } -export namespace EnableVpcClassicLinkResult { +export namespace DisassociateInstanceEventWindowResult { /** * @internal */ - export const filterSensitiveLog = (obj: EnableVpcClassicLinkResult): any => ({ + export const filterSensitiveLog = (obj: DisassociateInstanceEventWindowResult): any => ({ ...obj, }); } -export interface EnableVpcClassicLinkDnsSupportRequest { +export interface DisassociateRouteTableRequest { /** - *The ID of the VPC.
+ *The association ID representing the current association between the route table and subnet or gateway.
*/ - VpcId?: string; + AssociationId: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, it returns an error.
The association ID for the CIDR block.
*/ - Return?: boolean; + AssociationId: string | undefined; } -export namespace EnableVpcClassicLinkDnsSupportResult { +export namespace DisassociateSubnetCidrBlockRequest { /** * @internal */ - export const filterSensitiveLog = (obj: EnableVpcClassicLinkDnsSupportResult): any => ({ + export const filterSensitiveLog = (obj: DisassociateSubnetCidrBlockRequest): any => ({ ...obj, }); } -export interface ExportClientVpnClientCertificateRevocationListRequest { +export interface DisassociateSubnetCidrBlockResult { /** - *The ID of the Client VPN endpoint.
+ *Information about the IPv6 CIDR block association.
*/ - ClientVpnEndpointId: string | undefined; + Ipv6CidrBlockAssociation?: SubnetIpv6CidrBlockAssociation; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ID of the subnet.
*/ - DryRun?: boolean; + SubnetId?: string; } -export namespace ExportClientVpnClientCertificateRevocationListRequest { +export namespace DisassociateSubnetCidrBlockResult { /** * @internal */ - export const filterSensitiveLog = (obj: ExportClientVpnClientCertificateRevocationListRequest): any => ({ + export const filterSensitiveLog = (obj: DisassociateSubnetCidrBlockResult): any => ({ ...obj, }); } -export type ClientCertificateRevocationListStatusCode = "active" | "pending"; +export interface DisassociateTransitGatewayMulticastDomainRequest { + /** + *The ID of the transit gateway multicast domain.
+ */ + TransitGatewayMulticastDomainId?: string; -/** - *Describes the state of a client certificate revocation list.
- */ -export interface ClientCertificateRevocationListStatus { /** - *The state of the client certificate revocation list.
+ *The ID of the attachment.
*/ - Code?: ClientCertificateRevocationListStatusCode | string; + TransitGatewayAttachmentId?: string; /** - *A message about the status of the client certificate revocation list, if applicable.
+ *The IDs of the subnets;
*/ - Message?: string; + SubnetIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the client certificate revocation list.
- */ - CertificateRevocationList?: string; - +export interface DisassociateTransitGatewayMulticastDomainResult { /** - *The current state of the client certificate revocation list.
+ *Information about the association.
*/ - Status?: ClientCertificateRevocationListStatus; + Associations?: TransitGatewayMulticastDomainAssociations; } -export namespace ExportClientVpnClientCertificateRevocationListResult { +export namespace DisassociateTransitGatewayMulticastDomainResult { /** * @internal */ - export const filterSensitiveLog = (obj: ExportClientVpnClientCertificateRevocationListResult): any => ({ + export const filterSensitiveLog = (obj: DisassociateTransitGatewayMulticastDomainResult): any => ({ ...obj, }); } -export interface ExportClientVpnClientConfigurationRequest { - /** - *The ID of the Client VPN endpoint.
- */ - ClientVpnEndpointId: string | undefined; - +export interface DisassociateTransitGatewayRouteTableRequest { /** - *Checks whether you have the required permissions for the action, without 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 transit gateway route table.
*/ - DryRun?: boolean; -} + TransitGatewayRouteTableId: string | undefined; -export namespace ExportClientVpnClientConfigurationRequest { /** - * @internal + *The ID of the attachment.
*/ - export const filterSensitiveLog = (obj: ExportClientVpnClientConfigurationRequest): any => ({ - ...obj, - }); -} + TransitGatewayAttachmentId: string | undefined; -export interface ExportClientVpnClientConfigurationResult { /** - *The contents of the Client VPN endpoint configuration file.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the destination for an export image task.
- */ -export interface ExportTaskS3LocationRequest { - /** - *The destination Amazon S3 bucket.
- */ - S3Bucket: string | undefined; - +export interface DisassociateTransitGatewayRouteTableResult { /** - *The prefix (logical hierarchy) in the bucket.
+ *Information about the association.
*/ - S3Prefix?: string; + Association?: TransitGatewayAssociation; } -export namespace ExportTaskS3LocationRequest { +export namespace DisassociateTransitGatewayRouteTableResult { /** * @internal */ - export const filterSensitiveLog = (obj: ExportTaskS3LocationRequest): any => ({ + export const filterSensitiveLog = (obj: DisassociateTransitGatewayRouteTableResult): any => ({ ...obj, }); } -export interface ExportImageRequest { - /** - *Token to enable idempotency for export image requests.
- */ - ClientToken?: string; - +export interface DisassociateTrunkInterfaceRequest { /** - *A description of the image being exported. The maximum length is 255 characters.
+ *The ID of the association
*/ - Description?: string; + AssociationId: string | undefined; /** - *The disk image format.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. For more information, see How to Ensure + * Idempotency.
*/ - DiskImageFormat: DiskImageFormat | string | undefined; + ClientToken?: string; /** *Checks whether you have the required permissions for the action, without actually making the request,
@@ -4045,156 +4526,127 @@ export interface ExportImageRequest {
* Otherwise, it is UnauthorizedOperation.
The ID of the image.
- */ - ImageId: string | undefined; - - /** - *Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE - * and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.
+ * @internal */ - S3ExportLocation: ExportTaskS3LocationRequest | undefined; + export const filterSensitiveLog = (obj: DisassociateTrunkInterfaceRequest): any => ({ + ...obj, + }); +} +export interface DisassociateTrunkInterfaceResult { /** - *The name of the role that grants VM Import/Export permission to export images to your Amazon - * S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The tags to apply to the export image task during creation.
+ *Unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. For more information, see How to Ensure + * Idempotency.
*/ - TagSpecifications?: TagSpecification[]; + ClientToken?: string; } -export namespace ExportImageRequest { +export namespace DisassociateTrunkInterfaceResult { /** * @internal */ - export const filterSensitiveLog = (obj: ExportImageRequest): any => ({ + export const filterSensitiveLog = (obj: DisassociateTrunkInterfaceResult): any => ({ ...obj, }); } -export interface ExportImageResult { - /** - *A description of the image being exported.
- */ - Description?: string; - +export interface DisassociateVpcCidrBlockRequest { /** - *The disk image format for the exported image.
+ *The association ID for the CIDR block.
*/ - DiskImageFormat?: DiskImageFormat | string; + AssociationId: string | undefined; +} +export namespace DisassociateVpcCidrBlockRequest { /** - *The ID of the export image task.
+ * @internal */ - ExportImageTaskId?: string; + export const filterSensitiveLog = (obj: DisassociateVpcCidrBlockRequest): any => ({ + ...obj, + }); +} +export interface DisassociateVpcCidrBlockResult { /** - *The ID of the image.
+ *Information about the IPv6 CIDR block association.
*/ - ImageId?: string; + Ipv6CidrBlockAssociation?: VpcIpv6CidrBlockAssociation; /** - *The name of the role that grants VM Import/Export permission to export images to your Amazon - * S3 bucket.
+ *Information about the IPv4 CIDR block association.
*/ - RoleName?: string; + CidrBlockAssociation?: VpcCidrBlockAssociation; /** - *The percent complete of the export image task.
+ *The ID of the VPC.
*/ - Progress?: string; + VpcId?: string; +} +export namespace DisassociateVpcCidrBlockResult { /** - *Information about the destination Amazon S3 bucket.
+ * @internal */ - S3ExportLocation?: ExportTaskS3Location; + export const filterSensitiveLog = (obj: DisassociateVpcCidrBlockResult): any => ({ + ...obj, + }); +} +export interface EnableEbsEncryptionByDefaultRequest { /** - *The status of the export image task. The possible values are active, completed,
- * deleting, and deleted.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The status message for the export image task.
+ * @internal */ - StatusMessage?: string; + export const filterSensitiveLog = (obj: EnableEbsEncryptionByDefaultRequest): any => ({ + ...obj, + }); +} +export interface EnableEbsEncryptionByDefaultResult { /** - *Any tags assigned to the export image task.
+ *The updated status of encryption by default.
*/ - Tags?: Tag[]; + EbsEncryptionByDefault?: boolean; } -export namespace ExportImageResult { +export namespace EnableEbsEncryptionByDefaultResult { /** * @internal */ - export const filterSensitiveLog = (obj: ExportImageResult): any => ({ + export const filterSensitiveLog = (obj: EnableEbsEncryptionByDefaultResult): any => ({ ...obj, }); } -export interface ExportTransitGatewayRoutesRequest { - /** - *The ID of the route table.
- */ - TransitGatewayRouteTableId: string | undefined; - +export interface EnableFastSnapshotRestoresRequest { /** - *One or more filters. The possible values are:
- *
- * attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
- * attachment.resource-id - The resource id of the transit gateway attachment.
- * route-search.exact-match - The exact match of the specified filter.
- * route-search.longest-prefix-match - The longest prefix that matches the route.
- * route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
- * route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
- * state - The state of the route (active | blackhole).
- * transit-gateway-route-destination-cidr-block - The CIDR range.
- * type - The type of route (propagated |
- * static).
One or more Availability Zones. For example, us-east-2a.
The name of the S3 bucket.
+ *The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify
+ * a snapshot that was shared with you from another Amazon Web Services account.
Checks whether you have the required permissions for the action, without actually making the request, @@ -4204,804 +4656,787 @@ export interface ExportTransitGatewayRoutesRequest { DryRun?: boolean; } -export namespace ExportTransitGatewayRoutesRequest { +export namespace EnableFastSnapshotRestoresRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ExportTransitGatewayRoutesRequest): any => ({ + export const filterSensitiveLog = (obj: EnableFastSnapshotRestoresRequest): any => ({ ...obj, }); } -export interface ExportTransitGatewayRoutesResult { +/** + *
Describes fast snapshot restores that were successfully enabled.
+ */ +export interface EnableFastSnapshotRestoreSuccessItem { /** - *The URL of the exported file in Amazon S3. For example, - * s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.
+ *The ID of the snapshot.
*/ - S3Location?: string; -} + SnapshotId?: string; -export namespace ExportTransitGatewayRoutesResult { /** - * @internal + *The Availability Zone.
*/ - export const filterSensitiveLog = (obj: ExportTransitGatewayRoutesResult): any => ({ - ...obj, - }); -} + AvailabilityZone?: string; -export interface GetAssociatedEnclaveCertificateIamRolesRequest { /** - *The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon - * S3 object information.
+ *The state of fast snapshot restores.
*/ - CertificateArn?: string; + State?: FastSnapshotRestoreStateCode | string; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The reason for the state transition. The possible values are as follows:
+ *
+ * Client.UserInitiated - The state successfully transitioned to enabling or
+ * disabling.
+ * Client.UserInitiated - Lifecycle state transition - The state successfully transitioned
+ * to optimizing, enabled, or disabled.
The ID of the Amazon Web Services account that enabled fast snapshot restores on the snapshot.
*/ - export const filterSensitiveLog = (obj: GetAssociatedEnclaveCertificateIamRolesRequest): any => ({ - ...obj, - }); -} + OwnerId?: string; -/** - *Information about the associated IAM roles.
- */ -export interface AssociatedRole { /** - *The ARN of the associated IAM role.
+ *The Amazon Web Services owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.
*/ - AssociatedRoleArn?: string; + OwnerAlias?: string; /** - *The name of the Amazon S3 bucket in which the Amazon S3 object is stored.
+ *The time at which fast snapshot restores entered the enabling state.
The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle
- * is stored. The object key is formated as follows: role_arn/certificate_arn.
- *
The time at which fast snapshot restores entered the optimizing state.
The ID of the KMS customer master key (CMK) used to encrypt the private key.
+ *The time at which fast snapshot restores entered the enabled state.
The time at which fast snapshot restores entered the disabling state.
Information about the associated IAM roles.
+ *The time at which fast snapshot restores entered the disabled state.
Describes an error that occurred when enabling fast snapshot restores.
+ */ +export interface EnableFastSnapshotRestoreStateError { /** - *The ID of the IPv6 address pool.
+ *The error code.
*/ - PoolId: string | undefined; + Code?: string; /** - *The token for the next page of results.
+ *The error message.
*/ - NextToken?: string; + Message?: string; +} + +export namespace EnableFastSnapshotRestoreStateError { + /** + * @internal + */ + export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreStateError): any => ({ + ...obj, + }); +} +/** + *Contains information about an error that occurred when enabling fast snapshot restores.
+ */ +export interface EnableFastSnapshotRestoreStateErrorItem { /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The Availability Zone.
*/ - MaxResults?: number; + AvailabilityZone?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The error.
*/ - DryRun?: boolean; + Error?: EnableFastSnapshotRestoreStateError; } -export namespace GetAssociatedIpv6PoolCidrsRequest { +export namespace EnableFastSnapshotRestoreStateErrorItem { /** * @internal */ - export const filterSensitiveLog = (obj: GetAssociatedIpv6PoolCidrsRequest): any => ({ + export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreStateErrorItem): any => ({ ...obj, }); } /** - *Describes an IPv6 CIDR block association.
+ *Contains information about the errors that occurred when enabling fast snapshot restores.
*/ -export interface Ipv6CidrAssociation { +export interface EnableFastSnapshotRestoreErrorItem { /** - *The IPv6 CIDR block.
+ *The ID of the snapshot.
*/ - Ipv6Cidr?: string; + SnapshotId?: string; /** - *The resource that's associated with the IPv6 CIDR block.
+ *The errors.
*/ - AssociatedResource?: string; + FastSnapshotRestoreStateErrors?: EnableFastSnapshotRestoreStateErrorItem[]; } -export namespace Ipv6CidrAssociation { +export namespace EnableFastSnapshotRestoreErrorItem { /** * @internal */ - export const filterSensitiveLog = (obj: Ipv6CidrAssociation): any => ({ + export const filterSensitiveLog = (obj: EnableFastSnapshotRestoreErrorItem): any => ({ ...obj, }); } -export interface GetAssociatedIpv6PoolCidrsResult { +export interface EnableFastSnapshotRestoresResult { /** - *Information about the IPv6 CIDR block associations.
+ *Information about the snapshots for which fast snapshot restores were successfully enabled.
*/ - Ipv6CidrAssociations?: Ipv6CidrAssociation[]; + Successful?: EnableFastSnapshotRestoreSuccessItem[]; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the snapshots for which fast snapshot restores could not be enabled.
*/ - NextToken?: string; + Unsuccessful?: EnableFastSnapshotRestoreErrorItem[]; } -export namespace GetAssociatedIpv6PoolCidrsResult { +export namespace EnableFastSnapshotRestoresResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetAssociatedIpv6PoolCidrsResult): any => ({ + export const filterSensitiveLog = (obj: EnableFastSnapshotRestoresResult): any => ({ ...obj, }); } -export interface GetCapacityReservationUsageRequest { - /** - *The ID of the Capacity Reservation.
- */ - CapacityReservationId: string | undefined; - +export interface EnableImageDeprecationRequest { /** - *The token to use to retrieve the next page of results.
+ *The ID of the AMI.
*/ - NextToken?: string; + ImageId: string | undefined; /** - *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Valid range: Minimum value of 1. Maximum value of 1000.
+ *The date and time to deprecate the AMI, in UTC, in the following format: + * YYYY-MM-DDTHH:MM:SSZ. + * If you specify a value for seconds, Amazon EC2 rounds the seconds to the + * nearest minute.
+ *You can’t specify a date in the past. The upper limit for DeprecateAt is 10
+ * years from now.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the Capacity Reservation usage.
- */ -export interface InstanceUsage { +export interface EnableImageDeprecationResult { /** - *The ID of the Amazon Web Services account that is making use of the Capacity Reservation.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The number of instances the Amazon Web Services account currently has in the Capacity Reservation.
+ * @internal */ - UsedInstanceCount?: number; + export const filterSensitiveLog = (obj: EnableImageDeprecationResult): any => ({ + ...obj, + }); } -export namespace InstanceUsage { +export interface EnableSerialConsoleAccessRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
If true, access to the EC2 serial console of all instances is enabled for
+ * your account. If false, access to the EC2 serial console of all instances
+ * is disabled for your account.
The ID of the Capacity Reservation.
+ * @internal */ - CapacityReservationId?: string; + export const filterSensitiveLog = (obj: EnableSerialConsoleAccessResult): any => ({ + ...obj, + }); +} +export interface EnableTransitGatewayRouteTablePropagationRequest { /** - *The type of instance for which the Capacity Reservation reserves capacity.
+ *The ID of the propagation route table.
*/ - InstanceType?: string; + TransitGatewayRouteTableId: string | undefined; /** - *The number of instances for which the Capacity Reservation reserves capacity.
+ *The ID of the attachment.
*/ - TotalInstanceCount?: number; + TransitGatewayAttachmentId: string | undefined; /** - *The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
- *
- * active - The Capacity Reservation is active and the capacity is available for your use.
- * expired - The Capacity Reservation expired automatically at the date and time specified
- * in your request. The reserved capacity is no longer available for your use.
- * cancelled - The Capacity Reservation was cancelled. The reserved capacity is no
- * longer available for your use.
- * pending - The Capacity Reservation request was successful but the capacity
- * provisioning is still pending.
- * failed - The Capacity Reservation request has failed. A request might fail
- * due to invalid request parameters, capacity constraints, or instance limit constraints.
- * Failed requests are retained for 60 minutes.
Information about the Capacity Reservation usage.
+ *Information about route propagation.
*/ - InstanceUsages?: InstanceUsage[]; + Propagation?: TransitGatewayPropagation; } -export namespace GetCapacityReservationUsageResult { +export namespace EnableTransitGatewayRouteTablePropagationResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetCapacityReservationUsageResult): any => ({ + export const filterSensitiveLog = (obj: EnableTransitGatewayRouteTablePropagationResult): any => ({ ...obj, }); } -export interface GetCoipPoolUsageRequest { +/** + *Contains the parameters for EnableVgwRoutePropagation.
+ */ +export interface EnableVgwRoutePropagationRequest { /** - *The ID of the address pool.
+ *The ID of the virtual private gateway that is attached to a VPC. The virtual private + * gateway must be attached to the same VPC that the routing tables are associated with. + *
*/ - PoolId: string | undefined; + GatewayId: string | undefined; /** - *The filters. The following are the possible values:
- *
- * coip-address-usage.allocation-id
- *
- * coip-address-usage.aws-account-id
- *
- * coip-address-usage.aws-service
- *
- * coip-address-usage.co-ip
- *
The ID of the route table. The routing table must be associated with the same VPC that + * the virtual private gateway is attached to.
*/ - Filters?: Filter[]; + RouteTableId: string | undefined; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The token for the next page of results.
+ * @internal */ - NextToken?: string; + export const filterSensitiveLog = (obj: EnableVgwRoutePropagationRequest): any => ({ + ...obj, + }); +} +export interface EnableVolumeIORequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the volume.
+ */ + VolumeId: string | undefined; } -export namespace GetCoipPoolUsageRequest { +export namespace EnableVolumeIORequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetCoipPoolUsageRequest): any => ({ + export const filterSensitiveLog = (obj: EnableVolumeIORequest): any => ({ ...obj, }); } -/** - *Describes address usage for a customer-owned address pool.
- */ -export interface CoipAddressUsage { +export interface EnableVpcClassicLinkRequest { /** - *The allocation ID of the address.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The Amazon Web Services account ID.
+ *The ID of the VPC.
*/ - AwsAccountId?: string; + VpcId: string | undefined; +} +export namespace EnableVpcClassicLinkRequest { /** - *The Amazon Web Services service.
+ * @internal */ - AwsService?: string; + export const filterSensitiveLog = (obj: EnableVpcClassicLinkRequest): any => ({ + ...obj, + }); +} +export interface EnableVpcClassicLinkResult { /** - *The customer-owned IP address.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The ID of the customer-owned address pool.
+ *The ID of the VPC.
*/ - CoipPoolId?: string; + VpcId?: string; +} +export namespace EnableVpcClassicLinkDnsSupportRequest { /** - *Information about the address usage.
+ * @internal */ - CoipAddressUsages?: CoipAddressUsage[]; + export const filterSensitiveLog = (obj: EnableVpcClassicLinkDnsSupportRequest): any => ({ + ...obj, + }); +} +export interface EnableVpcClassicLinkDnsSupportResult { /** - *The ID of the local gateway route table.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The ID of the instance.
+ *The ID of the Client VPN endpoint.
*/ - InstanceId: string | undefined; + ClientVpnEndpointId: string | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
When enabled, retrieves the latest console output for the instance.
- *Default: disabled (false)
The ID of the instance.
- */ - InstanceId?: string; +export type ClientCertificateRevocationListStatusCode = "active" | "pending"; +/** + *Describes the state of a client certificate revocation list.
+ */ +export interface ClientCertificateRevocationListStatus { /** - *The console output, base64-encoded. If you are using a command line tool, the tool - * decodes the output for you.
+ *The state of the client certificate revocation list.
*/ - Output?: string; + Code?: ClientCertificateRevocationListStatusCode | string; /** - *The time at which the output was last updated.
+ *A message about the status of the client certificate revocation list, if applicable.
*/ - Timestamp?: Date; + Message?: string; } -export namespace GetConsoleOutputResult { +export namespace ClientCertificateRevocationListStatus { /** * @internal */ - export const filterSensitiveLog = (obj: GetConsoleOutputResult): any => ({ + export const filterSensitiveLog = (obj: ClientCertificateRevocationListStatus): any => ({ ...obj, }); } -export interface GetConsoleScreenshotRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the instance.
+ *Information about the client certificate revocation list.
*/ - InstanceId: string | undefined; + CertificateRevocationList?: string; /** - *When set to true, acts as keystroke input and wakes up an instance that's
- * in standby or "sleep" mode.
The current state of the client certificate revocation list.
*/ - WakeUp?: boolean; + Status?: ClientCertificateRevocationListStatus; } -export namespace GetConsoleScreenshotRequest { +export namespace ExportClientVpnClientCertificateRevocationListResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetConsoleScreenshotRequest): any => ({ + export const filterSensitiveLog = (obj: ExportClientVpnClientCertificateRevocationListResult): any => ({ ...obj, }); } -export interface GetConsoleScreenshotResult { +export interface ExportClientVpnClientConfigurationRequest { /** - *The data that comprises the image.
+ *The ID of the Client VPN endpoint.
*/ - ImageData?: string; + ClientVpnEndpointId: string | undefined; /** - *The ID of the instance.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The instance family.
+ *The contents of the Client VPN endpoint configuration file.
*/ - InstanceFamily: UnlimitedSupportedInstanceFamily | string | undefined; + ClientConfiguration?: string; } -export namespace GetDefaultCreditSpecificationRequest { +export namespace ExportClientVpnClientConfigurationResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetDefaultCreditSpecificationRequest): any => ({ + export const filterSensitiveLog = (obj: ExportClientVpnClientConfigurationResult): any => ({ ...obj, }); } /** - *Describes the default credit option for CPU usage of a burstable performance instance family.
+ *Describes the destination for an export image task.
*/ -export interface InstanceFamilyCreditSpecification { +export interface ExportTaskS3LocationRequest { /** - *The instance family.
+ *The destination Amazon S3 bucket.
*/ - InstanceFamily?: UnlimitedSupportedInstanceFamily | string; + S3Bucket: string | undefined; /** - *The default credit option for CPU usage of the instance family. Valid values are standard and unlimited.
The prefix (logical hierarchy) in the bucket.
*/ - CpuCredits?: string; + S3Prefix?: string; } -export namespace InstanceFamilyCreditSpecification { +export namespace ExportTaskS3LocationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: InstanceFamilyCreditSpecification): any => ({ + export const filterSensitiveLog = (obj: ExportTaskS3LocationRequest): any => ({ ...obj, }); } -export interface GetDefaultCreditSpecificationResult { +export interface ExportImageRequest { /** - *The default credit option for CPU usage of the instance family.
+ *Token to enable idempotency for export image requests.
*/ - InstanceFamilyCreditSpecification?: InstanceFamilyCreditSpecification; -} + ClientToken?: string; -export namespace GetDefaultCreditSpecificationResult { /** - * @internal + *A description of the image being exported. The maximum length is 255 characters.
*/ - export const filterSensitiveLog = (obj: GetDefaultCreditSpecificationResult): any => ({ - ...obj, - }); -} + Description?: string; + + /** + *The disk image format.
+ */ + DiskImageFormat: DiskImageFormat | string | undefined; -export interface GetEbsDefaultKmsKeyIdRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
The ID of the image.
*/ - export const filterSensitiveLog = (obj: GetEbsDefaultKmsKeyIdRequest): any => ({ - ...obj, - }); -} + ImageId: string | undefined; -export interface GetEbsDefaultKmsKeyIdResult { /** - *The Amazon Resource Name (ARN) of the default KMS key for encryption by default.
+ *Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE + * and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.
*/ - KmsKeyId?: string; -} + S3ExportLocation: ExportTaskS3LocationRequest | undefined; -export namespace GetEbsDefaultKmsKeyIdResult { /** - * @internal + *The name of the role that grants VM Import/Export permission to export images to your Amazon + * S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
*/ - export const filterSensitiveLog = (obj: GetEbsDefaultKmsKeyIdResult): any => ({ - ...obj, - }); -} + RoleName?: string; -export interface GetEbsEncryptionByDefaultRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The tags to apply to the export image task during creation.
*/ - DryRun?: boolean; + TagSpecifications?: TagSpecification[]; } -export namespace GetEbsEncryptionByDefaultRequest { +export namespace ExportImageRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetEbsEncryptionByDefaultRequest): any => ({ + export const filterSensitiveLog = (obj: ExportImageRequest): any => ({ ...obj, }); } -export interface GetEbsEncryptionByDefaultResult { +export interface ExportImageResult { /** - *Indicates whether encryption by default is enabled.
+ *A description of the image being exported.
*/ - EbsEncryptionByDefault?: boolean; -} + Description?: string; -export namespace GetEbsEncryptionByDefaultResult { /** - * @internal + *The disk image format for the exported image.
*/ - export const filterSensitiveLog = (obj: GetEbsEncryptionByDefaultResult): any => ({ - ...obj, - }); -} + DiskImageFormat?: DiskImageFormat | string; -export enum PartitionLoadFrequency { - DAILY = "daily", - MONTHLY = "monthly", - NONE = "none", - WEEKLY = "weekly", -} + /** + *The ID of the export image task.
+ */ + ExportImageTaskId?: string; + + /** + *The ID of the image.
+ */ + ImageId?: string; -/** - *Describes integration options for Amazon Athena.
- */ -export interface AthenaIntegration { /** - *The location in Amazon S3 to store the generated CloudFormation template.
+ *The name of the role that grants VM Import/Export permission to export images to your Amazon + * S3 bucket.
*/ - IntegrationResultS3DestinationArn: string | undefined; + RoleName?: string; /** - *The schedule for adding new partitions to the table.
+ *The percent complete of the export image task.
*/ - PartitionLoadFrequency: PartitionLoadFrequency | string | undefined; + Progress?: string; /** - *The start date for the partition.
+ *Information about the destination Amazon S3 bucket.
*/ - PartitionStartDate?: Date; + S3ExportLocation?: ExportTaskS3Location; /** - *The end date for the partition.
+ *The status of the export image task. The possible values are active, completed,
+ * deleting, and deleted.
The status message for the export image task.
*/ - export const filterSensitiveLog = (obj: AthenaIntegration): any => ({ - ...obj, - }); -} + StatusMessage?: string; -/** - *Describes service integrations with VPC Flow logs.
- */ -export interface IntegrateServices { /** - *Information about the integration with Amazon Athena.
+ *Any tags assigned to the export image task.
*/ - AthenaIntegrations?: AthenaIntegration[]; + Tags?: Tag[]; } -export namespace IntegrateServices { +export namespace ExportImageResult { /** * @internal */ - export const filterSensitiveLog = (obj: IntegrateServices): any => ({ + export const filterSensitiveLog = (obj: ExportImageResult): any => ({ ...obj, }); } -export interface GetFlowLogsIntegrationTemplateRequest { +export interface ExportTransitGatewayRoutesRequest { /** - *Checks whether you have the required permissions for the action, without 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 route table.
*/ - DryRun?: boolean; + TransitGatewayRouteTableId: string | undefined; /** - *The ID of the flow log.
+ *One or more filters. The possible values are:
+ *
+ * attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
+ * attachment.resource-id - The resource id of the transit gateway attachment.
+ * route-search.exact-match - The exact match of the specified filter.
+ * route-search.longest-prefix-match - The longest prefix that matches the route.
+ * route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
+ * route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
+ * state - The state of the route (active | blackhole).
+ * transit-gateway-route-destination-cidr-block - The CIDR range.
+ * type - The type of route (propagated |
+ * static).
To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.
+ *The name of the S3 bucket.
*/ - ConfigDeliveryS3DestinationArn: string | undefined; + S3Bucket: string | undefined; /** - *Information about the service integration.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The generated CloudFormation template.
+ *The URL of the exported file in Amazon S3. For example, + * s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.
*/ - Result?: string; + S3Location?: string; } -export namespace GetFlowLogsIntegrationTemplateResult { +export namespace ExportTransitGatewayRoutesResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetFlowLogsIntegrationTemplateResult): any => ({ + export const filterSensitiveLog = (obj: ExportTransitGatewayRoutesResult): any => ({ ...obj, }); } -export interface GetGroupsForCapacityReservationRequest { - /** - *The ID of the Capacity Reservation.
- */ - CapacityReservationId: string | undefined; - - /** - *The token to use to retrieve the next page of results.
- */ - NextToken?: string; - +export interface GetAssociatedEnclaveCertificateIamRolesRequest { /** - *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon + * S3 object information.
*/ - MaxResults?: number; + CertificateArn?: string; /** *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Describes a resource group to which a Capacity Reservation has been added.
+ *Information about the associated IAM roles.
*/ -export interface CapacityReservationGroup { +export interface AssociatedRole { /** - *The ARN of the resource group.
+ *The ARN of the associated IAM role.
*/ - GroupArn?: string; + AssociatedRoleArn?: string; /** - *The ID of the Amazon Web Services account that owns the resource group.
+ *The name of the Amazon S3 bucket in which the Amazon S3 object is stored.
*/ - OwnerId?: string; + CertificateS3BucketName?: string; + + /** + *The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle
+ * is stored. The object key is formated as follows: role_arn/certificate_arn.
+ *
The ID of the KMS customer master key (CMK) used to encrypt the private key.
+ */ + EncryptionKmsKeyId?: string; } -export namespace CapacityReservationGroup { +export namespace AssociatedRole { /** * @internal */ - export const filterSensitiveLog = (obj: CapacityReservationGroup): any => ({ + export const filterSensitiveLog = (obj: AssociatedRole): any => ({ ...obj, }); } -export interface GetGroupsForCapacityReservationResult { - /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the resource groups to which the Capacity Reservation has been added.
+ *Information about the associated IAM roles.
*/ - CapacityReservationGroups?: CapacityReservationGroup[]; + AssociatedRoles?: AssociatedRole[]; } -export namespace GetGroupsForCapacityReservationResult { +export namespace GetAssociatedEnclaveCertificateIamRolesResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetGroupsForCapacityReservationResult): any => ({ + export const filterSensitiveLog = (obj: GetAssociatedEnclaveCertificateIamRolesResult): any => ({ ...obj, }); } -export interface GetHostReservationPurchasePreviewRequest { +export interface GetAssociatedIpv6PoolCidrsRequest { /** - *The IDs of the Dedicated Hosts with which the reservation is associated.
+ *The ID of the IPv6 address pool.
*/ - HostIdSet: string[] | undefined; + PoolId: string | undefined; /** - *The offering ID of the reservation.
+ *The token for the next page of results.
*/ - OfferingId: string | undefined; + NextToken?: string; + + /** + *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the result of the purchase.
+ *Describes an IPv6 CIDR block association.
*/ -export interface Purchase { - /** - *The currency in which the UpfrontPrice and HourlyPrice
- * amounts are specified. At this time, the only supported currency is
- * USD.
The duration of the reservation's term in seconds.
- */ - Duration?: number; - - /** - *The IDs of the Dedicated Hosts associated with the reservation.
- */ - HostIdSet?: string[]; - +export interface Ipv6CidrAssociation { /** - *The ID of the reservation.
+ *The IPv6 CIDR block.
*/ - HostReservationId?: string; + Ipv6Cidr?: string; /** - *The hourly price of the reservation per hour.
+ *The resource that's associated with the IPv6 CIDR block.
*/ - HourlyPrice?: string; + AssociatedResource?: string; +} +export namespace Ipv6CidrAssociation { /** - *The instance family on the Dedicated Host that the reservation can be associated - * with.
+ * @internal */ - InstanceFamily?: string; + export const filterSensitiveLog = (obj: Ipv6CidrAssociation): any => ({ + ...obj, + }); +} +export interface GetAssociatedIpv6PoolCidrsResult { /** - *The payment option for the reservation.
+ *Information about the IPv6 CIDR block associations.
*/ - PaymentOption?: PaymentOption | string; + Ipv6CidrAssociations?: Ipv6CidrAssociation[]; /** - *The upfront price of the reservation.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The currency in which the totalUpfrontPrice and
- * totalHourlyPrice amounts are specified. At this time, the only
- * supported currency is USD.
The ID of the Capacity Reservation.
*/ - CurrencyCode?: CurrencyCodeValues | string; + CapacityReservationId: string | undefined; /** - *The purchase information of the Dedicated Host reservation and the Dedicated Hosts - * associated with it.
+ *The token to use to retrieve the next page of results.
*/ - Purchase?: Purchase[]; + NextToken?: string; /** - *The potential total hourly price of the reservation per hour.
+ *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Valid range: Minimum value of 1. Maximum value of 1000.
*/ - TotalHourlyPrice?: string; + MaxResults?: number; /** - *The potential total upfront price. This is billed immediately.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the Capacity Reservation usage.
+ */ +export interface InstanceUsage { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The ID of the Amazon Web Services account that is making use of the Capacity Reservation.
*/ - DryRun?: boolean; + AccountId?: string; /** - *The ID of the instance.
+ *The number of instances the Amazon Web Services account currently has in the Capacity Reservation.
*/ - InstanceId: string | undefined; + UsedInstanceCount?: number; } -export namespace GetLaunchTemplateDataRequest { +export namespace InstanceUsage { /** * @internal */ - export const filterSensitiveLog = (obj: GetLaunchTemplateDataRequest): any => ({ + export const filterSensitiveLog = (obj: InstanceUsage): any => ({ ...obj, }); } -export interface GetLaunchTemplateDataResult { +export interface GetCapacityReservationUsageResult { /** - *The instance data.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the Capacity Reservation.
+ */ + CapacityReservationId?: string; + + /** + *The type of instance for which the Capacity Reservation reserves capacity.
+ */ + InstanceType?: string; + + /** + *The number of instances for which the Capacity Reservation reserves capacity.
+ */ + TotalInstanceCount?: number; + + /** + *The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
+ */ + AvailableInstanceCount?: number; + + /** + *The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
+ *
+ * active - The Capacity Reservation is active and the capacity is available for your use.
+ * expired - The Capacity Reservation expired automatically at the date and time specified
+ * in your request. The reserved capacity is no longer available for your use.
+ * cancelled - The Capacity Reservation was cancelled. The reserved capacity is no
+ * longer available for your use.
+ * pending - The Capacity Reservation request was successful but the capacity
+ * provisioning is still pending.
+ * failed - The Capacity Reservation request has failed. A request might fail
+ * due to invalid request parameters, capacity constraints, or instance limit constraints.
+ * Failed requests are retained for 60 minutes.
Information about the Capacity Reservation usage.
+ */ + InstanceUsages?: InstanceUsage[]; } -export namespace GetLaunchTemplateDataResult { +export namespace GetCapacityReservationUsageResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetLaunchTemplateDataResult): any => ({ + export const filterSensitiveLog = (obj: GetCapacityReservationUsageResult): any => ({ ...obj, }); } -export interface GetManagedPrefixListAssociationsRequest { +export interface GetCoipPoolUsageRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the address pool.
*/ - DryRun?: boolean; + PoolId: string | undefined; /** - *The ID of the prefix list.
+ *The filters. The following are the possible values:
+ *
+ * coip-address-usage.allocation-id
+ *
+ * coip-address-usage.aws-account-id
+ *
+ * coip-address-usage.aws-service
+ *
+ * coip-address-usage.co-ip
+ *
The maximum number of results to return with a single call. @@ -5238,63 +5762,90 @@ export interface GetManagedPrefixListAssociationsRequest { *
The token for the next page of results.
*/ NextToken?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the resource with which a prefix list is associated.
+ *Describes address usage for a customer-owned address pool.
*/ -export interface PrefixListAssociation { +export interface CoipAddressUsage { /** - *The ID of the resource.
+ *The allocation ID of the address.
*/ - ResourceId?: string; + AllocationId?: string; /** - *The owner of the resource.
+ *The Amazon Web Services account ID.
*/ - ResourceOwner?: string; + AwsAccountId?: string; + + /** + *The Amazon Web Services service.
+ */ + AwsService?: string; + + /** + *The customer-owned IP address.
+ */ + CoIp?: string; } -export namespace PrefixListAssociation { +export namespace CoipAddressUsage { /** * @internal */ - export const filterSensitiveLog = (obj: PrefixListAssociation): any => ({ + export const filterSensitiveLog = (obj: CoipAddressUsage): any => ({ ...obj, }); } -export interface GetManagedPrefixListAssociationsResult { +export interface GetCoipPoolUsageResult { /** - *Information about the associations.
+ *The ID of the customer-owned address pool.
*/ - PrefixListAssociations?: PrefixListAssociation[]; + CoipPoolId?: string; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the address usage.
*/ - NextToken?: string; + CoipAddressUsages?: CoipAddressUsage[]; + + /** + *The ID of the local gateway route table.
+ */ + LocalGatewayRouteTableId?: string; } -export namespace GetManagedPrefixListAssociationsResult { +export namespace GetCoipPoolUsageResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetManagedPrefixListAssociationsResult): any => ({ + export const filterSensitiveLog = (obj: GetCoipPoolUsageResult): any => ({ ...obj, }); } -export interface GetManagedPrefixListEntriesRequest { +export interface GetConsoleOutputRequest { + /** + *The ID of the instance.
+ */ + InstanceId: 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.
@@ -5303,701 +5854,665 @@ export interface GetManagedPrefixListEntriesRequest {
DryRun?: boolean;
/**
- *
The ID of the prefix list.
- */ - PrefixListId: string | undefined; - - /** - *The version of the prefix list for which to return the entries. The default is the current version.
- */ - TargetVersion?: number; - - /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ *When enabled, retrieves the latest console output for the instance.
+ *Default: disabled (false)
Describes a prefix list entry.
- */ -export interface PrefixListEntry { +export interface GetConsoleOutputResult { /** - *The CIDR block.
+ *The ID of the instance.
+ */ + InstanceId?: string; + + /** + *The console output, base64-encoded. If you are using a command line tool, the tool + * decodes the output for you.
*/ - Cidr?: string; + Output?: string; /** - *The description.
+ *The time at which the output was last updated.
*/ - Description?: string; + Timestamp?: Date; } -export namespace PrefixListEntry { +export namespace GetConsoleOutputResult { /** * @internal */ - export const filterSensitiveLog = (obj: PrefixListEntry): any => ({ + export const filterSensitiveLog = (obj: GetConsoleOutputResult): any => ({ ...obj, }); } -export interface GetManagedPrefixListEntriesResult { +export interface GetConsoleScreenshotRequest { /** - *Information about the prefix list entries.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the instance.
*/ - NextToken?: string; + InstanceId: string | undefined; + + /** + *When set to true, acts as keystroke input and wakes up an instance that's
+ * in standby or "sleep" mode.
The ID of the Windows instance.
+ *The data that comprises the image.
*/ - InstanceId: string | undefined; + ImageData?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the instance.
*/ - DryRun?: boolean; + InstanceId?: string; } -export namespace GetPasswordDataRequest { +export namespace GetConsoleScreenshotResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetPasswordDataRequest): any => ({ + export const filterSensitiveLog = (obj: GetConsoleScreenshotResult): any => ({ ...obj, }); } -export interface GetPasswordDataResult { - /** - *The ID of the Windows instance.
- */ - InstanceId?: string; +export type UnlimitedSupportedInstanceFamily = "t2" | "t3" | "t3a" | "t4g"; +export interface GetDefaultCreditSpecificationRequest { /** - *The password of the instance. Returns an empty string if the password is not - * available.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The time the data was last updated.
+ *The instance family.
*/ - Timestamp?: Date; + InstanceFamily: UnlimitedSupportedInstanceFamily | string | undefined; } -export namespace GetPasswordDataResult { +export namespace GetDefaultCreditSpecificationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetPasswordDataResult): any => ({ + export const filterSensitiveLog = (obj: GetDefaultCreditSpecificationRequest): any => ({ ...obj, }); } /** - *Contains the parameters for GetReservedInstanceExchangeQuote.
+ *Describes the default credit option for CPU usage of a burstable performance instance family.
*/ -export interface GetReservedInstancesExchangeQuoteRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The IDs of the Convertible Reserved Instances to exchange.
+ *The instance family.
*/ - ReservedInstanceIds: string[] | undefined; + InstanceFamily?: UnlimitedSupportedInstanceFamily | string; /** - *The configuration of the target Convertible Reserved Instance to exchange for your - * current Convertible Reserved Instances.
+ *The default credit option for CPU usage of the instance family. Valid values are standard and unlimited.
The cost associated with the Reserved Instance.
- */ -export interface ReservationValue { +export interface GetDefaultCreditSpecificationResult { /** - *The hourly rate of the reservation.
+ *The default credit option for CPU usage of the instance family.
*/ - HourlyPrice?: string; + InstanceFamilyCreditSpecification?: InstanceFamilyCreditSpecification; +} +export namespace GetDefaultCreditSpecificationResult { /** - *The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
+ * @internal */ - RemainingTotalValue?: string; + export const filterSensitiveLog = (obj: GetDefaultCreditSpecificationResult): any => ({ + ...obj, + }); +} +export interface GetEbsDefaultKmsKeyIdRequest { /** - *The remaining upfront cost of the reservation.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The total value of the Convertible Reserved Instance.
- */ -export interface ReservedInstanceReservationValue { - /** - *The total value of the Convertible Reserved Instance that you are exchanging.
- */ - ReservationValue?: ReservationValue; - +export interface GetEbsDefaultKmsKeyIdResult { /** - *The ID of the Convertible Reserved Instance that you are exchanging.
+ *The Amazon Resource Name (ARN) of the default KMS key for encryption by default.
*/ - ReservedInstanceId?: string; + KmsKeyId?: string; } -export namespace ReservedInstanceReservationValue { +export namespace GetEbsDefaultKmsKeyIdResult { /** * @internal */ - export const filterSensitiveLog = (obj: ReservedInstanceReservationValue): any => ({ + export const filterSensitiveLog = (obj: GetEbsDefaultKmsKeyIdResult): any => ({ ...obj, }); } -/** - *Information about the Convertible Reserved Instance offering.
- */ -export interface TargetConfiguration { - /** - *The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is - * reserved and cannot be specified in a request
- */ - InstanceCount?: number; - +export interface GetEbsEncryptionByDefaultRequest { /** - *The ID of the Convertible Reserved Instance offering.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The total value of the new Convertible Reserved Instances.
- */ -export interface TargetReservationValue { - /** - *The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of - * the list value, remaining upfront price, and additional upfront cost of the exchange.
- */ - ReservationValue?: ReservationValue; - +export interface GetEbsEncryptionByDefaultResult { /** - *The configuration of the Convertible Reserved Instances that make up the exchange.
+ *Indicates whether encryption by default is enabled.
*/ - TargetConfiguration?: TargetConfiguration; + EbsEncryptionByDefault?: boolean; } -export namespace TargetReservationValue { +export namespace GetEbsEncryptionByDefaultResult { /** * @internal */ - export const filterSensitiveLog = (obj: TargetReservationValue): any => ({ + export const filterSensitiveLog = (obj: GetEbsEncryptionByDefaultResult): any => ({ ...obj, }); } +export enum PartitionLoadFrequency { + DAILY = "daily", + MONTHLY = "monthly", + NONE = "none", + WEEKLY = "weekly", +} + /** - *Contains the output of GetReservedInstancesExchangeQuote.
+ *Describes integration options for Amazon Athena.
*/ -export interface GetReservedInstancesExchangeQuoteResult { +export interface AthenaIntegration { /** - *The currency of the transaction.
+ *The location in Amazon S3 to store the generated CloudFormation template.
*/ - CurrencyCode?: string; + IntegrationResultS3DestinationArn: string | undefined; /** - *If true, the exchange is valid. If false, the exchange cannot be completed.
The schedule for adding new partitions to the table.
*/ - IsValidExchange?: boolean; + PartitionLoadFrequency: PartitionLoadFrequency | string | undefined; /** - *The new end date of the reservation term.
+ *The start date for the partition.
*/ - OutputReservedInstancesWillExpireAt?: Date; + PartitionStartDate?: Date; /** - *The total true upfront charge for the exchange.
+ *The end date for the partition.
*/ - PaymentDue?: string; + PartitionEndDate?: Date; +} +export namespace AthenaIntegration { /** - *The cost associated with the Reserved Instance.
+ * @internal */ - ReservedInstanceValueRollup?: ReservationValue; + export const filterSensitiveLog = (obj: AthenaIntegration): any => ({ + ...obj, + }); +} +/** + *Describes service integrations with VPC Flow logs.
+ */ +export interface IntegrateServices { /** - *The configuration of your Convertible Reserved Instances.
+ *Information about the integration with Amazon Athena.
*/ - ReservedInstanceValueSet?: ReservedInstanceReservationValue[]; + AthenaIntegrations?: AthenaIntegration[]; +} +export namespace IntegrateServices { /** - *The cost associated with the Reserved Instance.
+ * @internal */ - TargetConfigurationValueRollup?: ReservationValue; + export const filterSensitiveLog = (obj: IntegrateServices): any => ({ + ...obj, + }); +} +export interface GetFlowLogsIntegrationTemplateRequest { /** - *The values of the target Convertible Reserved Instances.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes the reason why the exchange cannot be completed.
+ *The ID of the flow log.
*/ - ValidationFailureReason?: string; + FlowLogId: string | undefined; + + /** + *To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.
+ */ + ConfigDeliveryS3DestinationArn: string | undefined; + + /** + *Information about the service integration.
+ */ + IntegrateServices: IntegrateServices | undefined; } -export namespace GetReservedInstancesExchangeQuoteResult { +export namespace GetFlowLogsIntegrationTemplateRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetReservedInstancesExchangeQuoteResult): any => ({ + export const filterSensitiveLog = (obj: GetFlowLogsIntegrationTemplateRequest): any => ({ ...obj, }); } -export interface GetSerialConsoleAccessStatusRequest { +export interface GetFlowLogsIntegrationTemplateResult { /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The generated CloudFormation template.
*/ - DryRun?: boolean; + Result?: string; } -export namespace GetSerialConsoleAccessStatusRequest { +export namespace GetFlowLogsIntegrationTemplateResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetSerialConsoleAccessStatusRequest): any => ({ + export const filterSensitiveLog = (obj: GetFlowLogsIntegrationTemplateResult): any => ({ ...obj, }); } -export interface GetSerialConsoleAccessStatusResult { +export interface GetGroupsForCapacityReservationRequest { /** - *If true, access to the EC2 serial console of all instances is enabled for
- * your account. If false, access to the EC2 serial console of all instances
- * is disabled for your account.
The ID of the Capacity Reservation.
*/ - SerialConsoleAccessEnabled?: boolean; + CapacityReservationId: string | undefined; + + /** + *The token to use to retrieve the next page of results.
+ */ + NextToken?: string; + + /** + *The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Describes a resource group to which a Capacity Reservation has been added.
+ */ +export interface CapacityReservationGroup { /** - *One or more filters.
- *
- * reservationType - The type of reservation (prefix |
- * explicit).
- * subnet-id - The ID of the subnet.
- * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The ARN of the resource group.
*/ - Filters?: Filter[]; + GroupArn?: string; /** - *The ID of the subnet.
+ *The ID of the Amazon Web Services account that owns the resource group.
*/ - SubnetId: string | undefined; + OwnerId?: string; +} +export namespace CapacityReservationGroup { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
Information about the resource groups to which the Capacity Reservation has been added.
*/ - MaxResults?: number; + CapacityReservationGroups?: CapacityReservationGroup[]; } -export namespace GetSubnetCidrReservationsRequest { +export namespace GetGroupsForCapacityReservationResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetSubnetCidrReservationsRequest): any => ({ + export const filterSensitiveLog = (obj: GetGroupsForCapacityReservationResult): any => ({ ...obj, }); } -export interface GetSubnetCidrReservationsResult { - /** - *Information about the IPv4 subnet CIDR reservations.
- */ - SubnetIpv4CidrReservations?: SubnetCidrReservation[]; - +export interface GetHostReservationPurchasePreviewRequest { /** - *Information about the IPv6 subnet CIDR reservations.
+ *The IDs of the Dedicated Hosts with which the reservation is associated.
*/ - SubnetIpv6CidrReservations?: SubnetCidrReservation[]; + HostIdSet: string[] | undefined; /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The offering ID of the reservation.
*/ - NextToken?: string; + OfferingId: string | undefined; } -export namespace GetSubnetCidrReservationsResult { +export namespace GetHostReservationPurchasePreviewRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetSubnetCidrReservationsResult): any => ({ + export const filterSensitiveLog = (obj: GetHostReservationPurchasePreviewRequest): any => ({ ...obj, }); } -export interface GetTransitGatewayAttachmentPropagationsRequest { +/** + *Describes the result of the purchase.
+ */ +export interface Purchase { /** - *The ID of the attachment.
+ *The currency in which the UpfrontPrice and HourlyPrice
+ * amounts are specified. At this time, the only supported currency is
+ * USD.
One or more filters. The possible values are:
- *
- * transit-gateway-route-table-id - The ID of the transit gateway route table.
The duration of the reservation's term in seconds.
*/ - Filters?: Filter[]; + Duration?: number; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The IDs of the Dedicated Hosts associated with the reservation.
*/ - MaxResults?: number; + HostIdSet?: string[]; /** - *The token for the next page of results.
+ *The ID of the reservation.
*/ - NextToken?: string; + HostReservationId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The hourly price of the reservation per hour.
*/ - DryRun?: boolean; -} + HourlyPrice?: string; -export namespace GetTransitGatewayAttachmentPropagationsRequest { /** - * @internal + *The instance family on the Dedicated Host that the reservation can be associated + * with.
*/ - export const filterSensitiveLog = (obj: GetTransitGatewayAttachmentPropagationsRequest): any => ({ - ...obj, - }); -} + InstanceFamily?: string; -/** - *Describes a propagation route table.
- */ -export interface TransitGatewayAttachmentPropagation { /** - *The ID of the propagation route table.
+ *The payment option for the reservation.
*/ - TransitGatewayRouteTableId?: string; + PaymentOption?: PaymentOption | string; /** - *The state of the propagation route table.
+ *The upfront price of the reservation.
*/ - State?: TransitGatewayPropagationState | string; + UpfrontPrice?: string; } -export namespace TransitGatewayAttachmentPropagation { +export namespace Purchase { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayAttachmentPropagation): any => ({ + export const filterSensitiveLog = (obj: Purchase): any => ({ ...obj, }); } -export interface GetTransitGatewayAttachmentPropagationsResult { +export interface GetHostReservationPurchasePreviewResult { /** - *Information about the propagation route tables.
+ *The currency in which the totalUpfrontPrice and
+ * totalHourlyPrice amounts are specified. At this time, the only
+ * supported currency is USD.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The purchase information of the Dedicated Host reservation and the Dedicated Hosts + * associated with it.
*/ - NextToken?: string; + Purchase?: Purchase[]; + + /** + *The potential total hourly price of the reservation per hour.
+ */ + TotalHourlyPrice?: string; + + /** + *The potential total upfront price. This is billed immediately.
+ */ + TotalUpfrontPrice?: string; } -export namespace GetTransitGatewayAttachmentPropagationsResult { +export namespace GetHostReservationPurchasePreviewResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayAttachmentPropagationsResult): any => ({ + export const filterSensitiveLog = (obj: GetHostReservationPurchasePreviewResult): any => ({ ...obj, }); } -export interface GetTransitGatewayMulticastDomainAssociationsRequest { +export interface GetInstanceTypesFromInstanceRequirementsRequest { /** - *The ID of the transit gateway multicast domain.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters. The possible values are:
- *
- * resource-id - The ID of the resource.
- * resource-type - The type of resource. The valid value is: vpc.
- * state - The state of the subnet association. Valid values are
- * associated |
- * associating
- * | disassociated | disassociating.
- * subnet-id - The ID of the subnet.
- * transit-gateway-attachment-id - The id of the transit gateway attachment.
The processor architecture type.
*/ - Filters?: Filter[]; + ArchitectureTypes: (ArchitectureType | string)[] | undefined; /** - *The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The virtualization type.
+ */ + VirtualizationTypes: (VirtualizationType | string)[] | undefined; + + /** + *The attributes required for the instance types.
+ */ + InstanceRequirements: InstanceRequirementsRequest | undefined; + + /** + *The maximum number of results to return in a single call. Specify a value between 1 and
+ * 1000. The default value is 1000. To retrieve the remaining results, make another call with
+ * the returned NextToken value.
The token for the next page of results.
+ *The token for the next set of results.
*/ NextToken?: string; +} + +export namespace GetInstanceTypesFromInstanceRequirementsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: GetInstanceTypesFromInstanceRequirementsRequest): any => ({ + ...obj, + }); +} +/** + *The list of instance types with the specified instance attributes.
+ */ +export interface InstanceTypeInfoFromInstanceRequirements { /** - *Checks whether you have the required permissions for the action, without 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 matching instance type.
*/ - DryRun?: boolean; + InstanceType?: string; } -export namespace GetTransitGatewayMulticastDomainAssociationsRequest { +export namespace InstanceTypeInfoFromInstanceRequirements { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayMulticastDomainAssociationsRequest): any => ({ + export const filterSensitiveLog = (obj: InstanceTypeInfoFromInstanceRequirements): any => ({ ...obj, }); } -/** - *Describes the resources associated with the transit gateway multicast domain.
- */ -export interface TransitGatewayMulticastDomainAssociation { +export interface GetInstanceTypesFromInstanceRequirementsResult { /** - *The ID of the transit gateway attachment.
+ *The instance types with the specified instance attributes.
*/ - TransitGatewayAttachmentId?: string; + InstanceTypes?: InstanceTypeInfoFromInstanceRequirements[]; /** - *The ID of the resource.
+ *The token for the next set of results.
*/ - ResourceId?: string; + NextToken?: string; +} +export namespace GetInstanceTypesFromInstanceRequirementsResult { /** - *The type of resource, for example a VPC attachment.
+ * @internal */ - ResourceType?: TransitGatewayAttachmentResourceType | string; + export const filterSensitiveLog = (obj: GetInstanceTypesFromInstanceRequirementsResult): any => ({ + ...obj, + }); +} +export interface GetLaunchTemplateDataRequest { /** - *The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
The subnet associated with the transit gateway multicast domain.
+ *The ID of the instance.
*/ - Subnet?: SubnetAssociation; + InstanceId: string | undefined; } -export namespace TransitGatewayMulticastDomainAssociation { +export namespace GetLaunchTemplateDataRequest { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayMulticastDomainAssociation): any => ({ + export const filterSensitiveLog = (obj: GetLaunchTemplateDataRequest): any => ({ ...obj, }); } -export interface GetTransitGatewayMulticastDomainAssociationsResult { - /** - *Information about the multicast domain associations.
- */ - MulticastDomainAssociations?: TransitGatewayMulticastDomainAssociation[]; - +export interface GetLaunchTemplateDataResult { /** - *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The instance data.
*/ - NextToken?: string; + LaunchTemplateData?: ResponseLaunchTemplateData; } -export namespace GetTransitGatewayMulticastDomainAssociationsResult { +export namespace GetLaunchTemplateDataResult { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayMulticastDomainAssociationsResult): any => ({ + export const filterSensitiveLog = (obj: GetLaunchTemplateDataResult): any => ({ ...obj, }); } -export interface GetTransitGatewayPrefixListReferencesRequest { +export interface GetManagedPrefixListAssociationsRequest { /** - *The ID of the transit gateway route table.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters. The possible values are:
- *
- * attachment.resource-id - The ID of the resource for the attachment.
- * attachment.resource-type - The type of resource for the
- * attachment. Valid values are vpc | vpn |
- * direct-connect-gateway | peering.
- * attachment.transit-gateway-attachment-id - The ID of the attachment.
- * is-blackhole - Whether traffic matching the route is blocked (true | false).
- * prefix-list-id - The ID of the prefix list.
- * prefix-list-owner-id - The ID of the owner of the prefix list.
- * state - The state of the prefix list reference (pending | available | modifying | deleting).
The ID of the prefix list.
*/ - Filters?: Filter[]; + PrefixListId: string | undefined; /** *The maximum number of results to return with a single call. @@ -6009,29 +6524,46 @@ export interface GetTransitGatewayPrefixListReferencesRequest { *
The token for the next page of results.
*/ NextToken?: string; +} +export namespace GetManagedPrefixListAssociationsRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes the resource with which a prefix list is associated.
+ */ +export interface PrefixListAssociation { + /** + *The ID of the resource.
+ */ + ResourceId?: string; + + /** + *The owner of the resource.
+ */ + ResourceOwner?: string; +} + +export namespace PrefixListAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayPrefixListReferencesRequest): any => ({ + export const filterSensitiveLog = (obj: PrefixListAssociation): any => ({ ...obj, }); } -export interface GetTransitGatewayPrefixListReferencesResult { +export interface GetManagedPrefixListAssociationsResult { /** - *Information about the prefix list references.
+ *Information about the associations.
*/ - TransitGatewayPrefixListReferences?: TransitGatewayPrefixListReference[]; + PrefixListAssociations?: PrefixListAssociation[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the transit gateway route table.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
One or more filters. The possible values are:
- *
- * resource-id - The ID of the resource.
- * resource-type - The resource type. Valid values are vpc
- * | vpn | direct-connect-gateway | peering
- * | connect.
- * transit-gateway-attachment-id - The ID of the attachment.
The ID of the prefix list.
*/ - Filters?: Filter[]; + PrefixListId: string | undefined; + + /** + *The version of the prefix list for which to return the entries. The default is the current version.
+ */ + TargetVersion?: number; /** *The maximum number of results to return with a single call. @@ -6085,63 +6608,46 @@ export interface GetTransitGatewayRouteTableAssociationsRequest { *
The token for the next page of results.
*/ NextToken?: string; - - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Describes an association between a route table and a resource attachment.
+ *Describes a prefix list entry.
*/ -export interface TransitGatewayRouteTableAssociation { - /** - *The ID of the attachment.
- */ - TransitGatewayAttachmentId?: string; - - /** - *The ID of the resource.
- */ - ResourceId?: string; - +export interface PrefixListEntry { /** - *The resource type. Note that the tgw-peering resource type has been deprecated.
The CIDR block.
*/ - ResourceType?: TransitGatewayAttachmentResourceType | string; + Cidr?: string; /** - *The state of the association.
+ *The description.
*/ - State?: TransitGatewayAssociationState | string; + Description?: string; } -export namespace TransitGatewayRouteTableAssociation { +export namespace PrefixListEntry { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayRouteTableAssociation): any => ({ + export const filterSensitiveLog = (obj: PrefixListEntry): any => ({ ...obj, }); } -export interface GetTransitGatewayRouteTableAssociationsResult { +export interface GetManagedPrefixListEntriesResult { /** - *Information about the associations.
+ *Information about the prefix list entries.
*/ - Associations?: TransitGatewayRouteTableAssociation[]; + Entries?: PrefixListEntry[]; /** *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The ID of the transit gateway route table.
- */ - TransitGatewayRouteTableId: string | undefined; - - /** - *One or more filters. The possible values are:
- *
- * resource-id - The ID of the resource.
- * resource-type - The resource type. Valid values are vpc
- * | vpn | direct-connect-gateway | peering
- * | connect.
- * transit-gateway-attachment-id - The ID of the attachment.
The maximum number of results to return with a single call.
- * To retrieve the remaining results, make another call with the returned nextToken value.
The token for the next page of results.
+ *The ID of the Windows instance.
*/ - NextToken?: string; + InstanceId: string | undefined; /** *Checks whether you have the required permissions for the action, without actually making the request, @@ -6204,1705 +6678,1787 @@ export interface GetTransitGatewayRouteTablePropagationsRequest { DryRun?: boolean; } -export namespace GetTransitGatewayRouteTablePropagationsRequest { +export namespace GetPasswordDataRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayRouteTablePropagationsRequest): any => ({ + export const filterSensitiveLog = (obj: GetPasswordDataRequest): any => ({ ...obj, }); } -/** - *
Describes a route table propagation.
- */ -export interface TransitGatewayRouteTablePropagation { - /** - *The ID of the attachment.
- */ - TransitGatewayAttachmentId?: string; - +export interface GetPasswordDataResult { /** - *The ID of the resource.
+ *The ID of the Windows instance.
*/ - ResourceId?: string; + InstanceId?: string; /** - *The type of resource. Note that the tgw-peering resource type has been deprecated.
The password of the instance. Returns an empty string if the password is not + * available.
*/ - ResourceType?: TransitGatewayAttachmentResourceType | string; + PasswordData?: string; /** - *The state of the resource.
+ *The time the data was last updated.
*/ - State?: TransitGatewayPropagationState | string; + Timestamp?: Date; } -export namespace TransitGatewayRouteTablePropagation { +export namespace GetPasswordDataResult { /** * @internal */ - export const filterSensitiveLog = (obj: TransitGatewayRouteTablePropagation): any => ({ + export const filterSensitiveLog = (obj: GetPasswordDataResult): any => ({ ...obj, }); } -export interface GetTransitGatewayRouteTablePropagationsResult { +/** + *Contains the parameters for GetReservedInstanceExchangeQuote.
+ */ +export interface GetReservedInstancesExchangeQuoteRequest { /** - *Information about the route table propagations.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The IDs of the Convertible Reserved Instances to exchange.
*/ - NextToken?: string; + ReservedInstanceIds: string[] | undefined; + + /** + *The configuration of the target Convertible Reserved Instance to exchange for your + * current Convertible Reserved Instances.
+ */ + TargetConfigurations?: TargetConfigurationRequest[]; } -export namespace GetTransitGatewayRouteTablePropagationsResult { +export namespace GetReservedInstancesExchangeQuoteRequest { /** * @internal */ - export const filterSensitiveLog = (obj: GetTransitGatewayRouteTablePropagationsResult): any => ({ + export const filterSensitiveLog = (obj: GetReservedInstancesExchangeQuoteRequest): any => ({ ...obj, }); } -export interface GetVpnConnectionDeviceSampleConfigurationRequest { - /** - *The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample
- * configuration.
The cost associated with the Reserved Instance.
+ */ +export interface ReservationValue { /** - *Device identifier provided by the GetVpnConnectionDeviceTypes API.
The hourly rate of the reservation.
*/ - VpnConnectionDeviceTypeId: string | undefined; + HourlyPrice?: string; /** - *The IKE version to be used in the sample configuration file for your customer gateway
- * device. You can specify one of the following versions: ikev1 or
- * ikev2.
The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
*/ - InternetKeyExchangeVersion?: string; + RemainingTotalValue?: string; /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The remaining upfront cost of the reservation.
*/ - DryRun?: boolean; + RemainingUpfrontValue?: string; } -export namespace GetVpnConnectionDeviceSampleConfigurationRequest { +export namespace ReservationValue { /** * @internal */ - export const filterSensitiveLog = (obj: GetVpnConnectionDeviceSampleConfigurationRequest): any => ({ + export const filterSensitiveLog = (obj: ReservationValue): any => ({ ...obj, }); } -export interface GetVpnConnectionDeviceSampleConfigurationResult { +/** + *The total value of the Convertible Reserved Instance.
+ */ +export interface ReservedInstanceReservationValue { /** - *Sample configuration file for the specified customer gateway device.
+ *The total value of the Convertible Reserved Instance that you are exchanging.
*/ - VpnConnectionDeviceSampleConfiguration?: string; + ReservationValue?: ReservationValue; + + /** + *The ID of the Convertible Reserved Instance that you are exchanging.
+ */ + ReservedInstanceId?: string; } -export namespace GetVpnConnectionDeviceSampleConfigurationResult { +export namespace ReservedInstanceReservationValue { /** * @internal */ - export const filterSensitiveLog = (obj: GetVpnConnectionDeviceSampleConfigurationResult): any => ({ + export const filterSensitiveLog = (obj: ReservedInstanceReservationValue): any => ({ ...obj, - ...(obj.VpnConnectionDeviceSampleConfiguration && { VpnConnectionDeviceSampleConfiguration: SENSITIVE_STRING }), }); } -export interface GetVpnConnectionDeviceTypesRequest { - /** - *The maximum number of results returned by GetVpnConnectionDeviceTypes in
- * paginated output. When this parameter is used, GetVpnConnectionDeviceTypes
- * only returns MaxResults results in a single page along with a
- * NextToken response element. The remaining results of the initial
- * request can be seen by sending another GetVpnConnectionDeviceTypes request
- * with the returned NextToken value. This value can be between 200 and 1000.
- * If this parameter is not used, then GetVpnConnectionDeviceTypes returns all
- * results.
Information about the Convertible Reserved Instance offering.
+ */ +export interface TargetConfiguration { /** - *The NextToken value returned from a previous paginated
- * GetVpnConnectionDeviceTypes request where MaxResults was
- * used and the results exceeded the value of that parameter. Pagination continues from the
- * end of the previous results that returned the NextToken value. This value
- * is null when there are no more results to return.
The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is + * reserved and cannot be specified in a request
*/ - NextToken?: string; + InstanceCount?: number; /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The ID of the Convertible Reserved Instance offering.
*/ - DryRun?: boolean; + OfferingId?: string; } -export namespace GetVpnConnectionDeviceTypesRequest { +export namespace TargetConfiguration { /** * @internal */ - export const filterSensitiveLog = (obj: GetVpnConnectionDeviceTypesRequest): any => ({ + export const filterSensitiveLog = (obj: TargetConfiguration): any => ({ ...obj, }); } /** - *List of customer gateway devices that have a sample configuration file available for - * use. You can also see the list of device types with sample configuration files available - * under Your customer - * gateway device in the Amazon Web Services Site-to-Site VPN User Guide.
+ *The total value of the new Convertible Reserved Instances.
*/ -export interface VpnConnectionDeviceType { - /** - *Customer gateway device identifier.
- */ - VpnConnectionDeviceTypeId?: string; - - /** - *Customer gateway device vendor.
- */ - Vendor?: string; - +export interface TargetReservationValue { /** - *Customer gateway device platform.
+ *The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of + * the list value, remaining upfront price, and additional upfront cost of the exchange.
*/ - Platform?: string; + ReservationValue?: ReservationValue; /** - *Customer gateway device software version.
+ *The configuration of the Convertible Reserved Instances that make up the exchange.
*/ - Software?: string; + TargetConfiguration?: TargetConfiguration; } -export namespace VpnConnectionDeviceType { +export namespace TargetReservationValue { /** * @internal */ - export const filterSensitiveLog = (obj: VpnConnectionDeviceType): any => ({ + export const filterSensitiveLog = (obj: TargetReservationValue): any => ({ ...obj, }); } -export interface GetVpnConnectionDeviceTypesResult { +/** + *Contains the output of GetReservedInstancesExchangeQuote.
+ */ +export interface GetReservedInstancesExchangeQuoteResult { /** - *List of customer gateway devices that have a sample configuration file available for - * use.
+ *The currency of the transaction.
*/ - VpnConnectionDeviceTypes?: VpnConnectionDeviceType[]; + CurrencyCode?: string; /** - *The NextToken value to include in a future
- * GetVpnConnectionDeviceTypes request. When the results of a
- * GetVpnConnectionDeviceTypes request exceed MaxResults,
- * this value can be used to retrieve the next page of results. This value is null when
- * there are no more results to return.
If true, the exchange is valid. If false, the exchange cannot be completed.
The new end date of the reservation term.
*/ - export const filterSensitiveLog = (obj: GetVpnConnectionDeviceTypesResult): any => ({ - ...obj, - }); -} + OutputReservedInstancesWillExpireAt?: Date; -export interface ImportClientVpnClientCertificateRevocationListRequest { /** - *The ID of the Client VPN endpoint to which the client certificate revocation list applies.
+ *The total true upfront charge for the exchange.
*/ - ClientVpnEndpointId: string | undefined; + PaymentDue?: string; /** - *The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the - * Client VPN Administrator Guide.
+ *The cost associated with the Reserved Instance.
*/ - CertificateRevocationList: string | undefined; + ReservedInstanceValueRollup?: ReservationValue; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The configuration of your Convertible Reserved Instances.
*/ - DryRun?: boolean; -} + ReservedInstanceValueSet?: ReservedInstanceReservationValue[]; -export namespace ImportClientVpnClientCertificateRevocationListRequest { /** - * @internal + *The cost associated with the Reserved Instance.
*/ - export const filterSensitiveLog = (obj: ImportClientVpnClientCertificateRevocationListRequest): any => ({ - ...obj, - }); -} + TargetConfigurationValueRollup?: ReservationValue; -export interface ImportClientVpnClientCertificateRevocationListResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
The values of the target Convertible Reserved Instances.
*/ - Return?: boolean; + TargetConfigurationValueSet?: TargetReservationValue[]; + + /** + *Describes the reason why the exchange cannot be completed.
+ */ + ValidationFailureReason?: string; } -export namespace ImportClientVpnClientCertificateRevocationListResult { +export namespace GetReservedInstancesExchangeQuoteResult { /** * @internal */ - export const filterSensitiveLog = (obj: ImportClientVpnClientCertificateRevocationListResult): any => ({ + export const filterSensitiveLog = (obj: GetReservedInstancesExchangeQuoteResult): any => ({ ...obj, }); } -/** - *Describes the client-specific data.
- */ -export interface ClientData { - /** - *A user-defined comment about the disk upload.
- */ - Comment?: string; - +export interface GetSerialConsoleAccessStatusRequest { /** - *The time that the disk upload ends.
+ *Checks whether you have the required permissions for the action, without 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 size of the uploaded disk image, in GiB.
+ * @internal */ - UploadSize?: number; + export const filterSensitiveLog = (obj: GetSerialConsoleAccessStatusRequest): any => ({ + ...obj, + }); +} +export interface GetSerialConsoleAccessStatusResult { /** - *The time that the disk upload starts.
+ *If true, access to the EC2 serial console of all instances is enabled for
+ * your account. If false, access to the EC2 serial console of all instances
+ * is disabled for your account.
Describes the Amazon S3 bucket for the disk image.
+ *The architecture type, virtualization type, and other attributes for the instance types. + * When you specify instance attributes, Amazon EC2 will identify instance types with those + * attributes.
+ *If you specify InstanceRequirementsWithMetadataRequest, you can't specify
+ * InstanceTypes.
The name of the Amazon S3 bucket where the disk image is located.
+ *The architecture type.
*/ - S3Bucket?: string; + ArchitectureTypes?: (ArchitectureType | string)[]; /** - *The file name of the disk image.
+ *The virtualization type.
*/ - S3Key?: string; + VirtualizationTypes?: (VirtualizationType | string)[]; + + /** + *The attributes for the instance types. When you specify instance attributes, Amazon EC2 will + * identify instance types with those attributes.
+ */ + InstanceRequirements?: InstanceRequirementsRequest; } -export namespace UserBucket { +export namespace InstanceRequirementsWithMetadataRequest { /** * @internal */ - export const filterSensitiveLog = (obj: UserBucket): any => ({ + export const filterSensitiveLog = (obj: InstanceRequirementsWithMetadataRequest): any => ({ ...obj, }); } -/** - *Describes the disk container object for an import image task.
- */ -export interface ImageDiskContainer { +export interface GetSpotPlacementScoresRequest { /** - *The description of the disk image.
+ *The instance types. We recommend that you specify at least three instance types. If you
+ * specify one or two instance types, or specify variations of a single instance type (for
+ * example, an m3.xlarge with and without instance storage), the returned
+ * placement score will always be low.
If you specify InstanceTypes, you can't specify
+ * InstanceRequirementsWithMetadata.
The block device mapping for the disk.
+ *The target capacity.
*/ - DeviceName?: string; + TargetCapacity: number | undefined; /** - *The format of the disk image being imported.
- *Valid values: OVA | VHD | VHDX | VMDK | RAW
- *
The unit for the target capacity.
+ *Default: units (translates to number of instances)
The ID of the EBS snapshot to be used for importing the snapshot.
+ *Specify true so that the response returns a list of scored Availability Zones.
+ * Otherwise, the response returns a list of scored Regions.
A list of scored Availability Zones is useful if you want to launch all of your Spot + * capacity into a single Availability Zone.
*/ - SnapshotId?: string; + SingleAvailabilityZone?: boolean; /** - *The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an - * Amazon S3 URL (s3://..)
+ *The Regions used to narrow down the list of Regions to be scored. Enter the Region code,
+ * for example, us-east-1.
The S3 bucket for the disk image.
+ *The attributes for the instance types. When you specify instance attributes, Amazon EC2 will + * identify instance types with those attributes.
+ *If you specify InstanceRequirementsWithMetadata, you can't specify
+ * InstanceTypes.
Checks whether you have the required permissions for the action, without 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 request information of license configurations.
- */ -export interface ImportImageLicenseConfigurationRequest { /** - *The ARN of a license configuration.
+ *The maximum number of results to return in a single call. Specify a value between 1 and
+ * 1000. The default value is 1000. To retrieve the remaining results, make another call with
+ * the returned NextToken value.
The token for the next set of results.
+ */ + NextToken?: string; } -export namespace ImportImageLicenseConfigurationRequest { +export namespace GetSpotPlacementScoresRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ImportImageLicenseConfigurationRequest): any => ({ + export const filterSensitiveLog = (obj: GetSpotPlacementScoresRequest): any => ({ ...obj, }); } -export interface ImportImageRequest { - /** - *The architecture of the virtual machine.
- *Valid values: i386 | x86_64 | arm64
- *
The Spot placement score for this Region or Availability Zone. The score is calculated
+ * based on the assumption that the capacity-optimized allocation strategy is
+ * used and that all of the Availability Zones in the Region can be used.
The client-specific data.
+ *The Region.
*/ - ClientData?: ClientData; + Region?: string; /** - *The token to enable idempotency for VM import requests.
+ *The Availability Zone.
*/ - ClientToken?: string; + AvailabilityZoneId?: string; /** - *A description string for the import image task.
+ *The placement score, on a scale from 1 to 10. A score of
+ * 10 indicates that your Spot request is highly likely to succeed in this
+ * Region or Availability Zone. A score of 1 indicates that your Spot request is
+ * not likely to succeed.
Information about the disk containers.
+ * @internal */ - DiskContainers?: ImageDiskContainer[]; + export const filterSensitiveLog = (obj: SpotPlacementScore): any => ({ + ...obj, + }); +} +export interface GetSpotPlacementScoresResult { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The Spot placement score for the top 10 Regions or Availability Zones, scored on a scale
+ * from 1 to 10. Each score
 reflects how likely it is that each Region or Availability Zone
+ * will succeed at fulfilling the specified target capacity
 at the time of the Spot
+ * placement score request. A score of 10 means that your Spot
+ * capacity request is highly likely to succeed in that Region or Availability Zone.
If you request a Spot placement score for Regions, a high score assumes that your fleet
+ * request will be configured to use all Availability Zones and the
+ * capacity-optimized allocation strategy. If you request a Spot placement
+ * score for Availability Zones, a high score assumes that your fleet request will be
+ * configured to use a single Availability Zone and the capacity-optimized
+ * allocation strategy.
Different
 Regions or Availability Zones might return the same score.
+ *The Spot placement score serves as a recommendation only. No score guarantees that your + * Spot request will be fully or partially fulfilled.
+ *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.
The token for the next set of results.
*/ - Encrypted?: boolean; + NextToken?: string; +} +export namespace GetSpotPlacementScoresResult { /** - *The target hypervisor platform.
- *Valid values: xen
- *
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 KMS key identifier may be provided in any of the following formats:
- *One or more filters.
+ *Key ID
+ *
+ * reservationType - The type of reservation (prefix |
+ * explicit).
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.
+ * subnet-id - The ID of the subnet.
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.
+ * tag:Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
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.
+ * tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
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 KMS key must exist in the Region that the AMI is being copied to.
- *Amazon EBS does not support asymmetric KMS keys.
*/ - KmsKeyId?: string; + Filters?: Filter[]; /** - *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 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 Amazon Web Services. For more information, see Prerequisites in the
- * VM Import/Export User Guide.
The ID of the subnet.
*/ - LicenseType?: string; + SubnetId: string | undefined; /** - *The operating system of the virtual machine.
- *Valid values: Windows | Linux
- *
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The name of the role to use when not using the default role, 'vmimport'.
+ *The token for the next page of results.
*/ - RoleName?: string; + NextToken?: string; /** - *The ARNs of the license configurations.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The tags to apply to the import image task during creation.
+ * @internal */ - TagSpecifications?: TagSpecification[]; + export const filterSensitiveLog = (obj: GetSubnetCidrReservationsRequest): any => ({ + ...obj, + }); +} +export interface GetSubnetCidrReservationsResult { /** - *The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.
+ *Information about the IPv4 subnet CIDR reservations.
*/ - UsageOperation?: string; + SubnetIpv4CidrReservations?: SubnetCidrReservation[]; /** - *The boot mode of the virtual machine.
+ *Information about the IPv6 subnet CIDR reservations.
*/ - BootMode?: BootModeValues | string; + SubnetIpv6CidrReservations?: SubnetCidrReservation[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The architecture of the virtual machine.
+ *The ID of the attachment.
*/ - Architecture?: string; + TransitGatewayAttachmentId: string | undefined; /** - *A description of the import task.
+ *One or more filters. The possible values are:
+ *
+ * transit-gateway-route-table-id - The ID of the transit gateway route table.
Indicates whether the AMI is encrypted.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The target hypervisor of the import task.
+ *The token for the next page of results.
*/ - Hypervisor?: string; + NextToken?: string; /** - *The ID of the Amazon Machine Image (AMI) created by the import task.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The task ID of the import image task.
+ * @internal */ - ImportTaskId?: string; + export const filterSensitiveLog = (obj: GetTransitGatewayAttachmentPropagationsRequest): any => ({ + ...obj, + }); +} + +/** + *Describes a propagation route table.
+ */ +export interface TransitGatewayAttachmentPropagation { + /** + *The ID of the propagation route table.
+ */ + TransitGatewayRouteTableId?: string; /** - *The identifier for the symmetric KMS key that was used to create the encrypted AMI.
+ *The state of the propagation route table.
*/ - KmsKeyId?: string; + State?: TransitGatewayPropagationState | string; +} +export namespace TransitGatewayAttachmentPropagation { /** - *The license type of the virtual machine.
+ * @internal */ - LicenseType?: string; + export const filterSensitiveLog = (obj: TransitGatewayAttachmentPropagation): any => ({ + ...obj, + }); +} +export interface GetTransitGatewayAttachmentPropagationsResult { /** - *The operating system of the virtual machine.
+ *Information about the propagation route tables.
*/ - Platform?: string; + TransitGatewayAttachmentPropagations?: TransitGatewayAttachmentPropagation[]; /** - *The progress of the task.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Information about the snapshots.
+ * @internal */ - SnapshotDetails?: SnapshotDetail[]; + export const filterSensitiveLog = (obj: GetTransitGatewayAttachmentPropagationsResult): any => ({ + ...obj, + }); +} +export interface GetTransitGatewayMulticastDomainAssociationsRequest { /** - *A brief status of the task.
+ *The ID of the transit gateway multicast domain.
*/ - Status?: string; + TransitGatewayMulticastDomainId?: string; /** - *A detailed status message of the import task.
+ *One or more filters. The possible values are:
+ *
+ * resource-id - The ID of the resource.
+ * resource-type - The type of resource. The valid value is: vpc.
+ * state - The state of the subnet association. Valid values are
+ * associated |
+ * associating
+ * | disassociated | disassociating.
+ * subnet-id - The ID of the subnet.
+ * transit-gateway-attachment-id - The id of the transit gateway attachment.
The ARNs of the license configurations.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
Any tags assigned to the import image task.
+ *The token for the next page of results.
*/ - Tags?: Tag[]; + NextToken?: string; /** - *The usage operation value.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a disk image.
+ *Describes the resources associated with the transit gateway multicast domain.
*/ -export interface DiskImageDetail { +export interface TransitGatewayMulticastDomainAssociation { /** - *The size of the disk image, in GiB.
+ *The ID of the transit gateway attachment.
*/ - Bytes: number | undefined; + TransitGatewayAttachmentId?: string; /** - *The disk image format.
+ *The ID of the resource.
*/ - Format: DiskImageFormat | string | undefined; + ResourceId?: string; /** - *A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. - * For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication - * Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer - * Guide.
- *For information about the import manifest referenced by this API action, see VM Import Manifest.
+ *The type of resource, for example a VPC attachment.
*/ - ImportManifestUrl: string | undefined; -} + ResourceType?: TransitGatewayAttachmentResourceType | string; -export namespace DiskImageDetail { /** - * @internal + *The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.
*/ - export const filterSensitiveLog = (obj: DiskImageDetail): any => ({ - ...obj, - }); -} + ResourceOwnerId?: string; -/** - *Describes an EBS volume.
- */ -export interface VolumeDetail { /** - *The size of the volume, in GiB.
+ *The subnet associated with the transit gateway multicast domain.
*/ - Size: number | undefined; + Subnet?: SubnetAssociation; } -export namespace VolumeDetail { +export namespace TransitGatewayMulticastDomainAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: VolumeDetail): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayMulticastDomainAssociation): any => ({ ...obj, }); } -/** - *Describes a disk image.
- */ -export interface DiskImage { - /** - *A description of the disk image.
- */ - Description?: string; - +export interface GetTransitGatewayMulticastDomainAssociationsResult { /** - *Information about the disk image.
+ *Information about the multicast domain associations.
*/ - Image?: DiskImageDetail; + MulticastDomainAssociations?: TransitGatewayMulticastDomainAssociation[]; /** - *Information about the volume.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Describes the user data for an instance.
- */ -export interface UserData { +export interface GetTransitGatewayPrefixListReferencesRequest { /** - *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.
+ *The ID of the transit gateway route table.
*/ - Data?: string; -} + TransitGatewayRouteTableId: string | undefined; -export namespace UserData { /** - * @internal + *One or more filters. The possible values are:
+ *
+ * attachment.resource-id - The ID of the resource for the attachment.
+ * attachment.resource-type - The type of resource for the
+ * attachment. Valid values are vpc | vpn |
+ * direct-connect-gateway | peering.
+ * attachment.transit-gateway-attachment-id - The ID of the attachment.
+ * is-blackhole - Whether traffic matching the route is blocked (true | false).
+ * prefix-list-id - The ID of the prefix list.
+ * prefix-list-owner-id - The ID of the owner of the prefix list.
+ * state - The state of the prefix list reference (pending | available | modifying | deleting).
Describes the launch specification for VM import.
- */ -export interface ImportInstanceLaunchSpecification { /** - *Reserved.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The architecture of the instance.
+ *The token for the next page of results.
*/ - Architecture?: ArchitectureValues | string; + NextToken?: string; /** - *The security group IDs.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The security group names.
+ * @internal */ - GroupNames?: string[]; + export const filterSensitiveLog = (obj: GetTransitGatewayPrefixListReferencesRequest): any => ({ + ...obj, + }); +} +export interface GetTransitGatewayPrefixListReferencesResult { /** - *Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the - * operating system command for system shutdown).
+ *Information about the prefix list references.
*/ - InstanceInitiatedShutdownBehavior?: ShutdownBehavior | string; + TransitGatewayPrefixListReferences?: TransitGatewayPrefixListReference[]; /** - *The instance type. For more information about the instance types that you can import, see Instance Types in the - * VM Import/Export User Guide.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Indicates whether monitoring is enabled.
+ * @internal */ - Monitoring?: boolean; + export const filterSensitiveLog = (obj: GetTransitGatewayPrefixListReferencesResult): any => ({ + ...obj, + }); +} +export interface GetTransitGatewayRouteTableAssociationsRequest { /** - *The placement information for the instance.
+ *The ID of the transit gateway route table.
+ */ + TransitGatewayRouteTableId: string | undefined; + + /** + *One or more filters. The possible values are:
+ *
+ * resource-id - The ID of the resource.
+ * resource-type - The resource type. Valid values are vpc
+ * | vpn | direct-connect-gateway | peering
+ * | connect.
+ * transit-gateway-attachment-id - The ID of the attachment.
[EC2-VPC] An available IP address from the IP address range of the subnet.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
[EC2-VPC] The ID of the subnet in which to launch the instance.
+ *The token for the next page of results.
*/ - SubnetId?: string; + NextToken?: string; /** - *The Base64-encoded user data to make available to the instance.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
A description for the instance being imported.
- */ - Description?: string; - +/** + *Describes an association between a route table and a resource attachment.
+ */ +export interface TransitGatewayRouteTableAssociation { /** - *The disk image.
+ *The ID of the attachment.
*/ - DiskImages?: DiskImage[]; + TransitGatewayAttachmentId?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the resource.
*/ - DryRun?: boolean; + ResourceId?: string; /** - *The launch specification.
+ *The resource type. Note that the tgw-peering resource type has been deprecated.
The instance operating system.
+ *The state of the association.
*/ - Platform: PlatformValues | string | undefined; + State?: TransitGatewayAssociationState | string; } -export namespace ImportInstanceRequest { +export namespace TransitGatewayRouteTableAssociation { /** * @internal */ - export const filterSensitiveLog = (obj: ImportInstanceRequest): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayRouteTableAssociation): any => ({ ...obj, - ...(obj.LaunchSpecification && { - LaunchSpecification: ImportInstanceLaunchSpecification.filterSensitiveLog(obj.LaunchSpecification), - }), }); } -export interface ImportInstanceResult { +export interface GetTransitGatewayRouteTableAssociationsResult { /** - *Information about the conversion task.
+ *Information about the associations.
*/ - ConversionTask?: ConversionTask; + Associations?: TransitGatewayRouteTableAssociation[]; + + /** + *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the transit gateway route table.
*/ - DryRun?: boolean; + TransitGatewayRouteTableId: string | undefined; /** - *A unique name for the key pair.
+ *One or more filters. The possible values are:
+ *
+ * resource-id - The ID of the resource.
+ * resource-type - The resource type. Valid values are vpc
+ * | vpn | direct-connect-gateway | peering
+ * | connect.
+ * transit-gateway-attachment-id - The ID of the attachment.
The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
+ *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
The tags to apply to the imported key pair.
+ *The token for the next page of results.
*/ - TagSpecifications?: TagSpecification[]; + NextToken?: string; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes a route table propagation.
+ */ +export interface TransitGatewayRouteTablePropagation { /** - *The MD5 public key fingerprint as specified in section 4 of RFC 4716.
+ *The ID of the attachment.
*/ - KeyFingerprint?: string; + TransitGatewayAttachmentId?: string; /** - *The key pair name that you provided.
+ *The ID of the resource.
*/ - KeyName?: string; + ResourceId?: string; /** - *The ID of the resulting key pair.
+ *The type of resource. Note that the tgw-peering resource type has been deprecated.
The tags applied to the imported key pair.
+ *The state of the resource.
*/ - Tags?: Tag[]; + State?: TransitGatewayPropagationState | string; } -export namespace ImportKeyPairResult { +export namespace TransitGatewayRouteTablePropagation { /** * @internal */ - export const filterSensitiveLog = (obj: ImportKeyPairResult): any => ({ + export const filterSensitiveLog = (obj: TransitGatewayRouteTablePropagation): any => ({ ...obj, }); } -/** - *The disk container object for the import snapshot request.
- */ -export interface SnapshotDiskContainer { - /** - *The description of the disk image being imported.
- */ - Description?: string; - - /** - *The format of the disk image being imported.
- *Valid values: VHD | VMDK | RAW
- *
The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon - * S3 URL (s3://..).
+ *Information about the route table propagations.
*/ - Url?: string; + TransitGatewayRouteTablePropagations?: TransitGatewayRouteTablePropagation[]; /** - *The Amazon S3 bucket for the disk image.
+ *The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The client-specific data.
+ *The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample
+ * configuration.
Token to enable idempotency for VM import requests.
+ *Device identifier provided by the GetVpnConnectionDeviceTypes API.
The description string for the import snapshot task.
+ *The IKE version to be used in the sample configuration file for your customer gateway
+ * device. You can specify one of the following versions: ikev1 or
+ * ikev2.
Information about the disk container.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Specifies whether 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.
Sample configuration file for the specified customer gateway device.
*/ - Encrypted?: boolean; + VpnConnectionDeviceSampleConfiguration?: string; +} +export namespace GetVpnConnectionDeviceSampleConfigurationResult { /** - *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 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 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 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 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.
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 KMS key must exist in the Region that the snapshot is being copied to.
- *Amazon EBS does not support asymmetric KMS keys.
+ * @internal + */ + export const filterSensitiveLog = (obj: GetVpnConnectionDeviceSampleConfigurationResult): any => ({ + ...obj, + ...(obj.VpnConnectionDeviceSampleConfiguration && { VpnConnectionDeviceSampleConfiguration: SENSITIVE_STRING }), + }); +} + +export interface GetVpnConnectionDeviceTypesRequest { + /** + *The maximum number of results returned by GetVpnConnectionDeviceTypes in
+ * paginated output. When this parameter is used, GetVpnConnectionDeviceTypes
+ * only returns MaxResults results in a single page along with a
+ * NextToken response element. The remaining results of the initial
+ * request can be seen by sending another GetVpnConnectionDeviceTypes request
+ * with the returned NextToken value. This value can be between 200 and 1000.
+ * If this parameter is not used, then GetVpnConnectionDeviceTypes returns all
+ * results.
The name of the role to use when not using the default role, 'vmimport'.
+ *The NextToken value returned from a previous paginated
+ * GetVpnConnectionDeviceTypes request where MaxResults was
+ * used and the results exceeded the value of that parameter. Pagination continues from the
+ * end of the previous results that returned the NextToken value. This value
+ * is null when there are no more results to return.
The tags to apply to the import snapshot task during creation.
+ *Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
List of customer gateway devices that have a sample configuration file available for + * use. You can also see the list of device types with sample configuration files available + * under Your customer + * gateway device in the Amazon Web Services Site-to-Site VPN User Guide.
+ */ +export interface VpnConnectionDeviceType { /** - *A description of the import snapshot task.
+ *Customer gateway device identifier.
*/ - Description?: string; + VpnConnectionDeviceTypeId?: string; /** - *The ID of the import snapshot task.
+ *Customer gateway device vendor.
*/ - ImportTaskId?: string; + Vendor?: string; /** - *Information about the import snapshot task.
+ *Customer gateway device platform.
*/ - SnapshotTaskDetail?: SnapshotTaskDetail; + Platform?: string; /** - *Any tags assigned to the import snapshot task.
+ *Customer gateway device software version.
*/ - Tags?: Tag[]; + Software?: string; } -export namespace ImportSnapshotResult { +export namespace VpnConnectionDeviceType { /** * @internal */ - export const filterSensitiveLog = (obj: ImportSnapshotResult): any => ({ + export const filterSensitiveLog = (obj: VpnConnectionDeviceType): any => ({ ...obj, }); } -export interface ImportVolumeRequest { +export interface GetVpnConnectionDeviceTypesResult { /** - *The Availability Zone for the resulting EBS volume.
+ *List of customer gateway devices that have a sample configuration file available for + * use.
*/ - AvailabilityZone: string | undefined; + VpnConnectionDeviceTypes?: VpnConnectionDeviceType[]; /** - *A description of the volume.
+ *The NextToken value to include in a future
+ * GetVpnConnectionDeviceTypes request. When the results of a
+ * GetVpnConnectionDeviceTypes request exceed MaxResults,
+ * this value can be used to retrieve the next page of results. This value is null when
+ * there are no more results to return.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The disk image.
+ *The ID of the Client VPN endpoint to which the client certificate revocation list applies.
*/ - Image: DiskImageDetail | undefined; + ClientVpnEndpointId: string | undefined; /** - *The volume size.
+ *The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the + * Client VPN Administrator Guide.
*/ - Volume: VolumeDetail | undefined; + CertificateRevocationList: string | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Information about the conversion task.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Describes the client-specific data.
+ */ +export interface ClientData { /** - *[EC2-VPC] The allocation ID.
+ *A user-defined comment about the disk upload.
*/ - AllocationId: string | undefined; + Comment?: string; /** - *The domain name to modify for the IP address.
+ *The time that the disk upload ends.
*/ - DomainName?: string; + UploadEnd?: Date; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The size of the uploaded disk image, in GiB.
*/ - DryRun?: boolean; + UploadSize?: number; + + /** + *The time that the disk upload starts.
+ */ + UploadStart?: Date; } -export namespace ModifyAddressAttributeRequest { +export namespace ClientData { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyAddressAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: ClientData): any => ({ ...obj, }); } -export interface ModifyAddressAttributeResult { +/** + *Describes the Amazon S3 bucket for the disk image.
+ */ +export interface UserBucket { /** - *Information about the Elastic IP address.
+ *The name of the Amazon S3 bucket where the disk image is located.
*/ - Address?: AddressAttribute; + S3Bucket?: string; + + /** + *The file name of the disk image.
+ */ + S3Key?: string; } -export namespace ModifyAddressAttributeResult { +export namespace UserBucket { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyAddressAttributeResult): any => ({ + export const filterSensitiveLog = (obj: UserBucket): any => ({ ...obj, }); } -export type ModifyAvailabilityZoneOptInStatus = "not-opted-in" | "opted-in"; +/** + *Describes the disk container object for an import image task.
+ */ +export interface ImageDiskContainer { + /** + *The description of the disk image.
+ */ + Description?: string; -export interface ModifyAvailabilityZoneGroupRequest { /** - *The name of the Availability Zone group, Local Zone group, or Wavelength Zone - * group.
+ *The block device mapping for the disk.
*/ - GroupName: string | undefined; + DeviceName?: string; /** - *Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The
- * only valid value is opted-in. You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.
The format of the disk image being imported.
+ *Valid values: OVA | VHD | VHDX | VMDK | RAW
+ *
Checks whether you have the required permissions for the action, without 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 EBS snapshot to be used for importing the snapshot.
*/ - DryRun?: boolean; + SnapshotId?: string; + + /** + *The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an + * Amazon S3 URL (s3://..)
+ */ + Url?: string; + + /** + *The S3 bucket for the disk image.
+ */ + UserBucket?: UserBucket; } -export namespace ModifyAvailabilityZoneGroupRequest { +export namespace ImageDiskContainer { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyAvailabilityZoneGroupRequest): any => ({ + export const filterSensitiveLog = (obj: ImageDiskContainer): any => ({ ...obj, }); } -export interface ModifyAvailabilityZoneGroupResult { +/** + *The request information of license configurations.
+ */ +export interface ImportImageLicenseConfigurationRequest { /** - *Is true if the request succeeds, and an error otherwise.
The ARN of a license configuration.
*/ - Return?: boolean; + LicenseConfigurationArn?: string; } -export namespace ModifyAvailabilityZoneGroupResult { +export namespace ImportImageLicenseConfigurationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyAvailabilityZoneGroupResult): any => ({ + export const filterSensitiveLog = (obj: ImportImageLicenseConfigurationRequest): any => ({ ...obj, }); } -export interface ModifyCapacityReservationRequest { +export interface ImportImageRequest { /** - *The ID of the Capacity Reservation.
+ *The architecture of the virtual machine.
+ *Valid values: i386 | x86_64 | arm64
+ *
The number of instances for which to reserve capacity. The number of instances can't be increased or
- * decreased by more than 1000 in a single request.
The client-specific data.
*/ - InstanceCount?: number; + ClientData?: ClientData; /** - *The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity
- * is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
- * expired when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify - * 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
- *You must provide an EndDate value if EndDateType is
- * limited. Omit EndDate if EndDateType is
- * unlimited.
The token to enable idempotency for VM import requests.
*/ - EndDate?: Date; + ClientToken?: string; /** - *Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end - * types:
- *
- * unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not
- * provide an EndDate value if EndDateType is
- * unlimited.
- * limited - The Capacity Reservation expires automatically at a specified date and time. You must
- * provide an EndDate value if EndDateType is
- * limited.
A description string for the import image task.
*/ - EndDateType?: EndDateType | string; + Description?: string; /** - *Reserved. Capacity Reservations you have created are accepted by default.
+ *Information about the disk containers.
*/ - Accept?: boolean; + DiskContainers?: ImageDiskContainer[]; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Specifies whether 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.
Returns true if the request succeeds; otherwise, it returns an error.
The target hypervisor platform.
+ *Valid values: xen
+ *
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 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 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 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 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.
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 KMS key must exist in the Region that the AMI is being copied to.
+ *Amazon EBS does not support asymmetric KMS keys.
*/ - export const filterSensitiveLog = (obj: ModifyCapacityReservationResult): any => ({ - ...obj, - }); -} + KmsKeyId?: string; -export interface ModifyCapacityReservationFleetRequest { /** - *The ID of the Capacity Reservation Fleet to modify.
+ *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 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 Amazon Web Services. For more information, see Prerequisites in the
+ * VM Import/Export User Guide.
The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, - * together with the instance type weights that you assign to each instance type used by the Fleet - * determine the number of instances for which the Fleet reserves capacity. Both values are based on - * units that make sense for your workload. For more information, see Total target capacity - * in the Amazon EC2 User Guide.
+ *The operating system of the virtual machine.
+ *Valid values: Windows | Linux
+ *
The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation
- * Fleet expires, its state changes to expired and all of the Capacity Reservations in the
- * Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you
- * specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed
- * to expire between 13:30:55 and 14:30:55 on 5/31/2019.
You can't specify EndDate and - * RemoveEndDate in the same request.
+ *The name of the role to use when not using the default role, 'vmimport'.
*/ - EndDate?: Date; + RoleName?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The ARNs of the license configurations.
*/ - DryRun?: boolean; + LicenseSpecifications?: ImportImageLicenseConfigurationRequest[]; /** - *Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the - * end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly - * cancel it using the CancelCapacityReservationFleet action.
- *You can't specify RemoveEndDate and - * EndDate in the same request.
+ *The tags to apply to the import image task during creation.
*/ - RemoveEndDate?: boolean; -} + TagSpecifications?: TagSpecification[]; -export namespace ModifyCapacityReservationFleetRequest { /** - * @internal + *The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.
*/ - export const filterSensitiveLog = (obj: ModifyCapacityReservationFleetRequest): any => ({ - ...obj, - }); -} + UsageOperation?: string; -export interface ModifyCapacityReservationFleetResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
The boot mode of the virtual machine.
*/ - Return?: boolean; + BootMode?: BootModeValues | string; } -export namespace ModifyCapacityReservationFleetResult { +export namespace ImportImageRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyCapacityReservationFleetResult): any => ({ + export const filterSensitiveLog = (obj: ImportImageRequest): any => ({ ...obj, }); } -/** - *Information about the DNS server to be used.
- */ -export interface DnsServersOptionsModifyStructure { - /** - *The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to - * two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values - * overwrite the existing values.
- */ - CustomDnsServers?: string[]; - +export interface ImportImageResult { /** - *Indicates whether DNS servers should be used. Specify False to delete the existing DNS
- * servers.
The architecture of the virtual machine.
*/ - Enabled?: boolean; -} + Architecture?: string; -export namespace DnsServersOptionsModifyStructure { /** - * @internal + *A description of the import task.
*/ - export const filterSensitiveLog = (obj: DnsServersOptionsModifyStructure): any => ({ - ...obj, - }); -} + Description?: string; -export interface ModifyClientVpnEndpointRequest { /** - *The ID of the Client VPN endpoint to modify.
+ *Indicates whether the AMI is encrypted.
*/ - ClientVpnEndpointId: string | undefined; + Encrypted?: boolean; /** - *The ARN of the server certificate to be used. The server certificate must be provisioned in - * Certificate Manager (ACM).
+ *The target hypervisor of the import task.
*/ - ServerCertificateArn?: string; + Hypervisor?: string; /** - *Information about the client connection logging options.
- *If you enable client connection logging, data about client connections is sent to a - * Cloudwatch Logs log stream. The following information is logged:
- *Client connection requests
- *Client connection results (successful and unsuccessful)
- *Reasons for unsuccessful client connection requests
- *Client connection termination time
- *The ID of the Amazon Machine Image (AMI) created by the import task.
*/ - ConnectionLogOptions?: ConnectionLogOptions; + ImageId?: string; /** - *Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have - * up to two DNS servers.
+ *The task ID of the import image task.
*/ - DnsServers?: DnsServersOptionsModifyStructure; + ImportTaskId?: string; /** - *The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
- *Valid Values: 443 | 1194
- *
Default Value: 443
- *
The identifier for the symmetric KMS key that was used to create the encrypted AMI.
*/ - VpnPort?: number; + KmsKeyId?: string; /** - *A brief description of the Client VPN endpoint.
+ *The license type of the virtual machine.
*/ - Description?: string; + LicenseType?: string; /** - *Indicates whether the VPN is split-tunnel.
- *For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the - * Client VPN Administrator Guide.
+ *The operating system of the virtual machine.
*/ - SplitTunnel?: boolean; + Platform?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The progress of the task.
*/ - DryRun?: boolean; + Progress?: string; /** - *The IDs of one or more security groups to apply to the target network.
+ *Information about the snapshots.
*/ - SecurityGroupIds?: string[]; + SnapshotDetails?: SnapshotDetail[]; /** - *The ID of the VPC to associate with the Client VPN endpoint.
+ *A brief status of the task.
*/ - VpcId?: string; + Status?: string; /** - *Specify whether to enable the self-service portal for the Client VPN endpoint.
+ *A detailed status message of the import task.
*/ - SelfServicePortal?: SelfServicePortal | string; + StatusMessage?: string; /** - *The options for managing connection authorization for new client connections.
+ *The ARNs of the license configurations.
*/ - ClientConnectOptions?: ClientConnectOptions; -} + LicenseSpecifications?: ImportImageLicenseConfigurationResponse[]; -export namespace ModifyClientVpnEndpointRequest { /** - * @internal + *Any tags assigned to the import image task.
*/ - export const filterSensitiveLog = (obj: ModifyClientVpnEndpointRequest): any => ({ - ...obj, - }); -} + Tags?: Tag[]; -export interface ModifyClientVpnEndpointResult { /** - *Returns true if the request succeeds; otherwise, it returns an error.
The usage operation value.
*/ - Return?: boolean; + UsageOperation?: string; } -export namespace ModifyClientVpnEndpointResult { +export namespace ImportImageResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyClientVpnEndpointResult): any => ({ + export const filterSensitiveLog = (obj: ImportImageResult): any => ({ ...obj, }); } -export interface ModifyDefaultCreditSpecificationRequest { +/** + *Describes a disk image.
+ */ +export interface DiskImageDetail { /** - *Checks whether you have the required permissions for the action, without 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 size of the disk image, in GiB.
*/ - DryRun?: boolean; + Bytes: number | undefined; /** - *The instance family.
+ *The disk image format.
*/ - InstanceFamily: UnlimitedSupportedInstanceFamily | string | undefined; + Format: DiskImageFormat | string | undefined; /** - *The credit option for CPU usage of the instance family.
- *Valid Values: standard | unlimited
- *
A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. + * For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication + * Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer + * Guide.
+ *For information about the import manifest referenced by this API action, see VM Import Manifest.
*/ - CpuCredits: string | undefined; + ImportManifestUrl: string | undefined; } -export namespace ModifyDefaultCreditSpecificationRequest { +export namespace DiskImageDetail { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyDefaultCreditSpecificationRequest): any => ({ + export const filterSensitiveLog = (obj: DiskImageDetail): any => ({ ...obj, }); } -export interface ModifyDefaultCreditSpecificationResult { +/** + *Describes an EBS volume.
+ */ +export interface VolumeDetail { /** - *The default credit option for CPU usage of the instance family.
+ *The size of the volume, in GiB.
*/ - InstanceFamilyCreditSpecification?: InstanceFamilyCreditSpecification; + Size: number | undefined; } -export namespace ModifyDefaultCreditSpecificationResult { +export namespace VolumeDetail { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyDefaultCreditSpecificationResult): any => ({ + export const filterSensitiveLog = (obj: VolumeDetail): any => ({ ...obj, }); } -export interface ModifyEbsDefaultKmsKeyIdRequest { +/** + *Describes a disk image.
+ */ +export interface DiskImage { /** - *The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.
- * If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is
- * specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
- *Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
- *Key alias. For example, alias/ExampleAlias.
- *Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
- *Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
- *Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, - * the action can appear to complete, but eventually fails.
- *Amazon EBS does not support asymmetric KMS keys.
+ *A description of the disk image.
*/ - KmsKeyId: string | undefined; + Description?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Information about the disk image.
*/ - DryRun?: boolean; + Image?: DiskImageDetail; + + /** + *Information about the volume.
+ */ + Volume?: VolumeDetail; } -export namespace ModifyEbsDefaultKmsKeyIdRequest { +export namespace DiskImage { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyEbsDefaultKmsKeyIdRequest): any => ({ + export const filterSensitiveLog = (obj: DiskImage): any => ({ ...obj, }); } -export interface ModifyEbsDefaultKmsKeyIdResult { +/** + *Describes the user data for an instance.
+ */ +export interface UserData { /** - *The Amazon Resource Name (ARN) of the default KMS key for encryption by default.
+ *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.
*/ - KmsKeyId?: string; + Data?: string; } -export namespace ModifyEbsDefaultKmsKeyIdResult { +export namespace UserData { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyEbsDefaultKmsKeyIdResult): any => ({ + export const filterSensitiveLog = (obj: UserData): any => ({ ...obj, }); } -export interface ModifyFleetRequest { +/** + *Describes the launch specification for VM import.
+ */ +export interface ImportInstanceLaunchSpecification { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Reserved.
*/ - DryRun?: boolean; + AdditionalInfo?: string; /** - *Indicates whether running instances should be terminated if the total target capacity of - * the EC2 Fleet is decreased below the current size of the EC2 Fleet.
+ *The architecture of the instance.
*/ - ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy | string; + Architecture?: ArchitectureValues | string; /** - *The launch template and overrides.
+ *The security group IDs.
*/ - LaunchTemplateConfigs?: FleetLaunchTemplateConfigRequest[]; + GroupIds?: string[]; /** - *The ID of the EC2 Fleet.
+ *The security group names.
*/ - FleetId: string | undefined; + GroupNames?: string[]; /** - *The size of the EC2 Fleet.
+ *Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the + * operating system command for system shutdown).
*/ - TargetCapacitySpecification?: TargetCapacitySpecificationRequest; + InstanceInitiatedShutdownBehavior?: ShutdownBehavior | string; /** - *Reserved.
+ *The instance type. For more information about the instance types that you can import, see Instance Types in the + * VM Import/Export User Guide.
*/ - Context?: string; -} + InstanceType?: _InstanceType | string; -export namespace ModifyFleetRequest { /** - * @internal + *Indicates whether monitoring is enabled.
*/ - export const filterSensitiveLog = (obj: ModifyFleetRequest): any => ({ - ...obj, - }); -} + Monitoring?: boolean; -export interface ModifyFleetResult { /** - *Is true if the request succeeds, and an error otherwise.
The placement information for the instance.
*/ - Return?: boolean; -} + Placement?: Placement; -export namespace ModifyFleetResult { /** - * @internal + *[EC2-VPC] An available IP address from the IP address range of the subnet.
*/ - export const filterSensitiveLog = (obj: ModifyFleetResult): any => ({ - ...obj, - }); -} + PrivateIpAddress?: string; -/** - *Describes a load permission.
- */ -export interface LoadPermissionRequest { /** - *The name of the group.
+ *[EC2-VPC] The ID of the subnet in which to launch the instance.
*/ - Group?: PermissionGroup | string; + SubnetId?: string; /** - *The Amazon Web Services account ID.
+ *The Base64-encoded user data to make available to the instance.
*/ - UserId?: string; + UserData?: UserData; } -export namespace LoadPermissionRequest { +export namespace ImportInstanceLaunchSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: LoadPermissionRequest): any => ({ + export const filterSensitiveLog = (obj: ImportInstanceLaunchSpecification): any => ({ ...obj, + ...(obj.UserData && { UserData: SENSITIVE_STRING }), }); } -/** - *Describes modifications to the load permissions of an Amazon FPGA image (AFI).
- */ -export interface LoadPermissionModifications { - /** - *The load permissions to add.
- */ - Add?: LoadPermissionRequest[]; - +export interface ImportInstanceRequest { /** - *The load permissions to remove.
+ *A description for the instance being imported.
*/ - Remove?: LoadPermissionRequest[]; -} + Description?: string; -export namespace LoadPermissionModifications { /** - * @internal + *The disk image.
*/ - export const filterSensitiveLog = (obj: LoadPermissionModifications): any => ({ - ...obj, - }); -} - -export type OperationType = "add" | "remove"; + DiskImages?: DiskImage[]; -export interface ModifyFpgaImageAttributeRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -7911,422 +8467,370 @@ export interface ModifyFpgaImageAttributeRequest {
DryRun?: boolean;
/**
- *
The ID of the AFI.
- */ - FpgaImageId: string | undefined; - - /** - *The name of the attribute.
- */ - Attribute?: FpgaImageAttributeName | string; - - /** - *The operation type.
+ *The launch specification.
*/ - OperationType?: OperationType | string; + LaunchSpecification?: ImportInstanceLaunchSpecification; /** - *The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.
The instance operating system.
*/ - UserIds?: string[]; + Platform: PlatformValues | string | undefined; +} +export namespace ImportInstanceRequest { /** - *The user groups. This parameter is valid only when modifying the loadPermission attribute.
The product codes. After you add a product code to an AFI, it can't be removed.
- * This parameter is valid only when modifying the productCodes attribute.
Information about the conversion task.
*/ - ProductCodes?: string[]; + ConversionTask?: ConversionTask; +} +export namespace ImportInstanceResult { /** - *The load permission for the AFI.
+ * @internal */ - LoadPermission?: LoadPermissionModifications; + export const filterSensitiveLog = (obj: ImportInstanceResult): any => ({ + ...obj, + }); +} +export interface ImportKeyPairRequest { /** - *A description for the AFI.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
A name for the AFI.
+ *A unique name for the key pair.
*/ - Name?: string; -} + KeyName: string | undefined; -export namespace ModifyFpgaImageAttributeRequest { /** - * @internal + *The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
*/ - export const filterSensitiveLog = (obj: ModifyFpgaImageAttributeRequest): any => ({ - ...obj, - }); -} + PublicKeyMaterial: Uint8Array | undefined; -export interface ModifyFpgaImageAttributeResult { /** - *Information about the attribute.
+ *The tags to apply to the imported key pair.
*/ - FpgaImageAttribute?: FpgaImageAttribute; + TagSpecifications?: TagSpecification[]; } -export namespace ModifyFpgaImageAttributeResult { +export namespace ImportKeyPairRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyFpgaImageAttributeResult): any => ({ + export const filterSensitiveLog = (obj: ImportKeyPairRequest): any => ({ ...obj, }); } -export interface ModifyHostsRequest { - /** - *Specify whether to enable or disable auto-placement.
- */ - AutoPlacement?: AutoPlacement | string; - +export interface ImportKeyPairResult { /** - *The IDs of the Dedicated Hosts to modify.
+ *The MD5 public key fingerprint as specified in section 4 of RFC 4716.
*/ - HostIds: string[] | undefined; + KeyFingerprint?: string; /** - *Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, - * see - * Host recovery in the Amazon EC2 User Guide.
+ *The key pair name that you provided.
*/ - HostRecovery?: HostRecovery | string; + KeyName?: string; /** - *Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to - * modify a Dedicated Host to support only a specific instance type.
- * - *If you want to modify a Dedicated Host to support multiple instance types in its current instance - * family, omit this parameter and specify InstanceFamily - * instead. You cannot specify InstanceType and - * InstanceFamily in the same request.
+ *The ID of the resulting key pair.
*/ - InstanceType?: string; + KeyPairId?: string; /** - *Specifies the instance family to be supported by the Dedicated Host. Specify this parameter - * to modify a Dedicated Host to support multiple instance types within its current - * instance family.
- * - *If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter - * and specify InstanceType instead. You cannot specify - * InstanceFamily and InstanceType - * in the same request.
+ *The tags applied to the imported key pair.
*/ - InstanceFamily?: string; + Tags?: Tag[]; } -export namespace ModifyHostsRequest { +export namespace ImportKeyPairResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyHostsRequest): any => ({ + export const filterSensitiveLog = (obj: ImportKeyPairResult): any => ({ ...obj, }); } -export interface ModifyHostsResult { +/** + *The disk container object for the import snapshot request.
+ */ +export interface SnapshotDiskContainer { /** - *The IDs of the Dedicated Hosts that were successfully modified.
+ *The description of the disk image being imported.
*/ - Successful?: string[]; + Description?: string; /** - *The IDs of the Dedicated Hosts that could not be modified. Check whether the - * setting you requested can be used.
+ *The format of the disk image being imported.
+ *Valid values: VHD | VMDK | RAW
+ *
The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon + * S3 URL (s3://..).
+ */ + Url?: string; + + /** + *The Amazon S3 bucket for the disk image.
+ */ + UserBucket?: UserBucket; } -export namespace ModifyHostsResult { +export namespace SnapshotDiskContainer { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyHostsResult): any => ({ + export const filterSensitiveLog = (obj: SnapshotDiskContainer): any => ({ ...obj, }); } -export interface ModifyIdentityIdFormatRequest { +export interface ImportSnapshotRequest { /** - *The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify
- * all to modify the ID format for all IAM users, IAM roles, and the root user of
- * the account.
The client-specific data.
*/ - PrincipalArn: string | undefined; + ClientData?: ClientData; /** - *The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |
- * elastic-ip-allocation | elastic-ip-association |
- * export-task | flow-log | image |
- * import-task | internet-gateway | network-acl
- * | network-acl-association | network-interface |
- * network-interface-attachment | prefix-list |
- * route-table | route-table-association |
- * security-group | subnet |
- * subnet-cidr-block-association | vpc |
- * vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are
- * currently within their opt-in period for longer IDs.
Token to enable idempotency for VM import requests.
*/ - Resource: string | undefined; + ClientToken?: string; /** - *Indicates whether the resource should use longer IDs (17-character IDs)
+ *The description string for the import snapshot task.
*/ - UseLongIds: boolean | undefined; -} + Description?: string; -export namespace ModifyIdentityIdFormatRequest { /** - * @internal + *Information about the disk container.
*/ - export const filterSensitiveLog = (obj: ModifyIdentityIdFormatRequest): any => ({ - ...obj, - }); -} + DiskContainer?: SnapshotDiskContainer; -export interface ModifyIdFormatRequest { /** - *The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |
- * elastic-ip-allocation | elastic-ip-association |
- * export-task | flow-log | image |
- * import-task | internet-gateway | network-acl
- * | network-acl-association | network-interface |
- * network-interface-attachment | prefix-list |
- * route-table | route-table-association |
- * security-group | subnet |
- * subnet-cidr-block-association | vpc |
- * vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are
- * currently within their opt-in period for longer IDs.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Indicate whether the resource should use longer IDs (17-character IDs).
+ *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 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 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 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 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 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.
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 KMS key must exist in the Region that the snapshot is being copied to.
+ *Amazon EBS does not support asymmetric KMS keys.
*/ - export const filterSensitiveLog = (obj: ModifyIdFormatRequest): any => ({ - ...obj, - }); -} + KmsKeyId?: string; -/** - *Describes a launch permission modification.
- */ -export interface LaunchPermissionModifications { /** - *The Amazon Web Services account ID to add to the list of launch permissions for the AMI.
+ *The name of the role to use when not using the default role, 'vmimport'.
*/ - Add?: LaunchPermission[]; + RoleName?: string; /** - *The Amazon Web Services account ID to remove from the list of launch permissions for the AMI.
+ *The tags to apply to the import snapshot task during creation.
*/ - Remove?: LaunchPermission[]; + TagSpecifications?: TagSpecification[]; } -export namespace LaunchPermissionModifications { +export namespace ImportSnapshotRequest { /** * @internal */ - export const filterSensitiveLog = (obj: LaunchPermissionModifications): any => ({ + export const filterSensitiveLog = (obj: ImportSnapshotRequest): any => ({ ...obj, }); } -/** - *Contains the parameters for ModifyImageAttribute.
- */ -export interface ModifyImageAttributeRequest { +export interface ImportSnapshotResult { /** - *The name of the attribute to modify.
- * The valid values are description and launchPermission.
A description of the import snapshot task.
*/ - Attribute?: string; + Description?: string; /** - *A new description for the AMI.
+ *The ID of the import snapshot task.
*/ - Description?: AttributeValue; + ImportTaskId?: string; /** - *The ID of the AMI.
+ *Information about the import snapshot task.
*/ - ImageId: string | undefined; + SnapshotTaskDetail?: SnapshotTaskDetail; /** - *A new launch permission for the AMI.
+ *Any tags assigned to the import snapshot task.
*/ - LaunchPermission?: LaunchPermissionModifications; + Tags?: Tag[]; +} +export namespace ImportSnapshotResult { /** - *The operation type.
- * This parameter can be used only when the Attribute parameter is launchPermission.
Not supported.
+ *The Availability Zone for the resulting EBS volume.
*/ - ProductCodes?: string[]; + AvailabilityZone: string | undefined; /** - *The user groups.
- * This parameter can be used only when the Attribute parameter is launchPermission.
A description of the volume.
*/ - UserGroups?: string[]; + Description?: string; /** - *The Amazon Web Services account IDs.
- * This parameter can be used only when the Attribute parameter is launchPermission.
Checks whether you have the required permissions for the action, without 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 value of the attribute being modified.
- * This parameter can be used only when the Attribute parameter is description.
The disk image.
*/ - Value?: string; + Image: DiskImageDetail | 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 volume size.
*/ - DryRun?: boolean; + Volume: VolumeDetail | undefined; } -export namespace ModifyImageAttributeRequest { +export namespace ImportVolumeRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyImageAttributeRequest): any => ({ - ...obj, - }); -} - -/** - *Describes information used to set up an EBS volume specified in a block device - * mapping.
- */ -export interface EbsInstanceBlockDeviceSpecification { - /** - *Indicates whether the volume is deleted on instance termination.
- */ - DeleteOnTermination?: boolean; + export const filterSensitiveLog = (obj: ImportVolumeRequest): any => ({ + ...obj, + }); +} +export interface ImportVolumeResult { /** - *The ID of the EBS volume.
+ *Information about the conversion task.
*/ - VolumeId?: string; + ConversionTask?: ConversionTask; } -export namespace EbsInstanceBlockDeviceSpecification { +export namespace ImportVolumeResult { /** * @internal */ - export const filterSensitiveLog = (obj: EbsInstanceBlockDeviceSpecification): any => ({ + export const filterSensitiveLog = (obj: ImportVolumeResult): any => ({ ...obj, }); } -/** - *Describes a block device mapping entry.
- */ -export interface InstanceBlockDeviceMappingSpecification { - /** - *The device name (for example, /dev/sdh or xvdh).
Parameters used to automatically set up EBS volumes when the instance is - * launched.
+ *[EC2-VPC] The allocation ID.
*/ - Ebs?: EbsInstanceBlockDeviceSpecification; + AllocationId: string | undefined; /** - *suppress the specified device included in the block device mapping.
+ *The domain name to modify for the IP address.
*/ - NoDevice?: string; + DomainName?: string; /** - *The virtual device name.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Information about the Elastic IP address.
+ */ + Address?: AddressAttribute; } -export namespace BlobAttributeValue { +export namespace ModifyAddressAttributeResult { /** * @internal */ - export const filterSensitiveLog = (obj: BlobAttributeValue): any => ({ + export const filterSensitiveLog = (obj: ModifyAddressAttributeResult): any => ({ ...obj, }); } -export interface ModifyInstanceAttributeRequest { - /** - *Enable or disable source/destination checks, which ensure that the instance
- * is either the source or the destination of any traffic that it receives.
- * If the value is true, source/destination checks are enabled;
- * otherwise, they are disabled. The default value is true.
- * You must disable source/destination checks if the instance runs services
- * such as network address translation, routing, or firewalls.
The name of the attribute.
- */ - Attribute?: InstanceAttributeName | string; +export type ModifyAvailabilityZoneOptInStatus = "not-opted-in" | "opted-in"; +export interface ModifyAvailabilityZoneGroupRequest { /** - *Modifies the DeleteOnTermination attribute for volumes that are currently
- * attached. The volume must be owned by the caller. If no value is specified for
- * DeleteOnTermination, the default is true and the volume is
- * deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when - * you launch the instance. For more information, see Updating the block device mapping when launching an instance in the - * Amazon EC2 User Guide.
+ *The name of the Availability Zone group, Local Zone group, or Wavelength Zone + * group.
*/ - BlockDeviceMappings?: InstanceBlockDeviceMappingSpecification[]; + GroupName: string | undefined; /** - *If the value is true, you can't terminate the instance using the Amazon
- * EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot
- * Instances.
Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The
+ * only valid value is opted-in. You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.
Checks whether you have the required permissions for the action, without actually making the request,
@@ -8334,338 +8838,324 @@ export interface ModifyInstanceAttributeRequest {
* Otherwise, it is UnauthorizedOperation.
Specifies whether the instance is optimized for Amazon EBS I/O. This optimization - * provides dedicated throughput to Amazon EBS and an optimized configuration stack to - * provide optimal EBS I/O performance. This optimization isn't available with all instance - * types. Additional usage charges apply when using an EBS Optimized instance.
- */ - EbsOptimized?: AttributeBooleanValue; - - /** - *Set to true to enable enhanced networking with ENA for the
- * instance.
This option is supported only for HVM instances. Specifying this option with a PV - * instance can make it unreachable.
+ * @internal */ - EnaSupport?: AttributeBooleanValue; + export const filterSensitiveLog = (obj: ModifyAvailabilityZoneGroupRequest): any => ({ + ...obj, + }); +} +export interface ModifyAvailabilityZoneGroupResult { /** - *[EC2-VPC] Replaces the security groups of the instance with the specified security groups. - * You must specify at least one security group, even if it's just the default security group for the VPC. You must - * specify the security group ID, not the security group name.
+ *Is true if the request succeeds, and an error otherwise.
The ID of the instance.
+ * @internal */ - InstanceId: string | undefined; + export const filterSensitiveLog = (obj: ModifyAvailabilityZoneGroupResult): any => ({ + ...obj, + }); +} +export interface ModifyCapacityReservationRequest { /** - *Specifies whether an instance stops or terminates when you initiate shutdown from the - * instance (using the operating system command for system shutdown).
+ *The ID of the Capacity Reservation.
*/ - InstanceInitiatedShutdownBehavior?: AttributeValue; + CapacityReservationId: string | undefined; /** - *Changes the instance type to the specified value. For more information, see Instance
- * types in the Amazon EC2 User Guide. If the instance type is not valid,
- * the error returned is InvalidInstanceAttributeValue.
The number of instances for which to reserve capacity. The number of instances can't be increased or
+ * decreased by more than 1000 in a single request.
Changes the instance's kernel to the specified value. We recommend that you use - * PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
+ *The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity
+ * is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
+ * expired when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify + * 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
+ *You must provide an EndDate value if EndDateType is
+ * limited. Omit EndDate if EndDateType is
+ * unlimited.
Changes the instance's RAM disk to the specified value. We recommend that you use - * PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
+ *Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end + * types:
+ *
+ * unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not
+ * provide an EndDate value if EndDateType is
+ * unlimited.
+ * limited - The Capacity Reservation expires automatically at a specified date and time. You must
+ * provide an EndDate value if EndDateType is
+ * limited.
Set to simple to enable enhanced networking with the Intel 82599 Virtual
- * Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function - * interface at this time.
- *This option is supported only for HVM instances. Specifying this option with a PV - * instance can make it unreachable.
+ *Reserved. Capacity Reservations you have created are accepted by default.
*/ - SriovNetSupport?: AttributeValue; + Accept?: boolean; /** - *Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK - * or command line tool, base64-encoding is performed for you, and you can load the text - * from a file. Otherwise, you must provide base64-encoded text.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
A new value for the attribute. Use only with the kernel,
- * ramdisk, userData, disableApiTermination, or
- * instanceInitiatedShutdownBehavior attribute.
Reserved for future use.
*/ - Value?: string; + AdditionalInfo?: string; } -export namespace ModifyInstanceAttributeRequest { +export namespace ModifyCapacityReservationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstanceAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyCapacityReservationRequest): any => ({ ...obj, }); } -/** - *Describes an instance's Capacity Reservation targeting option. You can specify only one parameter
- * at a time. If you specify CapacityReservationPreference and
- * CapacityReservationTarget, the request fails.
Use the CapacityReservationPreference parameter to configure the instance
- * to run as an On-Demand Instance or to run in any open Capacity Reservation that has
- * matching attributes (instance type, platform, Availability Zone). Use the
- * CapacityReservationTarget parameter to explicitly target a specific
- * Capacity Reservation or a Capacity Reservation group.
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
- *
- * open - The instance can run in any open Capacity Reservation that has matching attributes
- * (instance type, platform, Availability Zone).
- * none - The instance avoids running in a Capacity Reservation even if one is available. The
- * instance runs as an On-Demand Instance.
Information about the target Capacity Reservation or Capacity Reservation group.
+ *Returns true if the request succeeds; otherwise, it returns an error.
The ID of the instance to be modified.
+ *The ID of the Capacity Reservation Fleet to modify.
+ */ + CapacityReservationFleetId: string | undefined; + + /** + *The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, + * together with the instance type weights that you assign to each instance type used by the Fleet + * determine the number of instances for which the Fleet reserves capacity. Both values are based on + * units that make sense for your workload. For more information, see Total target capacity + * in the Amazon EC2 User Guide.
+ */ + TotalTargetCapacity?: number; + + /** + *The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation
+ * Fleet expires, its state changes to expired and all of the Capacity Reservations in the
+ * Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you
+ * specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed
+ * to expire between 13:30:55 and 14:30:55 on 5/31/2019.
You can't specify EndDate and + * RemoveEndDate in the same request.
*/ - InstanceId: string | undefined; + EndDate?: Date; /** - *Information about the Capacity Reservation targeting option.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the + * end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly + * cancel it using the CancelCapacityReservationFleet action.
+ *You can't specify RemoveEndDate and + * EndDate in the same request.
*/ - DryRun?: boolean; + RemoveEndDate?: boolean; } -export namespace ModifyInstanceCapacityReservationAttributesRequest { +export namespace ModifyCapacityReservationFleetRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstanceCapacityReservationAttributesRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyCapacityReservationFleetRequest): any => ({ ...obj, }); } -export interface ModifyInstanceCapacityReservationAttributesResult { +export interface ModifyCapacityReservationFleetResult { /** *Returns true if the request succeeds; otherwise, it returns an error.
Describes the credit option for CPU usage of a burstable performance instance.
+ *Information about the DNS server to be used.
*/ -export interface InstanceCreditSpecificationRequest { +export interface DnsServersOptionsModifyStructure { /** - *The ID of the instance.
+ *The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to + * two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values + * overwrite the existing values.
*/ - InstanceId?: string; + CustomDnsServers?: string[]; /** - *The credit option for CPU usage of the instance. Valid values are
- * standard and unlimited.
T3 instances with host tenancy do not support the unlimited
- * CPU credit option.
Indicates whether DNS servers should be used. Specify False to delete the existing DNS
+ * servers.
Checks whether you have the required permissions for the action, without 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 endpoint to modify.
*/ - DryRun?: boolean; + ClientVpnEndpointId: string | undefined; /** - *A unique, case-sensitive token that you provide to ensure idempotency of your - * modification request. For more information, see Ensuring - * Idempotency.
+ *The ARN of the server certificate to be used. The server certificate must be provisioned in + * Certificate Manager (ACM).
*/ - ClientToken?: string; + ServerCertificateArn?: string; /** - *Information about the credit option for CPU usage.
+ *Information about the client connection logging options.
+ *If you enable client connection logging, data about client connections is sent to a + * Cloudwatch Logs log stream. The following information is logged:
+ *Client connection requests
+ *Client connection results (successful and unsuccessful)
+ *Reasons for unsuccessful client connection requests
+ *Client connection termination time
+ *Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have + * up to two DNS servers.
*/ - export const filterSensitiveLog = (obj: ModifyInstanceCreditSpecificationRequest): any => ({ - ...obj, - }); -} + DnsServers?: DnsServersOptionsModifyStructure; -/** - *Describes the burstable performance instance whose credit option for CPU usage was - * successfully modified.
- */ -export interface SuccessfulInstanceCreditSpecificationItem { /** - *The ID of the instance.
+ *The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
+ *Valid Values: 443 | 1194
+ *
Default Value: 443
+ *
A brief description of the Client VPN endpoint.
*/ - export const filterSensitiveLog = (obj: SuccessfulInstanceCreditSpecificationItem): any => ({ - ...obj, - }); -} + Description?: string; -export enum UnsuccessfulInstanceCreditSpecificationErrorCode { - INCORRECT_INSTANCE_STATE = "IncorrectInstanceState", - INSTANCE_CREDIT_SPECIFICATION_NOT_SUPPORTED = "InstanceCreditSpecification.NotSupported", - INSTANCE_NOT_FOUND = "InvalidInstanceID.NotFound", - INVALID_INSTANCE_ID = "InvalidInstanceID.Malformed", -} + /** + *Indicates whether the VPN is split-tunnel.
+ *For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the + * Client VPN Administrator Guide.
+ */ + SplitTunnel?: boolean; -/** - *Information about the error for the burstable performance instance whose credit option - * for CPU usage was not modified.
- */ -export interface UnsuccessfulInstanceCreditSpecificationItemError { /** - *The error code.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The applicable error message.
+ *The IDs of one or more security groups to apply to the target network.
*/ - Message?: string; -} + SecurityGroupIds?: string[]; -export namespace UnsuccessfulInstanceCreditSpecificationItemError { /** - * @internal + *The ID of the VPC to associate with the Client VPN endpoint.
*/ - export const filterSensitiveLog = (obj: UnsuccessfulInstanceCreditSpecificationItemError): any => ({ - ...obj, - }); -} + VpcId?: string; -/** - *Describes the burstable performance instance whose credit option for CPU usage was not - * modified.
- */ -export interface UnsuccessfulInstanceCreditSpecificationItem { /** - *The ID of the instance.
+ *Specify whether to enable the self-service portal for the Client VPN endpoint.
*/ - InstanceId?: string; + SelfServicePortal?: SelfServicePortal | string; /** - *The applicable error for the burstable performance instance whose credit option for - * CPU usage was not modified.
+ *The options for managing connection authorization for new client connections.
*/ - Error?: UnsuccessfulInstanceCreditSpecificationItemError; + ClientConnectOptions?: ClientConnectOptions; } -export namespace UnsuccessfulInstanceCreditSpecificationItem { +export namespace ModifyClientVpnEndpointRequest { /** * @internal */ - export const filterSensitiveLog = (obj: UnsuccessfulInstanceCreditSpecificationItem): any => ({ + export const filterSensitiveLog = (obj: ModifyClientVpnEndpointRequest): any => ({ ...obj, }); } -export interface ModifyInstanceCreditSpecificationResult { - /** - *Information about the instances whose credit option for CPU usage was successfully - * modified.
- */ - SuccessfulInstanceCreditSpecifications?: SuccessfulInstanceCreditSpecificationItem[]; - +export interface ModifyClientVpnEndpointResult { /** - *Information about the instances whose credit option for CPU usage was not - * modified.
+ *Returns true if the request succeeds; otherwise, it returns an error.
Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
@@ -8674,928 +9164,870 @@ export interface ModifyInstanceEventStartTimeRequest {
DryRun?: boolean;
/**
- *
The ID of the instance with the scheduled event.
- */ - InstanceId: string | undefined; - - /** - *The ID of the event whose date and time you are modifying.
+ *The instance family.
*/ - InstanceEventId: string | undefined; + InstanceFamily: UnlimitedSupportedInstanceFamily | string | undefined; /** - *The new date and time when the event will take place.
+ *The credit option for CPU usage of the instance family.
+ *Valid Values: standard | unlimited
+ *
Describes a scheduled event for an instance.
+ *The default credit option for CPU usage of the instance family.
*/ - Event?: InstanceStatusEvent; + InstanceFamilyCreditSpecification?: InstanceFamilyCreditSpecification; } -export namespace ModifyInstanceEventStartTimeResult { +export namespace ModifyDefaultCreditSpecificationResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstanceEventStartTimeResult): any => ({ + export const filterSensitiveLog = (obj: ModifyDefaultCreditSpecificationResult): any => ({ ...obj, }); } -export interface ModifyInstanceEventWindowRequest { - /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The name of the event window.
- */ - Name?: string; - - /** - *The ID of the event window.
- */ - InstanceEventWindowId: string | undefined; - - /** - *The time ranges of the event window.
- */ - TimeRanges?: InstanceEventWindowTimeRangeRequest[]; - +export interface ModifyEbsDefaultKmsKeyIdRequest { /** - *The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.
Constraints:
+ *The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption.
+ * If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is
+ * specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
*Only hour and day of the week values are supported.
- *For day of the week values, you can specify either integers 0 through
- * 6, or alternative single values SUN through
- * SAT.
The minute, month, and year must be specified by *.
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
*The hour value must be one or a multiple range, for example, 0-4 or
- * 0-4,20-23.
Key alias. For example, alias/ExampleAlias.
*Each hour range must be >= 2 hours, for example, 0-2 or
- * 20-23.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
*The event window must be >= 4 hours. The combined total time ranges in the event - * window must be >= 4 hours.
+ *Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
*For more information about cron expressions, see cron on the Wikipedia - * website.
- */ - CronExpression?: string; -} - -export namespace ModifyInstanceEventWindowRequest { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ModifyInstanceEventWindowRequest): any => ({ - ...obj, - }); -} - -export interface ModifyInstanceEventWindowResult { - /** - *Information about the event window.
- */ - InstanceEventWindow?: InstanceEventWindow; -} - -export namespace ModifyInstanceEventWindowResult { - /** - * @internal - */ - export const filterSensitiveLog = (obj: ModifyInstanceEventWindowResult): any => ({ - ...obj, - }); -} - -export interface ModifyInstanceMetadataOptionsRequest { - /** - *The ID of the instance.
- */ - InstanceId: string | undefined; - - /** - *The state of token usage for your instance metadata requests. If the parameter is not
- * specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata
- * with or without a signed token header on your request. If you retrieve the IAM role
- * credentials without a token, the version 1.0 role credentials are returned. If you
- * retrieve the IAM role credentials using a valid signed token, the version 2.0 role
- * credentials are returned.
If the state is required, you must send a signed token header with any
- * instance metadata retrieval requests. In this state, retrieving the IAM role credential
- * always returns the version 2.0 credentials; the version 1.0 credentials are not
- * available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the - * number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
- *Possible values: Integers from 1 to 64
- */ - HttpPutResponseHopLimit?: number; - - /** - *This parameter enables or disables the HTTP metadata endpoint on your instances. If - * the parameter is not specified, the existing state is maintained.
- *If you specify a value of disabled, you will not be able to access your
- * instance metadata.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, + * the action can appear to complete, but eventually fails.
+ *Amazon EBS does not support asymmetric KMS keys.
*/ - HttpEndpoint?: InstanceMetadataEndpointState | string; + KmsKeyId: string | undefined; /** - *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Enables or disables the IPv6 endpoint for the instance metadata service.
- */ - HttpProtocolIpv6?: InstanceMetadataProtocolState | string; } -export namespace ModifyInstanceMetadataOptionsRequest { +export namespace ModifyEbsDefaultKmsKeyIdRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstanceMetadataOptionsRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyEbsDefaultKmsKeyIdRequest): any => ({ ...obj, }); } -export interface ModifyInstanceMetadataOptionsResult { - /** - *The ID of the instance.
- */ - InstanceId?: string; - +export interface ModifyEbsDefaultKmsKeyIdResult { /** - *The metadata options for the instance.
+ *The Amazon Resource Name (ARN) of the default KMS key for encryption by default.
*/ - InstanceMetadataOptions?: InstanceMetadataOptionsResponse; + KmsKeyId?: string; } -export namespace ModifyInstanceMetadataOptionsResult { +export namespace ModifyEbsDefaultKmsKeyIdResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstanceMetadataOptionsResult): any => ({ + export const filterSensitiveLog = (obj: ModifyEbsDefaultKmsKeyIdResult): any => ({ ...obj, }); } -export type HostTenancy = "dedicated" | "host"; - -export interface ModifyInstancePlacementRequest { - /** - *The affinity setting for the instance.
- */ - Affinity?: Affinity | string; - +export interface ModifyFleetRequest { /** - *The name of the placement group in which to place the instance. For spread placement
- * groups, the instance must have a tenancy of default. For cluster and
- * partition placement groups, the instance must have a tenancy of default or
- * dedicated.
To remove an instance from a placement group, specify an empty string - * ("").
+ *Checks whether you have the required permissions for the action, without 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 Dedicated Host with which to associate the instance.
+ *Indicates whether running instances should be terminated if the total target capacity of + * the EC2 Fleet is decreased below the current size of the EC2 Fleet.
*/ - HostId?: string; + ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy | string; /** - *The ID of the instance that you are modifying.
+ *The launch template and overrides.
*/ - InstanceId: string | undefined; + LaunchTemplateConfigs?: FleetLaunchTemplateConfigRequest[]; /** - *The tenancy for the instance.
- * - *For T3 instances, you can't change the tenancy from dedicated
- * to host, or from host to dedicated.
- * Attempting to make one of these unsupported tenancy changes results in the
- * InvalidTenancy error code.
The ID of the EC2 Fleet.
*/ - Tenancy?: HostTenancy | string; + FleetId: string | undefined; /** - *Reserved for future use.
+ *The size of the EC2 Fleet.
*/ - PartitionNumber?: number; + TargetCapacitySpecification?: TargetCapacitySpecificationRequest; /** - *The ARN of the host resource group in which to place the instance.
+ *Reserved.
*/ - HostResourceGroupArn?: string; + Context?: string; } -export namespace ModifyInstancePlacementRequest { +export namespace ModifyFleetRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyInstancePlacementRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyFleetRequest): any => ({ ...obj, }); } -export interface ModifyInstancePlacementResult { +export interface ModifyFleetResult { /** *Is true if the request succeeds, and an error otherwise.
Describes a load permission.
+ */ +export interface LoadPermissionRequest { /** - *Checks whether you have the required permissions for the action, without actually
- * making the request, and provides an error response. If you have the required
- * permissions, the error response is DryRunOperation. Otherwise, it is
- * UnauthorizedOperation.
The name of the group.
*/ - DryRun?: boolean; + Group?: PermissionGroup | string; /** - *Unique, case-sensitive identifier you provide to ensure the idempotency of the - * request. For more information, see Ensuring - * Idempotency.
- *Constraint: Maximum 128 ASCII characters.
+ *The Amazon Web Services account ID.
*/ - ClientToken?: string; + UserId?: string; +} +export namespace LoadPermissionRequest { /** - *The ID of the launch template. You must specify either the launch template ID or - * launch template name in the request.
+ * @internal */ - LaunchTemplateId?: string; + export const filterSensitiveLog = (obj: LoadPermissionRequest): any => ({ + ...obj, + }); +} +/** + *Describes modifications to the load permissions of an Amazon FPGA image (AFI).
+ */ +export interface LoadPermissionModifications { /** - *The name of the launch template. You must specify either the launch template ID or - * launch template name in the request.
+ *The load permissions to add.
*/ - LaunchTemplateName?: string; + Add?: LoadPermissionRequest[]; /** - *The version number of the launch template to set as the default version.
+ *The load permissions to remove.
*/ - DefaultVersion?: string; + Remove?: LoadPermissionRequest[]; } -export namespace ModifyLaunchTemplateRequest { +export namespace LoadPermissionModifications { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyLaunchTemplateRequest): any => ({ + export const filterSensitiveLog = (obj: LoadPermissionModifications): any => ({ ...obj, }); } -export interface ModifyLaunchTemplateResult { +export type OperationType = "add" | "remove"; + +export interface ModifyFpgaImageAttributeRequest { /** - *Information about the launch template.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the AFI.
*/ - export const filterSensitiveLog = (obj: ModifyLaunchTemplateResult): any => ({ - ...obj, - }); -} + FpgaImageId: string | undefined; -/** - *An entry for a prefix list.
- */ -export interface RemovePrefixListEntry { /** - *The CIDR block.
+ *The name of the attribute.
*/ - Cidr: string | undefined; -} + Attribute?: FpgaImageAttributeName | string; -export namespace RemovePrefixListEntry { /** - * @internal + *The operation type.
*/ - export const filterSensitiveLog = (obj: RemovePrefixListEntry): any => ({ - ...obj, - }); -} + OperationType?: OperationType | string; -export interface ModifyManagedPrefixListRequest { /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.
The ID of the prefix list.
+ *The user groups. This parameter is valid only when modifying the loadPermission attribute.
The product codes. After you add a product code to an AFI, it can't be removed.
+ * This parameter is valid only when modifying the productCodes attribute.
The current version of the prefix list.
+ *The load permission for the AFI.
*/ - CurrentVersion?: number; + LoadPermission?: LoadPermissionModifications; /** - *A name for the prefix list.
+ *A description for the AFI.
*/ - PrefixListName?: string; + Description?: string; /** - *One or more entries to add to the prefix list.
+ *A name for the AFI.
*/ - AddEntries?: AddPrefixListEntry[]; + Name?: string; +} +export namespace ModifyFpgaImageAttributeRequest { /** - *One or more entries to remove from the prefix list.
+ * @internal */ - RemoveEntries?: RemovePrefixListEntry[]; + export const filterSensitiveLog = (obj: ModifyFpgaImageAttributeRequest): any => ({ + ...obj, + }); +} +export interface ModifyFpgaImageAttributeResult { /** - *The maximum number of entries for the prefix list. You cannot modify the entries - * of a prefix list and modify the size of a prefix list at the same time.
- *If any of the resources that reference the prefix list cannot support the new - * maximum size, the modify operation fails. Check the state message for the IDs of - * the first ten resources that do not support the new maximum size.
+ *Information about the attribute.
*/ - MaxEntries?: number; + FpgaImageAttribute?: FpgaImageAttribute; } -export namespace ModifyManagedPrefixListRequest { +export namespace ModifyFpgaImageAttributeResult { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyManagedPrefixListRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyFpgaImageAttributeResult): any => ({ ...obj, }); } -export interface ModifyManagedPrefixListResult { +export interface ModifyHostsRequest { + /** + *Specify whether to enable or disable auto-placement.
+ */ + AutoPlacement?: AutoPlacement | string; + + /** + *The IDs of the Dedicated Hosts to modify.
+ */ + HostIds: string[] | undefined; + + /** + *Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, + * see + * Host recovery in the Amazon EC2 User Guide.
+ */ + HostRecovery?: HostRecovery | string; + + /** + *Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to + * modify a Dedicated Host to support only a specific instance type.
+ * + *If you want to modify a Dedicated Host to support multiple instance types in its current instance + * family, omit this parameter and specify InstanceFamily + * instead. You cannot specify InstanceType and + * InstanceFamily in the same request.
+ */ + InstanceType?: string; + /** - *Information about the prefix list.
+ *Specifies the instance family to be supported by the Dedicated Host. Specify this parameter + * to modify a Dedicated Host to support multiple instance types within its current + * instance family.
+ * + *If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter + * and specify InstanceType instead. You cannot specify + * InstanceFamily and InstanceType + * in the same request.
*/ - PrefixList?: ManagedPrefixList; + InstanceFamily?: string; } -export namespace ModifyManagedPrefixListResult { +export namespace ModifyHostsRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyManagedPrefixListResult): any => ({ + export const filterSensitiveLog = (obj: ModifyHostsRequest): any => ({ ...obj, }); } -/** - *Describes an attachment change.
- */ -export interface NetworkInterfaceAttachmentChanges { +export interface ModifyHostsResult { /** - *The ID of the network interface attachment.
+ *The IDs of the Dedicated Hosts that were successfully modified.
*/ - AttachmentId?: string; + Successful?: string[]; /** - *Indicates whether the network interface is deleted when the instance is terminated.
+ *The IDs of the Dedicated Hosts that could not be modified. Check whether the + * setting you requested can be used.
*/ - DeleteOnTermination?: boolean; + Unsuccessful?: UnsuccessfulItem[]; } -export namespace NetworkInterfaceAttachmentChanges { +export namespace ModifyHostsResult { /** * @internal */ - export const filterSensitiveLog = (obj: NetworkInterfaceAttachmentChanges): any => ({ + export const filterSensitiveLog = (obj: ModifyHostsResult): any => ({ ...obj, }); } -/** - *Contains the parameters for ModifyNetworkInterfaceAttribute.
- */ -export interface ModifyNetworkInterfaceAttributeRequest { +export interface ModifyIdentityIdFormatRequest { /** - *Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
+ *The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify
+ * all to modify the ID format for all IAM users, IAM roles, and the root user of
+ * the account.
A description for the network interface.
+ *The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |
+ * elastic-ip-allocation | elastic-ip-association |
+ * export-task | flow-log | image |
+ * import-task | internet-gateway | network-acl
+ * | network-acl-association | network-interface |
+ * network-interface-attachment | prefix-list |
+ * route-table | route-table-association |
+ * security-group | subnet |
+ * subnet-cidr-block-association | vpc |
+ * vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are
+ * currently within their opt-in period for longer IDs.
Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
Indicates whether the resource should use longer IDs (17-character IDs)
*/ - DryRun?: boolean; + UseLongIds: boolean | undefined; +} +export namespace ModifyIdentityIdFormatRequest { /** - *Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
+ * @internal */ - Groups?: string[]; + export const filterSensitiveLog = (obj: ModifyIdentityIdFormatRequest): any => ({ + ...obj, + }); +} +export interface ModifyIdFormatRequest { /** - *The ID of the network interface.
+ *The type of resource: bundle | conversion-task | customer-gateway | dhcp-options |
+ * elastic-ip-allocation | elastic-ip-association |
+ * export-task | flow-log | image |
+ * import-task | internet-gateway | network-acl
+ * | network-acl-association | network-interface |
+ * network-interface-attachment | prefix-list |
+ * route-table | route-table-association |
+ * security-group | subnet |
+ * subnet-cidr-block-association | vpc |
+ * vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are
+ * currently within their opt-in period for longer IDs.
Enable or disable source/destination checks, which ensure that the instance
- * is either the source or the destination of any traffic that it receives.
- * If the value is true, source/destination checks are enabled;
- * otherwise, they are disabled. The default value is true.
- * You must disable source/destination checks if the instance runs services
- * such as network address translation, routing, or firewalls.
Indicate whether the resource should use longer IDs (17-character IDs).
*/ - SourceDestCheck?: AttributeBooleanValue; + UseLongIds: boolean | undefined; } -export namespace ModifyNetworkInterfaceAttributeRequest { +export namespace ModifyIdFormatRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyNetworkInterfaceAttributeRequest): any => ({ + export const filterSensitiveLog = (obj: ModifyIdFormatRequest): any => ({ ...obj, }); } /** - *Contains the parameters for ModifyReservedInstances.
+ *Describes a launch permission modification.
*/ -export interface ModifyReservedInstancesRequest { - /** - *The IDs of the Reserved Instances to modify.
- */ - ReservedInstancesIds: string[] | undefined; - +export interface LaunchPermissionModifications { /** - *A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see - * Ensuring Idempotency.
+ *The Amazon Web Services account ID to add to the list of launch permissions for the AMI.
*/ - ClientToken?: string; + Add?: LaunchPermission[]; /** - *The configuration settings for the Reserved Instances to modify.
+ *The Amazon Web Services account ID to remove from the list of launch permissions for the AMI.
*/ - TargetConfigurations: ReservedInstancesConfiguration[] | undefined; + Remove?: LaunchPermission[]; } -export namespace ModifyReservedInstancesRequest { +export namespace LaunchPermissionModifications { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyReservedInstancesRequest): any => ({ + export const filterSensitiveLog = (obj: LaunchPermissionModifications): any => ({ ...obj, }); } /** - *Contains the output of ModifyReservedInstances.
+ *Contains the parameters for ModifyImageAttribute.
*/ -export interface ModifyReservedInstancesResult { +export interface ModifyImageAttributeRequest { /** - *The ID for the modification.
+ *The name of the attribute to modify.
+ * The valid values are description and launchPermission.
A new description for the AMI.
*/ - export const filterSensitiveLog = (obj: ModifyReservedInstancesResult): any => ({ - ...obj, - }); -} + Description?: AttributeValue; -/** - *Describes a security group rule.
- *You must specify exactly one of the following parameters, based on the rule type:
- *CidrIpv4
- *CidrIpv6
- *PrefixListId
- *ReferencedGroupId
- *When you modify a rule, you cannot change the rule type. For example, if the rule
- * uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4
- * address range.
The IP protocol name (tcp, udp, icmp,
- * icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
The ID of the AMI.
*/ - IpProtocol?: string; + ImageId: string | undefined; /** - *The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
+ *A new launch permission for the AMI.
*/ - FromPort?: number; + LaunchPermission?: LaunchPermissionModifications; /** - *The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The operation type.
+ * This parameter can be used only when the Attribute parameter is launchPermission.
The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
+ *Not supported.
*/ - CidrIpv4?: string; + ProductCodes?: string[]; /** - *The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
+ *The user groups.
+ * This parameter can be used only when the Attribute parameter is launchPermission.
The ID of the prefix list.
+ *The Amazon Web Services account IDs.
+ * This parameter can be used only when the Attribute parameter is launchPermission.
The ID of the security group that is referenced in the security group rule.
+ *The value of the attribute being modified.
+ * This parameter can be used only when the Attribute parameter is description.
The description of the security group rule.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Describes an update to a security group rule.
+ *Describes information used to set up an EBS volume specified in a block device + * mapping.
*/ -export interface SecurityGroupRuleUpdate { +export interface EbsInstanceBlockDeviceSpecification { /** - *The ID of the security group rule.
+ *Indicates whether the volume is deleted on instance termination.
*/ - SecurityGroupRuleId?: string; + DeleteOnTermination?: boolean; /** - *Information about the security group rule.
+ *The ID of the EBS volume.
*/ - SecurityGroupRule?: SecurityGroupRuleRequest; + VolumeId?: string; } -export namespace SecurityGroupRuleUpdate { +export namespace EbsInstanceBlockDeviceSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: SecurityGroupRuleUpdate): any => ({ + export const filterSensitiveLog = (obj: EbsInstanceBlockDeviceSpecification): any => ({ ...obj, }); } -export interface ModifySecurityGroupRulesRequest { +/** + *Describes a block device mapping entry.
+ */ +export interface InstanceBlockDeviceMappingSpecification { + /** + *The device name (for example, /dev/sdh or xvdh).
The ID of the security group.
+ *Parameters used to automatically set up EBS volumes when the instance is + * launched.
*/ - GroupId: string | undefined; + Ebs?: EbsInstanceBlockDeviceSpecification; /** - *Information about the security group properties to update.
+ *suppress the specified device included in the block device mapping.
*/ - SecurityGroupRules: SecurityGroupRuleUpdate[] | undefined; + NoDevice?: string; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The virtual device name.
*/ - DryRun?: boolean; + VirtualName?: string; } -export namespace ModifySecurityGroupRulesRequest { +export namespace InstanceBlockDeviceMappingSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: ModifySecurityGroupRulesRequest): any => ({ + export const filterSensitiveLog = (obj: InstanceBlockDeviceMappingSpecification): any => ({ ...obj, }); } -export interface ModifySecurityGroupRulesResult { - /** - *Returns true if the request succeeds; otherwise, returns an error.
Describes modifications to the list of create volume permissions for a volume.
- */ -export interface CreateVolumePermissionModifications { - /** - *Adds the specified Amazon Web Services account ID or group to the list.
- */ - Add?: CreateVolumePermission[]; - +export interface ModifyInstanceAttributeRequest { /** - *Removes the specified Amazon Web Services account ID or group from the list.
+ *Enable or disable source/destination checks, which ensure that the instance
+ * is either the source or the destination of any traffic that it receives.
+ * If the value is true, source/destination checks are enabled;
+ * otherwise, they are disabled. The default value is true.
+ * You must disable source/destination checks if the instance runs services
+ * such as network address translation, routing, or firewalls.
The name of the attribute.
*/ - export const filterSensitiveLog = (obj: CreateVolumePermissionModifications): any => ({ - ...obj, - }); -} + Attribute?: InstanceAttributeName | string; -export interface ModifySnapshotAttributeRequest { /** - *The snapshot attribute to modify. Only volume creation permissions can be modified.
+ *Modifies the DeleteOnTermination attribute for volumes that are currently
+ * attached. The volume must be owned by the caller. If no value is specified for
+ * DeleteOnTermination, the default is true and the volume is
+ * deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when + * you launch the instance. For more information, see Updating the block device mapping when launching an instance in the + * Amazon EC2 User Guide.
*/ - Attribute?: SnapshotAttributeName | string; + BlockDeviceMappings?: InstanceBlockDeviceMappingSpecification[]; /** - *A JSON representation of the snapshot attribute modification.
+ *If the value is true, you can't terminate the instance using the Amazon
+ * EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot
+ * Instances.
The group to modify for the snapshot.
+ *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The type of operation to perform to the attribute.
+ *Specifies whether the instance is optimized for Amazon EBS I/O. This optimization + * provides dedicated throughput to Amazon EBS and an optimized configuration stack to + * provide optimal EBS I/O performance. This optimization isn't available with all instance + * types. Additional usage charges apply when using an EBS Optimized instance.
*/ - OperationType?: OperationType | string; + EbsOptimized?: AttributeBooleanValue; /** - *The ID of the snapshot.
+ *Set to true to enable enhanced networking with ENA for the
+ * instance.
This option is supported only for HVM instances. Specifying this option with a PV + * instance can make it unreachable.
*/ - SnapshotId: string | undefined; + EnaSupport?: AttributeBooleanValue; /** - *The account ID to modify for the snapshot.
+ *[EC2-VPC] Replaces the security groups of the instance with the specified security groups. + * You must specify at least one security group, even if it's just the default security group for the VPC. You must + * specify the security group ID, not the security group name.
*/ - UserIds?: string[]; + Groups?: string[]; /** - *Checks whether you have the required permissions for the action, without actually making the request,
- * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
- * Otherwise, it is UnauthorizedOperation.
The ID of the instance.
*/ - DryRun?: boolean; -} + InstanceId: string | undefined; -export namespace ModifySnapshotAttributeRequest { /** - * @internal + *Specifies whether an instance stops or terminates when you initiate shutdown from the + * instance (using the operating system command for system shutdown).
*/ - export const filterSensitiveLog = (obj: ModifySnapshotAttributeRequest): any => ({ - ...obj, - }); -} + InstanceInitiatedShutdownBehavior?: AttributeValue; -/** - *Contains the parameters for ModifySpotFleetRequest.
- */ -export interface ModifySpotFleetRequestRequest { /** - *Indicates whether running Spot Instances should be terminated if the target capacity - * of the Spot Fleet request is decreased below the current size of the Spot Fleet.
+ *Changes the instance type to the specified value. For more information, see Instance
+ * types in the Amazon EC2 User Guide. If the instance type is not valid,
+ * the error returned is InvalidInstanceAttributeValue.
The launch template and overrides. You can only use this parameter if you specified a
- * launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you
- * specified LaunchSpecifications in your Spot Fleet request, then omit this
- * parameter.
Changes the instance's kernel to the specified value. We recommend that you use + * PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
*/ - LaunchTemplateConfigs?: LaunchTemplateConfig[]; + Kernel?: AttributeValue; /** - *The ID of the Spot Fleet request.
+ *Changes the instance's RAM disk to the specified value. We recommend that you use + * PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
*/ - SpotFleetRequestId: string | undefined; + Ramdisk?: AttributeValue; /** - *The size of the fleet.
+ *Set to simple to enable enhanced networking with the Intel 82599 Virtual
+ * Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function + * interface at this time.
+ *This option is supported only for HVM instances. Specifying this option with a PV + * instance can make it unreachable.
*/ - TargetCapacity?: number; + SriovNetSupport?: AttributeValue; /** - *The number of On-Demand Instances in the fleet.
+ *Changes the instance's user data to the specified value. If you are using an Amazon Web Services SDK + * or command line tool, base64-encoding is performed for you, and you can load the text + * from a file. Otherwise, you must provide base64-encoded text.
*/ - OnDemandTargetCapacity?: number; + UserData?: BlobAttributeValue; /** - *Reserved.
+ *A new value for the attribute. Use only with the kernel,
+ * ramdisk, userData, disableApiTermination, or
+ * instanceInitiatedShutdownBehavior attribute.
Contains the output of ModifySpotFleetRequest.
+ *Describes an instance's Capacity Reservation targeting option. You can specify only one parameter
+ * at a time. If you specify CapacityReservationPreference and
+ * CapacityReservationTarget, the request fails.
Use the CapacityReservationPreference parameter to configure the instance
+ * to run as an On-Demand Instance or to run in any open Capacity Reservation that has
+ * matching attributes (instance type, platform, Availability Zone). Use the
+ * CapacityReservationTarget parameter to explicitly target a specific
+ * Capacity Reservation or a Capacity Reservation group.
Is true if the request succeeds, and an error otherwise.
Indicates the instance's Capacity Reservation preferences. Possible preferences include:
+ *
+ * open - The instance can run in any open Capacity Reservation that has matching attributes
+ * (instance type, platform, Availability Zone).
+ * none - The instance avoids running in a Capacity Reservation even if one is available. The
+ * instance runs as an On-Demand Instance.
Information about the target Capacity Reservation or Capacity Reservation group.
+ */ + CapacityReservationTarget?: CapacityReservationTarget; } -export namespace ModifySpotFleetRequestResponse { +export namespace CapacityReservationSpecification { /** * @internal */ - export const filterSensitiveLog = (obj: ModifySpotFleetRequestResponse): any => ({ + export const filterSensitiveLog = (obj: CapacityReservationSpecification): any => ({ ...obj, }); } -export interface ModifySubnetAttributeRequest { +export interface ModifyInstanceCapacityReservationAttributesRequest { /** - *Specify true to indicate that network interfaces created in the
- * specified subnet should be assigned an IPv6 address. This includes a network interface
- * that's created when launching an instance into the subnet (the instance therefore
- * receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface
- * or instance only receives an IPv6 address if it's created using version
- * 2016-11-15 or later of the Amazon EC2 API.
The ID of the instance to be modified.
*/ - AssignIpv6AddressOnCreation?: AttributeBooleanValue; + InstanceId: string | undefined; /** - *Specify true to indicate that network interfaces attached to instances created in the
- * specified subnet should be assigned a public IPv4 address.
Information about the Capacity Reservation targeting option.
*/ - MapPublicIpOnLaunch?: AttributeBooleanValue; + CapacityReservationSpecification: CapacityReservationSpecification | undefined; /** - *The ID of the subnet.
+ *Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Specify true to indicate that network interfaces attached to instances created in the
- * specified subnet should be assigned a customer-owned IPv4 address.
When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.
The customer-owned IPv4 address pool associated with the subnet.
- *You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.
Returns true if the request succeeds; otherwise, it returns an error.
Describes the credit option for CPU usage of a burstable performance instance.
+ */ +export interface InstanceCreditSpecificationRequest { /** - *The ID of the Traffic Mirror filter.
+ *The ID of the instance.
*/ - TrafficMirrorFilterId: string | undefined; + InstanceId?: string; /** - *The network service, for example Amazon DNS, that you want to mirror.
+ *The credit option for CPU usage of the instance. Valid values are
+ * standard and unlimited.
T3 instances with host tenancy do not support the unlimited
+ * CPU credit option.
The network service, for example Amazon DNS, that you no longer want to mirror.
+ * @internal */ - RemoveNetworkServices?: (TrafficMirrorNetworkService | string)[]; + export const filterSensitiveLog = (obj: InstanceCreditSpecificationRequest): any => ({ + ...obj, + }); +} +export interface ModifyInstanceCreditSpecificationRequest { /** *Checks whether you have the required permissions for the action, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is DryRunOperation.
* Otherwise, it is UnauthorizedOperation.
A unique, case-sensitive token that you provide to ensure idempotency of your + * modification request. For more information, see Ensuring + * Idempotency.
*/ - export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterNetworkServicesRequest): any => ({ - ...obj, - }); -} + ClientToken?: string; -export interface ModifyTrafficMirrorFilterNetworkServicesResult { /** - *The Traffic Mirror filter that the network service is associated with.
+ *Information about the credit option for CPU usage.
*/ - TrafficMirrorFilter?: TrafficMirrorFilter; + InstanceCreditSpecifications: InstanceCreditSpecificationRequest[] | undefined; } -export namespace ModifyTrafficMirrorFilterNetworkServicesResult { +export namespace ModifyInstanceCreditSpecificationRequest { /** * @internal */ - export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterNetworkServicesResult): any => ({ + export const filterSensitiveLog = (obj: ModifyInstanceCreditSpecificationRequest): any => ({ ...obj, }); } - -export type TrafficMirrorFilterRuleField = "description" | "destination-port-range" | "protocol" | "source-port-range"; diff --git a/clients/client-ec2/src/models/models_5.ts b/clients/client-ec2/src/models/models_5.ts index 991b37796b69..a9d0f864edd7 100644 --- a/clients/client-ec2/src/models/models_5.ts +++ b/clients/client-ec2/src/models/models_5.ts @@ -1,15 +1,18 @@ import { _InstanceType, + AddPrefixListEntry, AddressAttribute, AddressAttributeName, + Affinity, ApplianceModeSupportValue, - BlockDeviceMapping, + AttributeValue, ByoipCidr, ClientVpnAuthorizationRuleStatus, CurrencyCodeValues, DnsSupportValue, IamInstanceProfileAssociation, IamInstanceProfileSpecification, + InstanceEventWindow, IpPermission, Ipv6SupportValue, Placement, @@ -20,59 +23,70 @@ import { TransitGatewayPeeringAttachment, TransitGatewayVpcAttachment, UnsuccessfulItem, - VolumeType, } from "./models_0"; import { AutoAcceptSharedAttachmentsValue, + BlockDeviceMapping, CreditSpecificationRequest, DefaultRouteTableAssociationValue, DefaultRouteTablePropagationValue, ElasticGpuSpecification, IcmpTypeCode, - IKEVersionsRequestListValue, + InstanceEventWindowTimeRangeRequest, InstanceInterruptionBehavior, InstanceIpv6Address, + LaunchTemplate, LocalGatewayRoute, ManagedPrefixList, MarketType, - Phase1DHGroupNumbersRequestListValue, - Phase1EncryptionAlgorithmsRequestListValue, - Phase1IntegrityAlgorithmsRequestListValue, - Phase2DHGroupNumbersRequestListValue, - Phase2EncryptionAlgorithmsRequestListValue, - Phase2IntegrityAlgorithmsRequestListValue, PortRange, RuleAction, ShutdownBehavior, SpotInstanceType, TrafficDirection, + TrafficMirrorFilter, TrafficMirrorFilterRule, + TrafficMirrorNetworkService, TrafficMirrorPortRangeRequest, TrafficMirrorRuleAction, TrafficMirrorSession, TransitGateway, TransitGatewayPrefixListReference, TransitGatewayRoute, + VolumeType, VpnEcmpSupportValue, } from "./models_1"; import { - ArchitectureValues, - BootModeValues, ClientVpnConnectionStatus, Filter, + IKEVersionsRequestListValue, InstanceTagNotificationAttribute, + Phase1DHGroupNumbersRequestListValue, + Phase1EncryptionAlgorithmsRequestListValue, + Phase1IntegrityAlgorithmsRequestListValue, + Phase2DHGroupNumbersRequestListValue, + Phase2EncryptionAlgorithmsRequestListValue, + Phase2IntegrityAlgorithmsRequestListValue, VpnConnection, } from "./models_2"; import { + ArchitectureValues, AttributeBooleanValue, + BootModeValues, + CreateVolumePermission, + ExcessCapacityTerminationPolicy, HttpTokensState, InstanceAttributeName, InstanceMetadataEndpointState, + InstanceMetadataOptionsResponse, InstanceMetadataProtocolState, InstanceNetworkInterfaceSpecification, InstanceState, + InstanceStatusEvent, + LaunchTemplateConfig, Monitoring, NetworkInsightsAnalysis, + ReservedInstancesConfiguration, RunInstancesMonitoringEnabled, ScheduledInstance, SnapshotAttributeName, @@ -80,12 +94,1043 @@ import { SpotInstanceRequest, SpotPlacement, } from "./models_3"; -import { - CapacityReservationSpecification, - Purchase, - TrafficMirrorFilterRuleField, - VolumeModification, -} from "./models_4"; +import { CapacityReservationSpecification, OperationType, Purchase, VolumeModification } from "./models_4"; + +/** + *Describes the burstable performance instance whose credit option for CPU usage was + * successfully modified.
+ */ +export interface SuccessfulInstanceCreditSpecificationItem { + /** + *The ID of the instance.
+ */ + InstanceId?: string; +} + +export namespace SuccessfulInstanceCreditSpecificationItem { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SuccessfulInstanceCreditSpecificationItem): any => ({ + ...obj, + }); +} + +export enum UnsuccessfulInstanceCreditSpecificationErrorCode { + INCORRECT_INSTANCE_STATE = "IncorrectInstanceState", + INSTANCE_CREDIT_SPECIFICATION_NOT_SUPPORTED = "InstanceCreditSpecification.NotSupported", + INSTANCE_NOT_FOUND = "InvalidInstanceID.NotFound", + INVALID_INSTANCE_ID = "InvalidInstanceID.Malformed", +} + +/** + *Information about the error for the burstable performance instance whose credit option + * for CPU usage was not modified.
+ */ +export interface UnsuccessfulInstanceCreditSpecificationItemError { + /** + *The error code.
+ */ + Code?: UnsuccessfulInstanceCreditSpecificationErrorCode | string; + + /** + *The applicable error message.
+ */ + Message?: string; +} + +export namespace UnsuccessfulInstanceCreditSpecificationItemError { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UnsuccessfulInstanceCreditSpecificationItemError): any => ({ + ...obj, + }); +} + +/** + *Describes the burstable performance instance whose credit option for CPU usage was not + * modified.
+ */ +export interface UnsuccessfulInstanceCreditSpecificationItem { + /** + *The ID of the instance.
+ */ + InstanceId?: string; + + /** + *The applicable error for the burstable performance instance whose credit option for + * CPU usage was not modified.
+ */ + Error?: UnsuccessfulInstanceCreditSpecificationItemError; +} + +export namespace UnsuccessfulInstanceCreditSpecificationItem { + /** + * @internal + */ + export const filterSensitiveLog = (obj: UnsuccessfulInstanceCreditSpecificationItem): any => ({ + ...obj, + }); +} + +export interface ModifyInstanceCreditSpecificationResult { + /** + *Information about the instances whose credit option for CPU usage was successfully + * modified.
+ */ + SuccessfulInstanceCreditSpecifications?: SuccessfulInstanceCreditSpecificationItem[]; + + /** + *Information about the instances whose credit option for CPU usage was not + * modified.
+ */ + UnsuccessfulInstanceCreditSpecifications?: UnsuccessfulInstanceCreditSpecificationItem[]; +} + +export namespace ModifyInstanceCreditSpecificationResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyInstanceCreditSpecificationResult): any => ({ + ...obj, + }); +} + +export interface ModifyInstanceEventStartTimeRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the instance with the scheduled event.
+ */ + InstanceId: string | undefined; + + /** + *The ID of the event whose date and time you are modifying.
+ */ + InstanceEventId: string | undefined; + + /** + *The new date and time when the event will take place.
+ */ + NotBefore: Date | undefined; +} + +export namespace ModifyInstanceEventStartTimeRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyInstanceEventStartTimeRequest): any => ({ + ...obj, + }); +} + +export interface ModifyInstanceEventStartTimeResult { + /** + *Describes a scheduled event for an instance.
+ */ + Event?: InstanceStatusEvent; +} + +export namespace ModifyInstanceEventStartTimeResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyInstanceEventStartTimeResult): any => ({ + ...obj, + }); +} + +export interface ModifyInstanceEventWindowRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The name of the event window.
+ */ + Name?: string; + + /** + *The ID of the event window.
+ */ + InstanceEventWindowId: string | undefined; + + /** + *The time ranges of the event window.
+ */ + TimeRanges?: InstanceEventWindowTimeRangeRequest[]; + + /** + *The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.
Constraints:
+ *Only hour and day of the week values are supported.
+ *For day of the week values, you can specify either integers 0 through
+ * 6, or alternative single values SUN through
+ * SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or
+ * 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or
+ * 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event + * window must be >= 4 hours.
+ *For more information about cron expressions, see cron on the Wikipedia + * website.
+ */ + CronExpression?: string; +} + +export namespace ModifyInstanceEventWindowRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyInstanceEventWindowRequest): any => ({ + ...obj, + }); +} + +export interface ModifyInstanceEventWindowResult { + /** + *Information about the event window.
+ */ + InstanceEventWindow?: InstanceEventWindow; +} + +export namespace ModifyInstanceEventWindowResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyInstanceEventWindowResult): any => ({ + ...obj, + }); +} + +export interface ModifyInstanceMetadataOptionsRequest { + /** + *The ID of the instance.
+ */ + InstanceId: string | undefined; + + /** + *The state of token usage for your instance metadata requests. If the parameter is not
+ * specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata
+ * with or without a signed token header on your request. If you retrieve the IAM role
+ * credentials without a token, the version 1.0 role credentials are returned. If you
+ * retrieve the IAM role credentials using a valid signed token, the version 2.0 role
+ * credentials are returned.
If the state is required, you must send a signed token header with any
+ * instance metadata retrieval requests. In this state, retrieving the IAM role credential
+ * always returns the version 2.0 credentials; the version 1.0 credentials are not
+ * available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the + * number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
+ *Possible values: Integers from 1 to 64
+ */ + HttpPutResponseHopLimit?: number; + + /** + *This parameter enables or disables the HTTP metadata endpoint on your instances. If + * the parameter is not specified, the existing state is maintained.
+ *If you specify a value of disabled, you will not be able to access your
+ * instance metadata.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Enables or disables the IPv6 endpoint for the instance metadata service.
+ */ + HttpProtocolIpv6?: InstanceMetadataProtocolState | string; +} + +export namespace ModifyInstanceMetadataOptionsRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyInstanceMetadataOptionsRequest): any => ({ + ...obj, + }); +} + +export interface ModifyInstanceMetadataOptionsResult { + /** + *The ID of the instance.
+ */ + InstanceId?: string; + + /** + *The metadata options for the instance.
+ */ + InstanceMetadataOptions?: InstanceMetadataOptionsResponse; +} + +export namespace ModifyInstanceMetadataOptionsResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyInstanceMetadataOptionsResult): any => ({ + ...obj, + }); +} + +export type HostTenancy = "dedicated" | "host"; + +export interface ModifyInstancePlacementRequest { + /** + *The affinity setting for the instance.
+ */ + Affinity?: Affinity | string; + + /** + *The name of the placement group in which to place the instance. For spread placement
+ * groups, the instance must have a tenancy of default. For cluster and
+ * partition placement groups, the instance must have a tenancy of default or
+ * dedicated.
To remove an instance from a placement group, specify an empty string + * ("").
+ */ + GroupName?: string; + + /** + *The ID of the Dedicated Host with which to associate the instance.
+ */ + HostId?: string; + + /** + *The ID of the instance that you are modifying.
+ */ + InstanceId: string | undefined; + + /** + *The tenancy for the instance.
+ * + *For T3 instances, you can't change the tenancy from dedicated
+ * to host, or from host to dedicated.
+ * Attempting to make one of these unsupported tenancy changes results in the
+ * InvalidTenancy error code.
Reserved for future use.
+ */ + PartitionNumber?: number; + + /** + *The ARN of the host resource group in which to place the instance.
+ */ + HostResourceGroupArn?: string; +} + +export namespace ModifyInstancePlacementRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyInstancePlacementRequest): any => ({ + ...obj, + }); +} + +export interface ModifyInstancePlacementResult { + /** + *Is true if the request succeeds, and an error otherwise.
Checks whether you have the required permissions for the action, without actually
+ * making the request, and provides an error response. If you have the required
+ * permissions, the error response is DryRunOperation. Otherwise, it is
+ * UnauthorizedOperation.
Unique, case-sensitive identifier you provide to ensure the idempotency of the + * request. For more information, see Ensuring + * Idempotency.
+ *Constraint: Maximum 128 ASCII characters.
+ */ + ClientToken?: string; + + /** + *The ID of the launch template. You must specify either the launch template ID or + * launch template name in the request.
+ */ + LaunchTemplateId?: string; + + /** + *The name of the launch template. You must specify either the launch template ID or + * launch template name in the request.
+ */ + LaunchTemplateName?: string; + + /** + *The version number of the launch template to set as the default version.
+ */ + DefaultVersion?: string; +} + +export namespace ModifyLaunchTemplateRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyLaunchTemplateRequest): any => ({ + ...obj, + }); +} + +export interface ModifyLaunchTemplateResult { + /** + *Information about the launch template.
+ */ + LaunchTemplate?: LaunchTemplate; +} + +export namespace ModifyLaunchTemplateResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyLaunchTemplateResult): any => ({ + ...obj, + }); +} + +/** + *An entry for a prefix list.
+ */ +export interface RemovePrefixListEntry { + /** + *The CIDR block.
+ */ + Cidr: string | undefined; +} + +export namespace RemovePrefixListEntry { + /** + * @internal + */ + export const filterSensitiveLog = (obj: RemovePrefixListEntry): any => ({ + ...obj, + }); +} + +export interface ModifyManagedPrefixListRequest { + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The ID of the prefix list.
+ */ + PrefixListId: string | undefined; + + /** + *The current version of the prefix list.
+ */ + CurrentVersion?: number; + + /** + *A name for the prefix list.
+ */ + PrefixListName?: string; + + /** + *One or more entries to add to the prefix list.
+ */ + AddEntries?: AddPrefixListEntry[]; + + /** + *One or more entries to remove from the prefix list.
+ */ + RemoveEntries?: RemovePrefixListEntry[]; + + /** + *The maximum number of entries for the prefix list. You cannot modify the entries + * of a prefix list and modify the size of a prefix list at the same time.
+ *If any of the resources that reference the prefix list cannot support the new + * maximum size, the modify operation fails. Check the state message for the IDs of + * the first ten resources that do not support the new maximum size.
+ */ + MaxEntries?: number; +} + +export namespace ModifyManagedPrefixListRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyManagedPrefixListRequest): any => ({ + ...obj, + }); +} + +export interface ModifyManagedPrefixListResult { + /** + *Information about the prefix list.
+ */ + PrefixList?: ManagedPrefixList; +} + +export namespace ModifyManagedPrefixListResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyManagedPrefixListResult): any => ({ + ...obj, + }); +} + +/** + *Describes an attachment change.
+ */ +export interface NetworkInterfaceAttachmentChanges { + /** + *The ID of the network interface attachment.
+ */ + AttachmentId?: string; + + /** + *Indicates whether the network interface is deleted when the instance is terminated.
+ */ + DeleteOnTermination?: boolean; +} + +export namespace NetworkInterfaceAttachmentChanges { + /** + * @internal + */ + export const filterSensitiveLog = (obj: NetworkInterfaceAttachmentChanges): any => ({ + ...obj, + }); +} + +/** + *Contains the parameters for ModifyNetworkInterfaceAttribute.
+ */ +export interface ModifyNetworkInterfaceAttributeRequest { + /** + *Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
+ */ + Attachment?: NetworkInterfaceAttachmentChanges; + + /** + *A description for the network interface.
+ */ + Description?: AttributeValue; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
+ */ + Groups?: string[]; + + /** + *The ID of the network interface.
+ */ + NetworkInterfaceId: string | undefined; + + /** + *Enable or disable source/destination checks, which ensure that the instance
+ * is either the source or the destination of any traffic that it receives.
+ * If the value is true, source/destination checks are enabled;
+ * otherwise, they are disabled. The default value is true.
+ * You must disable source/destination checks if the instance runs services
+ * such as network address translation, routing, or firewalls.
Contains the parameters for ModifyReservedInstances.
+ */ +export interface ModifyReservedInstancesRequest { + /** + *The IDs of the Reserved Instances to modify.
+ */ + ReservedInstancesIds: string[] | undefined; + + /** + *A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see + * Ensuring Idempotency.
+ */ + ClientToken?: string; + + /** + *The configuration settings for the Reserved Instances to modify.
+ */ + TargetConfigurations: ReservedInstancesConfiguration[] | undefined; +} + +export namespace ModifyReservedInstancesRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyReservedInstancesRequest): any => ({ + ...obj, + }); +} + +/** + *Contains the output of ModifyReservedInstances.
+ */ +export interface ModifyReservedInstancesResult { + /** + *The ID for the modification.
+ */ + ReservedInstancesModificationId?: string; +} + +export namespace ModifyReservedInstancesResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyReservedInstancesResult): any => ({ + ...obj, + }); +} + +/** + *Describes a security group rule.
+ *You must specify exactly one of the following parameters, based on the rule type:
+ *CidrIpv4
+ *CidrIpv6
+ *PrefixListId
+ *ReferencedGroupId
+ *When you modify a rule, you cannot change the rule type. For example, if the rule
+ * uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4
+ * address range.
The IP protocol name (tcp, udp, icmp,
+ * icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
+ */ + FromPort?: number; + + /** + *The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
+ */ + CidrIpv4?: string; + + /** + *The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
+ */ + CidrIpv6?: string; + + /** + *The ID of the prefix list.
+ */ + PrefixListId?: string; + + /** + *The ID of the security group that is referenced in the security group rule.
+ */ + ReferencedGroupId?: string; + + /** + *The description of the security group rule.
+ */ + Description?: string; +} + +export namespace SecurityGroupRuleRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SecurityGroupRuleRequest): any => ({ + ...obj, + }); +} + +/** + *Describes an update to a security group rule.
+ */ +export interface SecurityGroupRuleUpdate { + /** + *The ID of the security group rule.
+ */ + SecurityGroupRuleId?: string; + + /** + *Information about the security group rule.
+ */ + SecurityGroupRule?: SecurityGroupRuleRequest; +} + +export namespace SecurityGroupRuleUpdate { + /** + * @internal + */ + export const filterSensitiveLog = (obj: SecurityGroupRuleUpdate): any => ({ + ...obj, + }); +} + +export interface ModifySecurityGroupRulesRequest { + /** + *The ID of the security group.
+ */ + GroupId: string | undefined; + + /** + *Information about the security group properties to update.
+ */ + SecurityGroupRules: SecurityGroupRuleUpdate[] | undefined; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Returns true if the request succeeds; otherwise, returns an error.
Describes modifications to the list of create volume permissions for a volume.
+ */ +export interface CreateVolumePermissionModifications { + /** + *Adds the specified Amazon Web Services account ID or group to the list.
+ */ + Add?: CreateVolumePermission[]; + + /** + *Removes the specified Amazon Web Services account ID or group from the list.
+ */ + Remove?: CreateVolumePermission[]; +} + +export namespace CreateVolumePermissionModifications { + /** + * @internal + */ + export const filterSensitiveLog = (obj: CreateVolumePermissionModifications): any => ({ + ...obj, + }); +} + +export interface ModifySnapshotAttributeRequest { + /** + *The snapshot attribute to modify. Only volume creation permissions can be modified.
+ */ + Attribute?: SnapshotAttributeName | string; + + /** + *A JSON representation of the snapshot attribute modification.
+ */ + CreateVolumePermission?: CreateVolumePermissionModifications; + + /** + *The group to modify for the snapshot.
+ */ + GroupNames?: string[]; + + /** + *The type of operation to perform to the attribute.
+ */ + OperationType?: OperationType | string; + + /** + *The ID of the snapshot.
+ */ + SnapshotId: string | undefined; + + /** + *The account ID to modify for the snapshot.
+ */ + UserIds?: string[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
Contains the parameters for ModifySpotFleetRequest.
+ */ +export interface ModifySpotFleetRequestRequest { + /** + *Indicates whether running Spot Instances should be terminated if the target capacity + * of the Spot Fleet request is decreased below the current size of the Spot Fleet.
+ */ + ExcessCapacityTerminationPolicy?: ExcessCapacityTerminationPolicy | string; + + /** + *The launch template and overrides. You can only use this parameter if you specified a
+ * launch template (LaunchTemplateConfigs) in your Spot Fleet request. If you
+ * specified LaunchSpecifications in your Spot Fleet request, then omit this
+ * parameter.
The ID of the Spot Fleet request.
+ */ + SpotFleetRequestId: string | undefined; + + /** + *The size of the fleet.
+ */ + TargetCapacity?: number; + + /** + *The number of On-Demand Instances in the fleet.
+ */ + OnDemandTargetCapacity?: number; + + /** + *Reserved.
+ */ + Context?: string; +} + +export namespace ModifySpotFleetRequestRequest { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifySpotFleetRequestRequest): any => ({ + ...obj, + }); +} + +/** + *Contains the output of ModifySpotFleetRequest.
+ */ +export interface ModifySpotFleetRequestResponse { + /** + *Is true if the request succeeds, and an error otherwise.
Specify true to indicate that network interfaces created in the
+ * specified subnet should be assigned an IPv6 address. This includes a network interface
+ * that's created when launching an instance into the subnet (the instance therefore
+ * receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface
+ * or instance only receives an IPv6 address if it's created using version
+ * 2016-11-15 or later of the Amazon EC2 API.
Specify true to indicate that network interfaces attached to instances created in the
+ * specified subnet should be assigned a public IPv4 address.
The ID of the subnet.
+ */ + SubnetId: string | undefined; + + /** + *Specify true to indicate that network interfaces attached to instances created in the
+ * specified subnet should be assigned a customer-owned IPv4 address.
When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.
The customer-owned IPv4 address pool associated with the subnet.
+ *You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.
The ID of the Traffic Mirror filter.
+ */ + TrafficMirrorFilterId: string | undefined; + + /** + *The network service, for example Amazon DNS, that you want to mirror.
+ */ + AddNetworkServices?: (TrafficMirrorNetworkService | string)[]; + + /** + *The network service, for example Amazon DNS, that you no longer want to mirror.
+ */ + RemoveNetworkServices?: (TrafficMirrorNetworkService | string)[]; + + /** + *Checks whether you have the required permissions for the action, without actually making the request,
+ * and provides an error response. If you have the required permissions, the error response is DryRunOperation.
+ * Otherwise, it is UnauthorizedOperation.
The Traffic Mirror filter that the network service is associated with.
+ */ + TrafficMirrorFilter?: TrafficMirrorFilter; +} + +export namespace ModifyTrafficMirrorFilterNetworkServicesResult { + /** + * @internal + */ + export const filterSensitiveLog = (obj: ModifyTrafficMirrorFilterNetworkServicesResult): any => ({ + ...obj, + }); +} + +export type TrafficMirrorFilterRuleField = "description" | "destination-port-range" | "protocol" | "source-port-range"; export interface ModifyTrafficMirrorFilterRuleRequest { /** diff --git a/clients/client-ec2/src/pagination/GetInstanceTypesFromInstanceRequirementsPaginator.ts b/clients/client-ec2/src/pagination/GetInstanceTypesFromInstanceRequirementsPaginator.ts new file mode 100644 index 000000000000..25a61cbb6165 --- /dev/null +++ b/clients/client-ec2/src/pagination/GetInstanceTypesFromInstanceRequirementsPaginator.ts @@ -0,0 +1,59 @@ +import { Paginator } from "@aws-sdk/types"; + +import { + GetInstanceTypesFromInstanceRequirementsCommand, + GetInstanceTypesFromInstanceRequirementsCommandInput, + GetInstanceTypesFromInstanceRequirementsCommandOutput, +} from "../commands/GetInstanceTypesFromInstanceRequirementsCommand"; +import { EC2 } from "../EC2"; +import { EC2Client } from "../EC2Client"; +import { EC2PaginationConfiguration } from "./Interfaces"; + +/** + * @private + */ +const makePagedClientRequest = async ( + client: EC2Client, + input: GetInstanceTypesFromInstanceRequirementsCommandInput, + ...args: any +): Promise