DirectConnectClient
extends AwsClient
in package
This client is used to interact with the AWS Direct Connect service.
Supported API Versions
This class uses a service description model that is associated at
runtime based on the version
option given when constructing the
client. The version
option will determine which API operations,
waiters, and paginators are available for a client. Creating a command or a
specific API operation can be done using magic methods (e.g.,
$client->commandName(/** parameters */)
, or using the
$client->getCommand
method of the client.
- AcceptDirectConnectGatewayAssociationProposal
- AllocateConnectionOnInterconnect
- AllocateHostedConnection
- AllocatePrivateVirtualInterface
- AllocatePublicVirtualInterface
- AllocateTransitVirtualInterface
- AssociateConnectionWithLag
- AssociateHostedConnection
- AssociateMacSecKey
- AssociateVirtualInterface
- ConfirmConnection
- ConfirmCustomerAgreement
- ConfirmPrivateVirtualInterface
- ConfirmPublicVirtualInterface
- ConfirmTransitVirtualInterface
- CreateBGPPeer
- CreateConnection
- CreateDirectConnectGateway
- CreateDirectConnectGatewayAssociation
- CreateDirectConnectGatewayAssociationProposal
- CreateInterconnect
- CreateLag
- CreatePrivateVirtualInterface
- CreatePublicVirtualInterface
- CreateTransitVirtualInterface
- DeleteBGPPeer
- DeleteConnection
- DeleteDirectConnectGateway
- DeleteDirectConnectGatewayAssociation
- DeleteDirectConnectGatewayAssociationProposal
- DeleteInterconnect
- DeleteLag
- DeleteVirtualInterface
- DescribeConnectionLoa
- DescribeConnections
- DescribeConnectionsOnInterconnect
- DescribeCustomerMetadata
- DescribeDirectConnectGatewayAssociationProposals
- DescribeDirectConnectGatewayAssociations
- DescribeDirectConnectGatewayAttachments
- DescribeDirectConnectGateways
- DescribeHostedConnections
- DescribeInterconnectLoa
- DescribeInterconnects
- DescribeLags
- DescribeLoa
- DescribeLocations
- DescribeRouterConfiguration
- DescribeTags
- DescribeVirtualGateways
- DescribeVirtualInterfaces
- DisassociateConnectionFromLag
- DisassociateMacSecKey
- ListVirtualInterfaceTestHistory
- StartBgpFailoverTest
- StopBgpFailoverTest
- TagResource
- UntagResource
- UpdateConnection
- UpdateDirectConnectGateway
- UpdateDirectConnectGatewayAssociation
- UpdateLag
- UpdateVirtualInterfaceAttributes
Table of Contents
Methods
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- acceptDirectConnectGatewayAssociationProposal() : Result
- acceptDirectConnectGatewayAssociationProposalAsync() : Promise
- allocateConnectionOnInterconnect() : Result
- allocateConnectionOnInterconnectAsync() : Promise
- allocateHostedConnection() : Result
- allocateHostedConnectionAsync() : Promise
- allocatePrivateVirtualInterface() : Result
- allocatePrivateVirtualInterfaceAsync() : Promise
- allocatePublicVirtualInterface() : Result
- allocatePublicVirtualInterfaceAsync() : Promise
- allocateTransitVirtualInterface() : Result
- allocateTransitVirtualInterfaceAsync() : Promise
- associateConnectionWithLag() : Result
- associateConnectionWithLagAsync() : Promise
- associateHostedConnection() : Result
- associateHostedConnectionAsync() : Promise
- associateMacSecKey() : Result
- associateMacSecKeyAsync() : Promise
- associateVirtualInterface() : Result
- associateVirtualInterfaceAsync() : Promise
- confirmConnection() : Result
- confirmConnectionAsync() : Promise
- confirmCustomerAgreement() : Result
- confirmCustomerAgreementAsync() : Promise
- confirmPrivateVirtualInterface() : Result
- confirmPrivateVirtualInterfaceAsync() : Promise
- confirmPublicVirtualInterface() : Result
- confirmPublicVirtualInterfaceAsync() : Promise
- confirmTransitVirtualInterface() : Result
- confirmTransitVirtualInterfaceAsync() : Promise
- createBGPPeer() : Result
- createBGPPeerAsync() : Promise
- createConnection() : Result
- createConnectionAsync() : Promise
- createDirectConnectGateway() : Result
- createDirectConnectGatewayAssociation() : Result
- createDirectConnectGatewayAssociationAsync() : Promise
- createDirectConnectGatewayAssociationProposal() : Result
- createDirectConnectGatewayAssociationProposalAsync() : Promise
- createDirectConnectGatewayAsync() : Promise
- createInterconnect() : Result
- createInterconnectAsync() : Promise
- createLag() : Result
- createLagAsync() : Promise
- createPrivateVirtualInterface() : Result
- createPrivateVirtualInterfaceAsync() : Promise
- createPublicVirtualInterface() : Result
- createPublicVirtualInterfaceAsync() : Promise
- createTransitVirtualInterface() : Result
- createTransitVirtualInterfaceAsync() : Promise
- deleteBGPPeer() : Result
- deleteBGPPeerAsync() : Promise
- deleteConnection() : Result
- deleteConnectionAsync() : Promise
- deleteDirectConnectGateway() : Result
- deleteDirectConnectGatewayAssociation() : Result
- deleteDirectConnectGatewayAssociationAsync() : Promise
- deleteDirectConnectGatewayAssociationProposal() : Result
- deleteDirectConnectGatewayAssociationProposalAsync() : Promise
- deleteDirectConnectGatewayAsync() : Promise
- deleteInterconnect() : Result
- deleteInterconnectAsync() : Promise
- deleteLag() : Result
- deleteLagAsync() : Promise
- deleteVirtualInterface() : Result
- deleteVirtualInterfaceAsync() : Promise
- describeConnectionLoa() : Result
- describeConnectionLoaAsync() : Promise
- describeConnections() : Result
- describeConnectionsAsync() : Promise
- describeConnectionsOnInterconnect() : Result
- describeConnectionsOnInterconnectAsync() : Promise
- describeCustomerMetadata() : Result
- describeCustomerMetadataAsync() : Promise
- describeDirectConnectGatewayAssociationProposals() : Result
- describeDirectConnectGatewayAssociationProposalsAsync() : Promise
- describeDirectConnectGatewayAssociations() : Result
- describeDirectConnectGatewayAssociationsAsync() : Promise
- describeDirectConnectGatewayAttachments() : Result
- describeDirectConnectGatewayAttachmentsAsync() : Promise
- describeDirectConnectGateways() : Result
- describeDirectConnectGatewaysAsync() : Promise
- describeHostedConnections() : Result
- describeHostedConnectionsAsync() : Promise
- describeInterconnectLoa() : Result
- describeInterconnectLoaAsync() : Promise
- describeInterconnects() : Result
- describeInterconnectsAsync() : Promise
- describeLags() : Result
- describeLagsAsync() : Promise
- describeLoa() : Result
- describeLoaAsync() : Promise
- describeLocations() : Result
- describeLocationsAsync() : Promise
- describeRouterConfiguration() : Result
- describeRouterConfigurationAsync() : Promise
- describeTags() : Result
- describeTagsAsync() : Promise
- describeVirtualGateways() : Result
- describeVirtualGatewaysAsync() : Promise
- describeVirtualInterfaces() : Result
- describeVirtualInterfacesAsync() : Promise
- disassociateConnectionFromLag() : Result
- disassociateConnectionFromLagAsync() : Promise
- disassociateMacSecKey() : Result
- disassociateMacSecKeyAsync() : Promise
- emitDeprecationWarning() : mixed
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- getApi() : Service
- getArguments() : array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
- getClientBuiltIns() : array<string|int, mixed>
- Provides the set of built-in keys and values used for endpoint resolution
- getClientContextParams() : array<string|int, mixed>
- Provides the set of service context parameter key-value pairs used for endpoint resolution.
- getCommand() : CommandInterface
- getConfig() : mixed|null
- Get a client configuration value.
- getCredentials() : PromiseInterface
- Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
- getEndpoint() : UriInterface
- Gets the default endpoint, or base URL, used by the client.
- getEndpointProvider() : mixed
- getEndpointProviderArgs() : array<string|int, mixed>
- Retrieves arguments to be used in endpoint resolution.
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getIterator() : mixed
- getPaginator() : mixed
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getWaiter() : mixed
- listVirtualInterfaceTestHistory() : Result
- listVirtualInterfaceTestHistoryAsync() : Promise
- startBgpFailoverTest() : Result
- startBgpFailoverTestAsync() : Promise
- stopBgpFailoverTest() : Result
- stopBgpFailoverTestAsync() : Promise
- tagResource() : Result
- tagResourceAsync() : Promise
- untagResource() : Result
- untagResourceAsync() : Promise
- updateConnection() : Result
- updateConnectionAsync() : Promise
- updateDirectConnectGateway() : Result
- updateDirectConnectGatewayAssociation() : Result
- updateDirectConnectGatewayAssociationAsync() : Promise
- updateDirectConnectGatewayAsync() : Promise
- updateLag() : Result
- updateLagAsync() : Promise
- updateVirtualInterfaceAttributes() : Result
- updateVirtualInterfaceAttributesAsync() : Promise
- waitUntil() : mixed
Methods
__call()
public
__call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed>
__construct()
The client constructor accepts the following options:
public
__construct(array<string|int, mixed> $args) : mixed
- api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
- credentials:
(Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies
the credentials used to sign requests. Provide an
Aws\Credentials\CredentialsInterface object, an associative array of
"key", "secret", and an optional "token" key,
false
to use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment. - token:
(Aws\Token\TokenInterface|array|bool|callable) Specifies
the token used to authorize requests. Provide an
Aws\Token\TokenInterface object, an associative array of
"token" and an optional "expires" key,
false
to use no token, or a callable token provider used to create a token or return null. See Aws\Token\TokenProvider for a list of built-in token providers. If no token is provided, the SDK will attempt to load one from the environment. - csm:
(Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies
the credentials used to sign requests. Provide an
Aws\ClientSideMonitoring\ConfigurationInterface object, a callable
configuration provider used to create client-side monitoring configuration,
false
to disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project - debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
- stats: (bool|array) Set to true to gather transfer statistics on
requests sent. Alternatively, you can provide an associative array with
the following keys: retries: (bool) Set to false to disable reporting
on retries attempted; http: (bool) Set to true to enable collecting
statistics from lower level HTTP adapters (e.g., values returned in
GuzzleHttp\TransferStats). HTTP handlers must support an
http_stats_receiver
option for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds. - disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
- endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
- endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
- endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
- handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
- http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
- http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
- idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
- profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
- region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
- retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
- scheme: (string, default=string(5) "https") URI scheme to use when
connecting connect. The SDK will utilize "https" endpoints (i.e.,
utilize SSL/TLS connections) by default. You can attempt to connect to
a service over an unencrypted "http" endpoint by setting
scheme
to "http". - signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
- signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
- use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
- validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
- version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
- ua_append: (string, array) To pass custom user agent parameters.
- app_id: (string) an optional application specific identifier that can be set. When set it will be appended to the User-Agent header of every request in the form of App/{AppId}. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. See https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html for more information on environment variables and shared config settings.
Parameters
- $args : array<string|int, mixed>
-
Client configuration arguments.
Tags
__sleep()
public
__sleep() : mixed
acceptDirectConnectGatewayAssociationProposal()
public
acceptDirectConnectGatewayAssociationProposal(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultacceptDirectConnectGatewayAssociationProposalAsync()
public
acceptDirectConnectGatewayAssociationProposalAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseallocateConnectionOnInterconnect()
public
allocateConnectionOnInterconnect(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultallocateConnectionOnInterconnectAsync()
public
allocateConnectionOnInterconnectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseallocateHostedConnection()
public
allocateHostedConnection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultallocateHostedConnectionAsync()
public
allocateHostedConnectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseallocatePrivateVirtualInterface()
public
allocatePrivateVirtualInterface(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultallocatePrivateVirtualInterfaceAsync()
public
allocatePrivateVirtualInterfaceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseallocatePublicVirtualInterface()
public
allocatePublicVirtualInterface(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultallocatePublicVirtualInterfaceAsync()
public
allocatePublicVirtualInterfaceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseallocateTransitVirtualInterface()
public
allocateTransitVirtualInterface(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultallocateTransitVirtualInterfaceAsync()
public
allocateTransitVirtualInterfaceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseassociateConnectionWithLag()
public
associateConnectionWithLag(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultassociateConnectionWithLagAsync()
public
associateConnectionWithLagAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseassociateHostedConnection()
public
associateHostedConnection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultassociateHostedConnectionAsync()
public
associateHostedConnectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseassociateMacSecKey()
public
associateMacSecKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultassociateMacSecKeyAsync()
public
associateMacSecKeyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseassociateVirtualInterface()
public
associateVirtualInterface(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultassociateVirtualInterfaceAsync()
public
associateVirtualInterfaceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseconfirmConnection()
public
confirmConnection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultconfirmConnectionAsync()
public
confirmConnectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseconfirmCustomerAgreement()
public
confirmCustomerAgreement(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultconfirmCustomerAgreementAsync()
public
confirmCustomerAgreementAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseconfirmPrivateVirtualInterface()
public
confirmPrivateVirtualInterface(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultconfirmPrivateVirtualInterfaceAsync()
public
confirmPrivateVirtualInterfaceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseconfirmPublicVirtualInterface()
public
confirmPublicVirtualInterface(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultconfirmPublicVirtualInterfaceAsync()
public
confirmPublicVirtualInterfaceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseconfirmTransitVirtualInterface()
public
confirmTransitVirtualInterface(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultconfirmTransitVirtualInterfaceAsync()
public
confirmTransitVirtualInterfaceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateBGPPeer()
public
createBGPPeer(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateBGPPeerAsync()
public
createBGPPeerAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateConnection()
public
createConnection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateConnectionAsync()
public
createConnectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateDirectConnectGateway()
public
createDirectConnectGateway(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateDirectConnectGatewayAssociation()
public
createDirectConnectGatewayAssociation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateDirectConnectGatewayAssociationAsync()
public
createDirectConnectGatewayAssociationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateDirectConnectGatewayAssociationProposal()
public
createDirectConnectGatewayAssociationProposal(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateDirectConnectGatewayAssociationProposalAsync()
public
createDirectConnectGatewayAssociationProposalAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateDirectConnectGatewayAsync()
public
createDirectConnectGatewayAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateInterconnect()
public
createInterconnect(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateInterconnectAsync()
public
createInterconnectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateLag()
public
createLag(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateLagAsync()
public
createLagAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreatePrivateVirtualInterface()
public
createPrivateVirtualInterface(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreatePrivateVirtualInterfaceAsync()
public
createPrivateVirtualInterfaceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreatePublicVirtualInterface()
public
createPublicVirtualInterface(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreatePublicVirtualInterfaceAsync()
public
createPublicVirtualInterfaceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateTransitVirtualInterface()
public
createTransitVirtualInterface(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateTransitVirtualInterfaceAsync()
public
createTransitVirtualInterfaceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteBGPPeer()
public
deleteBGPPeer(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteBGPPeerAsync()
public
deleteBGPPeerAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteConnection()
public
deleteConnection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteConnectionAsync()
public
deleteConnectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteDirectConnectGateway()
public
deleteDirectConnectGateway(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteDirectConnectGatewayAssociation()
public
deleteDirectConnectGatewayAssociation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteDirectConnectGatewayAssociationAsync()
public
deleteDirectConnectGatewayAssociationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteDirectConnectGatewayAssociationProposal()
public
deleteDirectConnectGatewayAssociationProposal(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteDirectConnectGatewayAssociationProposalAsync()
public
deleteDirectConnectGatewayAssociationProposalAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteDirectConnectGatewayAsync()
public
deleteDirectConnectGatewayAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteInterconnect()
public
deleteInterconnect(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteInterconnectAsync()
public
deleteInterconnectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteLag()
public
deleteLag(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteLagAsync()
public
deleteLagAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteVirtualInterface()
public
deleteVirtualInterface(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteVirtualInterfaceAsync()
public
deleteVirtualInterfaceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeConnectionLoa()
public
describeConnectionLoa(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeConnectionLoaAsync()
public
describeConnectionLoaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeConnections()
public
describeConnections(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeConnectionsAsync()
public
describeConnectionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeConnectionsOnInterconnect()
public
describeConnectionsOnInterconnect(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeConnectionsOnInterconnectAsync()
public
describeConnectionsOnInterconnectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeCustomerMetadata()
public
describeCustomerMetadata(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeCustomerMetadataAsync()
public
describeCustomerMetadataAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeDirectConnectGatewayAssociationProposals()
public
describeDirectConnectGatewayAssociationProposals(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeDirectConnectGatewayAssociationProposalsAsync()
public
describeDirectConnectGatewayAssociationProposalsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeDirectConnectGatewayAssociations()
public
describeDirectConnectGatewayAssociations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeDirectConnectGatewayAssociationsAsync()
public
describeDirectConnectGatewayAssociationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeDirectConnectGatewayAttachments()
public
describeDirectConnectGatewayAttachments(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeDirectConnectGatewayAttachmentsAsync()
public
describeDirectConnectGatewayAttachmentsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeDirectConnectGateways()
public
describeDirectConnectGateways(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeDirectConnectGatewaysAsync()
public
describeDirectConnectGatewaysAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeHostedConnections()
public
describeHostedConnections(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeHostedConnectionsAsync()
public
describeHostedConnectionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeInterconnectLoa()
public
describeInterconnectLoa(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeInterconnectLoaAsync()
public
describeInterconnectLoaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeInterconnects()
public
describeInterconnects(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeInterconnectsAsync()
public
describeInterconnectsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeLags()
public
describeLags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeLagsAsync()
public
describeLagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeLoa()
public
describeLoa(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeLoaAsync()
public
describeLoaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeLocations()
public
describeLocations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeLocationsAsync()
public
describeLocationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeRouterConfiguration()
public
describeRouterConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeRouterConfigurationAsync()
public
describeRouterConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeTags()
public
describeTags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeTagsAsync()
public
describeTagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeVirtualGateways()
public
describeVirtualGateways(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeVirtualGatewaysAsync()
public
describeVirtualGatewaysAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeVirtualInterfaces()
public
describeVirtualInterfaces(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeVirtualInterfacesAsync()
public
describeVirtualInterfacesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedisassociateConnectionFromLag()
public
disassociateConnectionFromLag(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdisassociateConnectionFromLagAsync()
public
disassociateConnectionFromLagAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedisassociateMacSecKey()
public
disassociateMacSecKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdisassociateMacSecKeyAsync()
public
disassociateMacSecKeyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseemitDeprecationWarning()
public
static emitDeprecationWarning() : mixed
execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
staticgetApi()
public
abstract getApi() : Service
Return values
ServicegetArguments()
Get an array of client constructor arguments used by the client.
public
static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>getClientBuiltIns()
Provides the set of built-in keys and values used for endpoint resolution
public
getClientBuiltIns() : array<string|int, mixed>
Return values
array<string|int, mixed>getClientContextParams()
Provides the set of service context parameter key-value pairs used for endpoint resolution.
public
getClientContextParams() : array<string|int, mixed>
Return values
array<string|int, mixed>getCommand()
public
abstract getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Parameters
- $name : string
- $args : array<string|int, mixed> = []
Return values
CommandInterfacegetConfig()
Get a client configuration value.
public
getConfig([mixed $option = null ]) : mixed|null
Parameters
- $option : mixed = null
-
The option to retrieve. Pass null to retrieve all options.
Return values
mixed|nullgetCredentials()
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
public
getCredentials() : PromiseInterface
If you need the credentials synchronously, then call the wait() method on the returned promise.
Return values
PromiseInterfacegetEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterfacegetEndpointProvider()
public
getEndpointProvider() : mixed
getEndpointProviderArgs()
Retrieves arguments to be used in endpoint resolution.
public
getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>getHandlerList()
Get the handler list used to transfer commands.
public
getHandlerList() : HandlerList
This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.
Return values
HandlerListgetIterator()
public
getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
stringgetSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callablegetWaiter()
public
getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
listVirtualInterfaceTestHistory()
public
listVirtualInterfaceTestHistory(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistVirtualInterfaceTestHistoryAsync()
public
listVirtualInterfaceTestHistoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestartBgpFailoverTest()
public
startBgpFailoverTest(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstartBgpFailoverTestAsync()
public
startBgpFailoverTestAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestopBgpFailoverTest()
public
stopBgpFailoverTest(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstopBgpFailoverTestAsync()
public
stopBgpFailoverTestAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagResource()
public
tagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagResourceAsync()
public
tagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagResource()
public
untagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagResourceAsync()
public
untagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateConnection()
public
updateConnection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateConnectionAsync()
public
updateConnectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateDirectConnectGateway()
public
updateDirectConnectGateway(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateDirectConnectGatewayAssociation()
public
updateDirectConnectGatewayAssociation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateDirectConnectGatewayAssociationAsync()
public
updateDirectConnectGatewayAssociationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateDirectConnectGatewayAsync()
public
updateDirectConnectGatewayAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateLag()
public
updateLag(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateLagAsync()
public
updateLagAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateVirtualInterfaceAttributes()
public
updateVirtualInterfaceAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateVirtualInterfaceAttributesAsync()
public
updateVirtualInterfaceAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisewaitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []