Table of Contents
ApiGatewayManagementApi.
Client
¶A low-level client representing AmazonApiGatewayManagementApi
The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.
import boto3
client = boto3.client('apigatewaymanagementapi')
These are the available methods:
can_paginate()
close()
delete_connection()
get_connection()
get_paginator()
get_waiter()
post_to_connection()
can_paginate
(operation_name)¶Check if an operation can be paginated.
create_foo
, and you'd normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.True
if the operation can be paginated,
False
otherwise.close
()¶Closes underlying endpoint connections.
delete_connection
(**kwargs)¶Delete the connection with the provided id.
See also: AWS API Documentation
Request Syntax
response = client.delete_connection(
ConnectionId='string'
)
Exceptions
ApiGatewayManagementApi.Client.exceptions.GoneException
ApiGatewayManagementApi.Client.exceptions.LimitExceededException
ApiGatewayManagementApi.Client.exceptions.ForbiddenException
get_connection
(**kwargs)¶Get information about the connection with the provided id.
See also: AWS API Documentation
Request Syntax
response = client.get_connection(
ConnectionId='string'
)
{
'ConnectedAt': datetime(2015, 1, 1),
'Identity': {
'SourceIp': 'string',
'UserAgent': 'string'
},
'LastActiveAt': datetime(2015, 1, 1)
}
Response Structure
The time in ISO 8601 format for when the connection was established.
The source IP address of the TCP connection making the request to API Gateway.
The User Agent of the API caller.
The time in ISO 8601 format for when the connection was last active.
Exceptions
ApiGatewayManagementApi.Client.exceptions.GoneException
ApiGatewayManagementApi.Client.exceptions.LimitExceededException
ApiGatewayManagementApi.Client.exceptions.ForbiddenException
get_paginator
(operation_name)¶Create a paginator for an operation.
create_foo
, and you'd normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.client.can_paginate
method to
check if an operation is pageable.get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
post_to_connection
(**kwargs)¶Sends the provided data to the specified connection.
See also: AWS API Documentation
Request Syntax
response = client.post_to_connection(
Data=b'bytes'|file,
ConnectionId='string'
)
[REQUIRED]
The data to be sent to the client specified by its connection id.
[REQUIRED]
The identifier of the connection that a specific client is using.
None
Exceptions
ApiGatewayManagementApi.Client.exceptions.GoneException
ApiGatewayManagementApi.Client.exceptions.LimitExceededException
ApiGatewayManagementApi.Client.exceptions.PayloadTooLargeException
ApiGatewayManagementApi.Client.exceptions.ForbiddenException
The available paginators are: