AWSEC2
Objective-C
@interface AWSEC2
Swift
class AWSEC2
You can access the features of Amazon Elastic Compute Cloud (Amazon EC2) programmatically. For more information, see the Amazon EC2 Developer Guide.
-
The service configuration used to instantiate this service client.
Warning
Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.Declaration
Objective-C
@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration
-
Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with
defaultServiceConfiguration
from[AWSServiceManager defaultServiceManager]
. The reference to this object is maintained by the SDK, and you do not need to retain it manually.For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider) AWSServiceManager.default().defaultServiceConfiguration = configuration return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 credentialsProvider:credentialsProvider]; [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration; return YES; }
Then call the following to get the default service client:
Swift
let EC2 = AWSEC2.default()
Objective-C
AWSEC2 *EC2 = [AWSEC2 defaultEC2];
Declaration
Objective-C
+ (nonnull instancetype)defaultEC2;
Swift
class func `default`() -> Self
Return Value
The default service client.
-
Creates a service client with the given service configuration and registers it for the key.
For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) AWSEC2.register(with: configuration!, forKey: "USWest2EC2") return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider]; [AWSEC2 registerEC2WithConfiguration:configuration forKey:@"USWest2EC2"]; return YES; }
Then call the following to get the service client:
Swift
let EC2 = AWSEC2(forKey: "USWest2EC2")
Objective-C
AWSEC2 *EC2 = [AWSEC2 EC2ForKey:@"USWest2EC2"];
Warning
After calling this method, do not modify the configuration object. It may cause unspecified behaviors.
Declaration
Objective-C
+ (void)registerEC2WithConfiguration:(id)configuration forKey:(nonnull NSString *)key;
Swift
class func register(withConfiguration configuration: Any!, forKey key: String)
Parameters
configuration
A service configuration object.
key
A string to identify the service client.
-
Retrieves the service client associated with the key. You need to call
+ registerEC2WithConfiguration:forKey:
before invoking this method.For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) AWSEC2.register(with: configuration!, forKey: "USWest2EC2") return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider]; [AWSEC2 registerEC2WithConfiguration:configuration forKey:@"USWest2EC2"]; return YES; }
Then call the following to get the service client:
Swift
let EC2 = AWSEC2(forKey: "USWest2EC2")
Objective-C
AWSEC2 *EC2 = [AWSEC2 EC2ForKey:@"USWest2EC2"];
Declaration
Objective-C
+ (nonnull instancetype)EC2ForKey:(nonnull NSString *)key;
Swift
convenience init(forKey key: String)
Parameters
key
A string to identify the service client.
Return Value
An instance of the service client.
-
Removes the service client associated with the key and release it.
Warning
Before calling this method, make sure no method is running on this client.
Declaration
Objective-C
+ (void)removeEC2ForKey:(nonnull NSString *)key;
Swift
class func remove(forKey key: String)
Parameters
key
A string to identify the service client.
-
Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon VPC User Guide.
See
AWSEC2AcceptAddressTransferRequest
See
AWSEC2AcceptAddressTransferResult
Declaration
Objective-C
- (id)acceptAddressTransfer: (nonnull AWSEC2AcceptAddressTransferRequest *)request;
Swift
func acceptAddressTransfer(_ request: AWSEC2AcceptAddressTransferRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AcceptAddressTransfer service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AcceptAddressTransferResult
. -
Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon VPC User Guide.
See
AWSEC2AcceptAddressTransferRequest
See
AWSEC2AcceptAddressTransferResult
Declaration
Objective-C
- (void)acceptAddressTransfer: (nonnull AWSEC2AcceptAddressTransferRequest *)request completionHandler: (void (^_Nullable)(AWSEC2AcceptAddressTransferResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func acceptAddressTransfer(_ request: AWSEC2AcceptAddressTransferRequest) async throws -> AWSEC2AcceptAddressTransferResult
Parameters
request
A container for the necessary parameters to execute the AcceptAddressTransfer service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
See
AWSEC2AcceptReservedInstancesExchangeQuoteRequest
See
AWSEC2AcceptReservedInstancesExchangeQuoteResult
Declaration
Objective-C
- (id)acceptReservedInstancesExchangeQuote: (nonnull AWSEC2AcceptReservedInstancesExchangeQuoteRequest *)request;
Swift
func acceptReservedInstancesExchangeQuote(_ request: AWSEC2AcceptReservedInstancesExchangeQuoteRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AcceptReservedInstancesExchangeQuote service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AcceptReservedInstancesExchangeQuoteResult
. -
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
See
AWSEC2AcceptReservedInstancesExchangeQuoteRequest
See
AWSEC2AcceptReservedInstancesExchangeQuoteResult
Declaration
Objective-C
- (void) acceptReservedInstancesExchangeQuote: (nonnull AWSEC2AcceptReservedInstancesExchangeQuoteRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AcceptReservedInstancesExchangeQuoteResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func acceptReservedInstancesExchangeQuote(_ request: AWSEC2AcceptReservedInstancesExchangeQuoteRequest) async throws -> AWSEC2AcceptReservedInstancesExchangeQuoteResult
Parameters
request
A container for the necessary parameters to execute the AcceptReservedInstancesExchangeQuote service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Accepts a request to associate subnets with a transit gateway multicast domain.
See
AWSEC2AcceptTransitGatewayMulticastDomainAssociationsRequest
See
AWSEC2AcceptTransitGatewayMulticastDomainAssociationsResult
Declaration
Objective-C
- (id)acceptTransitGatewayMulticastDomainAssociations: (nonnull AWSEC2AcceptTransitGatewayMulticastDomainAssociationsRequest *) request;
Swift
func acceptTransitGatewayMulticastDomainAssociations(_ request: AWSEC2AcceptTransitGatewayMulticastDomainAssociationsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AcceptTransitGatewayMulticastDomainAssociations service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AcceptTransitGatewayMulticastDomainAssociationsResult
. -
Accepts a request to associate subnets with a transit gateway multicast domain.
See
AWSEC2AcceptTransitGatewayMulticastDomainAssociationsRequest
See
AWSEC2AcceptTransitGatewayMulticastDomainAssociationsResult
Declaration
Objective-C
- (void) acceptTransitGatewayMulticastDomainAssociations: (nonnull AWSEC2AcceptTransitGatewayMulticastDomainAssociationsRequest *) request completionHandler: (void (^_Nullable)( AWSEC2AcceptTransitGatewayMulticastDomainAssociationsResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func acceptTransitGatewayMulticastDomainAssociations(_ request: AWSEC2AcceptTransitGatewayMulticastDomainAssociationsRequest) async throws -> AWSEC2AcceptTransitGatewayMulticastDomainAssociationsResult
Parameters
request
A container for the necessary parameters to execute the AcceptTransitGatewayMulticastDomainAssociations service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Accepts a transit gateway peering attachment request. The peering attachment must be in the
pendingAcceptance
state.See
AWSEC2AcceptTransitGatewayPeeringAttachmentRequest
See
AWSEC2AcceptTransitGatewayPeeringAttachmentResult
Declaration
Objective-C
- (id)acceptTransitGatewayPeeringAttachment: (nonnull AWSEC2AcceptTransitGatewayPeeringAttachmentRequest *)request;
Swift
func acceptTransitGatewayPeeringAttachment(_ request: AWSEC2AcceptTransitGatewayPeeringAttachmentRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AcceptTransitGatewayPeeringAttachment service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AcceptTransitGatewayPeeringAttachmentResult
. -
Accepts a transit gateway peering attachment request. The peering attachment must be in the
pendingAcceptance
state.See
AWSEC2AcceptTransitGatewayPeeringAttachmentRequest
See
AWSEC2AcceptTransitGatewayPeeringAttachmentResult
Declaration
Objective-C
- (void) acceptTransitGatewayPeeringAttachment: (nonnull AWSEC2AcceptTransitGatewayPeeringAttachmentRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AcceptTransitGatewayPeeringAttachmentResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func acceptTransitGatewayPeeringAttachment(_ request: AWSEC2AcceptTransitGatewayPeeringAttachmentRequest) async throws -> AWSEC2AcceptTransitGatewayPeeringAttachmentResult
Parameters
request
A container for the necessary parameters to execute the AcceptTransitGatewayPeeringAttachment service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Accepts a request to attach a VPC to a transit gateway.
The VPC attachment must be in the
pendingAcceptance
state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.See
AWSEC2AcceptTransitGatewayVpcAttachmentRequest
See
AWSEC2AcceptTransitGatewayVpcAttachmentResult
Declaration
Objective-C
- (id)acceptTransitGatewayVpcAttachment: (nonnull AWSEC2AcceptTransitGatewayVpcAttachmentRequest *)request;
Swift
func acceptTransitGatewayVpcAttachment(_ request: AWSEC2AcceptTransitGatewayVpcAttachmentRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AcceptTransitGatewayVpcAttachment service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AcceptTransitGatewayVpcAttachmentResult
. -
Accepts a request to attach a VPC to a transit gateway.
The VPC attachment must be in the
pendingAcceptance
state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.See
AWSEC2AcceptTransitGatewayVpcAttachmentRequest
See
AWSEC2AcceptTransitGatewayVpcAttachmentResult
Declaration
Objective-C
- (void)acceptTransitGatewayVpcAttachment: (nonnull AWSEC2AcceptTransitGatewayVpcAttachmentRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AcceptTransitGatewayVpcAttachmentResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func acceptTransitGatewayVpcAttachment(_ request: AWSEC2AcceptTransitGatewayVpcAttachmentRequest) async throws -> AWSEC2AcceptTransitGatewayVpcAttachmentResult
Parameters
request
A container for the necessary parameters to execute the AcceptTransitGatewayVpcAttachment service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Accepts connection requests to your VPC endpoint service.
See
AWSEC2AcceptVpcEndpointConnectionsRequest
See
AWSEC2AcceptVpcEndpointConnectionsResult
Declaration
Objective-C
- (id)acceptVpcEndpointConnections: (nonnull AWSEC2AcceptVpcEndpointConnectionsRequest *)request;
Swift
func acceptVpcEndpointConnections(_ request: AWSEC2AcceptVpcEndpointConnectionsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AcceptVpcEndpointConnections service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AcceptVpcEndpointConnectionsResult
. -
Accepts connection requests to your VPC endpoint service.
See
AWSEC2AcceptVpcEndpointConnectionsRequest
See
AWSEC2AcceptVpcEndpointConnectionsResult
Declaration
Objective-C
- (void)acceptVpcEndpointConnections: (nonnull AWSEC2AcceptVpcEndpointConnectionsRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AcceptVpcEndpointConnectionsResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func acceptVpcEndpointConnections(_ request: AWSEC2AcceptVpcEndpointConnectionsRequest) async throws -> AWSEC2AcceptVpcEndpointConnectionsResult
Parameters
request
A container for the necessary parameters to execute the AcceptVpcEndpointConnections service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the
pending-acceptance
state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
See
AWSEC2AcceptVpcPeeringConnectionRequest
See
AWSEC2AcceptVpcPeeringConnectionResult
Declaration
Objective-C
- (id)acceptVpcPeeringConnection: (nonnull AWSEC2AcceptVpcPeeringConnectionRequest *)request;
Swift
func acceptVpcPeeringConnection(_ request: AWSEC2AcceptVpcPeeringConnectionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AcceptVpcPeeringConnection service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AcceptVpcPeeringConnectionResult
. -
Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the
pending-acceptance
state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
See
AWSEC2AcceptVpcPeeringConnectionRequest
See
AWSEC2AcceptVpcPeeringConnectionResult
Declaration
Objective-C
- (void)acceptVpcPeeringConnection: (nonnull AWSEC2AcceptVpcPeeringConnectionRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AcceptVpcPeeringConnectionResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func acceptVpcPeeringConnection(_ request: AWSEC2AcceptVpcPeeringConnectionRequest) async throws -> AWSEC2AcceptVpcPeeringConnectionResult
Parameters
request
A container for the necessary parameters to execute the AcceptVpcPeeringConnection service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.
It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.
To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
See
AWSEC2AdvertiseByoipCidrRequest
See
AWSEC2AdvertiseByoipCidrResult
Declaration
Objective-C
- (id)advertiseByoipCidr:(nonnull AWSEC2AdvertiseByoipCidrRequest *)request;
Swift
func advertiseByoipCidr(_ request: AWSEC2AdvertiseByoipCidrRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AdvertiseByoipCidr service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AdvertiseByoipCidrResult
. -
Advertises an IPv4 or IPv6 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.
We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from Amazon Web Services. To minimize down time, you can configure your Amazon Web Services resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through Amazon Web Services.
It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of BGP propagation delays.
To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
See
AWSEC2AdvertiseByoipCidrRequest
See
AWSEC2AdvertiseByoipCidrResult
Declaration
Objective-C
- (void)advertiseByoipCidr:(nonnull AWSEC2AdvertiseByoipCidrRequest *)request completionHandler: (void (^_Nullable)(AWSEC2AdvertiseByoipCidrResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func advertiseByoipCidr(_ request: AWSEC2AdvertiseByoipCidrRequest) async throws -> AWSEC2AdvertiseByoipCidrResult
Parameters
request
A container for the necessary parameters to execute the AdvertiseByoipCidr service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.
You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon EC2 User Guide.
If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify it in this operation.
For more information, see Elastic IP Addresses in the Amazon EC2 User Guide.
You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
See
AWSEC2AllocateAddressRequest
See
AWSEC2AllocateAddressResult
Declaration
Objective-C
- (id)allocateAddress:(nonnull AWSEC2AllocateAddressRequest *)request;
Swift
func allocateAddress(_ request: AWSEC2AllocateAddressRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AllocateAddress service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AllocateAddressResult
. -
Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.
You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon EC2 User Guide.
If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify it in this operation.
For more information, see Elastic IP Addresses in the Amazon EC2 User Guide.
You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
See
AWSEC2AllocateAddressRequest
See
AWSEC2AllocateAddressResult
Declaration
Objective-C
- (void)allocateAddress:(nonnull AWSEC2AllocateAddressRequest *)request completionHandler: (void (^_Nullable)(AWSEC2AllocateAddressResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func allocateAddress(_ request: AWSEC2AllocateAddressRequest) async throws -> AWSEC2AllocateAddressResult
Parameters
request
A container for the necessary parameters to execute the AllocateAddress service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.
See
AWSEC2AllocateHostsRequest
See
AWSEC2AllocateHostsResult
Declaration
Objective-C
- (id)allocateHosts:(nonnull AWSEC2AllocateHostsRequest *)request;
Swift
func allocateHosts(_ request: AWSEC2AllocateHostsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AllocateHosts service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AllocateHostsResult
. -
Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.
See
AWSEC2AllocateHostsRequest
See
AWSEC2AllocateHostsResult
Declaration
Objective-C
- (void)allocateHosts:(nonnull AWSEC2AllocateHostsRequest *)request completionHandler:(void (^_Nullable)(AWSEC2AllocateHostsResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func allocateHosts(_ request: AWSEC2AllocateHostsRequest) async throws -> AWSEC2AllocateHostsResult
Parameters
request
A container for the necessary parameters to execute the AllocateHosts service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Allocate a CIDR from an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.
In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide.
This action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool.
See
AWSEC2AllocateIpamPoolCidrRequest
See
AWSEC2AllocateIpamPoolCidrResult
Declaration
Objective-C
- (id)allocateIpamPoolCidr:(nonnull AWSEC2AllocateIpamPoolCidrRequest *)request;
Swift
func allocateIpamPoolCidr(_ request: AWSEC2AllocateIpamPoolCidrRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AllocateIpamPoolCidr service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AllocateIpamPoolCidrResult
. -
Allocate a CIDR from an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.
In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide.
This action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool.
See
AWSEC2AllocateIpamPoolCidrRequest
See
AWSEC2AllocateIpamPoolCidrResult
Declaration
Objective-C
- (void)allocateIpamPoolCidr: (nonnull AWSEC2AllocateIpamPoolCidrRequest *)request completionHandler: (void (^_Nullable)(AWSEC2AllocateIpamPoolCidrResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func allocateIpamPoolCidr(_ request: AWSEC2AllocateIpamPoolCidrRequest) async throws -> AWSEC2AllocateIpamPoolCidrResult
Parameters
request
A container for the necessary parameters to execute the AllocateIpamPoolCidr service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.
See
AWSEC2ApplySecurityGroupsToClientVpnTargetNetworkRequest
See
AWSEC2ApplySecurityGroupsToClientVpnTargetNetworkResult
Declaration
Objective-C
- (id)applySecurityGroupsToClientVpnTargetNetwork: (nonnull AWSEC2ApplySecurityGroupsToClientVpnTargetNetworkRequest *)request;
Swift
func applySecurityGroups(toClientVpnTargetNetwork request: AWSEC2ApplySecurityGroupsToClientVpnTargetNetworkRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ApplySecurityGroupsToClientVpnTargetNetwork service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2ApplySecurityGroupsToClientVpnTargetNetworkResult
. -
Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.
See
AWSEC2ApplySecurityGroupsToClientVpnTargetNetworkRequest
See
AWSEC2ApplySecurityGroupsToClientVpnTargetNetworkResult
Declaration
Objective-C
- (void) applySecurityGroupsToClientVpnTargetNetwork: (nonnull AWSEC2ApplySecurityGroupsToClientVpnTargetNetworkRequest *) request completionHandler: (void (^_Nullable)( AWSEC2ApplySecurityGroupsToClientVpnTargetNetworkResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func applySecurityGroups(toClientVpnTargetNetwork request: AWSEC2ApplySecurityGroupsToClientVpnTargetNetworkRequest) async throws -> AWSEC2ApplySecurityGroupsToClientVpnTargetNetworkResult
Parameters
request
A container for the necessary parameters to execute the ApplySecurityGroupsToClientVpnTargetNetwork service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet’s IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type.
You must specify either the IPv6 addresses or the IPv6 address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
See
AWSEC2AssignIpv6AddressesRequest
See
AWSEC2AssignIpv6AddressesResult
Declaration
Objective-C
- (id)assignIpv6Addresses:(nonnull AWSEC2AssignIpv6AddressesRequest *)request;
Swift
func assignIpv6Addresses(_ request: AWSEC2AssignIpv6AddressesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssignIpv6Addresses service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssignIpv6AddressesResult
. -
Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet’s IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type.
You must specify either the IPv6 addresses or the IPv6 address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
See
AWSEC2AssignIpv6AddressesRequest
See
AWSEC2AssignIpv6AddressesResult
Declaration
Objective-C
- (void)assignIpv6Addresses:(nonnull AWSEC2AssignIpv6AddressesRequest *)request completionHandler: (void (^_Nullable)(AWSEC2AssignIpv6AddressesResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func assignIpv6Addresses(_ request: AWSEC2AssignIpv6AddressesRequest) async throws -> AWSEC2AssignIpv6AddressesResult
Parameters
request
A container for the necessary parameters to execute the AssignIpv6Addresses service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet’s CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon EC2 User Guide.
When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check
network/interfaces/macs/mac/local-ipv4s
in the instance metadata to confirm that the remapping is complete.You must specify either the IP addresses or the IP address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
See
AWSEC2AssignPrivateIpAddressesRequest
See
AWSEC2AssignPrivateIpAddressesResult
Declaration
Objective-C
- (id)assignPrivateIpAddresses: (nonnull AWSEC2AssignPrivateIpAddressesRequest *)request;
Swift
func assignPrivateIpAddresses(_ request: AWSEC2AssignPrivateIpAddressesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssignPrivateIpAddresses service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssignPrivateIpAddressesResult
. -
Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet’s CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon EC2 User Guide.
When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check
network/interfaces/macs/mac/local-ipv4s
in the instance metadata to confirm that the remapping is complete.You must specify either the IP addresses or the IP address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
See
AWSEC2AssignPrivateIpAddressesRequest
See
AWSEC2AssignPrivateIpAddressesResult
Declaration
Objective-C
- (void)assignPrivateIpAddresses: (nonnull AWSEC2AssignPrivateIpAddressesRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AssignPrivateIpAddressesResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func assignPrivateIpAddresses(_ request: AWSEC2AssignPrivateIpAddressesRequest) async throws -> AWSEC2AssignPrivateIpAddressesResult
Parameters
request
A container for the necessary parameters to execute the AssignPrivateIpAddresses service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Assigns private IPv4 addresses to a private NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.
See
AWSEC2AssignPrivateNatGatewayAddressRequest
See
AWSEC2AssignPrivateNatGatewayAddressResult
Declaration
Objective-C
- (id)assignPrivateNatGatewayAddress: (nonnull AWSEC2AssignPrivateNatGatewayAddressRequest *)request;
Swift
func assignPrivateNatGatewayAddress(_ request: AWSEC2AssignPrivateNatGatewayAddressRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssignPrivateNatGatewayAddress service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssignPrivateNatGatewayAddressResult
. -
Assigns private IPv4 addresses to a private NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.
See
AWSEC2AssignPrivateNatGatewayAddressRequest
See
AWSEC2AssignPrivateNatGatewayAddressResult
Declaration
Objective-C
- (void) assignPrivateNatGatewayAddress: (nonnull AWSEC2AssignPrivateNatGatewayAddressRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AssignPrivateNatGatewayAddressResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func assignPrivateNatGatewayAddress(_ request: AWSEC2AssignPrivateNatGatewayAddressRequest) async throws -> AWSEC2AssignPrivateNatGatewayAddressResult
Parameters
request
A container for the necessary parameters to execute the AssignPrivateNatGatewayAddress service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.
You cannot associate an Elastic IP address with an interface in a different network border group.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn’t return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
See
AWSEC2AssociateAddressRequest
See
AWSEC2AssociateAddressResult
Declaration
Objective-C
- (id)associateAddress:(nonnull AWSEC2AssociateAddressRequest *)request;
Swift
func associateAddress(_ request: AWSEC2AssociateAddressRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateAddress service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssociateAddressResult
. -
Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.
[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.
You cannot associate an Elastic IP address with an interface in a different network border group.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn’t return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
See
AWSEC2AssociateAddressRequest
See
AWSEC2AssociateAddressResult
Declaration
Objective-C
- (void)associateAddress:(nonnull AWSEC2AssociateAddressRequest *)request completionHandler: (void (^_Nullable)(AWSEC2AssociateAddressResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateAddress(_ request: AWSEC2AssociateAddressRequest) async throws -> AWSEC2AssociateAddressResult
Parameters
request
A container for the necessary parameters to execute the AssociateAddress service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that’s in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that’s associated with it.
See
AWSEC2AssociateClientVpnTargetNetworkRequest
See
AWSEC2AssociateClientVpnTargetNetworkResult
Declaration
Objective-C
- (id)associateClientVpnTargetNetwork: (nonnull AWSEC2AssociateClientVpnTargetNetworkRequest *)request;
Swift
func associateClientVpnTargetNetwork(_ request: AWSEC2AssociateClientVpnTargetNetworkRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateClientVpnTargetNetwork service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssociateClientVpnTargetNetworkResult
. -
Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.
If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that’s in a different VPC, you must first modify the Client VPN endpoint (ModifyClientVpnEndpoint) and change the VPC that’s associated with it.
See
AWSEC2AssociateClientVpnTargetNetworkRequest
See
AWSEC2AssociateClientVpnTargetNetworkResult
Declaration
Objective-C
- (void)associateClientVpnTargetNetwork: (nonnull AWSEC2AssociateClientVpnTargetNetworkRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AssociateClientVpnTargetNetworkResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateClientVpnTargetNetwork(_ request: AWSEC2AssociateClientVpnTargetNetworkRequest) async throws -> AWSEC2AssociateClientVpnTargetNetworkResult
Parameters
request
A container for the necessary parameters to execute the AssociateClientVpnTargetNetwork service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates a set of DHCP options (that you’ve previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don’t need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP option sets in the Amazon VPC User Guide.
See
AWSEC2AssociateDhcpOptionsRequest
Declaration
Objective-C
- (id)associateDhcpOptions:(nonnull AWSEC2AssociateDhcpOptionsRequest *)request;
Swift
func associateDhcpOptions(_ request: AWSEC2AssociateDhcpOptionsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateDhcpOptions service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Associates a set of DHCP options (that you’ve previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don’t need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP option sets in the Amazon VPC User Guide.
See
AWSEC2AssociateDhcpOptionsRequest
Declaration
Objective-C
- (void)associateDhcpOptions: (nonnull AWSEC2AssociateDhcpOptionsRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func associateDhcpOptions(_ request: AWSEC2AssociateDhcpOptionsRequest) async throws
Parameters
request
A container for the necessary parameters to execute the AssociateDhcpOptions service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide.
When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.
To enable the IAM role to access the Amazon S3 object, you must grant it permission to call
s3:GetObject
on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to callkms:Decrypt
on the KMS key returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the Amazon Web Services Nitro Enclaves User Guide.See
AWSEC2AssociateEnclaveCertificateIamRoleRequest
See
AWSEC2AssociateEnclaveCertificateIamRoleResult
Declaration
Objective-C
- (id)associateEnclaveCertificateIamRole: (nonnull AWSEC2AssociateEnclaveCertificateIamRoleRequest *)request;
Swift
func associateEnclaveCertificateIamRole(_ request: AWSEC2AssociateEnclaveCertificateIamRoleRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateEnclaveCertificateIamRole service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssociateEnclaveCertificateIamRoleResult
. -
Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide.
When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.
To enable the IAM role to access the Amazon S3 object, you must grant it permission to call
s3:GetObject
on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to callkms:Decrypt
on the KMS key returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the Amazon Web Services Nitro Enclaves User Guide.See
AWSEC2AssociateEnclaveCertificateIamRoleRequest
See
AWSEC2AssociateEnclaveCertificateIamRoleResult
Declaration
Objective-C
- (void)associateEnclaveCertificateIamRole: (nonnull AWSEC2AssociateEnclaveCertificateIamRoleRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AssociateEnclaveCertificateIamRoleResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateEnclaveCertificateIamRole(_ request: AWSEC2AssociateEnclaveCertificateIamRoleRequest) async throws -> AWSEC2AssociateEnclaveCertificateIamRoleResult
Parameters
request
A container for the necessary parameters to execute the AssociateEnclaveCertificateIamRole service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
See
AWSEC2AssociateIamInstanceProfileRequest
See
AWSEC2AssociateIamInstanceProfileResult
Declaration
Objective-C
- (id)associateIamInstanceProfile: (nonnull AWSEC2AssociateIamInstanceProfileRequest *)request;
Swift
func associateIamInstanceProfile(_ request: AWSEC2AssociateIamInstanceProfileRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateIamInstanceProfile service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssociateIamInstanceProfileResult
. -
Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
See
AWSEC2AssociateIamInstanceProfileRequest
See
AWSEC2AssociateIamInstanceProfileResult
Declaration
Objective-C
- (void)associateIamInstanceProfile: (nonnull AWSEC2AssociateIamInstanceProfileRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AssociateIamInstanceProfileResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateIamInstanceProfile(_ request: AWSEC2AssociateIamInstanceProfileRequest) async throws -> AWSEC2AssociateIamInstanceProfileResult
Parameters
request
A container for the necessary parameters to execute the AssociateIamInstanceProfile service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
See
AWSEC2AssociateInstanceEventWindowRequest
See
AWSEC2AssociateInstanceEventWindowResult
Declaration
Objective-C
- (id)associateInstanceEventWindow: (nonnull AWSEC2AssociateInstanceEventWindowRequest *)request;
Swift
func associateInstanceEventWindow(_ request: AWSEC2AssociateInstanceEventWindowRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateInstanceEventWindow service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssociateInstanceEventWindowResult
. -
Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
See
AWSEC2AssociateInstanceEventWindowRequest
See
AWSEC2AssociateInstanceEventWindowResult
Declaration
Objective-C
- (void)associateInstanceEventWindow: (nonnull AWSEC2AssociateInstanceEventWindowRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AssociateInstanceEventWindowResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateInstanceEventWindow(_ request: AWSEC2AssociateInstanceEventWindowRequest) async throws -> AWSEC2AssociateInstanceEventWindowResult
Parameters
request
A container for the necessary parameters to execute the AssociateInstanceEventWindow service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own in the same Amazon Web Services Region. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
After the association succeeds, the ASN is eligible for advertisement. You can view the association with DescribeByoipCidrs. You can advertise the CIDR with AdvertiseByoipCidr.
See
AWSEC2AssociateIpamByoasnRequest
See
AWSEC2AssociateIpamByoasnResult
Declaration
Objective-C
- (id)associateIpamByoasn:(nonnull AWSEC2AssociateIpamByoasnRequest *)request;
Swift
func associateIpamByoasn(_ request: AWSEC2AssociateIpamByoasnRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateIpamByoasn service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssociateIpamByoasnResult
. -
Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own in the same Amazon Web Services Region. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
After the association succeeds, the ASN is eligible for advertisement. You can view the association with DescribeByoipCidrs. You can advertise the CIDR with AdvertiseByoipCidr.
See
AWSEC2AssociateIpamByoasnRequest
See
AWSEC2AssociateIpamByoasnResult
Declaration
Objective-C
- (void)associateIpamByoasn:(nonnull AWSEC2AssociateIpamByoasnRequest *)request completionHandler: (void (^_Nullable)(AWSEC2AssociateIpamByoasnResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateIpamByoasn(_ request: AWSEC2AssociateIpamByoasnRequest) async throws -> AWSEC2AssociateIpamByoasnResult
Parameters
request
A container for the necessary parameters to execute the AssociateIpamByoasn service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
See
AWSEC2AssociateIpamResourceDiscoveryRequest
See
AWSEC2AssociateIpamResourceDiscoveryResult
Declaration
Objective-C
- (id)associateIpamResourceDiscovery: (nonnull AWSEC2AssociateIpamResourceDiscoveryRequest *)request;
Swift
func associateIpamResourceDiscovery(_ request: AWSEC2AssociateIpamResourceDiscoveryRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateIpamResourceDiscovery service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssociateIpamResourceDiscoveryResult
. -
Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
See
AWSEC2AssociateIpamResourceDiscoveryRequest
See
AWSEC2AssociateIpamResourceDiscoveryResult
Declaration
Objective-C
- (void) associateIpamResourceDiscovery: (nonnull AWSEC2AssociateIpamResourceDiscoveryRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AssociateIpamResourceDiscoveryResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateIpamResourceDiscovery(_ request: AWSEC2AssociateIpamResourceDiscoveryRequest) async throws -> AWSEC2AssociateIpamResourceDiscoveryResult
Parameters
request
A container for the necessary parameters to execute the AssociateIpamResourceDiscovery service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.
By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see Elastic IP address quotas in the Amazon VPC User Guide.
When you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it’s not the same, the EIP will fail to associate. You can see the network border group for the subnet’s AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide.
See
AWSEC2AssociateNatGatewayAddressRequest
See
AWSEC2AssociateNatGatewayAddressResult
Declaration
Objective-C
- (id)associateNatGatewayAddress: (nonnull AWSEC2AssociateNatGatewayAddressRequest *)request;
Swift
func associateNatGatewayAddress(_ request: AWSEC2AssociateNatGatewayAddressRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateNatGatewayAddress service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssociateNatGatewayAddressResult
. -
Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.
By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see Elastic IP address quotas in the Amazon VPC User Guide.
When you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it’s not the same, the EIP will fail to associate. You can see the network border group for the subnet’s AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see Allocate an Elastic IP address in the Amazon VPC User Guide.
See
AWSEC2AssociateNatGatewayAddressRequest
See
AWSEC2AssociateNatGatewayAddressResult
Declaration
Objective-C
- (void)associateNatGatewayAddress: (nonnull AWSEC2AssociateNatGatewayAddressRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AssociateNatGatewayAddressResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateNatGatewayAddress(_ request: AWSEC2AssociateNatGatewayAddressRequest) async throws -> AWSEC2AssociateNatGatewayAddressResult
Parameters
request
A container for the necessary parameters to execute the AssociateNatGatewayAddress service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route tables in the Amazon VPC User Guide.
See
AWSEC2AssociateRouteTableRequest
See
AWSEC2AssociateRouteTableResult
Declaration
Objective-C
- (id)associateRouteTable:(nonnull AWSEC2AssociateRouteTableRequest *)request;
Swift
func associateRouteTable(_ request: AWSEC2AssociateRouteTableRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateRouteTable service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssociateRouteTableResult
. -
Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route tables in the Amazon VPC User Guide.
See
AWSEC2AssociateRouteTableRequest
See
AWSEC2AssociateRouteTableResult
Declaration
Objective-C
- (void)associateRouteTable:(nonnull AWSEC2AssociateRouteTableRequest *)request completionHandler: (void (^_Nullable)(AWSEC2AssociateRouteTableResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateRouteTable(_ request: AWSEC2AssociateRouteTableRequest) async throws -> AWSEC2AssociateRouteTableResult
Parameters
request
A container for the necessary parameters to execute the AssociateRouteTable service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet.
See
AWSEC2AssociateSubnetCidrBlockRequest
See
AWSEC2AssociateSubnetCidrBlockResult
Declaration
Objective-C
- (id)associateSubnetCidrBlock: (nonnull AWSEC2AssociateSubnetCidrBlockRequest *)request;
Swift
func associateSubnetCidrBlock(_ request: AWSEC2AssociateSubnetCidrBlockRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateSubnetCidrBlock service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssociateSubnetCidrBlockResult
. -
Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet.
See
AWSEC2AssociateSubnetCidrBlockRequest
See
AWSEC2AssociateSubnetCidrBlockResult
Declaration
Objective-C
- (void)associateSubnetCidrBlock: (nonnull AWSEC2AssociateSubnetCidrBlockRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AssociateSubnetCidrBlockResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateSubnetCidrBlock(_ request: AWSEC2AssociateSubnetCidrBlockRequest) async throws -> AWSEC2AssociateSubnetCidrBlockResult
Parameters
request
A container for the necessary parameters to execute the AssociateSubnetCidrBlock service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
See
AWSEC2AssociateTransitGatewayMulticastDomainRequest
See
AWSEC2AssociateTransitGatewayMulticastDomainResult
Declaration
Objective-C
- (id)associateTransitGatewayMulticastDomain: (nonnull AWSEC2AssociateTransitGatewayMulticastDomainRequest *)request;
Swift
func associateTransitGatewayMulticastDomain(_ request: AWSEC2AssociateTransitGatewayMulticastDomainRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateTransitGatewayMulticastDomain service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssociateTransitGatewayMulticastDomainResult
. -
Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
See
AWSEC2AssociateTransitGatewayMulticastDomainRequest
See
AWSEC2AssociateTransitGatewayMulticastDomainResult
Declaration
Objective-C
- (void) associateTransitGatewayMulticastDomain: (nonnull AWSEC2AssociateTransitGatewayMulticastDomainRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AssociateTransitGatewayMulticastDomainResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateTransitGatewayMulticastDomain(_ request: AWSEC2AssociateTransitGatewayMulticastDomainRequest) async throws -> AWSEC2AssociateTransitGatewayMulticastDomainResult
Parameters
request
A container for the necessary parameters to execute the AssociateTransitGatewayMulticastDomain service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates the specified transit gateway attachment with a transit gateway policy table.
See
AWSEC2AssociateTransitGatewayPolicyTableRequest
See
AWSEC2AssociateTransitGatewayPolicyTableResult
Declaration
Objective-C
- (id)associateTransitGatewayPolicyTable: (nonnull AWSEC2AssociateTransitGatewayPolicyTableRequest *)request;
Swift
func associateTransitGatewayPolicyTable(_ request: AWSEC2AssociateTransitGatewayPolicyTableRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateTransitGatewayPolicyTable service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssociateTransitGatewayPolicyTableResult
. -
Associates the specified transit gateway attachment with a transit gateway policy table.
See
AWSEC2AssociateTransitGatewayPolicyTableRequest
See
AWSEC2AssociateTransitGatewayPolicyTableResult
Declaration
Objective-C
- (void)associateTransitGatewayPolicyTable: (nonnull AWSEC2AssociateTransitGatewayPolicyTableRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AssociateTransitGatewayPolicyTableResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateTransitGatewayPolicyTable(_ request: AWSEC2AssociateTransitGatewayPolicyTableRequest) async throws -> AWSEC2AssociateTransitGatewayPolicyTableResult
Parameters
request
A container for the necessary parameters to execute the AssociateTransitGatewayPolicyTable service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
See
AWSEC2AssociateTransitGatewayRouteTableRequest
See
AWSEC2AssociateTransitGatewayRouteTableResult
Declaration
Objective-C
- (id)associateTransitGatewayRouteTable: (nonnull AWSEC2AssociateTransitGatewayRouteTableRequest *)request;
Swift
func associateTransitGatewayRouteTable(_ request: AWSEC2AssociateTransitGatewayRouteTableRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateTransitGatewayRouteTable service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssociateTransitGatewayRouteTableResult
. -
Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
See
AWSEC2AssociateTransitGatewayRouteTableRequest
See
AWSEC2AssociateTransitGatewayRouteTableResult
Declaration
Objective-C
- (void)associateTransitGatewayRouteTable: (nonnull AWSEC2AssociateTransitGatewayRouteTableRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AssociateTransitGatewayRouteTableResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateTransitGatewayRouteTable(_ request: AWSEC2AssociateTransitGatewayRouteTableRequest) async throws -> AWSEC2AssociateTransitGatewayRouteTableResult
Parameters
request
A container for the necessary parameters to execute the AssociateTransitGatewayRouteTable service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates a branch network interface with a trunk network interface.
Before you create the association, use CreateNetworkInterface command and set the interface type to
trunk
. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.See
AWSEC2AssociateTrunkInterfaceRequest
See
AWSEC2AssociateTrunkInterfaceResult
Declaration
Objective-C
- (id)associateTrunkInterface: (nonnull AWSEC2AssociateTrunkInterfaceRequest *)request;
Swift
func associateTrunkInterface(_ request: AWSEC2AssociateTrunkInterfaceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateTrunkInterface service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssociateTrunkInterfaceResult
. -
Associates a branch network interface with a trunk network interface.
Before you create the association, use CreateNetworkInterface command and set the interface type to
trunk
. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.See
AWSEC2AssociateTrunkInterfaceRequest
See
AWSEC2AssociateTrunkInterfaceResult
Declaration
Objective-C
- (void) associateTrunkInterface: (nonnull AWSEC2AssociateTrunkInterfaceRequest *)request completionHandler: (void (^_Nullable)(AWSEC2AssociateTrunkInterfaceResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateTrunkInterface(_ request: AWSEC2AssociateTrunkInterfaceRequest) async throws -> AWSEC2AssociateTrunkInterfaceResult
Parameters
request
A container for the necessary parameters to execute the AssociateTrunkInterface service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.
For more information about associating CIDR blocks with your VPC and applicable restrictions, see IP addressing for your VPCs and subnets in the Amazon VPC User Guide.
See
AWSEC2AssociateVpcCidrBlockRequest
See
AWSEC2AssociateVpcCidrBlockResult
Declaration
Objective-C
- (id)associateVpcCidrBlock: (nonnull AWSEC2AssociateVpcCidrBlockRequest *)request;
Swift
func associateVpcCidrBlock(_ request: AWSEC2AssociateVpcCidrBlockRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AssociateVpcCidrBlock service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AssociateVpcCidrBlockResult
. -
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP).
You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block.
For more information about associating CIDR blocks with your VPC and applicable restrictions, see IP addressing for your VPCs and subnets in the Amazon VPC User Guide.
See
AWSEC2AssociateVpcCidrBlockRequest
See
AWSEC2AssociateVpcCidrBlockResult
Declaration
Objective-C
- (void)associateVpcCidrBlock: (nonnull AWSEC2AssociateVpcCidrBlockRequest *)request completionHandler: (void (^_Nullable)(AWSEC2AssociateVpcCidrBlockResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func associateVpcCidrBlock(_ request: AWSEC2AssociateVpcCidrBlockRequest) async throws -> AWSEC2AssociateVpcCidrBlockResult
Parameters
request
A container for the necessary parameters to execute the AssociateVpcCidrBlock service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
This action is deprecated.
Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that’s in the
running
state. An instance is automatically unlinked from a VPC when it’s stopped - you can link it to the VPC again when you restart it.After you’ve linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
Linking your instance to a VPC is sometimes referred to as attaching your instance.
See
AWSEC2AttachClassicLinkVpcRequest
See
AWSEC2AttachClassicLinkVpcResult
Declaration
Objective-C
- (id)attachClassicLinkVpc:(nonnull AWSEC2AttachClassicLinkVpcRequest *)request;
Swift
func attachClassicLinkVpc(_ request: AWSEC2AttachClassicLinkVpcRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AttachClassicLinkVpc service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AttachClassicLinkVpcResult
. -
This action is deprecated.
Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that’s in the
running
state. An instance is automatically unlinked from a VPC when it’s stopped - you can link it to the VPC again when you restart it.After you’ve linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.
Linking your instance to a VPC is sometimes referred to as attaching your instance.
See
AWSEC2AttachClassicLinkVpcRequest
See
AWSEC2AttachClassicLinkVpcResult
Declaration
Objective-C
- (void)attachClassicLinkVpc: (nonnull AWSEC2AttachClassicLinkVpcRequest *)request completionHandler: (void (^_Nullable)(AWSEC2AttachClassicLinkVpcResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func attachClassicLinkVpc(_ request: AWSEC2AttachClassicLinkVpcRequest) async throws -> AWSEC2AttachClassicLinkVpcResult
Parameters
request
A container for the necessary parameters to execute the AttachClassicLinkVpc service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information, see Internet gateways in the Amazon VPC User Guide.
See
AWSEC2AttachInternetGatewayRequest
Declaration
Objective-C
- (id)attachInternetGateway: (nonnull AWSEC2AttachInternetGatewayRequest *)request;
Swift
func attachInternetGateway(_ request: AWSEC2AttachInternetGatewayRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AttachInternetGateway service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information, see Internet gateways in the Amazon VPC User Guide.
See
AWSEC2AttachInternetGatewayRequest
Declaration
Objective-C
- (void)attachInternetGateway: (nonnull AWSEC2AttachInternetGatewayRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func attachInternetGateway(_ request: AWSEC2AttachInternetGatewayRequest) async throws
Parameters
request
A container for the necessary parameters to execute the AttachInternetGateway service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Attaches a network interface to an instance.
See
AWSEC2AttachNetworkInterfaceRequest
See
AWSEC2AttachNetworkInterfaceResult
Declaration
Objective-C
- (id)attachNetworkInterface: (nonnull AWSEC2AttachNetworkInterfaceRequest *)request;
Swift
func attachNetworkInterface(_ request: AWSEC2AttachNetworkInterfaceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AttachNetworkInterface service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AttachNetworkInterfaceResult
. -
Attaches a network interface to an instance.
See
AWSEC2AttachNetworkInterfaceRequest
See
AWSEC2AttachNetworkInterfaceResult
Declaration
Objective-C
- (void) attachNetworkInterface: (nonnull AWSEC2AttachNetworkInterfaceRequest *)request completionHandler: (void (^_Nullable)(AWSEC2AttachNetworkInterfaceResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func attachNetworkInterface(_ request: AWSEC2AttachNetworkInterfaceRequest) async throws -> AWSEC2AttachNetworkInterfaceResult
Parameters
request
A container for the necessary parameters to execute the AttachNetworkInterface service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.
See
AWSEC2AttachVerifiedAccessTrustProviderRequest
See
AWSEC2AttachVerifiedAccessTrustProviderResult
Declaration
Objective-C
- (id)attachVerifiedAccessTrustProvider: (nonnull AWSEC2AttachVerifiedAccessTrustProviderRequest *)request;
Swift
func attachVerifiedAccessTrustProvider(_ request: AWSEC2AttachVerifiedAccessTrustProviderRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AttachVerifiedAccessTrustProvider service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AttachVerifiedAccessTrustProviderResult
. -
Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.
See
AWSEC2AttachVerifiedAccessTrustProviderRequest
See
AWSEC2AttachVerifiedAccessTrustProviderResult
Declaration
Objective-C
- (void)attachVerifiedAccessTrustProvider: (nonnull AWSEC2AttachVerifiedAccessTrustProviderRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AttachVerifiedAccessTrustProviderResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func attachVerifiedAccessTrustProvider(_ request: AWSEC2AttachVerifiedAccessTrustProviderRequest) async throws -> AWSEC2AttachVerifiedAccessTrustProviderResult
Parameters
request
A container for the necessary parameters to execute the AttachVerifiedAccessTrustProvider service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
After you attach an EBS volume, you must make it available. For more information, see Make an EBS volume available for use.
If a volume has an Amazon Web Services Marketplace product code:
The volume can be attached only to a stopped instance.
Amazon Web Services Marketplace product codes are copied from the volume to the instance.
You must be subscribed to the product.
The instance type and operating system of the instance must support the product. For example, you can’t detach a volume from a Windows instance and attach it to a Linux instance.
For more information, see Attach an Amazon EBS volume to an instance in the Amazon EBS User Guide.
See
AWSEC2AttachVolumeRequest
See
AWSEC2VolumeAttachment
Declaration
Objective-C
- (id)attachVolume:(nonnull AWSEC2AttachVolumeRequest *)request;
Swift
func attachVolume(_ request: AWSEC2AttachVolumeRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AttachVolume service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2VolumeAttachment
. -
Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.
Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
After you attach an EBS volume, you must make it available. For more information, see Make an EBS volume available for use.
If a volume has an Amazon Web Services Marketplace product code:
The volume can be attached only to a stopped instance.
Amazon Web Services Marketplace product codes are copied from the volume to the instance.
You must be subscribed to the product.
The instance type and operating system of the instance must support the product. For example, you can’t detach a volume from a Windows instance and attach it to a Linux instance.
For more information, see Attach an Amazon EBS volume to an instance in the Amazon EBS User Guide.
See
AWSEC2AttachVolumeRequest
See
AWSEC2VolumeAttachment
Declaration
Objective-C
- (void)attachVolume:(nonnull AWSEC2AttachVolumeRequest *)request completionHandler:(void (^_Nullable)(AWSEC2VolumeAttachment *_Nullable, NSError *_Nullable))completionHandler;
Swift
func attachVolume(_ request: AWSEC2AttachVolumeRequest) async throws -> AWSEC2VolumeAttachment
Parameters
request
A container for the necessary parameters to execute the AttachVolume service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
See
AWSEC2AttachVpnGatewayRequest
See
AWSEC2AttachVpnGatewayResult
Declaration
Objective-C
- (id)attachVpnGateway:(nonnull AWSEC2AttachVpnGatewayRequest *)request;
Swift
func attachVpnGateway(_ request: AWSEC2AttachVpnGatewayRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AttachVpnGateway service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AttachVpnGatewayResult
. -
Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
See
AWSEC2AttachVpnGatewayRequest
See
AWSEC2AttachVpnGatewayResult
Declaration
Objective-C
- (void)attachVpnGateway:(nonnull AWSEC2AttachVpnGatewayRequest *)request completionHandler: (void (^_Nullable)(AWSEC2AttachVpnGatewayResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func attachVpnGateway(_ request: AWSEC2AttachVpnGatewayRequest) async throws -> AWSEC2AttachVpnGatewayResult
Parameters
request
A container for the necessary parameters to execute the AttachVpnGateway service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks.
See
AWSEC2AuthorizeClientVpnIngressRequest
See
AWSEC2AuthorizeClientVpnIngressResult
Declaration
Objective-C
- (id)authorizeClientVpnIngress: (nonnull AWSEC2AuthorizeClientVpnIngressRequest *)request;
Swift
func authorizeClientVpnIngress(_ request: AWSEC2AuthorizeClientVpnIngressRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AuthorizeClientVpnIngress service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AuthorizeClientVpnIngressResult
. -
Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in Amazon Web Services or on-premises networks.
See
AWSEC2AuthorizeClientVpnIngressRequest
See
AWSEC2AuthorizeClientVpnIngressResult
Declaration
Objective-C
- (void)authorizeClientVpnIngress: (nonnull AWSEC2AuthorizeClientVpnIngressRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AuthorizeClientVpnIngressResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func authorizeClientVpnIngress(_ request: AWSEC2AuthorizeClientVpnIngressRequest) async throws -> AWSEC2AuthorizeClientVpnIngressResult
Parameters
request
A container for the necessary parameters to execute the AuthorizeClientVpnIngress service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Adds the specified outbound (egress) rules to a security group.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address ranges, the IP address ranges specified by a prefix list, or the instances that are associated with a source security group. For more information, see Security group rules.
You must specify exactly one of the following destinations: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP type and code.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide.
For information about security group quotas, see Amazon VPC quotas in the Amazon VPC User Guide.
See
AWSEC2AuthorizeSecurityGroupEgressRequest
See
AWSEC2AuthorizeSecurityGroupEgressResult
Declaration
Objective-C
- (id)authorizeSecurityGroupEgress: (nonnull AWSEC2AuthorizeSecurityGroupEgressRequest *)request;
Swift
func authorizeSecurityGroupEgress(_ request: AWSEC2AuthorizeSecurityGroupEgressRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AuthorizeSecurityGroupEgress service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AuthorizeSecurityGroupEgressResult
. -
Adds the specified outbound (egress) rules to a security group.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address ranges, the IP address ranges specified by a prefix list, or the instances that are associated with a source security group. For more information, see Security group rules.
You must specify exactly one of the following destinations: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP type and code.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide.
For information about security group quotas, see Amazon VPC quotas in the Amazon VPC User Guide.
See
AWSEC2AuthorizeSecurityGroupEgressRequest
See
AWSEC2AuthorizeSecurityGroupEgressResult
Declaration
Objective-C
- (void)authorizeSecurityGroupEgress: (nonnull AWSEC2AuthorizeSecurityGroupEgressRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AuthorizeSecurityGroupEgressResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func authorizeSecurityGroupEgress(_ request: AWSEC2AuthorizeSecurityGroupEgressRequest) async throws -> AWSEC2AuthorizeSecurityGroupEgressResult
Parameters
request
A container for the necessary parameters to execute the AuthorizeSecurityGroupEgress service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Adds the specified inbound (ingress) rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 address range, the IP address ranges that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see Security group rules.
You must specify exactly one of the following sources: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide.
For more information about security group quotas, see Amazon VPC quotas in the Amazon VPC User Guide.
See
AWSEC2AuthorizeSecurityGroupIngressRequest
See
AWSEC2AuthorizeSecurityGroupIngressResult
Declaration
Objective-C
- (id)authorizeSecurityGroupIngress: (nonnull AWSEC2AuthorizeSecurityGroupIngressRequest *)request;
Swift
func authorizeSecurityGroupIngress(_ request: AWSEC2AuthorizeSecurityGroupIngressRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the AuthorizeSecurityGroupIngress service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2AuthorizeSecurityGroupIngressResult
. -
Adds the specified inbound (ingress) rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 address range, the IP address ranges that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see Security group rules.
You must specify exactly one of the following sources: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code.
Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur.
For examples of rules that you can add to security groups for specific access scenarios, see Security group rules for different use cases in the Amazon EC2 User Guide.
For more information about security group quotas, see Amazon VPC quotas in the Amazon VPC User Guide.
See
AWSEC2AuthorizeSecurityGroupIngressRequest
See
AWSEC2AuthorizeSecurityGroupIngressResult
Declaration
Objective-C
- (void) authorizeSecurityGroupIngress: (nonnull AWSEC2AuthorizeSecurityGroupIngressRequest *)request completionHandler: (void (^_Nullable)( AWSEC2AuthorizeSecurityGroupIngressResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func authorizeSecurityGroupIngress(_ request: AWSEC2AuthorizeSecurityGroupIngressRequest) async throws -> AWSEC2AuthorizeSecurityGroupIngressResult
Parameters
request
A container for the necessary parameters to execute the AuthorizeSecurityGroupIngress service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:) is bundled. Data on other instance store volumes is not preserved.
This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
See
AWSEC2BundleInstanceRequest
See
AWSEC2BundleInstanceResult
Declaration
Objective-C
- (id)bundleInstance:(nonnull AWSEC2BundleInstanceRequest *)request;
Swift
func bundleInstance(_ request: AWSEC2BundleInstanceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the BundleInstance service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2BundleInstanceResult
. -
Bundles an Amazon instance store-backed Windows instance.
During bundling, only the root device volume (C:) is bundled. Data on other instance store volumes is not preserved.
This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.
See
AWSEC2BundleInstanceRequest
See
AWSEC2BundleInstanceResult
Declaration
Objective-C
- (void)bundleInstance:(nonnull AWSEC2BundleInstanceRequest *)request completionHandler:(void (^_Nullable)(AWSEC2BundleInstanceResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func bundleInstance(_ request: AWSEC2BundleInstanceRequest) async throws -> AWSEC2BundleInstanceResult
Parameters
request
A container for the necessary parameters to execute the BundleInstance service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Cancels a bundling operation for an instance store-backed Windows instance.
See
AWSEC2CancelBundleTaskRequest
See
AWSEC2CancelBundleTaskResult
Declaration
Objective-C
- (id)cancelBundleTask:(nonnull AWSEC2CancelBundleTaskRequest *)request;
Swift
func cancelBundleTask(_ request: AWSEC2CancelBundleTaskRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CancelBundleTask service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CancelBundleTaskResult
. -
Cancels a bundling operation for an instance store-backed Windows instance.
See
AWSEC2CancelBundleTaskRequest
See
AWSEC2CancelBundleTaskResult
Declaration
Objective-C
- (void)cancelBundleTask:(nonnull AWSEC2CancelBundleTaskRequest *)request completionHandler: (void (^_Nullable)(AWSEC2CancelBundleTaskResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func cancelBundleTask(_ request: AWSEC2CancelBundleTaskRequest) async throws -> AWSEC2CancelBundleTaskResult
Parameters
request
A container for the necessary parameters to execute the CancelBundleTask service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation’s state to
cancelled
.Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.
See
AWSEC2CancelCapacityReservationRequest
See
AWSEC2CancelCapacityReservationResult
Declaration
Objective-C
- (id)cancelCapacityReservation: (nonnull AWSEC2CancelCapacityReservationRequest *)request;
Swift
func cancelCapacityReservation(_ request: AWSEC2CancelCapacityReservationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CancelCapacityReservation service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CancelCapacityReservationResult
. -
Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation’s state to
cancelled
.Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.
See
AWSEC2CancelCapacityReservationRequest
See
AWSEC2CancelCapacityReservationResult
Declaration
Objective-C
- (void)cancelCapacityReservation: (nonnull AWSEC2CancelCapacityReservationRequest *)request completionHandler: (void (^_Nullable)( AWSEC2CancelCapacityReservationResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func cancelCapacityReservation(_ request: AWSEC2CancelCapacityReservationRequest) async throws -> AWSEC2CancelCapacityReservationResult
Parameters
request
A container for the necessary parameters to execute the CancelCapacityReservation service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:
The Capacity Reservation Fleet’s status changes to
cancelled
.The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.
The Fleet stops creating new Capacity Reservations.
See
AWSEC2CancelCapacityReservationFleetsRequest
See
AWSEC2CancelCapacityReservationFleetsResult
Declaration
Objective-C
- (id)cancelCapacityReservationFleets: (nonnull AWSEC2CancelCapacityReservationFleetsRequest *)request;
Swift
func cancelCapacityReservationFleets(_ request: AWSEC2CancelCapacityReservationFleetsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CancelCapacityReservationFleets service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CancelCapacityReservationFleetsResult
. -
Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:
The Capacity Reservation Fleet’s status changes to
cancelled
.The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.
The Fleet stops creating new Capacity Reservations.
See
AWSEC2CancelCapacityReservationFleetsRequest
See
AWSEC2CancelCapacityReservationFleetsResult
Declaration
Objective-C
- (void)cancelCapacityReservationFleets: (nonnull AWSEC2CancelCapacityReservationFleetsRequest *)request completionHandler: (void (^_Nullable)( AWSEC2CancelCapacityReservationFleetsResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func cancelCapacityReservationFleets(_ request: AWSEC2CancelCapacityReservationFleetsRequest) async throws -> AWSEC2CancelCapacityReservationFleetsResult
Parameters
request
A container for the necessary parameters to execute the CancelCapacityReservationFleets service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
See
AWSEC2CancelConversionRequest
Declaration
Objective-C
- (id)cancelConversionTask:(nonnull AWSEC2CancelConversionRequest *)request;
Swift
func cancelConversionTask(_ request: AWSEC2CancelConversionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CancelConversionTask service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
See
AWSEC2CancelConversionRequest
Declaration
Objective-C
- (void)cancelConversionTask:(nonnull AWSEC2CancelConversionRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func cancelConversionTask(_ request: AWSEC2CancelConversionRequest) async throws
Parameters
request
A container for the necessary parameters to execute the CancelConversionTask service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.
See
AWSEC2CancelExportTaskRequest
Declaration
Objective-C
- (id)cancelExportTask:(nonnull AWSEC2CancelExportTaskRequest *)request;
Swift
func cancelExportTask(_ request: AWSEC2CancelExportTaskRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CancelExportTask service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. -
Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.
See
AWSEC2CancelExportTaskRequest
Declaration
Objective-C
- (void)cancelExportTask:(nonnull AWSEC2CancelExportTaskRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func cancelExportTask(_ request: AWSEC2CancelExportTaskRequest) async throws
Parameters
request
A container for the necessary parameters to execute the CancelExportTask service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more information, see Cancel having an AMI shared with your Amazon Web Services account in the Amazon EC2 User Guide.
See
AWSEC2CancelImageLaunchPermissionRequest
See
AWSEC2CancelImageLaunchPermissionResult
Declaration
Objective-C
- (id)cancelImageLaunchPermission: (nonnull AWSEC2CancelImageLaunchPermissionRequest *)request;
Swift
func cancelImageLaunchPermission(_ request: AWSEC2CancelImageLaunchPermissionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CancelImageLaunchPermission service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CancelImageLaunchPermissionResult
. -
Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more information, see Cancel having an AMI shared with your Amazon Web Services account in the Amazon EC2 User Guide.
See
AWSEC2CancelImageLaunchPermissionRequest
See
AWSEC2CancelImageLaunchPermissionResult
Declaration
Objective-C
- (void)cancelImageLaunchPermission: (nonnull AWSEC2CancelImageLaunchPermissionRequest *)request completionHandler: (void (^_Nullable)( AWSEC2CancelImageLaunchPermissionResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func cancelImageLaunchPermission(_ request: AWSEC2CancelImageLaunchPermissionRequest) async throws -> AWSEC2CancelImageLaunchPermissionResult
Parameters
request
A container for the necessary parameters to execute the CancelImageLaunchPermission service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Cancels an in-process import virtual machine or import snapshot task.
See
AWSEC2CancelImportTaskRequest
See
AWSEC2CancelImportTaskResult
Declaration
Objective-C
- (id)cancelImportTask:(nonnull AWSEC2CancelImportTaskRequest *)request;
Swift
func cancelImportTask(_ request: AWSEC2CancelImportTaskRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CancelImportTask service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CancelImportTaskResult
. -
Cancels an in-process import virtual machine or import snapshot task.
See
AWSEC2CancelImportTaskRequest
See
AWSEC2CancelImportTaskResult
Declaration
Objective-C
- (void)cancelImportTask:(nonnull AWSEC2CancelImportTaskRequest *)request completionHandler: (void (^_Nullable)(AWSEC2CancelImportTaskResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func cancelImportTask(_ request: AWSEC2CancelImportTaskRequest) async throws -> AWSEC2CancelImportTaskResult
Parameters
request
A container for the necessary parameters to execute the CancelImportTask service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
See
AWSEC2CancelReservedInstancesListingRequest
See
AWSEC2CancelReservedInstancesListingResult
Declaration
Objective-C
- (id)cancelReservedInstancesListing: (nonnull AWSEC2CancelReservedInstancesListingRequest *)request;
Swift
func cancelReservedInstancesListing(_ request: AWSEC2CancelReservedInstancesListingRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CancelReservedInstancesListing service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CancelReservedInstancesListingResult
. -
Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
See
AWSEC2CancelReservedInstancesListingRequest
See
AWSEC2CancelReservedInstancesListingResult
Declaration
Objective-C
- (void) cancelReservedInstancesListing: (nonnull AWSEC2CancelReservedInstancesListingRequest *)request completionHandler: (void (^_Nullable)( AWSEC2CancelReservedInstancesListingResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func cancelReservedInstancesListing(_ request: AWSEC2CancelReservedInstancesListingRequest) async throws -> AWSEC2CancelReservedInstancesListingResult
Parameters
request
A container for the necessary parameters to execute the CancelReservedInstancesListing service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the
cancelled_terminating
state. Otherwise, the Spot Fleet request enters thecancelled_running
state and the instances continue to run until they are interrupted or you terminate them manually.Restrictions
You can delete up to 100 fleets in a single request. If you exceed the specified number, no fleets are deleted.
See
AWSEC2CancelSpotFleetRequestsRequest
See
AWSEC2CancelSpotFleetRequestsResponse
Declaration
Objective-C
- (id)cancelSpotFleetRequests: (nonnull AWSEC2CancelSpotFleetRequestsRequest *)request;
Swift
func cancelSpotFleetRequests(_ request: AWSEC2CancelSpotFleetRequestsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CancelSpotFleetRequests service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CancelSpotFleetRequestsResponse
. -
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the
cancelled_terminating
state. Otherwise, the Spot Fleet request enters thecancelled_running
state and the instances continue to run until they are interrupted or you terminate them manually.Restrictions
You can delete up to 100 fleets in a single request. If you exceed the specified number, no fleets are deleted.
See
AWSEC2CancelSpotFleetRequestsRequest
See
AWSEC2CancelSpotFleetRequestsResponse
Declaration
Objective-C
- (void)cancelSpotFleetRequests: (nonnull AWSEC2CancelSpotFleetRequestsRequest *)request completionHandler: (void (^_Nullable)( AWSEC2CancelSpotFleetRequestsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func cancelSpotFleetRequests(_ request: AWSEC2CancelSpotFleetRequestsRequest) async throws -> AWSEC2CancelSpotFleetRequestsResponse
Parameters
request
A container for the necessary parameters to execute the CancelSpotFleetRequests service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
See
AWSEC2CancelSpotInstanceRequestsRequest
See
AWSEC2CancelSpotInstanceRequestsResult
Declaration
Objective-C
- (id)cancelSpotInstanceRequests: (nonnull AWSEC2CancelSpotInstanceRequestsRequest *)request;
Swift
func cancelSpotInstanceRequests(_ request: AWSEC2CancelSpotInstanceRequestsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CancelSpotInstanceRequests service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CancelSpotInstanceRequestsResult
. -
Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
See
AWSEC2CancelSpotInstanceRequestsRequest
See
AWSEC2CancelSpotInstanceRequestsResult
Declaration
Objective-C
- (void)cancelSpotInstanceRequests: (nonnull AWSEC2CancelSpotInstanceRequestsRequest *)request completionHandler: (void (^_Nullable)( AWSEC2CancelSpotInstanceRequestsResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func cancelSpotInstanceRequests(_ request: AWSEC2CancelSpotInstanceRequestsRequest) async throws -> AWSEC2CancelSpotInstanceRequestsResult
Parameters
request
A container for the necessary parameters to execute the CancelSpotInstanceRequests service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user’s instance is eligible for support.
See
AWSEC2ConfirmProductInstanceRequest
See
AWSEC2ConfirmProductInstanceResult
Declaration
Objective-C
- (id)confirmProductInstance: (nonnull AWSEC2ConfirmProductInstanceRequest *)request;
Swift
func confirmProductInstance(_ request: AWSEC2ConfirmProductInstanceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ConfirmProductInstance service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2ConfirmProductInstanceResult
. -
Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user’s instance is eligible for support.
See
AWSEC2ConfirmProductInstanceRequest
See
AWSEC2ConfirmProductInstanceResult
Declaration
Objective-C
- (void) confirmProductInstance: (nonnull AWSEC2ConfirmProductInstanceRequest *)request completionHandler: (void (^_Nullable)(AWSEC2ConfirmProductInstanceResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func confirmProductInstance(_ request: AWSEC2ConfirmProductInstanceRequest) async throws -> AWSEC2ConfirmProductInstanceResult
Parameters
request
A container for the necessary parameters to execute the ConfirmProductInstance service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Copies the specified Amazon FPGA Image (AFI) to the current Region.
See
AWSEC2ReplicateFpgaImageRequest
See
AWSEC2ReplicateFpgaImageResult
Declaration
Objective-C
- (id)replicateFpgaImage:(nonnull AWSEC2ReplicateFpgaImageRequest *)request;
Swift
func replicateFpgaImage(_ request: AWSEC2ReplicateFpgaImageRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CopyFpgaImage service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2ReplicateFpgaImageResult
. -
Copies the specified Amazon FPGA Image (AFI) to the current Region.
See
AWSEC2ReplicateFpgaImageRequest
See
AWSEC2ReplicateFpgaImageResult
Declaration
Objective-C
- (void)replicateFpgaImage:(nonnull AWSEC2ReplicateFpgaImageRequest *)request completionHandler: (void (^_Nullable)(AWSEC2ReplicateFpgaImageResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func replicateFpgaImage(_ request: AWSEC2ReplicateFpgaImageRequest) async throws -> AWSEC2ReplicateFpgaImageResult
Parameters
request
A container for the necessary parameters to execute the CopyFpgaImage service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can’t copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set
Encrypted
during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the Amazon EC2 User Guide.
See
AWSEC2ReplicateImageRequest
See
AWSEC2ReplicateImageResult
Declaration
Objective-C
- (id)replicateImage:(nonnull AWSEC2ReplicateImageRequest *)request;
Swift
func replicateImage(_ request: AWSEC2ReplicateImageRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CopyImage service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2ReplicateImageResult
. -
Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can’t copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set
Encrypted
during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the Amazon EC2 User Guide.
See
AWSEC2ReplicateImageRequest
See
AWSEC2ReplicateImageResult
Declaration
Objective-C
- (void)replicateImage:(nonnull AWSEC2ReplicateImageRequest *)request completionHandler:(void (^_Nullable)(AWSEC2ReplicateImageResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func replicateImage(_ request: AWSEC2ReplicateImageRequest) async throws -> AWSEC2ReplicateImageResult
Parameters
request
A container for the necessary parameters to execute the CopyImage service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can’t copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.
Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copy an Amazon EBS snapshot in the Amazon EBS User Guide.
See
AWSEC2ReplicateSnapshotRequest
See
AWSEC2ReplicateSnapshotResult
Declaration
Objective-C
- (id)replicateSnapshot:(nonnull AWSEC2ReplicateSnapshotRequest *)request;
Swift
func replicateSnapshot(_ request: AWSEC2ReplicateSnapshotRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CopySnapshot service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2ReplicateSnapshotResult
. -
Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can’t copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.
Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copy an Amazon EBS snapshot in the Amazon EBS User Guide.
See
AWSEC2ReplicateSnapshotRequest
See
AWSEC2ReplicateSnapshotResult
Declaration
Objective-C
- (void)replicateSnapshot:(nonnull AWSEC2ReplicateSnapshotRequest *)request completionHandler: (void (^_Nullable)(AWSEC2ReplicateSnapshotResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func replicateSnapshot(_ request: AWSEC2ReplicateSnapshotRequest) async throws -> AWSEC2ReplicateSnapshotResult
Parameters
request
A container for the necessary parameters to execute the CopySnapshot service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.
See
AWSEC2CreateCapacityReservationRequest
See
AWSEC2CreateCapacityReservationResult
Declaration
Objective-C
- (id)createCapacityReservation: (nonnull AWSEC2CreateCapacityReservationRequest *)request;
Swift
func createCapacityReservation(_ request: AWSEC2CreateCapacityReservationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateCapacityReservation service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CreateCapacityReservationResult
. -
Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.
See
AWSEC2CreateCapacityReservationRequest
See
AWSEC2CreateCapacityReservationResult
Declaration
Objective-C
- (void)createCapacityReservation: (nonnull AWSEC2CreateCapacityReservationRequest *)request completionHandler: (void (^_Nullable)( AWSEC2CreateCapacityReservationResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createCapacityReservation(_ request: AWSEC2CreateCapacityReservationRequest) async throws -> AWSEC2CreateCapacityReservationResult
Parameters
request
A container for the necessary parameters to execute the CreateCapacityReservation service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.
See
AWSEC2CreateCapacityReservationFleetRequest
See
AWSEC2CreateCapacityReservationFleetResult
Declaration
Objective-C
- (id)createCapacityReservationFleet: (nonnull AWSEC2CreateCapacityReservationFleetRequest *)request;
Swift
func createCapacityReservationFleet(_ request: AWSEC2CreateCapacityReservationFleetRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateCapacityReservationFleet service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CreateCapacityReservationFleetResult
. -
Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.
See
AWSEC2CreateCapacityReservationFleetRequest
See
AWSEC2CreateCapacityReservationFleetResult
Declaration
Objective-C
- (void) createCapacityReservationFleet: (nonnull AWSEC2CreateCapacityReservationFleetRequest *)request completionHandler: (void (^_Nullable)( AWSEC2CreateCapacityReservationFleetResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createCapacityReservationFleet(_ request: AWSEC2CreateCapacityReservationFleetRequest) async throws -> AWSEC2CreateCapacityReservationFleetResult
Parameters
request
A container for the necessary parameters to execute the CreateCapacityReservationFleet service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.
See
AWSEC2CreateCarrierGatewayRequest
See
AWSEC2CreateCarrierGatewayResult
Declaration
Objective-C
- (id)createCarrierGateway:(nonnull AWSEC2CreateCarrierGatewayRequest *)request;
Swift
func createCarrierGateway(_ request: AWSEC2CreateCarrierGatewayRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateCarrierGateway service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CreateCarrierGatewayResult
. -
Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.
See
AWSEC2CreateCarrierGatewayRequest
See
AWSEC2CreateCarrierGatewayResult
Declaration
Objective-C
- (void)createCarrierGateway: (nonnull AWSEC2CreateCarrierGatewayRequest *)request completionHandler: (void (^_Nullable)(AWSEC2CreateCarrierGatewayResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createCarrierGateway(_ request: AWSEC2CreateCarrierGatewayRequest) async throws -> AWSEC2CreateCarrierGatewayResult
Parameters
request
A container for the necessary parameters to execute the CreateCarrierGateway service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
See
AWSEC2CreateClientVpnEndpointRequest
See
AWSEC2CreateClientVpnEndpointResult
Declaration
Objective-C
- (id)createClientVpnEndpoint: (nonnull AWSEC2CreateClientVpnEndpointRequest *)request;
Swift
func createClientVpnEndpoint(_ request: AWSEC2CreateClientVpnEndpointRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateClientVpnEndpoint service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CreateClientVpnEndpointResult
. -
Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.
See
AWSEC2CreateClientVpnEndpointRequest
See
AWSEC2CreateClientVpnEndpointResult
Declaration
Objective-C
- (void) createClientVpnEndpoint: (nonnull AWSEC2CreateClientVpnEndpointRequest *)request completionHandler: (void (^_Nullable)(AWSEC2CreateClientVpnEndpointResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createClientVpnEndpoint(_ request: AWSEC2CreateClientVpnEndpointRequest) async throws -> AWSEC2CreateClientVpnEndpointResult
Parameters
request
A container for the necessary parameters to execute the CreateClientVpnEndpoint service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.
See
AWSEC2CreateClientVpnRouteRequest
See
AWSEC2CreateClientVpnRouteResult
Declaration
Objective-C
- (id)createClientVpnRoute:(nonnull AWSEC2CreateClientVpnRouteRequest *)request;
Swift
func createClientVpnRoute(_ request: AWSEC2CreateClientVpnRouteRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateClientVpnRoute service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CreateClientVpnRouteResult
. -
Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.
See
AWSEC2CreateClientVpnRouteRequest
See
AWSEC2CreateClientVpnRouteResult
Declaration
Objective-C
- (void)createClientVpnRoute: (nonnull AWSEC2CreateClientVpnRouteRequest *)request completionHandler: (void (^_Nullable)(AWSEC2CreateClientVpnRouteResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createClientVpnRoute(_ request: AWSEC2CreateClientVpnRouteRequest) async throws -> AWSEC2CreateClientVpnRouteResult
Parameters
request
A container for the necessary parameters to execute the CreateClientVpnRoute service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Creates a range of customer-owned IP addresses.
See
AWSEC2CreateCoipCidrRequest
See
AWSEC2CreateCoipCidrResult
Declaration
Objective-C
- (id)createCoipCidr:(nonnull AWSEC2CreateCoipCidrRequest *)request;
Swift
func createCoipCidr(_ request: AWSEC2CreateCoipCidrRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateCoipCidr service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CreateCoipCidrResult
. -
Creates a range of customer-owned IP addresses.
See
AWSEC2CreateCoipCidrRequest
See
AWSEC2CreateCoipCidrResult
Declaration
Objective-C
- (void)createCoipCidr:(nonnull AWSEC2CreateCoipCidrRequest *)request completionHandler:(void (^_Nullable)(AWSEC2CreateCoipCidrResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createCoipCidr(_ request: AWSEC2CreateCoipCidrRequest) async throws -> AWSEC2CreateCoipCidrResult
Parameters
request
A container for the necessary parameters to execute the CreateCoipCidr service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Creates a pool of customer-owned IP (CoIP) addresses.
See
AWSEC2CreateCoipPoolRequest
See
AWSEC2CreateCoipPoolResult
Declaration
Objective-C
- (id)createCoipPool:(nonnull AWSEC2CreateCoipPoolRequest *)request;
Swift
func createCoipPool(_ request: AWSEC2CreateCoipPoolRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateCoipPool service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CreateCoipPoolResult
. -
Creates a pool of customer-owned IP (CoIP) addresses.
See
AWSEC2CreateCoipPoolRequest
See
AWSEC2CreateCoipPoolResult
Declaration
Objective-C
- (void)createCoipPool:(nonnull AWSEC2CreateCoipPoolRequest *)request completionHandler:(void (^_Nullable)(AWSEC2CreateCoipPoolResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createCoipPool(_ request: AWSEC2CreateCoipPoolRequest) async throws -> AWSEC2CreateCoipPoolResult
Parameters
request
A container for the necessary parameters to execute the CreateCoipPool service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Provides information to Amazon Web Services about your customer gateway device. The customer gateway device is the appliance at your end of the VPN connection. You must provide the IP address of the customer gateway device’s external interface. The IP address must be static and can be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device’s BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don’t have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn’t create a new customer gateway.
See
AWSEC2CreateCustomerGatewayRequest
See
AWSEC2CreateCustomerGatewayResult
Declaration
Objective-C
- (id)createCustomerGateway: (nonnull AWSEC2CreateCustomerGatewayRequest *)request;
Swift
func createCustomerGateway(_ request: AWSEC2CreateCustomerGatewayRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateCustomerGateway service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CreateCustomerGatewayResult
. -
Provides information to Amazon Web Services about your customer gateway device. The customer gateway device is the appliance at your end of the VPN connection. You must provide the IP address of the customer gateway device’s external interface. The IP address must be static and can be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device’s BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don’t have an ASN already, you can use a private ASN. For more information, see Customer gateway options for your Site-to-Site VPN connection in the Amazon Web Services Site-to-Site VPN User Guide.
To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn’t create a new customer gateway.
See
AWSEC2CreateCustomerGatewayRequest
See
AWSEC2CreateCustomerGatewayResult
Declaration
Objective-C
- (void)createCustomerGateway: (nonnull AWSEC2CreateCustomerGatewayRequest *)request completionHandler: (void (^_Nullable)(AWSEC2CreateCustomerGatewayResult *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createCustomerGateway(_ request: AWSEC2CreateCustomerGatewayRequest) async throws -> AWSEC2CreateCustomerGatewayResult
Parameters
request
A container for the necessary parameters to execute the CreateCustomerGateway service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. -
Creates a default subnet with a size
/20
IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Create a default subnet in the Amazon VPC User Guide.See
AWSEC2CreateDefaultSubnetRequest
See
AWSEC2CreateDefaultSubnetResult
Declaration
Objective-C
- (id)createDefaultSubnet:(nonnull AWSEC2CreateDefaultSubnetRequest *)request;
Swift
func createDefaultSubnet(_ request: AWSEC2CreateDefaultSubnetRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateDefaultSubnet service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSEC2CreateDefaultSubnetResult
. -