SDK for PHP 3.x

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.

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
throws
InvalidArgumentException

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

__sleep()

public __sleep() : mixed

acceptDirectConnectGatewayAssociationProposal()

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

acceptDirectConnectGatewayAssociationProposalAsync()

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

allocateConnectionOnInterconnect()

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

allocateConnectionOnInterconnectAsync()

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

allocateHostedConnection()

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

allocateHostedConnectionAsync()

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

allocatePrivateVirtualInterface()

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

allocatePrivateVirtualInterfaceAsync()

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

allocatePublicVirtualInterface()

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

allocatePublicVirtualInterfaceAsync()

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

allocateTransitVirtualInterface()

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

allocateTransitVirtualInterfaceAsync()

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

associateConnectionWithLag()

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

associateConnectionWithLagAsync()

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

associateHostedConnection()

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

associateHostedConnectionAsync()

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

associateMacSecKey()

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

associateMacSecKeyAsync()

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

associateVirtualInterface()

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

associateVirtualInterfaceAsync()

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

confirmConnection()

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

confirmConnectionAsync()

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

confirmCustomerAgreement()

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

confirmCustomerAgreementAsync()

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

confirmPrivateVirtualInterface()

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

confirmPrivateVirtualInterfaceAsync()

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

confirmPublicVirtualInterface()

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

confirmPublicVirtualInterfaceAsync()

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

confirmTransitVirtualInterface()

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

confirmTransitVirtualInterfaceAsync()

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

createBGPPeer()

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

createBGPPeerAsync()

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

createConnection()

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

createConnectionAsync()

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

createDirectConnectGateway()

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

createDirectConnectGatewayAssociation()

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

createDirectConnectGatewayAssociationAsync()

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

createDirectConnectGatewayAssociationProposal()

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

createDirectConnectGatewayAssociationProposalAsync()

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

createDirectConnectGatewayAsync()

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

createInterconnect()

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

createInterconnectAsync()

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

createLag()

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

createLagAsync()

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

createPrivateVirtualInterface()

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

createPrivateVirtualInterfaceAsync()

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

createPublicVirtualInterface()

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

createPublicVirtualInterfaceAsync()

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

createTransitVirtualInterface()

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

createTransitVirtualInterfaceAsync()

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

deleteBGPPeer()

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

deleteBGPPeerAsync()

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

deleteConnection()

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

deleteConnectionAsync()

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

deleteDirectConnectGateway()

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

deleteDirectConnectGatewayAssociation()

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

deleteDirectConnectGatewayAssociationAsync()

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

deleteDirectConnectGatewayAssociationProposal()

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

deleteDirectConnectGatewayAssociationProposalAsync()

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

deleteDirectConnectGatewayAsync()

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

deleteInterconnect()

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

deleteInterconnectAsync()

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

deleteLag()

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

deleteLagAsync()

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

deleteVirtualInterface()

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

deleteVirtualInterfaceAsync()

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

describeConnectionLoa()

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

describeConnectionLoaAsync()

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

describeConnections()

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

describeConnectionsAsync()

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

describeConnectionsOnInterconnect()

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

describeConnectionsOnInterconnectAsync()

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

describeCustomerMetadata()

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

describeCustomerMetadataAsync()

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

describeDirectConnectGatewayAssociationProposals()

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

describeDirectConnectGatewayAssociationProposalsAsync()

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

describeDirectConnectGatewayAssociations()

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

describeDirectConnectGatewayAssociationsAsync()

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

describeDirectConnectGatewayAttachments()

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

describeDirectConnectGatewayAttachmentsAsync()

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

describeDirectConnectGateways()

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

describeDirectConnectGatewaysAsync()

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

describeHostedConnections()

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

describeHostedConnectionsAsync()

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

describeInterconnectLoa()

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

describeInterconnectLoaAsync()

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

describeInterconnects()

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

describeInterconnectsAsync()

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

describeLags()

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

describeLagsAsync()

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

describeLoa()

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

describeLoaAsync()

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

describeLocations()

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

describeLocationsAsync()

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

describeRouterConfiguration()

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

describeRouterConfigurationAsync()

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

describeTags()

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

describeTagsAsync()

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

describeVirtualGateways()

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

describeVirtualGatewaysAsync()

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

describeVirtualInterfaces()

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

describeVirtualInterfacesAsync()

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

disassociateConnectionFromLag()

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

disassociateConnectionFromLagAsync()

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

disassociateMacSecKey()

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

disassociateMacSecKeyAsync()

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

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

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>

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
CommandInterface

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

getEndpoint()

Gets the default endpoint, or base URL, used by the client.

public getEndpoint() : UriInterface
Return values
UriInterface

getEndpointProvider()

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
HandlerList

getIterator()

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
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> = []

listVirtualInterfaceTestHistory()

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

listVirtualInterfaceTestHistoryAsync()

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

startBgpFailoverTest()

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

startBgpFailoverTestAsync()

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

stopBgpFailoverTest()

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

stopBgpFailoverTestAsync()

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

tagResource()

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

tagResourceAsync()

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

untagResource()

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

untagResourceAsync()

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

updateConnection()

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

updateConnectionAsync()

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

updateDirectConnectGateway()

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

updateDirectConnectGatewayAssociation()

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

updateDirectConnectGatewayAssociationAsync()

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

updateDirectConnectGatewayAsync()

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

updateLag()

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

updateLagAsync()

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

updateVirtualInterfaceAttributes()

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

updateVirtualInterfaceAttributesAsync()

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

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
On this page