@aws-sdk/client-evs 3.1032.0 → 3.1033.0

package/dist-types/models/models_0.d.ts

@@ -1,4 +1,4 @@
-import type { _InstanceType, CheckResult, CheckType, EnvironmentState, HostState, VcfVersion, VlanState } from "./enums";
+import type { _InstanceType, CheckResult, CheckType, ConnectorState, ConnectorType, EntitlementStatus, EntitlementType, EnvironmentState, HostState, VcfVersion, VlanState } from "./enums";
 /**
  * @public
  */
@@ -137,6 +137,118 @@ export interface ValidationExceptionField {
      */
     message: string | undefined;
 }
+/**
+ * @public
+ */
+export interface CreateEntitlementRequest {
+    /**
+     * <note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the entitlement creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+    /**
+     * <p>A unique ID for the environment to create the entitlement in.</p>
+     * @public
+     */
+    environmentId: string | undefined;
+    /**
+     * <p>A unique ID for the connector associated with the entitlement.</p>
+     * @public
+     */
+    connectorId: string | undefined;
+    /**
+     * <p>The type of entitlement to create.</p>
+     * @public
+     */
+    entitlementType: EntitlementType | undefined;
+    /**
+     * <p>The list of VMware vSphere virtual machine managed object IDs to create entitlements for.</p>
+     * @public
+     */
+    vmIds: string[] | undefined;
+}
+/**
+ * <p>An object that contains error details for an entitlement.</p>
+ * @public
+ */
+export interface ErrorDetail {
+    /**
+     * <p>The error code.</p>
+     * @public
+     */
+    errorCode: string | undefined;
+    /**
+     * <p>The error message.</p>
+     * @public
+     */
+    errorMessage: string | undefined;
+}
+/**
+ * <p>An object that represents a Windows Server License entitlement for a virtual machine in an Amazon EVS environment.</p>
+ * @public
+ */
+export interface VmEntitlement {
+    /**
+     * <p>The unique ID of the virtual machine.</p>
+     * @public
+     */
+    vmId?: string | undefined;
+    /**
+     * <p>The unique ID of the environment.</p>
+     * @public
+     */
+    environmentId?: string | undefined;
+    /**
+     * <p>The unique ID of the connector associated with the entitlement.</p>
+     * @public
+     */
+    connectorId?: string | undefined;
+    /**
+     * <p>The name of the virtual machine.</p>
+     * @public
+     */
+    vmName?: string | undefined;
+    /**
+     * <p>The type of entitlement.</p>
+     * @public
+     */
+    type?: EntitlementType | undefined;
+    /**
+     * <p>The status of the entitlement.</p>
+     * @public
+     */
+    status?: EntitlementStatus | undefined;
+    /**
+     * <p>The date and time that the entitlement was last synced.</p>
+     * @public
+     */
+    lastSyncedAt?: Date | undefined;
+    /**
+     * <p>The date and time that the entitlement started.</p>
+     * @public
+     */
+    startedAt?: Date | undefined;
+    /**
+     * <p>The date and time that the entitlement stopped.</p>
+     * @public
+     */
+    stoppedAt?: Date | undefined;
+    /**
+     * <p>The error details associated with the entitlement, if applicable.</p>
+     * @public
+     */
+    errorDetail?: ErrorDetail | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateEntitlementResponse {
+    /**
+     * <p>A list of the created entitlements.</p>
+     * @public
+     */
+    entitlements?: VmEntitlement[] | undefined;
+}
 /**
  * <p>The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.</p>
  * @public
@@ -562,6 +674,133 @@ export interface CreateEnvironmentResponse {
      */
     environment?: Environment | undefined;
 }
+/**
+ * @public
+ */
+export interface CreateEnvironmentConnectorRequest {
+    /**
+     * <note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+    /**
+     * <p>A unique ID for the environment to create the connector in.</p>
+     * @public
+     */
+    environmentId: string | undefined;
+    /**
+     * <p>The type of connector to create.</p>
+     * @public
+     */
+    type: ConnectorType | undefined;
+    /**
+     * <p>The fully qualified domain name (FQDN) of the VCF appliance that the connector targets.</p>
+     * @public
+     */
+    applianceFqdn: string | undefined;
+    /**
+     * <p>The ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.</p> <important> <p>Do not use credentials with Administrator privileges. We recommend using a service account with the minimum required permissions.</p> </important>
+     * @public
+     */
+    secretIdentifier: string | undefined;
+}
+/**
+ * <p>A check on a connector to identify connectivity health.</p>
+ * @public
+ */
+export interface ConnectorCheck {
+    /**
+     * <p>The check type.</p>
+     * @public
+     */
+    type?: CheckType | undefined;
+    /**
+     * <p>The check result.</p>
+     * @public
+     */
+    result?: CheckResult | undefined;
+    /**
+     * <p>The date and time of the last check attempt.</p>
+     * @public
+     */
+    lastCheckAttempt?: Date | undefined;
+    /**
+     * <p>The time when connector health began to be impaired.</p>
+     * @public
+     */
+    impairedSince?: Date | undefined;
+}
+/**
+ * <p>An object that represents a connector for an Amazon EVS environment. A connector establishes a vCenter connection using the credentials stored in Amazon Web Services Secrets Manager.</p>
+ * @public
+ */
+export interface Connector {
+    /**
+     * <p>The unique ID of the environment that the connector belongs to.</p>
+     * @public
+     */
+    environmentId?: string | undefined;
+    /**
+     * <p>The unique ID of the connector.</p>
+     * @public
+     */
+    connectorId?: string | undefined;
+    /**
+     * <p>The type of the connector.</p>
+     * @public
+     */
+    type?: ConnectorType | undefined;
+    /**
+     * <p>The fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.</p>
+     * @public
+     */
+    applianceFqdn?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.</p>
+     * @public
+     */
+    secretArn?: string | undefined;
+    /**
+     * <p>The state of the connector.</p>
+     * @public
+     */
+    state?: ConnectorState | undefined;
+    /**
+     * <p>A detailed description of the connector state.</p>
+     * @public
+     */
+    stateDetails?: string | undefined;
+    /**
+     * <p>The status of the connector.</p>
+     * @public
+     */
+    status?: CheckResult | undefined;
+    /**
+     * <p>A list of checks that are run on the connector.</p>
+     * @public
+     */
+    checks?: ConnectorCheck[] | undefined;
+    /**
+     * <p>The date and time that the connector was created.</p>
+     * @public
+     */
+    createdAt?: Date | undefined;
+    /**
+     * <p>The date and time that the connector was modified.</p>
+     * @public
+     */
+    modifiedAt?: Date | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateEnvironmentConnectorResponse {
+    /**
+     * <p>A description of the created connector.</p>
+     * @public
+     */
+    connector?: Connector | undefined;
+}
 /**
  * @public
  */
@@ -725,6 +964,46 @@ export interface CreateEnvironmentHostResponse {
      */
     host?: Host | undefined;
 }
+/**
+ * @public
+ */
+export interface DeleteEntitlementRequest {
+    /**
+     * <note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the entitlement deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+    /**
+     * <p>A unique ID for the environment that the entitlement belongs to.</p>
+     * @public
+     */
+    environmentId: string | undefined;
+    /**
+     * <p>A unique ID for the connector associated with the entitlement.</p>
+     * @public
+     */
+    connectorId: string | undefined;
+    /**
+     * <p>The type of entitlement to delete.</p>
+     * @public
+     */
+    entitlementType: EntitlementType | undefined;
+    /**
+     * <p>The list of VMware vSphere virtual machine managed object IDs to delete entitlements for.</p>
+     * @public
+     */
+    vmIds: string[] | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteEntitlementResponse {
+    /**
+     * <p>A list of the deleted entitlements.</p>
+     * @public
+     */
+    entitlements?: VmEntitlement[] | undefined;
+}
 /**
  * @public
  */
@@ -750,6 +1029,41 @@ export interface DeleteEnvironmentResponse {
      */
     environment?: Environment | undefined;
 }
+/**
+ * @public
+ */
+export interface DeleteEnvironmentConnectorRequest {
+    /**
+     * <note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+    /**
+     * <p>A unique ID for the environment that the connector belongs to.</p>
+     * @public
+     */
+    environmentId: string | undefined;
+    /**
+     * <p>A unique ID for the connector to be deleted.</p>
+     * @public
+     */
+    connectorId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteEnvironmentConnectorResponse {
+    /**
+     * <p>A description of the deleted connector.</p>
+     * @public
+     */
+    connector?: Connector | undefined;
+    /**
+     * <p>A summary of the environment that the connector was deleted from.</p>
+     * @public
+     */
+    environmentSummary?: EnvironmentSummary | undefined;
+}
 /**
  * @public
  */
@@ -840,6 +1154,41 @@ export interface GetEnvironmentResponse {
      */
     environment?: Environment | undefined;
 }
+/**
+ * @public
+ */
+export interface ListEnvironmentConnectorsRequest {
+    /**
+     * <p>A unique pagination token for each page. If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+    /**
+     * <p>The maximum number of results to return. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified.</p>
+     * @public
+     */
+    maxResults?: number | undefined;
+    /**
+     * <p>A unique ID for the environment.</p>
+     * @public
+     */
+    environmentId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListEnvironmentConnectorsResponse {
+    /**
+     * <p>A unique pagination token for next page results. Make the call again using this token to retrieve the next page.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+    /**
+     * <p>A list of connectors in the environment.</p>
+     * @public
+     */
+    connectors?: Connector[] | undefined;
+}
 /**
  * @public
  */
@@ -945,6 +1294,91 @@ export interface ListEnvironmentVlansResponse {
      */
     environmentVlans?: Vlan[] | undefined;
 }
+/**
+ * @public
+ */
+export interface ListVmEntitlementsRequest {
+    /**
+     * <p>A unique pagination token for each page. If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+    /**
+     * <p>The maximum number of results to return. If you specify <code>MaxResults</code> in the request, the response includes information up to the limit specified.</p>
+     * @public
+     */
+    maxResults?: number | undefined;
+    /**
+     * <p>A unique ID for the environment.</p>
+     * @public
+     */
+    environmentId: string | undefined;
+    /**
+     * <p>A unique ID for the connector.</p>
+     * @public
+     */
+    connectorId: string | undefined;
+    /**
+     * <p>The type of entitlement to list.</p>
+     * @public
+     */
+    entitlementType: EntitlementType | undefined;
+}
+/**
+ * @public
+ */
+export interface ListVmEntitlementsResponse {
+    /**
+     * <p>A unique pagination token for next page results. Make the call again using this token to retrieve the next page.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+    /**
+     * <p>A list of entitlements for virtual machines in the environment.</p>
+     * @public
+     */
+    entitlements?: VmEntitlement[] | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateEnvironmentConnectorRequest {
+    /**
+     * <note> <p>This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.</p> </note> <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector update request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+    /**
+     * <p>A unique ID for the environment that the connector belongs to.</p>
+     * @public
+     */
+    environmentId: string | undefined;
+    /**
+     * <p>A unique ID for the connector to update.</p>
+     * @public
+     */
+    connectorId: string | undefined;
+    /**
+     * <p>The new fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.</p>
+     * @public
+     */
+    applianceFqdn?: string | undefined;
+    /**
+     * <p>The new ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.</p>
+     * @public
+     */
+    secretIdentifier?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateEnvironmentConnectorResponse {
+    /**
+     * <p>A description of the updated connector.</p>
+     * @public
+     */
+    connector?: Connector | undefined;
+}
 /**
  * @public
  */

package/dist-types/pagination/ListEnvironmentConnectorsPaginator.d.ts

@@ -0,0 +1,7 @@
+import type { Paginator } from "@smithy/types";
+import { ListEnvironmentConnectorsCommandInput, ListEnvironmentConnectorsCommandOutput } from "../commands/ListEnvironmentConnectorsCommand";
+import type { EvsPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListEnvironmentConnectors: (config: EvsPaginationConfiguration, input: ListEnvironmentConnectorsCommandInput, ...rest: any[]) => Paginator<ListEnvironmentConnectorsCommandOutput>;

package/dist-types/pagination/ListVmEntitlementsPaginator.d.ts

@@ -0,0 +1,7 @@
+import type { Paginator } from "@smithy/types";
+import { ListVmEntitlementsCommandInput, ListVmEntitlementsCommandOutput } from "../commands/ListVmEntitlementsCommand";
+import type { EvsPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateListVmEntitlements: (config: EvsPaginationConfiguration, input: ListVmEntitlementsCommandInput, ...rest: any[]) => Paginator<ListVmEntitlementsCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -1,4 +1,6 @@
 export * from "./Interfaces";
+export * from "./ListEnvironmentConnectorsPaginator";
 export * from "./ListEnvironmentHostsPaginator";
 export * from "./ListEnvironmentsPaginator";
 export * from "./ListEnvironmentVlansPaginator";
+export * from "./ListVmEntitlementsPaginator";

package/dist-types/schemas/schemas_0.d.ts

@@ -18,10 +18,20 @@ export declare var AssociateEipToVlanRequest$: StaticStructureSchema;
 export declare var AssociateEipToVlanResponse$: StaticStructureSchema;
 export declare var Check$: StaticStructureSchema;
 export declare var ConnectivityInfo$: StaticStructureSchema;
+export declare var Connector$: StaticStructureSchema;
+export declare var ConnectorCheck$: StaticStructureSchema;
+export declare var CreateEntitlementRequest$: StaticStructureSchema;
+export declare var CreateEntitlementResponse$: StaticStructureSchema;
+export declare var CreateEnvironmentConnectorRequest$: StaticStructureSchema;
+export declare var CreateEnvironmentConnectorResponse$: StaticStructureSchema;
 export declare var CreateEnvironmentHostRequest$: StaticStructureSchema;
 export declare var CreateEnvironmentHostResponse$: StaticStructureSchema;
 export declare var CreateEnvironmentRequest$: StaticStructureSchema;
 export declare var CreateEnvironmentResponse$: StaticStructureSchema;
+export declare var DeleteEntitlementRequest$: StaticStructureSchema;
+export declare var DeleteEntitlementResponse$: StaticStructureSchema;
+export declare var DeleteEnvironmentConnectorRequest$: StaticStructureSchema;
+export declare var DeleteEnvironmentConnectorResponse$: StaticStructureSchema;
 export declare var DeleteEnvironmentHostRequest$: StaticStructureSchema;
 export declare var DeleteEnvironmentHostResponse$: StaticStructureSchema;
 export declare var DeleteEnvironmentRequest$: StaticStructureSchema;
@@ -31,6 +41,7 @@ export declare var DisassociateEipFromVlanResponse$: StaticStructureSchema;
 export declare var EipAssociation$: StaticStructureSchema;
 export declare var Environment$: StaticStructureSchema;
 export declare var EnvironmentSummary$: StaticStructureSchema;
+export declare var ErrorDetail$: StaticStructureSchema;
 export declare var GetEnvironmentRequest$: StaticStructureSchema;
 export declare var GetEnvironmentResponse$: StaticStructureSchema;
 export declare var GetVersionsRequest$: StaticStructureSchema;
@@ -41,6 +52,8 @@ export declare var InitialVlanInfo$: StaticStructureSchema;
 export declare var InitialVlans$: StaticStructureSchema;
 export declare var InstanceTypeEsxVersionsInfo$: StaticStructureSchema;
 export declare var LicenseInfo$: StaticStructureSchema;
+export declare var ListEnvironmentConnectorsRequest$: StaticStructureSchema;
+export declare var ListEnvironmentConnectorsResponse$: StaticStructureSchema;
 export declare var ListEnvironmentHostsRequest$: StaticStructureSchema;
 export declare var ListEnvironmentHostsResponse$: StaticStructureSchema;
 export declare var ListEnvironmentsRequest$: StaticStructureSchema;
@@ -49,6 +62,8 @@ export declare var ListEnvironmentVlansRequest$: StaticStructureSchema;
 export declare var ListEnvironmentVlansResponse$: StaticStructureSchema;
 export declare var ListTagsForResourceRequest$: StaticStructureSchema;
 export declare var ListTagsForResourceResponse$: StaticStructureSchema;
+export declare var ListVmEntitlementsRequest$: StaticStructureSchema;
+export declare var ListVmEntitlementsResponse$: StaticStructureSchema;
 export declare var NetworkInterface$: StaticStructureSchema;
 export declare var Secret$: StaticStructureSchema;
 export declare var ServiceAccessSecurityGroups$: StaticStructureSchema;
@@ -56,21 +71,31 @@ export declare var TagResourceRequest$: StaticStructureSchema;
 export declare var TagResourceResponse$: StaticStructureSchema;
 export declare var UntagResourceRequest$: StaticStructureSchema;
 export declare var UntagResourceResponse$: StaticStructureSchema;
+export declare var UpdateEnvironmentConnectorRequest$: StaticStructureSchema;
+export declare var UpdateEnvironmentConnectorResponse$: StaticStructureSchema;
 export declare var ValidationExceptionField$: StaticStructureSchema;
 export declare var VcfHostnames$: StaticStructureSchema;
 export declare var VcfVersionInfo$: StaticStructureSchema;
 export declare var Vlan$: StaticStructureSchema;
+export declare var VmEntitlement$: StaticStructureSchema;
 export declare var AssociateEipToVlan$: StaticOperationSchema;
+export declare var CreateEntitlement$: StaticOperationSchema;
 export declare var CreateEnvironment$: StaticOperationSchema;
+export declare var CreateEnvironmentConnector$: StaticOperationSchema;
 export declare var CreateEnvironmentHost$: StaticOperationSchema;
+export declare var DeleteEntitlement$: StaticOperationSchema;
 export declare var DeleteEnvironment$: StaticOperationSchema;
+export declare var DeleteEnvironmentConnector$: StaticOperationSchema;
 export declare var DeleteEnvironmentHost$: StaticOperationSchema;
 export declare var DisassociateEipFromVlan$: StaticOperationSchema;
 export declare var GetEnvironment$: StaticOperationSchema;
 export declare var GetVersions$: StaticOperationSchema;
+export declare var ListEnvironmentConnectors$: StaticOperationSchema;
 export declare var ListEnvironmentHosts$: StaticOperationSchema;
 export declare var ListEnvironments$: StaticOperationSchema;
 export declare var ListEnvironmentVlans$: StaticOperationSchema;
 export declare var ListTagsForResource$: StaticOperationSchema;
+export declare var ListVmEntitlements$: StaticOperationSchema;
 export declare var TagResource$: StaticOperationSchema;
 export declare var UntagResource$: StaticOperationSchema;
+export declare var UpdateEnvironmentConnector$: StaticOperationSchema;