aws-sdk-evs 1.14.0 → 1.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-evs/client.rb +523 -14
- data/lib/aws-sdk-evs/client_api.rb +230 -0
- data/lib/aws-sdk-evs/types.rb +588 -16
- data/lib/aws-sdk-evs.rb +1 -1
- data/sig/client.rbs +99 -2
- data/sig/types.rbs +145 -5
- metadata +1 -1
data/lib/aws-sdk-evs/client.rb
CHANGED
|
@@ -552,6 +552,77 @@ module Aws::Evs
|
|
|
552
552
|
req.send_request(options)
|
|
553
553
|
end
|
|
554
554
|
|
|
555
|
+
# Creates a Windows Server License entitlement for virtual machines in
|
|
556
|
+
# an Amazon EVS environment using the provided vCenter Server connector.
|
|
557
|
+
# This is an asynchronous operation. Amazon EVS validates the specified
|
|
558
|
+
# virtual machines before starting usage tracking.
|
|
559
|
+
#
|
|
560
|
+
# @option params [String] :client_token
|
|
561
|
+
# <note markdown="1"> This parameter is not used in Amazon EVS
|
|
562
|
+
# currently. If you supply
|
|
563
|
+
# input for this parameter, it will have no effect.
|
|
564
|
+
#
|
|
565
|
+
# </note>
|
|
566
|
+
#
|
|
567
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
568
|
+
# idempotency of the entitlement creation request. If you do not specify
|
|
569
|
+
# a client token, a randomly generated token is used for the request to
|
|
570
|
+
# ensure idempotency.
|
|
571
|
+
#
|
|
572
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
573
|
+
# not need to pass this option.**
|
|
574
|
+
#
|
|
575
|
+
# @option params [required, String] :environment_id
|
|
576
|
+
# A unique ID for the environment to create the entitlement in.
|
|
577
|
+
#
|
|
578
|
+
# @option params [required, String] :connector_id
|
|
579
|
+
# A unique ID for the connector associated with the entitlement.
|
|
580
|
+
#
|
|
581
|
+
# @option params [required, String] :entitlement_type
|
|
582
|
+
# The type of entitlement to create.
|
|
583
|
+
#
|
|
584
|
+
# @option params [required, Array<String>] :vm_ids
|
|
585
|
+
# The list of VMware vSphere virtual machine managed object IDs to
|
|
586
|
+
# create entitlements for.
|
|
587
|
+
#
|
|
588
|
+
# @return [Types::CreateEntitlementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
589
|
+
#
|
|
590
|
+
# * {Types::CreateEntitlementResponse#entitlements #entitlements} => Array<Types::VmEntitlement>
|
|
591
|
+
#
|
|
592
|
+
# @example Request syntax with placeholder values
|
|
593
|
+
#
|
|
594
|
+
# resp = client.create_entitlement({
|
|
595
|
+
# client_token: "ClientToken",
|
|
596
|
+
# environment_id: "EnvironmentId", # required
|
|
597
|
+
# connector_id: "ConnectorId", # required
|
|
598
|
+
# entitlement_type: "WINDOWS_SERVER", # required, accepts WINDOWS_SERVER
|
|
599
|
+
# vm_ids: ["VmId"], # required
|
|
600
|
+
# })
|
|
601
|
+
#
|
|
602
|
+
# @example Response structure
|
|
603
|
+
#
|
|
604
|
+
# resp.entitlements #=> Array
|
|
605
|
+
# resp.entitlements[0].vm_id #=> String
|
|
606
|
+
# resp.entitlements[0].environment_id #=> String
|
|
607
|
+
# resp.entitlements[0].connector_id #=> String
|
|
608
|
+
# resp.entitlements[0].vm_name #=> String
|
|
609
|
+
# resp.entitlements[0].type #=> String, one of "WINDOWS_SERVER"
|
|
610
|
+
# resp.entitlements[0].status #=> String, one of "CREATING", "CREATED", "DELETED", "AT_RISK", "ENTITLEMENT_REMOVED", "CREATE_FAILED"
|
|
611
|
+
# resp.entitlements[0].last_synced_at #=> Time
|
|
612
|
+
# resp.entitlements[0].started_at #=> Time
|
|
613
|
+
# resp.entitlements[0].stopped_at #=> Time
|
|
614
|
+
# resp.entitlements[0].error_detail.error_code #=> String
|
|
615
|
+
# resp.entitlements[0].error_detail.error_message #=> String
|
|
616
|
+
#
|
|
617
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/CreateEntitlement AWS API Documentation
|
|
618
|
+
#
|
|
619
|
+
# @overload create_entitlement(params = {})
|
|
620
|
+
# @param [Hash] params ({})
|
|
621
|
+
def create_entitlement(params = {}, options = {})
|
|
622
|
+
req = build_request(:create_entitlement, params)
|
|
623
|
+
req.send_request(options)
|
|
624
|
+
end
|
|
625
|
+
|
|
555
626
|
# Creates an Amazon EVS environment that runs VCF software, such as SDDC
|
|
556
627
|
# Manager, NSX Manager, and vCenter Server.
|
|
557
628
|
#
|
|
@@ -670,15 +741,22 @@ module Aws::Evs
|
|
|
670
741
|
# @option params [required, Array<Types::LicenseInfo>] :license_info
|
|
671
742
|
# The license information that Amazon EVS requires to create an
|
|
672
743
|
# environment. Amazon EVS requires two license keys: a VCF solution key
|
|
673
|
-
# and a vSAN license key. The VCF solution key must
|
|
674
|
-
#
|
|
675
|
-
#
|
|
744
|
+
# and a vSAN license key. The VCF solution key must meet minimum core
|
|
745
|
+
# requirements, and the vSAN license key must meet minimum capacity
|
|
746
|
+
# requirements for your selected instance type.
|
|
747
|
+
#
|
|
748
|
+
# For information about minimum license requirements, see [the VCF
|
|
749
|
+
# subscriptions section][1] in the *Amazon EVS User Guide*.
|
|
676
750
|
#
|
|
677
751
|
# VCF licenses can be used for only one Amazon EVS environment. Amazon
|
|
678
752
|
# EVS does not support reuse of VCF licenses for multiple environments.
|
|
679
753
|
#
|
|
680
754
|
# VCF license information can be retrieved from the Broadcom portal.
|
|
681
755
|
#
|
|
756
|
+
#
|
|
757
|
+
#
|
|
758
|
+
# [1]: https://docs.aws.amazon.com/evs/latest/userguide/vcf-license-mgmt.html
|
|
759
|
+
#
|
|
682
760
|
# @option params [required, Types::InitialVlans] :initial_vlans
|
|
683
761
|
# The initial VLAN subnets for the Amazon EVS environment.
|
|
684
762
|
#
|
|
@@ -782,7 +860,7 @@ module Aws::Evs
|
|
|
782
860
|
# {
|
|
783
861
|
# host_name: "HostName", # required
|
|
784
862
|
# key_name: "KeyName", # required
|
|
785
|
-
# instance_type: "i4i.metal", # required, accepts i4i.metal
|
|
863
|
+
# instance_type: "i4i.metal", # required, accepts i4i.metal, i7i.metal-24xl
|
|
786
864
|
# placement_group_id: "PlacementGroupId",
|
|
787
865
|
# dedicated_host_id: "DedicatedHostId",
|
|
788
866
|
# },
|
|
@@ -823,7 +901,7 @@ module Aws::Evs
|
|
|
823
901
|
# resp.environment.site_id #=> String
|
|
824
902
|
# resp.environment.environment_status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
|
825
903
|
# resp.environment.checks #=> Array
|
|
826
|
-
# resp.environment.checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT"
|
|
904
|
+
# resp.environment.checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT", "VCENTER_REACHABILITY", "VCENTER_VM_SYNC", "VCENTER_VM_EVENT"
|
|
827
905
|
# resp.environment.checks[0].result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
|
828
906
|
# resp.environment.checks[0].impaired_since #=> Time
|
|
829
907
|
# resp.environment.connectivity_info.private_route_server_peerings #=> Array
|
|
@@ -852,6 +930,84 @@ module Aws::Evs
|
|
|
852
930
|
req.send_request(options)
|
|
853
931
|
end
|
|
854
932
|
|
|
933
|
+
# Creates a connector for an Amazon EVS environment. A connector
|
|
934
|
+
# establishes a connection to a VCF appliance, such as vCenter, using a
|
|
935
|
+
# fully qualified domain name and an Amazon Web Services Secrets Manager
|
|
936
|
+
# secret that stores the appliance credentials.
|
|
937
|
+
#
|
|
938
|
+
# @option params [String] :client_token
|
|
939
|
+
# <note markdown="1"> This parameter is not used in Amazon EVS
|
|
940
|
+
# currently. If you supply
|
|
941
|
+
# input for this parameter, it will have no effect.
|
|
942
|
+
#
|
|
943
|
+
# </note>
|
|
944
|
+
#
|
|
945
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
946
|
+
# idempotency of the connector creation request. If you do not specify a
|
|
947
|
+
# client token, a randomly generated token is used for the request to
|
|
948
|
+
# ensure idempotency.
|
|
949
|
+
#
|
|
950
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
951
|
+
# not need to pass this option.**
|
|
952
|
+
#
|
|
953
|
+
# @option params [required, String] :environment_id
|
|
954
|
+
# A unique ID for the environment to create the connector in.
|
|
955
|
+
#
|
|
956
|
+
# @option params [required, String] :type
|
|
957
|
+
# The type of connector to create.
|
|
958
|
+
#
|
|
959
|
+
# @option params [required, String] :appliance_fqdn
|
|
960
|
+
# The fully qualified domain name (FQDN) of the VCF appliance that the
|
|
961
|
+
# connector targets.
|
|
962
|
+
#
|
|
963
|
+
# @option params [required, String] :secret_identifier
|
|
964
|
+
# The ARN or name of the Amazon Web Services Secrets Manager secret that
|
|
965
|
+
# stores the credentials for the VCF appliance.
|
|
966
|
+
#
|
|
967
|
+
# Do not use credentials with Administrator privileges. We recommend
|
|
968
|
+
# using a service account with the minimum required permissions.
|
|
969
|
+
#
|
|
970
|
+
# @return [Types::CreateEnvironmentConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
971
|
+
#
|
|
972
|
+
# * {Types::CreateEnvironmentConnectorResponse#connector #connector} => Types::Connector
|
|
973
|
+
#
|
|
974
|
+
# @example Request syntax with placeholder values
|
|
975
|
+
#
|
|
976
|
+
# resp = client.create_environment_connector({
|
|
977
|
+
# client_token: "ClientToken",
|
|
978
|
+
# environment_id: "EnvironmentId", # required
|
|
979
|
+
# type: "VCENTER", # required, accepts VCENTER
|
|
980
|
+
# appliance_fqdn: "ApplianceFqdn", # required
|
|
981
|
+
# secret_identifier: "SecretIdentifier", # required
|
|
982
|
+
# })
|
|
983
|
+
#
|
|
984
|
+
# @example Response structure
|
|
985
|
+
#
|
|
986
|
+
# resp.connector.environment_id #=> String
|
|
987
|
+
# resp.connector.connector_id #=> String
|
|
988
|
+
# resp.connector.type #=> String, one of "VCENTER"
|
|
989
|
+
# resp.connector.appliance_fqdn #=> String
|
|
990
|
+
# resp.connector.secret_arn #=> String
|
|
991
|
+
# resp.connector.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETED"
|
|
992
|
+
# resp.connector.state_details #=> String
|
|
993
|
+
# resp.connector.status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
|
994
|
+
# resp.connector.checks #=> Array
|
|
995
|
+
# resp.connector.checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT", "VCENTER_REACHABILITY", "VCENTER_VM_SYNC", "VCENTER_VM_EVENT"
|
|
996
|
+
# resp.connector.checks[0].result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
|
997
|
+
# resp.connector.checks[0].last_check_attempt #=> Time
|
|
998
|
+
# resp.connector.checks[0].impaired_since #=> Time
|
|
999
|
+
# resp.connector.created_at #=> Time
|
|
1000
|
+
# resp.connector.modified_at #=> Time
|
|
1001
|
+
#
|
|
1002
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/CreateEnvironmentConnector AWS API Documentation
|
|
1003
|
+
#
|
|
1004
|
+
# @overload create_environment_connector(params = {})
|
|
1005
|
+
# @param [Hash] params ({})
|
|
1006
|
+
def create_environment_connector(params = {}, options = {})
|
|
1007
|
+
req = build_request(:create_environment_connector, params)
|
|
1008
|
+
req.send_request(options)
|
|
1009
|
+
end
|
|
1010
|
+
|
|
855
1011
|
# Creates an ESX host and adds it to an Amazon EVS environment. Amazon
|
|
856
1012
|
# EVS supports 4-16 hosts per environment.
|
|
857
1013
|
#
|
|
@@ -915,7 +1071,7 @@ module Aws::Evs
|
|
|
915
1071
|
# host: { # required
|
|
916
1072
|
# host_name: "HostName", # required
|
|
917
1073
|
# key_name: "KeyName", # required
|
|
918
|
-
# instance_type: "i4i.metal", # required, accepts i4i.metal
|
|
1074
|
+
# instance_type: "i4i.metal", # required, accepts i4i.metal, i7i.metal-24xl
|
|
919
1075
|
# placement_group_id: "PlacementGroupId",
|
|
920
1076
|
# dedicated_host_id: "DedicatedHostId",
|
|
921
1077
|
# },
|
|
@@ -935,7 +1091,7 @@ module Aws::Evs
|
|
|
935
1091
|
# resp.host.host_name #=> String
|
|
936
1092
|
# resp.host.ip_address #=> String
|
|
937
1093
|
# resp.host.key_name #=> String
|
|
938
|
-
# resp.host.instance_type #=> String, one of "i4i.metal"
|
|
1094
|
+
# resp.host.instance_type #=> String, one of "i4i.metal", "i7i.metal-24xl"
|
|
939
1095
|
# resp.host.placement_group_id #=> String
|
|
940
1096
|
# resp.host.dedicated_host_id #=> String
|
|
941
1097
|
# resp.host.created_at #=> Time
|
|
@@ -955,6 +1111,76 @@ module Aws::Evs
|
|
|
955
1111
|
req.send_request(options)
|
|
956
1112
|
end
|
|
957
1113
|
|
|
1114
|
+
# Deletes a Windows Server License entitlement for virtual machines in
|
|
1115
|
+
# an Amazon EVS environment. Deleting an entitlement stops usage
|
|
1116
|
+
# tracking for the specified virtual machines.
|
|
1117
|
+
#
|
|
1118
|
+
# @option params [String] :client_token
|
|
1119
|
+
# <note markdown="1"> This parameter is not used in Amazon EVS
|
|
1120
|
+
# currently. If you supply
|
|
1121
|
+
# input for this parameter, it will have no effect.
|
|
1122
|
+
#
|
|
1123
|
+
# </note>
|
|
1124
|
+
#
|
|
1125
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
1126
|
+
# idempotency of the entitlement deletion request. If you do not specify
|
|
1127
|
+
# a client token, a randomly generated token is used for the request to
|
|
1128
|
+
# ensure idempotency.
|
|
1129
|
+
#
|
|
1130
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
1131
|
+
# not need to pass this option.**
|
|
1132
|
+
#
|
|
1133
|
+
# @option params [required, String] :environment_id
|
|
1134
|
+
# A unique ID for the environment that the entitlement belongs to.
|
|
1135
|
+
#
|
|
1136
|
+
# @option params [required, String] :connector_id
|
|
1137
|
+
# A unique ID for the connector associated with the entitlement.
|
|
1138
|
+
#
|
|
1139
|
+
# @option params [required, String] :entitlement_type
|
|
1140
|
+
# The type of entitlement to delete.
|
|
1141
|
+
#
|
|
1142
|
+
# @option params [required, Array<String>] :vm_ids
|
|
1143
|
+
# The list of VMware vSphere virtual machine managed object IDs to
|
|
1144
|
+
# delete entitlements for.
|
|
1145
|
+
#
|
|
1146
|
+
# @return [Types::DeleteEntitlementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1147
|
+
#
|
|
1148
|
+
# * {Types::DeleteEntitlementResponse#entitlements #entitlements} => Array<Types::VmEntitlement>
|
|
1149
|
+
#
|
|
1150
|
+
# @example Request syntax with placeholder values
|
|
1151
|
+
#
|
|
1152
|
+
# resp = client.delete_entitlement({
|
|
1153
|
+
# client_token: "ClientToken",
|
|
1154
|
+
# environment_id: "EnvironmentId", # required
|
|
1155
|
+
# connector_id: "ConnectorId", # required
|
|
1156
|
+
# entitlement_type: "WINDOWS_SERVER", # required, accepts WINDOWS_SERVER
|
|
1157
|
+
# vm_ids: ["VmId"], # required
|
|
1158
|
+
# })
|
|
1159
|
+
#
|
|
1160
|
+
# @example Response structure
|
|
1161
|
+
#
|
|
1162
|
+
# resp.entitlements #=> Array
|
|
1163
|
+
# resp.entitlements[0].vm_id #=> String
|
|
1164
|
+
# resp.entitlements[0].environment_id #=> String
|
|
1165
|
+
# resp.entitlements[0].connector_id #=> String
|
|
1166
|
+
# resp.entitlements[0].vm_name #=> String
|
|
1167
|
+
# resp.entitlements[0].type #=> String, one of "WINDOWS_SERVER"
|
|
1168
|
+
# resp.entitlements[0].status #=> String, one of "CREATING", "CREATED", "DELETED", "AT_RISK", "ENTITLEMENT_REMOVED", "CREATE_FAILED"
|
|
1169
|
+
# resp.entitlements[0].last_synced_at #=> Time
|
|
1170
|
+
# resp.entitlements[0].started_at #=> Time
|
|
1171
|
+
# resp.entitlements[0].stopped_at #=> Time
|
|
1172
|
+
# resp.entitlements[0].error_detail.error_code #=> String
|
|
1173
|
+
# resp.entitlements[0].error_detail.error_message #=> String
|
|
1174
|
+
#
|
|
1175
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/DeleteEntitlement AWS API Documentation
|
|
1176
|
+
#
|
|
1177
|
+
# @overload delete_entitlement(params = {})
|
|
1178
|
+
# @param [Hash] params ({})
|
|
1179
|
+
def delete_entitlement(params = {}, options = {})
|
|
1180
|
+
req = build_request(:delete_entitlement, params)
|
|
1181
|
+
req.send_request(options)
|
|
1182
|
+
end
|
|
1183
|
+
|
|
958
1184
|
# Deletes an Amazon EVS environment.
|
|
959
1185
|
#
|
|
960
1186
|
# Amazon EVS environments will only be enabled for deletion once the
|
|
@@ -1014,7 +1240,7 @@ module Aws::Evs
|
|
|
1014
1240
|
# resp.environment.site_id #=> String
|
|
1015
1241
|
# resp.environment.environment_status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
|
1016
1242
|
# resp.environment.checks #=> Array
|
|
1017
|
-
# resp.environment.checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT"
|
|
1243
|
+
# resp.environment.checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT", "VCENTER_REACHABILITY", "VCENTER_VM_SYNC", "VCENTER_VM_EVENT"
|
|
1018
1244
|
# resp.environment.checks[0].result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
|
1019
1245
|
# resp.environment.checks[0].impaired_since #=> Time
|
|
1020
1246
|
# resp.environment.connectivity_info.private_route_server_peerings #=> Array
|
|
@@ -1043,6 +1269,82 @@ module Aws::Evs
|
|
|
1043
1269
|
req.send_request(options)
|
|
1044
1270
|
end
|
|
1045
1271
|
|
|
1272
|
+
# Deletes a connector from an Amazon EVS environment.
|
|
1273
|
+
#
|
|
1274
|
+
# <note markdown="1"> Before deleting a connector, you must remove all entitlements that are
|
|
1275
|
+
# associated with the same vCenter.
|
|
1276
|
+
#
|
|
1277
|
+
# </note>
|
|
1278
|
+
#
|
|
1279
|
+
# @option params [String] :client_token
|
|
1280
|
+
# <note markdown="1"> This parameter is not used in Amazon EVS
|
|
1281
|
+
# currently. If you supply
|
|
1282
|
+
# input for this parameter, it will have no effect.
|
|
1283
|
+
#
|
|
1284
|
+
# </note>
|
|
1285
|
+
#
|
|
1286
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
1287
|
+
# idempotency of the connector deletion request. If you do not specify a
|
|
1288
|
+
# client token, a randomly generated token is used for the request to
|
|
1289
|
+
# ensure idempotency.
|
|
1290
|
+
#
|
|
1291
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
1292
|
+
# not need to pass this option.**
|
|
1293
|
+
#
|
|
1294
|
+
# @option params [required, String] :environment_id
|
|
1295
|
+
# A unique ID for the environment that the connector belongs to.
|
|
1296
|
+
#
|
|
1297
|
+
# @option params [required, String] :connector_id
|
|
1298
|
+
# A unique ID for the connector to be deleted.
|
|
1299
|
+
#
|
|
1300
|
+
# @return [Types::DeleteEnvironmentConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1301
|
+
#
|
|
1302
|
+
# * {Types::DeleteEnvironmentConnectorResponse#connector #connector} => Types::Connector
|
|
1303
|
+
# * {Types::DeleteEnvironmentConnectorResponse#environment_summary #environment_summary} => Types::EnvironmentSummary
|
|
1304
|
+
#
|
|
1305
|
+
# @example Request syntax with placeholder values
|
|
1306
|
+
#
|
|
1307
|
+
# resp = client.delete_environment_connector({
|
|
1308
|
+
# client_token: "ClientToken",
|
|
1309
|
+
# environment_id: "EnvironmentId", # required
|
|
1310
|
+
# connector_id: "ConnectorId", # required
|
|
1311
|
+
# })
|
|
1312
|
+
#
|
|
1313
|
+
# @example Response structure
|
|
1314
|
+
#
|
|
1315
|
+
# resp.connector.environment_id #=> String
|
|
1316
|
+
# resp.connector.connector_id #=> String
|
|
1317
|
+
# resp.connector.type #=> String, one of "VCENTER"
|
|
1318
|
+
# resp.connector.appliance_fqdn #=> String
|
|
1319
|
+
# resp.connector.secret_arn #=> String
|
|
1320
|
+
# resp.connector.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETED"
|
|
1321
|
+
# resp.connector.state_details #=> String
|
|
1322
|
+
# resp.connector.status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
|
1323
|
+
# resp.connector.checks #=> Array
|
|
1324
|
+
# resp.connector.checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT", "VCENTER_REACHABILITY", "VCENTER_VM_SYNC", "VCENTER_VM_EVENT"
|
|
1325
|
+
# resp.connector.checks[0].result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
|
1326
|
+
# resp.connector.checks[0].last_check_attempt #=> Time
|
|
1327
|
+
# resp.connector.checks[0].impaired_since #=> Time
|
|
1328
|
+
# resp.connector.created_at #=> Time
|
|
1329
|
+
# resp.connector.modified_at #=> Time
|
|
1330
|
+
# resp.environment_summary.environment_id #=> String
|
|
1331
|
+
# resp.environment_summary.environment_name #=> String
|
|
1332
|
+
# resp.environment_summary.vcf_version #=> String, one of "VCF-5.2.1", "VCF-5.2.2"
|
|
1333
|
+
# resp.environment_summary.environment_status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
|
1334
|
+
# resp.environment_summary.environment_state #=> String, one of "CREATING", "CREATED", "DELETING", "DELETED", "CREATE_FAILED"
|
|
1335
|
+
# resp.environment_summary.created_at #=> Time
|
|
1336
|
+
# resp.environment_summary.modified_at #=> Time
|
|
1337
|
+
# resp.environment_summary.environment_arn #=> String
|
|
1338
|
+
#
|
|
1339
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/DeleteEnvironmentConnector AWS API Documentation
|
|
1340
|
+
#
|
|
1341
|
+
# @overload delete_environment_connector(params = {})
|
|
1342
|
+
# @param [Hash] params ({})
|
|
1343
|
+
def delete_environment_connector(params = {}, options = {})
|
|
1344
|
+
req = build_request(:delete_environment_connector, params)
|
|
1345
|
+
req.send_request(options)
|
|
1346
|
+
end
|
|
1347
|
+
|
|
1046
1348
|
# Deletes a host from an Amazon EVS environment.
|
|
1047
1349
|
#
|
|
1048
1350
|
# <note markdown="1"> Before deleting a host, you must unassign and decommission the host
|
|
@@ -1098,7 +1400,7 @@ module Aws::Evs
|
|
|
1098
1400
|
# resp.host.host_name #=> String
|
|
1099
1401
|
# resp.host.ip_address #=> String
|
|
1100
1402
|
# resp.host.key_name #=> String
|
|
1101
|
-
# resp.host.instance_type #=> String, one of "i4i.metal"
|
|
1403
|
+
# resp.host.instance_type #=> String, one of "i4i.metal", "i7i.metal-24xl"
|
|
1102
1404
|
# resp.host.placement_group_id #=> String
|
|
1103
1405
|
# resp.host.dedicated_host_id #=> String
|
|
1104
1406
|
# resp.host.created_at #=> Time
|
|
@@ -1221,7 +1523,7 @@ module Aws::Evs
|
|
|
1221
1523
|
# resp.environment.site_id #=> String
|
|
1222
1524
|
# resp.environment.environment_status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
|
1223
1525
|
# resp.environment.checks #=> Array
|
|
1224
|
-
# resp.environment.checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT"
|
|
1526
|
+
# resp.environment.checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT", "VCENTER_REACHABILITY", "VCENTER_VM_SYNC", "VCENTER_VM_EVENT"
|
|
1225
1527
|
# resp.environment.checks[0].result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
|
1226
1528
|
# resp.environment.checks[0].impaired_since #=> Time
|
|
1227
1529
|
# resp.environment.connectivity_info.private_route_server_peerings #=> Array
|
|
@@ -1266,9 +1568,9 @@ module Aws::Evs
|
|
|
1266
1568
|
# resp.vcf_versions[0].status #=> String
|
|
1267
1569
|
# resp.vcf_versions[0].default_esx_version #=> String
|
|
1268
1570
|
# resp.vcf_versions[0].instance_types #=> Array
|
|
1269
|
-
# resp.vcf_versions[0].instance_types[0] #=> String, one of "i4i.metal"
|
|
1571
|
+
# resp.vcf_versions[0].instance_types[0] #=> String, one of "i4i.metal", "i7i.metal-24xl"
|
|
1270
1572
|
# resp.instance_type_esx_versions #=> Array
|
|
1271
|
-
# resp.instance_type_esx_versions[0].instance_type #=> String, one of "i4i.metal"
|
|
1573
|
+
# resp.instance_type_esx_versions[0].instance_type #=> String, one of "i4i.metal", "i7i.metal-24xl"
|
|
1272
1574
|
# resp.instance_type_esx_versions[0].esx_versions #=> Array
|
|
1273
1575
|
# resp.instance_type_esx_versions[0].esx_versions[0] #=> String
|
|
1274
1576
|
#
|
|
@@ -1281,6 +1583,68 @@ module Aws::Evs
|
|
|
1281
1583
|
req.send_request(options)
|
|
1282
1584
|
end
|
|
1283
1585
|
|
|
1586
|
+
# Lists the connectors within an environment. Returns the status of each
|
|
1587
|
+
# connector and its applicable checks, among other connector details.
|
|
1588
|
+
#
|
|
1589
|
+
# @option params [String] :next_token
|
|
1590
|
+
# A unique pagination token for each page. If `nextToken` is returned,
|
|
1591
|
+
# there are more results available. Make the call again using the
|
|
1592
|
+
# returned token with all other arguments unchanged to retrieve the next
|
|
1593
|
+
# page. Each pagination token expires after 24 hours. Using an expired
|
|
1594
|
+
# pagination token will return an *HTTP 400 InvalidToken* error.
|
|
1595
|
+
#
|
|
1596
|
+
# @option params [Integer] :max_results
|
|
1597
|
+
# The maximum number of results to return. If you specify `MaxResults`
|
|
1598
|
+
# in the request, the response includes information up to the limit
|
|
1599
|
+
# specified.
|
|
1600
|
+
#
|
|
1601
|
+
# @option params [required, String] :environment_id
|
|
1602
|
+
# A unique ID for the environment.
|
|
1603
|
+
#
|
|
1604
|
+
# @return [Types::ListEnvironmentConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1605
|
+
#
|
|
1606
|
+
# * {Types::ListEnvironmentConnectorsResponse#next_token #next_token} => String
|
|
1607
|
+
# * {Types::ListEnvironmentConnectorsResponse#connectors #connectors} => Array<Types::Connector>
|
|
1608
|
+
#
|
|
1609
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1610
|
+
#
|
|
1611
|
+
# @example Request syntax with placeholder values
|
|
1612
|
+
#
|
|
1613
|
+
# resp = client.list_environment_connectors({
|
|
1614
|
+
# next_token: "PaginationToken",
|
|
1615
|
+
# max_results: 1,
|
|
1616
|
+
# environment_id: "EnvironmentId", # required
|
|
1617
|
+
# })
|
|
1618
|
+
#
|
|
1619
|
+
# @example Response structure
|
|
1620
|
+
#
|
|
1621
|
+
# resp.next_token #=> String
|
|
1622
|
+
# resp.connectors #=> Array
|
|
1623
|
+
# resp.connectors[0].environment_id #=> String
|
|
1624
|
+
# resp.connectors[0].connector_id #=> String
|
|
1625
|
+
# resp.connectors[0].type #=> String, one of "VCENTER"
|
|
1626
|
+
# resp.connectors[0].appliance_fqdn #=> String
|
|
1627
|
+
# resp.connectors[0].secret_arn #=> String
|
|
1628
|
+
# resp.connectors[0].state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETED"
|
|
1629
|
+
# resp.connectors[0].state_details #=> String
|
|
1630
|
+
# resp.connectors[0].status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
|
1631
|
+
# resp.connectors[0].checks #=> Array
|
|
1632
|
+
# resp.connectors[0].checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT", "VCENTER_REACHABILITY", "VCENTER_VM_SYNC", "VCENTER_VM_EVENT"
|
|
1633
|
+
# resp.connectors[0].checks[0].result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
|
1634
|
+
# resp.connectors[0].checks[0].last_check_attempt #=> Time
|
|
1635
|
+
# resp.connectors[0].checks[0].impaired_since #=> Time
|
|
1636
|
+
# resp.connectors[0].created_at #=> Time
|
|
1637
|
+
# resp.connectors[0].modified_at #=> Time
|
|
1638
|
+
#
|
|
1639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ListEnvironmentConnectors AWS API Documentation
|
|
1640
|
+
#
|
|
1641
|
+
# @overload list_environment_connectors(params = {})
|
|
1642
|
+
# @param [Hash] params ({})
|
|
1643
|
+
def list_environment_connectors(params = {}, options = {})
|
|
1644
|
+
req = build_request(:list_environment_connectors, params)
|
|
1645
|
+
req.send_request(options)
|
|
1646
|
+
end
|
|
1647
|
+
|
|
1284
1648
|
# List the hosts within an environment.
|
|
1285
1649
|
#
|
|
1286
1650
|
# @option params [String] :next_token
|
|
@@ -1320,7 +1684,7 @@ module Aws::Evs
|
|
|
1320
1684
|
# resp.environment_hosts[0].host_name #=> String
|
|
1321
1685
|
# resp.environment_hosts[0].ip_address #=> String
|
|
1322
1686
|
# resp.environment_hosts[0].key_name #=> String
|
|
1323
|
-
# resp.environment_hosts[0].instance_type #=> String, one of "i4i.metal"
|
|
1687
|
+
# resp.environment_hosts[0].instance_type #=> String, one of "i4i.metal", "i7i.metal-24xl"
|
|
1324
1688
|
# resp.environment_hosts[0].placement_group_id #=> String
|
|
1325
1689
|
# resp.environment_hosts[0].dedicated_host_id #=> String
|
|
1326
1690
|
# resp.environment_hosts[0].created_at #=> Time
|
|
@@ -1488,6 +1852,73 @@ module Aws::Evs
|
|
|
1488
1852
|
req.send_request(options)
|
|
1489
1853
|
end
|
|
1490
1854
|
|
|
1855
|
+
# Lists the Windows Server License entitlements for virtual machines in
|
|
1856
|
+
# an Amazon EVS environment. Returns existing entitlements for virtual
|
|
1857
|
+
# machines associated with the specified environment and connector.
|
|
1858
|
+
#
|
|
1859
|
+
# @option params [String] :next_token
|
|
1860
|
+
# A unique pagination token for each page. If `nextToken` is returned,
|
|
1861
|
+
# there are more results available. Make the call again using the
|
|
1862
|
+
# returned token with all other arguments unchanged to retrieve the next
|
|
1863
|
+
# page. Each pagination token expires after 24 hours. Using an expired
|
|
1864
|
+
# pagination token will return an *HTTP 400 InvalidToken* error.
|
|
1865
|
+
#
|
|
1866
|
+
# @option params [Integer] :max_results
|
|
1867
|
+
# The maximum number of results to return. If you specify `MaxResults`
|
|
1868
|
+
# in the request, the response includes information up to the limit
|
|
1869
|
+
# specified.
|
|
1870
|
+
#
|
|
1871
|
+
# @option params [required, String] :environment_id
|
|
1872
|
+
# A unique ID for the environment.
|
|
1873
|
+
#
|
|
1874
|
+
# @option params [required, String] :connector_id
|
|
1875
|
+
# A unique ID for the connector.
|
|
1876
|
+
#
|
|
1877
|
+
# @option params [required, String] :entitlement_type
|
|
1878
|
+
# The type of entitlement to list.
|
|
1879
|
+
#
|
|
1880
|
+
# @return [Types::ListVmEntitlementsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1881
|
+
#
|
|
1882
|
+
# * {Types::ListVmEntitlementsResponse#next_token #next_token} => String
|
|
1883
|
+
# * {Types::ListVmEntitlementsResponse#entitlements #entitlements} => Array<Types::VmEntitlement>
|
|
1884
|
+
#
|
|
1885
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1886
|
+
#
|
|
1887
|
+
# @example Request syntax with placeholder values
|
|
1888
|
+
#
|
|
1889
|
+
# resp = client.list_vm_entitlements({
|
|
1890
|
+
# next_token: "PaginationToken",
|
|
1891
|
+
# max_results: 1,
|
|
1892
|
+
# environment_id: "EnvironmentId", # required
|
|
1893
|
+
# connector_id: "ConnectorId", # required
|
|
1894
|
+
# entitlement_type: "WINDOWS_SERVER", # required, accepts WINDOWS_SERVER
|
|
1895
|
+
# })
|
|
1896
|
+
#
|
|
1897
|
+
# @example Response structure
|
|
1898
|
+
#
|
|
1899
|
+
# resp.next_token #=> String
|
|
1900
|
+
# resp.entitlements #=> Array
|
|
1901
|
+
# resp.entitlements[0].vm_id #=> String
|
|
1902
|
+
# resp.entitlements[0].environment_id #=> String
|
|
1903
|
+
# resp.entitlements[0].connector_id #=> String
|
|
1904
|
+
# resp.entitlements[0].vm_name #=> String
|
|
1905
|
+
# resp.entitlements[0].type #=> String, one of "WINDOWS_SERVER"
|
|
1906
|
+
# resp.entitlements[0].status #=> String, one of "CREATING", "CREATED", "DELETED", "AT_RISK", "ENTITLEMENT_REMOVED", "CREATE_FAILED"
|
|
1907
|
+
# resp.entitlements[0].last_synced_at #=> Time
|
|
1908
|
+
# resp.entitlements[0].started_at #=> Time
|
|
1909
|
+
# resp.entitlements[0].stopped_at #=> Time
|
|
1910
|
+
# resp.entitlements[0].error_detail.error_code #=> String
|
|
1911
|
+
# resp.entitlements[0].error_detail.error_message #=> String
|
|
1912
|
+
#
|
|
1913
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/ListVmEntitlements AWS API Documentation
|
|
1914
|
+
#
|
|
1915
|
+
# @overload list_vm_entitlements(params = {})
|
|
1916
|
+
# @param [Hash] params ({})
|
|
1917
|
+
def list_vm_entitlements(params = {}, options = {})
|
|
1918
|
+
req = build_request(:list_vm_entitlements, params)
|
|
1919
|
+
req.send_request(options)
|
|
1920
|
+
end
|
|
1921
|
+
|
|
1491
1922
|
# Associates the specified tags to an Amazon EVS resource with the
|
|
1492
1923
|
# specified `resourceArn`. If existing tags on a resource are not
|
|
1493
1924
|
# specified in the request parameters, they aren't changed. When a
|
|
@@ -1552,6 +1983,84 @@ module Aws::Evs
|
|
|
1552
1983
|
req.send_request(options)
|
|
1553
1984
|
end
|
|
1554
1985
|
|
|
1986
|
+
# Updates a connector for an Amazon EVS environment. You can update the
|
|
1987
|
+
# Amazon Web Services Secrets Manager secret ARN or the appliance FQDN
|
|
1988
|
+
# to reconfigure the connector metadata.
|
|
1989
|
+
#
|
|
1990
|
+
# <note markdown="1"> You cannot update both the secret and the FQDN in the same request.
|
|
1991
|
+
#
|
|
1992
|
+
# </note>
|
|
1993
|
+
#
|
|
1994
|
+
# @option params [String] :client_token
|
|
1995
|
+
# <note markdown="1"> This parameter is not used in Amazon EVS
|
|
1996
|
+
# currently. If you supply
|
|
1997
|
+
# input for this parameter, it will have no effect.
|
|
1998
|
+
#
|
|
1999
|
+
# </note>
|
|
2000
|
+
#
|
|
2001
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
2002
|
+
# idempotency of the connector update request. If you do not specify a
|
|
2003
|
+
# client token, a randomly generated token is used for the request to
|
|
2004
|
+
# ensure idempotency.
|
|
2005
|
+
#
|
|
2006
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
2007
|
+
# not need to pass this option.**
|
|
2008
|
+
#
|
|
2009
|
+
# @option params [required, String] :environment_id
|
|
2010
|
+
# A unique ID for the environment that the connector belongs to.
|
|
2011
|
+
#
|
|
2012
|
+
# @option params [required, String] :connector_id
|
|
2013
|
+
# A unique ID for the connector to update.
|
|
2014
|
+
#
|
|
2015
|
+
# @option params [String] :appliance_fqdn
|
|
2016
|
+
# The new fully qualified domain name (FQDN) of the VCF appliance that
|
|
2017
|
+
# the connector connects to.
|
|
2018
|
+
#
|
|
2019
|
+
# @option params [String] :secret_identifier
|
|
2020
|
+
# The new ARN or name of the Amazon Web Services Secrets Manager secret
|
|
2021
|
+
# that stores the credentials for the VCF appliance.
|
|
2022
|
+
#
|
|
2023
|
+
# @return [Types::UpdateEnvironmentConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2024
|
+
#
|
|
2025
|
+
# * {Types::UpdateEnvironmentConnectorResponse#connector #connector} => Types::Connector
|
|
2026
|
+
#
|
|
2027
|
+
# @example Request syntax with placeholder values
|
|
2028
|
+
#
|
|
2029
|
+
# resp = client.update_environment_connector({
|
|
2030
|
+
# client_token: "ClientToken",
|
|
2031
|
+
# environment_id: "EnvironmentId", # required
|
|
2032
|
+
# connector_id: "ConnectorId", # required
|
|
2033
|
+
# appliance_fqdn: "ApplianceFqdn",
|
|
2034
|
+
# secret_identifier: "SecretIdentifier",
|
|
2035
|
+
# })
|
|
2036
|
+
#
|
|
2037
|
+
# @example Response structure
|
|
2038
|
+
#
|
|
2039
|
+
# resp.connector.environment_id #=> String
|
|
2040
|
+
# resp.connector.connector_id #=> String
|
|
2041
|
+
# resp.connector.type #=> String, one of "VCENTER"
|
|
2042
|
+
# resp.connector.appliance_fqdn #=> String
|
|
2043
|
+
# resp.connector.secret_arn #=> String
|
|
2044
|
+
# resp.connector.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETED"
|
|
2045
|
+
# resp.connector.state_details #=> String
|
|
2046
|
+
# resp.connector.status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
|
2047
|
+
# resp.connector.checks #=> Array
|
|
2048
|
+
# resp.connector.checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT", "VCENTER_REACHABILITY", "VCENTER_VM_SYNC", "VCENTER_VM_EVENT"
|
|
2049
|
+
# resp.connector.checks[0].result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
|
2050
|
+
# resp.connector.checks[0].last_check_attempt #=> Time
|
|
2051
|
+
# resp.connector.checks[0].impaired_since #=> Time
|
|
2052
|
+
# resp.connector.created_at #=> Time
|
|
2053
|
+
# resp.connector.modified_at #=> Time
|
|
2054
|
+
#
|
|
2055
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/evs-2023-07-27/UpdateEnvironmentConnector AWS API Documentation
|
|
2056
|
+
#
|
|
2057
|
+
# @overload update_environment_connector(params = {})
|
|
2058
|
+
# @param [Hash] params ({})
|
|
2059
|
+
def update_environment_connector(params = {}, options = {})
|
|
2060
|
+
req = build_request(:update_environment_connector, params)
|
|
2061
|
+
req.send_request(options)
|
|
2062
|
+
end
|
|
2063
|
+
|
|
1555
2064
|
# @!endgroup
|
|
1556
2065
|
|
|
1557
2066
|
# @param params ({})
|
|
@@ -1570,7 +2079,7 @@ module Aws::Evs
|
|
|
1570
2079
|
tracer: tracer
|
|
1571
2080
|
)
|
|
1572
2081
|
context[:gem_name] = 'aws-sdk-evs'
|
|
1573
|
-
context[:gem_version] = '1.
|
|
2082
|
+
context[:gem_version] = '1.16.0'
|
|
1574
2083
|
Seahorse::Client::Request.new(handlers, context)
|
|
1575
2084
|
end
|
|
1576
2085
|
|