Documentation

DirectConnectClient extends AwsClient
in package

This client is used to interact with the **AWS Direct Connect** service.

Table of Contents

$aliases  : array<string|int, mixed>
$api  : Service
$config  : array<string|int, mixed>
$credentialProvider  : callable
$defaultRequestOptions  : array<string|int, mixed>
$endpoint  : string
$handlerList  : HandlerList
$region  : string
$signatureProvider  : callable
__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
acceptDirectConnectGatewayAssociationProposal()  :
acceptDirectConnectGatewayAssociationProposalAsync()  :
allocateConnectionOnInterconnect()  :
allocateConnectionOnInterconnectAsync()  :
allocateHostedConnection()  :
allocateHostedConnectionAsync()  :
allocatePrivateVirtualInterface()  :
allocatePrivateVirtualInterfaceAsync()  :
allocatePublicVirtualInterface()  :
allocatePublicVirtualInterfaceAsync()  :
allocateTransitVirtualInterface()  :
allocateTransitVirtualInterfaceAsync()  :
associateConnectionWithLag()  :
associateConnectionWithLagAsync()  :
associateHostedConnection()  :
associateHostedConnectionAsync()  :
associateVirtualInterface()  :
associateVirtualInterfaceAsync()  :
confirmConnection()  :
confirmConnectionAsync()  :
confirmPrivateVirtualInterface()  :
confirmPrivateVirtualInterfaceAsync()  :
confirmPublicVirtualInterface()  :
confirmPublicVirtualInterfaceAsync()  :
confirmTransitVirtualInterface()  :
confirmTransitVirtualInterfaceAsync()  :
createBGPPeer()  :
createBGPPeerAsync()  :
createConnection()  :
createConnectionAsync()  :
createDirectConnectGateway()  :
createDirectConnectGatewayAssociation()  :
createDirectConnectGatewayAssociationAsync()  :
createDirectConnectGatewayAssociationProposal()  :
createDirectConnectGatewayAssociationProposalAsync()  :
createDirectConnectGatewayAsync()  :
createInterconnect()  :
createInterconnectAsync()  :
createLag()  :
createLagAsync()  :
createPrivateVirtualInterface()  :
createPrivateVirtualInterfaceAsync()  :
createPublicVirtualInterface()  :
createPublicVirtualInterfaceAsync()  :
createTransitVirtualInterface()  :
createTransitVirtualInterfaceAsync()  :
deleteBGPPeer()  :
deleteBGPPeerAsync()  :
deleteConnection()  :
deleteConnectionAsync()  :
deleteDirectConnectGateway()  :
deleteDirectConnectGatewayAssociation()  :
deleteDirectConnectGatewayAssociationAsync()  :
deleteDirectConnectGatewayAssociationProposal()  :
deleteDirectConnectGatewayAssociationProposalAsync()  :
deleteDirectConnectGatewayAsync()  :
deleteInterconnect()  :
deleteInterconnectAsync()  :
deleteLag()  :
deleteLagAsync()  :
deleteVirtualInterface()  :
deleteVirtualInterfaceAsync()  :
describeConnectionLoa()  :
describeConnectionLoaAsync()  :
describeConnections()  :
describeConnectionsAsync()  :
describeConnectionsOnInterconnect()  :
describeConnectionsOnInterconnectAsync()  :
describeDirectConnectGatewayAssociationProposals()  :
describeDirectConnectGatewayAssociationProposalsAsync()  :
describeDirectConnectGatewayAssociations()  :
describeDirectConnectGatewayAssociationsAsync()  :
describeDirectConnectGatewayAttachments()  :
describeDirectConnectGatewayAttachmentsAsync()  :
describeDirectConnectGateways()  :
describeDirectConnectGatewaysAsync()  :
describeHostedConnections()  :
describeHostedConnectionsAsync()  :
describeInterconnectLoa()  :
describeInterconnectLoaAsync()  :
describeInterconnects()  :
describeInterconnectsAsync()  :
describeLags()  :
describeLagsAsync()  :
describeLoa()  :
describeLoaAsync()  :
describeLocations()  :
describeLocationsAsync()  :
describeTags()  :
describeTagsAsync()  :
describeVirtualGateways()  :
describeVirtualGatewaysAsync()  :
describeVirtualInterfaces()  :
describeVirtualInterfacesAsync()  :
disassociateConnectionFromLag()  :
disassociateConnectionFromLagAsync()  :
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
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.
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()  :
listVirtualInterfaceTestHistoryAsync()  :
startBgpFailoverTest()  :
startBgpFailoverTestAsync()  :
stopBgpFailoverTest()  :
stopBgpFailoverTestAsync()  :
tagResource()  :
tagResourceAsync()  :
untagResource()  :
untagResourceAsync()  :
updateDirectConnectGatewayAssociation()  :
updateDirectConnectGatewayAssociationAsync()  :
updateLag()  :
updateLagAsync()  :
updateVirtualInterfaceAttributes()  :
updateVirtualInterfaceAttributesAsync()  :
waitUntil()  : mixed
addEndpointDiscoveryMiddleware()  : mixed
addEndpointParameterMiddleware()  : mixed
addInvocationId()  : mixed
addSignatureMiddleware()  : mixed
addStreamRequestPayload()  : mixed
loadAliases()  : mixed
parseClass()  : array<string|int, mixed>
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

Properties

$aliases

private array<string|int, mixed> $aliases

$config

private array<string|int, mixed> $config

$credentialProvider

private callable $credentialProvider

$defaultRequestOptions

private array<string|int, mixed> $defaultRequestOptions

$signatureProvider

private callable $signatureProvider

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed>
Return values
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.
  • 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).
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

if any required options are missing or the service is not supported.

Return values
mixed —

__sleep()

public __sleep() : mixed
Return values
mixed —

acceptDirectConnectGatewayAssociationProposal()

public acceptDirectConnectGatewayAssociationProposal(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

acceptDirectConnectGatewayAssociationProposalAsync()

public acceptDirectConnectGatewayAssociationProposalAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

allocateConnectionOnInterconnect()

public allocateConnectionOnInterconnect(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

allocateConnectionOnInterconnectAsync()

public allocateConnectionOnInterconnectAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

allocateHostedConnection()

public allocateHostedConnection(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

allocateHostedConnectionAsync()

public allocateHostedConnectionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

allocatePrivateVirtualInterface()

public allocatePrivateVirtualInterface(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

allocatePrivateVirtualInterfaceAsync()

public allocatePrivateVirtualInterfaceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

allocatePublicVirtualInterface()

public allocatePublicVirtualInterface(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

allocatePublicVirtualInterfaceAsync()

public allocatePublicVirtualInterfaceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

allocateTransitVirtualInterface()

public allocateTransitVirtualInterface(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

allocateTransitVirtualInterfaceAsync()

public allocateTransitVirtualInterfaceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

associateConnectionWithLag()

public associateConnectionWithLag(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

associateConnectionWithLagAsync()

public associateConnectionWithLagAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

associateHostedConnection()

public associateHostedConnection(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

associateHostedConnectionAsync()

public associateHostedConnectionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

associateVirtualInterface()

public associateVirtualInterface(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

associateVirtualInterfaceAsync()

public associateVirtualInterfaceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

confirmConnection()

public confirmConnection(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

confirmConnectionAsync()

public confirmConnectionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

confirmPrivateVirtualInterface()

public confirmPrivateVirtualInterface(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

confirmPrivateVirtualInterfaceAsync()

public confirmPrivateVirtualInterfaceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

confirmPublicVirtualInterface()

public confirmPublicVirtualInterface(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

confirmPublicVirtualInterfaceAsync()

public confirmPublicVirtualInterfaceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

confirmTransitVirtualInterface()

public confirmTransitVirtualInterface(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

confirmTransitVirtualInterfaceAsync()

public confirmTransitVirtualInterfaceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createBGPPeer()

public createBGPPeer(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createBGPPeerAsync()

public createBGPPeerAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createConnection()

public createConnection(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createConnectionAsync()

public createConnectionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createDirectConnectGateway()

public createDirectConnectGateway(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createDirectConnectGatewayAssociation()

public createDirectConnectGatewayAssociation(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createDirectConnectGatewayAssociationAsync()

public createDirectConnectGatewayAssociationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createDirectConnectGatewayAssociationProposal()

public createDirectConnectGatewayAssociationProposal(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createDirectConnectGatewayAssociationProposalAsync()

public createDirectConnectGatewayAssociationProposalAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createDirectConnectGatewayAsync()

public createDirectConnectGatewayAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createInterconnect()

public createInterconnect(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createInterconnectAsync()

public createInterconnectAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createLag()

public createLag(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createLagAsync()

public createLagAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createPrivateVirtualInterface()

public createPrivateVirtualInterface(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createPrivateVirtualInterfaceAsync()

public createPrivateVirtualInterfaceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createPublicVirtualInterface()

public createPublicVirtualInterface(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createPublicVirtualInterfaceAsync()

public createPublicVirtualInterfaceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createTransitVirtualInterface()

public createTransitVirtualInterface(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createTransitVirtualInterfaceAsync()

public createTransitVirtualInterfaceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteBGPPeer()

public deleteBGPPeer(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteBGPPeerAsync()

public deleteBGPPeerAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteConnection()

public deleteConnection(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteConnectionAsync()

public deleteConnectionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteDirectConnectGateway()

public deleteDirectConnectGateway(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteDirectConnectGatewayAssociation()

public deleteDirectConnectGatewayAssociation(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteDirectConnectGatewayAssociationAsync()

public deleteDirectConnectGatewayAssociationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteDirectConnectGatewayAssociationProposal()

public deleteDirectConnectGatewayAssociationProposal(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteDirectConnectGatewayAssociationProposalAsync()

public deleteDirectConnectGatewayAssociationProposalAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteDirectConnectGatewayAsync()

public deleteDirectConnectGatewayAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteInterconnect()

public deleteInterconnect(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteInterconnectAsync()

public deleteInterconnectAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteLag()

public deleteLag(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteLagAsync()

public deleteLagAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteVirtualInterface()

public deleteVirtualInterface(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteVirtualInterfaceAsync()

public deleteVirtualInterfaceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConnectionLoa()

public describeConnectionLoa(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConnectionLoaAsync()

public describeConnectionLoaAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConnections()

public describeConnections(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConnectionsAsync()

public describeConnectionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConnectionsOnInterconnect()

public describeConnectionsOnInterconnect(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeConnectionsOnInterconnectAsync()

public describeConnectionsOnInterconnectAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeDirectConnectGatewayAssociationProposals()

public describeDirectConnectGatewayAssociationProposals(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeDirectConnectGatewayAssociationProposalsAsync()

public describeDirectConnectGatewayAssociationProposalsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeDirectConnectGatewayAssociations()

public describeDirectConnectGatewayAssociations(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeDirectConnectGatewayAssociationsAsync()

public describeDirectConnectGatewayAssociationsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeDirectConnectGatewayAttachments()

public describeDirectConnectGatewayAttachments(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeDirectConnectGatewayAttachmentsAsync()

public describeDirectConnectGatewayAttachmentsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeDirectConnectGateways()

public describeDirectConnectGateways(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeDirectConnectGatewaysAsync()

public describeDirectConnectGatewaysAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeHostedConnections()

public describeHostedConnections(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeHostedConnectionsAsync()

public describeHostedConnectionsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeInterconnectLoa()

public describeInterconnectLoa(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeInterconnectLoaAsync()

public describeInterconnectLoaAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeInterconnects()

public describeInterconnects(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeInterconnectsAsync()

public describeInterconnectsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeLags()

public describeLags(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeLagsAsync()

public describeLagsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeLoa()

public describeLoa(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeLoaAsync()

public describeLoaAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeLocations()

public describeLocations(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeLocationsAsync()

public describeLocationsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeTags()

public describeTags(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeTagsAsync()

public describeTagsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeVirtualGateways()

public describeVirtualGateways(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeVirtualGatewaysAsync()

public describeVirtualGatewaysAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeVirtualInterfaces()

public describeVirtualInterfaces(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeVirtualInterfacesAsync()

public describeVirtualInterfacesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

disassociateConnectionFromLag()

public disassociateConnectionFromLag(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

disassociateConnectionFromLagAsync()

public disassociateConnectionFromLagAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

factory()

public static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
$config : array<string|int, mixed> = []
Tags
deprecated
Return values
static —

getArguments()

Get an array of client constructor arguments used by the client.

public static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getConfig()

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|null —

getCredentials()

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
PromiseInterface —

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
HandlerList —

getIterator()

public getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

getPaginator()

public getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

getRegion()

Get the region to which the client is configured to send requests.

public getRegion() : string
Return values
string —

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable —

getWaiter()

public getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

listVirtualInterfaceTestHistory()

public listVirtualInterfaceTestHistory(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listVirtualInterfaceTestHistoryAsync()

public listVirtualInterfaceTestHistoryAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startBgpFailoverTest()

public startBgpFailoverTest(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startBgpFailoverTestAsync()

public startBgpFailoverTestAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

stopBgpFailoverTest()

public stopBgpFailoverTest(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

stopBgpFailoverTestAsync()

public stopBgpFailoverTestAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

tagResource()

public tagResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

tagResourceAsync()

public tagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

untagResource()

public untagResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

untagResourceAsync()

public untagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateDirectConnectGatewayAssociation()

public updateDirectConnectGatewayAssociation(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateDirectConnectGatewayAssociationAsync()

public updateDirectConnectGatewayAssociationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateLag()

public updateLag(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateLagAsync()

public updateLagAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateVirtualInterfaceAttributes()

public updateVirtualInterfaceAttributes(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateVirtualInterfaceAttributesAsync()

public updateVirtualInterfaceAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

addEndpointDiscoveryMiddleware()

private addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
$config : mixed
$args : mixed
Return values
mixed —

addEndpointParameterMiddleware()

private addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
$args : mixed
Return values
mixed —

addInvocationId()

private addInvocationId() : mixed
Return values
mixed —

addSignatureMiddleware()

private addSignatureMiddleware() : mixed
Return values
mixed —

addStreamRequestPayload()

private addStreamRequestPayload() : mixed
Return values
mixed —

loadAliases()

private loadAliases([mixed $file = null ]) : mixed
Parameters
$file : mixed = null
Return values
mixed —

parseClass()

Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

private parseClass() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results