Class: Aws::Evs::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Evs::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb
Overview
An API client for Evs. To construct a client, you need to configure a :region and :credentials.
client = Aws::Evs::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_eip_to_vlan(params = {}) ⇒ Types::AssociateEipToVlanResponse
Associates an Elastic IP address with a public HCX VLAN.
-
#create_entitlement(params = {}) ⇒ Types::CreateEntitlementResponse
Creates a Windows Server License entitlement for virtual machines in an Amazon EVS environment using the provided vCenter Server connector.
-
#create_environment(params = {}) ⇒ Types::CreateEnvironmentResponse
Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.
-
#create_environment_connector(params = {}) ⇒ Types::CreateEnvironmentConnectorResponse
Creates a connector for an Amazon EVS environment.
-
#create_environment_host(params = {}) ⇒ Types::CreateEnvironmentHostResponse
Creates an ESX host and adds it to an Amazon EVS environment.
-
#delete_entitlement(params = {}) ⇒ Types::DeleteEntitlementResponse
Deletes a Windows Server License entitlement for virtual machines in an Amazon EVS environment.
-
#delete_environment(params = {}) ⇒ Types::DeleteEnvironmentResponse
Deletes an Amazon EVS environment.
-
#delete_environment_connector(params = {}) ⇒ Types::DeleteEnvironmentConnectorResponse
Deletes a connector from an Amazon EVS environment.
-
#delete_environment_host(params = {}) ⇒ Types::DeleteEnvironmentHostResponse
Deletes a host from an Amazon EVS environment.
-
#disassociate_eip_from_vlan(params = {}) ⇒ Types::DisassociateEipFromVlanResponse
Disassociates an Elastic IP address from a public HCX VLAN.
-
#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResponse
Returns the configured EVS settings for your Amazon Web Services account in the specified Amazon Web Services Region.
-
#get_depot_url(params = {}) ⇒ Types::GetDepotUrlResponse
Returns a URL and authentication token for accessing the Amazon EVS Custom Addon depot.
-
#get_environment(params = {}) ⇒ Types::GetEnvironmentResponse
Returns a description of the specified environment.
-
#get_versions(params = {}) ⇒ Types::GetVersionsResponse
Returns information about VCF versions, ESX versions and EC2 instance types provided by Amazon EVS.
-
#list_environment_connectors(params = {}) ⇒ Types::ListEnvironmentConnectorsResponse
Lists the connectors within an environment.
-
#list_environment_hosts(params = {}) ⇒ Types::ListEnvironmentHostsResponse
List the hosts within an environment.
-
#list_environment_vlans(params = {}) ⇒ Types::ListEnvironmentVlansResponse
Lists environment VLANs that are associated with the specified environment.
-
#list_environments(params = {}) ⇒ Types::ListEnvironmentsResponse
Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for an Amazon EVS resource.
-
#list_vm_entitlements(params = {}) ⇒ Types::ListVmEntitlementsResponse
Lists the Windows Server License entitlements for virtual machines in an Amazon EVS environment.
-
#put_account_settings(params = {}) ⇒ Types::PutAccountSettingsResponse
Creates or updates account-level EVS settings for your Amazon Web Services account in the specified Amazon Web Services Region.
-
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to an Amazon EVS resource with the specified
resourceArn. -
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from an Amazon EVS resource.
-
#update_environment_connector(params = {}) ⇒ Types::UpdateEnvironmentConnectorResponse
Updates a connector for an Amazon EVS environment.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
486 487 488 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 486 def initialize(*args) super end |
Instance Method Details
#associate_eip_to_vlan(params = {}) ⇒ Types::AssociateEipToVlanResponse
Associates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.
556 557 558 559 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 556 def associate_eip_to_vlan(params = {}, = {}) req = build_request(:associate_eip_to_vlan, params) req.send_request() end |
#create_entitlement(params = {}) ⇒ Types::CreateEntitlementResponse
Creates a Windows Server License entitlement for virtual machines in an Amazon EVS environment using the provided vCenter Server connector. This is an asynchronous operation. Amazon EVS validates the specified virtual machines before starting usage tracking.
627 628 629 630 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 627 def create_entitlement(params = {}, = {}) req = build_request(:create_entitlement, params) req.send_request() end |
#create_environment(params = {}) ⇒ Types::CreateEnvironmentResponse
Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.
SELF_DEPLOYED for vcfVersion, Amazon EVS
provisions only the VLAN subnets; no hosts are added and no VCF
installation is performed. After the environment is created, you can
add hosts with CreateEnvironmentHost and install VCF yourself. The
licenseInfo, hosts, vcfHostnames, siteId, and
connectivityInfo parameters are not supported in this mode.
When you specify any other VCF version, Amazon EVS installs and configures VCF for you. For more information, see Self-deployed mode in the Amazon EVS User Guide.
When Amazon EVS installs VCF, the default ESX version for the selected VCF version will be used. After a host is added with a specific ESX version, it can only be upgraded using vCenter Lifecycle Manager.
dedicatedHostId and placementGroupId parameters
together in the same CreateEnvironment action. This results in a
ValidationException response.
966 967 968 969 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 966 def create_environment(params = {}, = {}) req = build_request(:create_environment, params) req.send_request() end |
#create_environment_connector(params = {}) ⇒ Types::CreateEnvironmentConnectorResponse
Creates a connector for an Amazon EVS environment. A connector allows the Amazon EVS control plane to interface with VCF appliances using a fully qualified domain name.
You can create only one connector of each type per environment. For
environments where Amazon EVS installs VCF, the SDDC_MANAGER
connector is created automatically.
1065 1066 1067 1068 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1065 def create_environment_connector(params = {}, = {}) req = build_request(:create_environment_connector, params) req.send_request() end |
#create_environment_host(params = {}) ⇒ Types::CreateEnvironmentHostResponse
Creates an ESX host and adds it to an Amazon EVS environment.
This action can only be used after the Amazon EVS environment is deployed.
You can use the dedicatedHostId parameter to specify an Amazon EC2
Dedicated Host for ESX host creation.
You can use the placementGroupId parameter to specify a cluster or
partition placement group to launch EC2 instances into.
CreateEnvironmentHost action, Amazon EVS automatically uses the
default ESX version for your environment's VCF version. To find the
available ESX versions for a particular VCF version, use the
GetVersions action.
You cannot use the dedicatedHostId and placementGroupId parameters
together in the same CreateEnvironmentHost action. This results in a
ValidationException response.
1165 1166 1167 1168 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1165 def create_environment_host(params = {}, = {}) req = build_request(:create_environment_host, params) req.send_request() end |
#delete_entitlement(params = {}) ⇒ Types::DeleteEntitlementResponse
Deletes a Windows Server License entitlement for virtual machines in an Amazon EVS environment. Deleting an entitlement stops usage tracking for the specified virtual machines.
1235 1236 1237 1238 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1235 def delete_entitlement(params = {}, = {}) req = build_request(:delete_entitlement, params) req.send_request() end |
#delete_environment(params = {}) ⇒ Types::DeleteEnvironmentResponse
Deletes an Amazon EVS environment.
Amazon EVS environments will only be enabled for deletion once the
hosts are deleted. You can delete hosts using the
DeleteEnvironmentHost action.
Environment deletion also deletes the associated Amazon EVS VLAN subnets and Amazon Web Services Secrets Manager secrets that Amazon EVS created. Amazon Web Services resources that you create are not deleted. These resources may continue to incur costs.
1324 1325 1326 1327 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1324 def delete_environment(params = {}, = {}) req = build_request(:delete_environment, params) req.send_request() end |
#delete_environment_connector(params = {}) ⇒ Types::DeleteEnvironmentConnectorResponse
Deletes a connector from an Amazon EVS environment.
1400 1401 1402 1403 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1400 def delete_environment_connector(params = {}, = {}) req = build_request(:delete_environment_connector, params) req.send_request() end |
#delete_environment_host(params = {}) ⇒ Types::DeleteEnvironmentHostResponse
Deletes a host from an Amazon EVS environment.
1475 1476 1477 1478 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1475 def delete_environment_host(params = {}, = {}) req = build_request(:delete_environment_host, params) req.send_request() end |
#disassociate_eip_from_vlan(params = {}) ⇒ Types::DisassociateEipFromVlanResponse
Disassociates an Elastic IP address from a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.
1544 1545 1546 1547 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1544 def disassociate_eip_from_vlan(params = {}, = {}) req = build_request(:disassociate_eip_from_vlan, params) req.send_request() end |
#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResponse
Returns the configured EVS settings for your Amazon Web Services account in the specified Amazon Web Services Region. If no settings have been set, an empty list is returned.
1567 1568 1569 1570 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1567 def get_account_settings(params = {}, = {}) req = build_request(:get_account_settings, params) req.send_request() end |
#get_depot_url(params = {}) ⇒ Types::GetDepotUrlResponse
Returns a URL and authentication token for accessing the Amazon EVS Custom Addon depot. Configure the depot URL as a download source in vSphere Lifecycle Manager (vLCM) to sync and install the Amazon EVS Custom Addon.
The depot URL remains active until you rotate the authentication token
by calling this action with rotate set to true.
1609 1610 1611 1612 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1609 def get_depot_url(params = {}, = {}) req = build_request(:get_depot_url, params) req.send_request() end |
#get_environment(params = {}) ⇒ Types::GetEnvironmentResponse
Returns a description of the specified environment.
1673 1674 1675 1676 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1673 def get_environment(params = {}, = {}) req = build_request(:get_environment, params) req.send_request() end |
#get_versions(params = {}) ⇒ Types::GetVersionsResponse
Returns information about VCF versions, ESX versions and EC2 instance types provided by Amazon EVS. For each VCF version, the response also includes the default ESX version and provided EC2 instance types.
1704 1705 1706 1707 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1704 def get_versions(params = {}, = {}) req = build_request(:get_versions, params) req.send_request() end |
#list_environment_connectors(params = {}) ⇒ Types::ListEnvironmentConnectorsResponse
Lists the connectors within an environment. Returns the status of each connector and its applicable checks, among other connector details.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1766 1767 1768 1769 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1766 def list_environment_connectors(params = {}, = {}) req = build_request(:list_environment_connectors, params) req.send_request() end |
#list_environment_hosts(params = {}) ⇒ Types::ListEnvironmentHostsResponse
List the hosts within an environment.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1825 1826 1827 1828 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1825 def list_environment_hosts(params = {}, = {}) req = build_request(:list_environment_hosts, params) req.send_request() end |
#list_environment_vlans(params = {}) ⇒ Types::ListEnvironmentVlansResponse
Lists environment VLANs that are associated with the specified environment.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1887 1888 1889 1890 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1887 def list_environment_vlans(params = {}, = {}) req = build_request(:list_environment_vlans, params) req.send_request() end |
#list_environments(params = {}) ⇒ Types::ListEnvironmentsResponse
Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1943 1944 1945 1946 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1943 def list_environments(params = {}, = {}) req = build_request(:list_environments, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for an Amazon EVS resource.
1973 1974 1975 1976 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1973 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_vm_entitlements(params = {}) ⇒ Types::ListVmEntitlementsResponse
Lists the Windows Server License entitlements for virtual machines in an Amazon EVS environment. Returns existing entitlements for virtual machines associated with the specified environment and connector.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2040 2041 2042 2043 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 2040 def list_vm_entitlements(params = {}, = {}) req = build_request(:list_vm_entitlements, params) req.send_request() end |
#put_account_settings(params = {}) ⇒ Types::PutAccountSettingsResponse
Creates or updates account-level EVS settings for your Amazon Web Services account in the specified Amazon Web Services Region.
EVS settings included in the request are created or overwritten. Settings omitted from the request retain their current values.
2080 2081 2082 2083 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 2080 def put_account_settings(params = {}, = {}) req = build_request(:put_account_settings, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to an Amazon EVS resource with the
specified resourceArn. If existing tags on a resource are not
specified in the request parameters, they aren't changed. When a
resource is deleted, the tags associated with that resource are also
deleted. Tags that you create for Amazon EVS resources don't
propagate to any other resources associated with the environment. For
example, if you tag an environment with this operation, that tag
doesn't automatically propagate to the VLAN subnets and hosts
associated with the environment.
2118 2119 2120 2121 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 2118 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from an Amazon EVS resource.
2144 2145 2146 2147 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 2144 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_environment_connector(params = {}) ⇒ Types::UpdateEnvironmentConnectorResponse
Updates a connector for an Amazon EVS environment. You can update the Amazon Web Services Secrets Manager secret ARN or the appliance FQDN to reconfigure the connector metadata.
2222 2223 2224 2225 |
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 2222 def update_environment_connector(params = {}, = {}) req = build_request(:update_environment_connector, params) req.send_request() end |